GoldenPogacsa/producer
GoldenPogacsa/producer
Archived
7
0
Fork 0
Code Issues Pull Requests Releases Activity

docs #6

Merged
dscharnitzky merged 7 commits from docs into master 2020-04-08 23:05:32 +02:00
Conversation 0 Commits 7 Files Changed 17 +8 -7
3 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit b31213c55c - Show all commits

3
communicator.py
View File

@ -21,7 +21,8 @@ class Communicator:
""" """
def __init__(self, currentconsumer: str, uuid: str): def __init__(self, currentconsumer: str, uuid: str):
"""Initialize object """**Constructor:**
Initializes the object.
:param consumerlocator: the current consumer's IP address as a string :param consumerlocator: the current consumer's IP address as a string
:param uuid: string typed UUID. :param uuid: string typed UUID.

9
consumerlocator.py
View File

@ -8,7 +8,6 @@ import datetime
from communicator import Communicator from communicator import Communicator
import os import os
__author__ = "@dscharnitzky" __author__ = "@dscharnitzky"
__copyright__ = "Copyright 2020, GoldenPogácsa Team" __copyright__ = "Copyright 2020, GoldenPogácsa Team"
__module_name__ = "consumerlocator" __module_name__ = "consumerlocator"
@ -23,13 +22,13 @@ class ConsumerLocator:
""" """
def __init__(self, uuid: str, communicator: Communicator): def __init__(self, uuid: str, communicator: Communicator):
"""Initializes the object. """**Constructor:**
Initializes the object.
Gets the known consumer's IP address from the PRODUCER_KNOWNCONSUMER envar. Gets the known consumer's IP address from the PRODUCER_KNOWNCONSUMER envar.
:param str uuid: Not used :param uuid: Not used
:param communicator: the :class:'communicator.Communicator' instance that will be used for the low level :param communicator: the :class:'communicator.Communicator' instance that will be used for the low level communication.
communication.
""" """
self.consumerlist = [{"Host": KNOWNCONSUMER, "State": True, "LastOk": datetime.datetime.now()}] self.consumerlist = [{"Host": KNOWNCONSUMER, "State": True, "LastOk": datetime.datetime.now()}]
self.currentconsumer = self.consumerlist[0] self.currentconsumer = self.consumerlist[0]

3
messagesender.py
View File

@ -24,7 +24,8 @@ class MessageSender:
""" """
def __init__(self, communicator: Communicator): def __init__(self, communicator: Communicator):
"""Initializes the object. """**Constructor:**
Initializes the object.
:param communicator: an instance of :class:`communicator.Communicator`. :param communicator: an instance of :class:`communicator.Communicator`.
""" """