spinnman.connections.udp_packet_connections package

Module contents

class spinnman.connections.udp_packet_connections.BMPConnection(connection_data)[source]

Bases: spinnman.connections.udp_packet_connections.udp_connection.UDPConnection, spinnman.connections.abstract_classes.scp_receiver.SCPReceiver, spinnman.connections.abstract_classes.scp_sender.SCPSender

A BMP connection which supports queries to the BMP of a SpiNNaker machine

Parameters:connection_data (BMPConnectionData) – The description of what to connect to.
boards

The set of boards supported by the BMP

Return type:iterable of int
cabinet

The cabinet ID of the BMP

Return type:int
chip_x

Defined to satisfy the SCPSender - always 0 for a BMP

chip_y

Defined to satisfy the SCPSender - always 0 for a BMP

frame

The frame ID of the BMP

Return type:int
get_scp_data(scp_request)[source]

Returns the data of an SCP request as it would be sent down this connection

receive_scp_response(timeout=1.0)[source]

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

Parameters:

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

Returns:

The SCP result, the sequence number, the data of the response and the offset at which the data starts (i.e., where the SDP header starts).

Return type:

tuple(SCPResult, int, bytes, int)

Raises:
send_scp_request(scp_request)[source]

Sends an SCP request down this connection

Messages must have the following properties:

  • source_port is None or 7
  • source_cpu is None or 31
  • source_chip_x is None or 0
  • source_chip_y is None or 0

tag in the message is optional; if not set, the default set in the constructor will be used. sequence in the message is optional; if not set, (sequence number last assigned + 1) % 65536 will be used

Parameters:scp_request (AbstractSCPRequest) – message packet to send
Raises:SpinnmanIOException – If there is an error sending the message
class spinnman.connections.udp_packet_connections.BootConnection(local_host=None, local_port=None, remote_host=None, remote_port=None)[source]

Bases: spinnman.connections.udp_packet_connections.udp_connection.UDPConnection, spinnman.connections.abstract_classes.spinnaker_boot_sender.SpinnakerBootSender, spinnman.connections.abstract_classes.spinnaker_boot_receiver.SpinnakerBootReceiver

A connection to the SpiNNaker board that uses UDP to for booting

Parameters:
  • local_host (str) – The local host name or IP address to bind to. If not specified defaults to bind to all interfaces, unless remote_host is specified, in which case binding is done to the IP address that will be used to send packets.
  • local_port (int) – The local port to bind to, between 1025 and 65535. If not specified, defaults to a random unused local port
  • remote_host (str) – The remote host name or IP address to send packets to. If not specified, the socket will be available for listening only, and will throw and exception if used for sending
  • remote_port (int) – The remote port to send packets to. If remote_host is None, this is ignored.
Raises:

SpinnmanIOException – If there is an error setting up the communication channel

receive_boot_message(timeout=None)[source]

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

Parameters:

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.

Returns:

a boot message

Return type:

SpinnakerBootMessage

Raises:
send_boot_message(boot_message)[source]

Sends a SpiNNaker boot message using this connection.

Parameters:boot_message (SpinnakerBootMessage) – The message to be sent
Raises:SpinnmanIOException – If there is an error sending the message
class spinnman.connections.udp_packet_connections.UDPConnection(local_host=None, local_port=None, remote_host=None, remote_port=None)[source]

Bases: spinnman.connections.abstract_classes.connection.Connection

Parameters:
  • local_host (str) – The local host name or IP address to bind to. If not specified defaults to bind to all interfaces, unless remote_host is specified, in which case binding is done to the IP address that will be used to send packets
  • local_port (int) – The local port to bind to, between 1025 and 65535. If not specified, defaults to a random unused local port
  • remote_host (str) – The remote host name or IP address to send packets to. If not specified, the socket will be available for listening only, and will throw and exception if used for sending
  • remote_port (int) – The remote port to send packets to. If remote_host is None, this is ignored. If remote_host is specified specified, this must also be specified for the connection to allow sending
Raises:

SpinnmanIOException – If there is an error setting up the communication channel

close()[source]

Closes the connection

is_connected()[source]

Determines if the medium is connected at this point in time

Returns:True if the medium is connected, False otherwise
Return type:bool
Raises:SpinnmanIOException – If there is an error when determining the connectivity of the medium.
is_ready_to_receive(timeout=0)[source]
local_ip_address

