spinnman.connections.abstract_classes.abstract_scp_receiver module

class spinnman.connections.abstract_classes.abstract_scp_receiver.AbstractSCPReceiver

Bases: spinnman.connections.abstract_classes.abstract_connection.AbstractConnection

A receiver of SCP messages

Abstract Methods

is_scp_receiver()
receive_scp_response(scp_response[, timeout])	Receives an SCP message from this connection.

Detailed Methods

is_scp_receiver()

receive_scp_response(scp_response, timeout=None)

Receives an SCP message from this connection. Blocks until a message has been received, or a timeout occurs.

Parameters:

• scp_response – The response to fill in
• timeout (int) – The time in seconds to wait for the message to arrive; if not specified, will wait forever, or until the connection is closed

Rtype scp_response:  

spinnman.messages.scp.abstract_scp_response.AbstractSCPResponse

Returns:

Nothing is returned

Return type:

None

Raises:

• spinnman.exceptions.SpinnmanIOException – If there is an error receiving the message
• spinnman.exceptions.SpinnmanTimeoutException – If there is a timeout before a message is received
• spinnman.exceptions.SpinnmanInvalidPacketException – If the received packet is not a valid SCP message
• spinnman.exceptions.SpinnmanInvalidParameterException – If one of the fields of the SCP message is invalid