Module enrgdaq.cnc.handlers.base

Classes

class CNCMessageHandler (cnc: SupervisorCNC)

Expand source code

class CNCMessageHandler(ABC):
    """
    Abstract base class for C&C message handlers.
    """

    def __init__(self, cnc: SupervisorCNC):
        """
        Initialize the handler.
        :param cnc: The SupervisorCNC instance.
        """
        self.cnc = cnc
        self._logger = cnc._logger

    @abstractmethod
    def handle(
        self, sender_identity: bytes, msg: CNCMessage
    ) -> Optional[Tuple[CNCMessage, bool]]:
        """
        Handles an incoming C&C message.
        :param sender_identity: The ZMQ identity of the message sender.
        :param msg: The C&C message to handle.
        :return: An optional tuple containing the response message and a boolean
                 indicating if it's a forward reply.
        """
        pass

Abstract base class for C&C message handlers.

Initialize the handler. :param cnc: The SupervisorCNC instance.

Ancestors

• abc.ABC

Subclasses

• HeartbeatHandler
• ReqListClientsHandler
• ReqLogHandler
• ReqPingHandler
• ReqRestartHandler
• ReqStopDAQJobsHandler
• ReqRunCustomDAQJobHandler
• ReqSendMessageHandler
• ReqStatusHandler
• ReqStopDAQJobHandler
• ResPingHandler
• ResStatusHandler

Methods

def handle(self, sender_identity: bytes, msg: CNCMessage) ‑> Tuple[CNCMessage, bool] | None

Expand source code

@abstractmethod
def handle(
    self, sender_identity: bytes, msg: CNCMessage
) -> Optional[Tuple[CNCMessage, bool]]:
    """
    Handles an incoming C&C message.
    :param sender_identity: The ZMQ identity of the message sender.
    :param msg: The C&C message to handle.
    :return: An optional tuple containing the response message and a boolean
             indicating if it's a forward reply.
    """
    pass

Handles an incoming C&C message. :param sender_identity: The ZMQ identity of the message sender. :param msg: The C&C message to handle. :return: An optional tuple containing the response message and a boolean indicating if it's a forward reply.