The local IP address to which the connection is bound.

Returns:The local IP address as a dotted string, e.g., 0.0.0.0
Return type:str
local_port

The local port to which the connection is bound.

Returns:The local port number
Return type:int
receive(timeout=None)[source]

Receive data from the connection

Parameters:

timeout (float) – The timeout in seconds, or None to wait forever

Returns:

The data received as a bytestring

Return type:

bytes

Raises:
receive_with_address(timeout=None)[source]

Receive data from the connection along with the address where the data was received from

Parameters:

timeout (float) – The timeout, or None to wait forever

Returns:

A tuple of the data received and a tuple of the (address, port) received from

Return type:

tuple(bytes, tuple(str, int))

Raises:
remote_ip_address

The remote IP address to which the connection is connected.

Returns:The remote IP address as a dotted string, or None if not connected remotely
Return type:str
remote_port

The remote port to which the connection is connected.

Returns:The remote port, or None if not connected remotely
Return type:int
send(data)[source]

Send data down this connection

Parameters:data (bytes or bytearray) – The data to be sent
Raises:SpinnmanIOException – If there is an error sending the data
send_to(data, address)[source]

Send data down this connection

Parameters:
  • data (bytes or bytearray) – The data to be sent as a bytestring
  • address (tuple(str,int)) – A tuple of (address, port) to send the data to
Raises:

SpinnmanIOException – If there is an error sending the data

class spinnman.connections.udp_packet_connections.EIEIOConnection(local_host=None, local_port=None, remote_host=None, remote_port=None)[source]

Bases: spinnman.connections.udp_packet_connections.udp_connection.UDPConnection, spinnman.connections.abstract_classes.eieio_receiver.EIEIOReceiver, spinnman.connections.abstract_classes.eieio_sender.EIEIOSender, spinnman.connections.abstract_classes.listenable.Listenable

A UDP connection for sending and receiving raw EIEIO messages.

Parameters:
  • local_host (str) – The local host name or IP address to bind to. If not specified defaults to bind to all interfaces, unless remote_host is specified, in which case binding is done to the IP address that will be used to send packets
  • local_port (int) – The local port to bind to, between 1025 and 65535. If not specified, defaults to a random unused local port
  • remote_host (str) – The remote host name or IP address to send packets to. If not specified, the socket will be available for listening only, and will throw and exception if used for sending
  • remote_port (int) – The remote port to send packets to. If remote_host is None, this is ignored. If remote_host is specified specified, this must also be specified for the connection to allow sending
Raises:

SpinnmanIOException – If there is an error setting up the communication channel

get_receive_method()[source]

Get the method that receives for this connection.

receive_eieio_message(timeout=None)[source]

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

Parameters:

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

Returns:

an EIEIO message

Return type:

AbstractEIEIOMessage

Raises:
send_eieio_message(eieio_message)[source]

Sends an EIEIO message down this connection

Parameters:eieio_message (AbstractEIEIOMessage) – The EIEIO message to be sent
Raises:SpinnmanIOException – If there is an error sending the message
send_eieio_message_to(eieio_message, ip_address, port)[source]
class spinnman.connections.udp_packet_connections.IPAddressesConnection(local_host=None, local_port=54321)[source]

Bases: spinnman.connections.udp_packet_connections.udp_connection.UDPConnection

A connection that detects any UDP packet that is transmitted by SpiNNaker boards prior to boot

receive_ip_address(timeout=None)[source]
supports_sends_message(message)[source]
class spinnman.connections.udp_packet_connections.UDPListenableConnection(local_host=None, local_port=None, remote_host=None, remote_port=None)[source]

Bases: spinnman.connections.udp_packet_connections.udp_connection.UDPConnection, spinnman.connections.abstract_classes.listenable.Listenable

Parameters:
  • local_host (str) – The local host name or IP address to bind to. If not specified defaults to bind to all interfaces, unless remote_host is specified, in which case binding is done to the IP address that will be used to send packets
  • local_port (int) – The local port to bind to, between 1025 and 65535. If not specified, defaults to a random unused local port
  • remote_host (str) – The remote host name or IP address to send packets to. If not specified, the socket will be available for listening only, and will throw and exception if used for sending
  • remote_port (int) – The remote port to send packets to. If remote_host is None, this is ignored. If remote_host is specified specified, this must also be specified for the connection to allow sending
