Files
pepperplus-ri/src/robot_interface/endpoints/receiver_base.py
Pim Hutting 051f904576 chore: add documentation RI
Code functionality left unchanged, only added docs where missing

close: N25B-298
2025-11-21 16:35:40 +01:00

22 lines
642 B
Python

from abc import ABCMeta, abstractmethod
from robot_interface.endpoints.socket_base import SocketBase
class ReceiverBase(SocketBase, object):
"""Base class for receivers associated with a ZeroMQ socket."""
__metaclass__ = ABCMeta
@abstractmethod
def handle_message(self, message):
"""
Handle a message with the receiver.
:param message: The message to handle, must contain properties "endpoint" and "data".
:type message: dict
:return: A response message or None if this type of receiver doesn't publish.
:rtype: dict | None
"""
raise NotImplementedError()