spinn_machine.tags package

Submodules

spinn_machine.tags.abstract_tag module

class spinn_machine.tags.abstract_tag.AbstractTag(board_address, tag, port)[source]

Bases: object

Common properties of SpiNNaker IP tags and reverse IP tags.

board_address

The board address of the tag

port

The port of the tag

tag

The tag ID of the tag

spinn_machine.tags.iptag module

class spinn_machine.tags.iptag.IPTag(board_address, destination_x, destination_y, tag, ip_address, port=None, strip_sdp=False, traffic_identifier='DEFAULT')[source]

Bases: spinn_machine.tags.abstract_tag.AbstractTag

Used to hold data that is contained within an IP tag

Parameters:
  • board_address (str or None) – The IP address of the board on which the tag is allocated
  • destination_x (int) – The x-coordinate where users of this tag should send packets to
  • destination_y (int) – The y-coordinate where users of this tag should send packets to
  • tag (int) – The tag of the SDP packet
  • ip_address (str) – The IP address to which SDP packets with the tag will be sent
  • port (int or None) – The port to which the SDP packets with the tag will be sent, or None if not yet assigned
  • strip_sdp (bool) – Indicates whether the SDP header should be removed
  • traffic_identifier (str) – The identifier for traffic transmitted using this tag
Raises:

None – No known exceptions are raised
destination_x

The x-coordinate where users of this tag should send packets to

destination_y

The y-coordinate where users of this tag should send packets to

ip_address

The IP address to which SDP packets with this tag will be sent.

strip_sdp

Return if the SDP header is to be stripped

traffic_identifier

The identifier of traffic using this tag

spinn_machine.tags.reverse_iptag module

class spinn_machine.tags.reverse_iptag.ReverseIPTag(board_address, tag, port, destination_x, destination_y, destination_p, sdp_port=1)[source]

Bases: spinn_machine.tags.abstract_tag.AbstractTag

Used to hold data that is contained within a Reverse IP tag

Parameters:
  • board_address (str or None) – The IP address of the board on which the tag is allocated
  • tag (int) – The tag of the SDP packet
  • port (int) – The UDP port on which SpiNNaker will listen for packets
  • destination_x (int) – The x-coordinate of the chip to send packets to
  • destination_y (int) – The y-coordinate of the chip to send packets to
  • destination_p (int) – The ID of the processor to send packets to
  • sdp_port (int) – The optional port number to use for SDP packets that are formed on the machine (default is 1)
Raises:

None – No known exceptions are raised
destination_p

The destination processor ID for the chip at (x,y) that packets should be send to for this reverse IP tag

destination_x

The destination x coordinate of a chip in the SpiNNaker machine that packets should be sent to for this reverse IP tag.

destination_y

The destination y coordinate of a chip in the SpiNNaker machine that packets should be sent to for this reverse IP tag.

sdp_port

The SDP port number of the tag that these packets are to be received on for the processor.

Module contents

class spinn_machine.tags.AbstractTag(board_address, tag, port)[source]

Bases: object

Common properties of SpiNNaker IP tags and reverse IP tags.

board_address

The board address of the tag

port

The port of the tag

tag

The tag ID of the tag

class spinn_machine.tags.IPTag(board_address, destination_x, destination_y, tag, ip_address, port=None, strip_sdp=False, traffic_identifier='DEFAULT')[source]

Bases: spinn_machine.tags.abstract_tag.AbstractTag

Used to hold data that is contained within an IP tag

Parameters:
  • board_address (str or None) – The IP address of the board on which the tag is allocated
  • destination_x (int) – The x-coordinate where users of this tag should send packets to
  • destination_y (int) – The y-coordinate where users of this tag should send packets to
  • tag (int) – The tag of the SDP packet
  • ip_address (str) – The IP address to which SDP packets with the tag will be sent
  • port (int or None) – The port to which the SDP packets with the tag will be sent, or None if not yet assigned
  • strip_sdp (bool) – Indicates whether the SDP header should be removed
  • traffic_identifier (str) – The identifier for traffic transmitted using this tag
Raises:

None – No known exceptions are raised
destination_x

The x-coordinate where users of this tag should send packets to

destination_y

The y-coordinate where users of this tag should send packets to

ip_address

The IP address to which SDP packets with this tag will be sent.

strip_sdp

Return if the SDP header is to be stripped

traffic_identifier

The identifier of traffic using this tag

class spinn_machine.tags.ReverseIPTag(board_address, tag, port, destination_x, destination_y, destination_p, sdp_port=1)[source]

Bases: spinn_machine.tags.abstract_tag.AbstractTag

Used to hold data that is contained within a Reverse IP tag

Parameters:
  • board_address (str or None) – The IP address of the board on which the tag is allocated
  • tag (int) – The tag of the SDP packet
  • port (int) – The UDP port on which SpiNNaker will listen for packets
  • destination_x (int) – The x-coordinate of the chip to send packets to
  • destination_y (int) – The y-coordinate of the chip to send packets to
  • destination_p (int) – The ID of the processor to send packets to
  • sdp_port (int) – The optional port number to use for SDP packets that are formed on the machine (default is 1)
Raises:

None – No known exceptions are raised
destination_p

The destination processor ID for the chip at (x,y) that packets should be send to for this reverse IP tag

destination_x

The destination x coordinate of a chip in the SpiNNaker machine that packets should be sent to for this reverse IP tag.

destination_y

The destination y coordinate of a chip in the SpiNNaker machine that packets should be sent to for this reverse IP tag.

sdp_port

The SDP port number of the tag that these packets are to be received on for the processor.