Raises:

SpinnmanIOException – If there is an error setting up the communication channel

get_receive_method()[source]

Get the method that receives for this connection.

class spinnman.connections.udp_packet_connections.SCAMPConnection(chip_x=255, chip_y=255, local_host=None, local_port=None, remote_host=None, remote_port=None)[source]

Bases: spinnman.connections.udp_packet_connections.sdp_connection.SDPConnection, spinnman.connections.abstract_classes.scp_sender.SCPSender, spinnman.connections.abstract_classes.scp_receiver.SCPReceiver

A UDP connection to SCAMP on the board.

Parameters:
  • chip_x (int) – The x-coordinate of the chip on the board with this remote_host
  • chip_y (int) – The y-coordinate of the chip on the board with this remote_host
  • local_host (str) – The optional IP address or host name of the local interface to listen on
  • local_port (int) – The optional local port to listen on
  • remote_host (str) – The optional remote host name or IP address to send messages to. If not specified, sending will not be possible using this connection
  • remote_port (int) – The optional remote port number to send messages to. If not specified, sending will not be possible using this connection
chip_x

The x-coordinate of the chip at which messages sent down this connection will arrive at first

Return type:int
chip_y

The y-coordinate of the chip at which messages sent down this connection will arrive at first

Return type:int
get_scp_data(scp_request, x=None, y=None)[source]

Returns the data of an SCP request as it would be sent down this connection

Parameters:
  • x (int) – Optional: x-coordinate of where to send to
  • y (int) – Optional: y-coordinate of where to send to
receive_scp_response(timeout=1.0)[source]

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

Parameters:

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

Returns:

The SCP result, the sequence number, the data of the response and the offset at which the data starts (i.e., where the SDP header starts).

Return type:

tuple(SCPResult, int, bytes, int)

Raises:
receive_scp_response_with_address(timeout=1.0)[source]
send_scp_request(scp_request)[source]

Sends an SCP request down this connection

Messages must have the following properties:

  • source_port is None or 7
  • source_cpu is None or 31
  • source_chip_x is None or 0
  • source_chip_y is None or 0

tag in the message is optional; if not set, the default set in the constructor will be used. sequence in the message is optional; if not set, (sequence number last assigned + 1) % 65536 will be used

Parameters:scp_request (AbstractSCPRequest) – message packet to send
Raises:SpinnmanIOException – If there is an error sending the message
send_scp_request_to(scp_request, x, y, ip_address)[source]
update_chip_coordinates(x, y)[source]
class spinnman.connections.udp_packet_connections.SDPConnection(chip_x=None, chip_y=None, local_host=None, local_port=None, remote_host=None, remote_port=None)[source]

Bases: spinnman.connections.udp_packet_connections.udp_connection.UDPConnection, spinnman.connections.abstract_classes.sdp_receiver.SDPReceiver, spinnman.connections.abstract_classes.sdp_sender.SDPSender, spinnman.connections.abstract_classes.listenable.Listenable

Parameters:
  • chip_x (int) – The optional x-coordinate of the chip at the remote end of the connection. If not specified, it will not be possible to send SDP messages that require a response with this connection.
  • chip_y (int) – The optional y-coordinate of the chip at the remote end of the connection. If not specified, it will not be possible to send SDP messages that require a response with this connection.
  • local_host (str) – The optional IP address or host name of the local interface to listen on
  • local_port (int) – The optional local port to listen on
  • remote_host (str) – The optional remote host name or IP address to send messages to. If not specified, sending will not be possible using this connection
  • remote_port (int) – The optional remote port number to send messages to. If not specified, sending will not be possible using this connection
get_receive_method()[source]

Get the method that receives for this connection.

receive_sdp_message(timeout=None)[source]

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

Parameters:

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.

Returns:

The received SDP message

Return type:

SDPMessage

Raises:
send_sdp_message(sdp_message)[source]

Sends an SDP message down this connection

Parameters:sdp_message (SDPMessage) – The SDP message to be sent
Raises:SpinnmanIOException – If there is an error sending the message.
spinnman.connections.udp_packet_connections.update_sdp_header_for_udp_send(sdp_header, source_x, source_y)[source]

Apply defaults to the SDP header for sending over UDP

Parameters:sdp_header (SDPHeader) – The SDP header values
Returns:Nothing is returned