mirror of
				https://github.com/avatao-content/baseimage-tutorial-framework
				synced 2025-11-04 12:02:55 +00:00 
			
		
		
		
	Add a huge bunch of docstrings
This commit is contained in:
		@@ -24,18 +24,30 @@ class ServerDownlinkConnector(ZMQConnectorBase):
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
class ServerUplinkConnector(ZMQConnectorBase):
 | 
			
		||||
    """
 | 
			
		||||
    Class capable of sending messages to the TFW server and event handlers.
 | 
			
		||||
    """
 | 
			
		||||
    def __init__(self, zmq_context=None):
 | 
			
		||||
        super(ServerUplinkConnector, self).__init__(zmq_context)
 | 
			
		||||
        self._zmq_push_socket = self._zmq_context.socket(zmq.PUSH)
 | 
			
		||||
        self._zmq_push_socket.connect('tcp://localhost:{}'.format(TFWENV.RECEIVER_PORT))
 | 
			
		||||
 | 
			
		||||
    def send_to_eventhandler(self, message):
 | 
			
		||||
        """
 | 
			
		||||
        Send a message to an event handler.
 | 
			
		||||
        :param message: JSON message you want to send
 | 
			
		||||
        :param message['key']: key of event handler you want to address
 | 
			
		||||
        """
 | 
			
		||||
        nested_message = {'key': message['key'], 'data': message.pop('data')}
 | 
			
		||||
        message['key'] = 'mirror'
 | 
			
		||||
        message['data'] = nested_message
 | 
			
		||||
        self.send(message)
 | 
			
		||||
 | 
			
		||||
    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))
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user