Previous topic

spinnman.connections.abstract_classes.abstract_spinnaker_boot_sender module

Next topic

spinnman.connections.listeners package

This Page

spinnman.connections.abstract_classes.abstract_udp_connection module

class spinnman.connections.abstract_classes.abstract_udp_connection.AbstractUDPConnection(local_host=None, local_port=None, remote_host=None, remote_port=17893)[source]

Bases: object

Parameters:
  • local_host (str or None) – 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 or None) – 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 – The remote port to send packets to. If remote_host is None, this is ignored.
Raises spinnman.exceptions.SpinnmanIOException:
 

If there is an error setting up the communication channel

Attributes

can_send a helper property method to check if this connection can send
local_ip_address The local IP address to which the connection is bound.
local_port The local port to which the connection is bound.
remote_ip_address The remote ip address to which the connection is connected.
remote_port The remote port to which the connection is connected.

Abstract Methods

connection_type() method to help identify the connection
supports_sends_message(message) helper method to verify if the connection can deal with this message

Methods

close() See spinnman.connections.abstract_connection.AbstractConnection.close()
is_connected() See spinnman.connections.AbstractConnection.abstract_connection.is_connected()

Detailed Methods

close()[source]

See spinnman.connections.abstract_connection.AbstractConnection.close()

connection_type()[source]

method to help identify the connection :return:

is_connected()[source]

See spinnman.connections.AbstractConnection.abstract_connection.is_connected()

supports_sends_message(message)[source]

helper method to verify if the connection can deal with this message format

Parameters:message
Returns: