Source code for spinnman.connections.abstract_classes.multicast_receiver
# Copyright (c) 2017-2019 The University of Manchester
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
from six import add_metaclass
from spinn_utilities.abstract_base import AbstractBase, abstractmethod
from .connection import Connection
[docs]@add_metaclass(AbstractBase)
class MulticastReceiver(Connection):
""" A receiver of multicast messages
"""
__slots__ = ()
[docs] @abstractmethod
def receive_multicast_message(self, timeout=None):
""" Receives a multicast 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: a multicast message
:rtype:\
:py:class:`spinnman.messages.multicast_message.MulticastMessage`
: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 multicast message.
:raise spinnman.exceptions.SpinnmanInvalidParameterException: \
If one of the fields of the multicast message is invalid.
"""