From d30226d55bcc3dd03c3df2006f6cc775dfdfe10f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krist=C3=B3f=20T=C3=B3th?= Date: Fri, 11 May 2018 14:07:59 +0200 Subject: [PATCH] Extend docstrings in server_connector --- lib/tfw/networking/event_handlers/server_connector.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/tfw/networking/event_handlers/server_connector.py b/lib/tfw/networking/event_handlers/server_connector.py index 29c89da..6685ead 100644 --- a/lib/tfw/networking/event_handlers/server_connector.py +++ b/lib/tfw/networking/event_handlers/server_connector.py @@ -35,6 +35,9 @@ class ServerUplinkConnector(ZMQConnectorBase): def send_to_eventhandler(self, message): """ Send a message to an event handler. + This envelopes the desired message in the 'data' field of the message to + TFWServer, which will mirror it to event handlers. + :param message: JSON message you want to send :param message['key']: key of event handler you want to address """ @@ -46,6 +49,7 @@ class ServerUplinkConnector(ZMQConnectorBase): def send(self, message): """ Send a message to the TFW server + :param message: JSON message you want to send """ self._zmq_push_socket.send_multipart(serialize_tfw_msg(message))