Source code for spinnman.connections.abstract_classes.eieio_receiver

from six import add_metaclass

from spinn_utilities.abstract_base import AbstractBase, abstractmethod
from .connection import Connection


@add_metaclass(AbstractBase)
class EIEIOReceiver(Connection):
    """ A receiver of EIEIO data or commands
    """

    __slots__ = ()

    @abstractmethod
    def receive_eieio_message(self, timeout=None):
        """ Receives an EIEIO message from this connection.  Blocks\
            until a message has been received, or a timeout occurs.

        :param timeout: The time in seconds to wait for the message to arrive;\
                    if not specified, will wait forever, or until the\
                    connection is closed
        :type timeout: int
        :return: an EIEIO message
        :rtype:\
                    :py:class:`spinnman.messages.eieio.abstract_messages.abstractMulticastMessage`
        :raise spinnman.exceptions.SpinnmanIOException: If there is an error\
                    receiving the message
        :raise spinnman.exceptions.SpinnmanTimeoutException: If there is a\
                    timeout before a message is received
        :raise spinnman.exceptions.SpinnmanInvalidPacketException: If the\
                    received packet is not a valid EIEIO message
        :raise spinnman.exceptions.SpinnmanInvalidParameterException: If one\
                    of the fields of the EIEIO message is invalid
        """
        pass