mirror of
https://github.com/avatao-content/baseimage-tutorial-framework
synced 2024-12-23 00:01:56 +00:00
Extend docstrings in server_connector
This commit is contained in:
parent
9e454a83d0
commit
d30226d55b
@ -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))
|
||||
|
Loading…
Reference in New Issue
Block a user