Source code for spinnman.connections.abstract_classes.listenable

# 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 spinn_utilities.abstract_base import AbstractBase, abstractmethod


[docs]class Listenable(object, metaclass=AbstractBase): """ An interface for connections that can listen for incoming messages. """ __slots__ = ()
[docs] @abstractmethod def get_receive_method(self): """ Get the method that receives for this connection. """
[docs] @abstractmethod def is_ready_to_receive(self, timeout=0): """ Determines if there is an SCP packet to be read without blocking. :param int timeout: The time to wait before returning if the connection is not ready :return: True if there is an SCP packet to be read :rtype: bool """