spinnman.messages.eieio.command_messages package¶
Submodules¶
spinnman.messages.eieio.command_messages.database_confirmation module¶
-
class
spinnman.messages.eieio.command_messages.database_confirmation.
DatabaseConfirmation
(database_path=None)[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet which contains the path to the database created by the toolchain which is to be used by any software which interfaces with SpiNNaker
-
bytestring
¶
-
database_path
¶
-
spinnman.messages.eieio.command_messages.eieio_command_header module¶
-
class
spinnman.messages.eieio.command_messages.eieio_command_header.
EIEIOCommandHeader
(command)[source]¶ Bases:
object
EIEIO header for command packets
-
bytestring
¶ Get a bytestring of the header
Return type: str
-
command
¶
-
static
from_bytestring
(data, offset)[source]¶ Read an eieio command header from a bytestring
Parameters: - data (str) – The bytestring to read the data from
- offset (int) – The offset where the valid data starts
Returns: an EIEIO command header
Return type: spinnman.messages.eieio.command_messages.eieio_command_header.EIEIOCommandHeader
Raises: - spinnman.exceptions.SpinnmanIOException – If there is an error reading from the reader
- spinnman.exceptions.SpinnmanInvalidParameterException – If there is an error setting any of the values
-
spinnman.messages.eieio.command_messages.eieio_command_message module¶
-
class
spinnman.messages.eieio.command_messages.eieio_command_message.
EIEIOCommandMessage
(eieio_command_header, data=None, offset=0)[source]¶ Bases:
spinnman.messages.eieio.abstract_messages.eieio_message.AbstractEIEIOMessage
An EIEIO command message
Parameters: - eieio_command_header (
spinnman.messages.eieio.command_messages.eieio_command_header.EIEIOCommandHeader
) – The header of the message - data (str) – Optional incoming data
- offset (int) – Offset into the data where valid data begins
-
bytestring
¶
-
data
¶
-
eieio_header
¶
-
offset
¶
- eieio_command_header (
spinnman.messages.eieio.command_messages.event_stop_request module¶
-
class
spinnman.messages.eieio.command_messages.event_stop_request.
EventStopRequest
[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet used for the buffering input technique which causes the parser of the input packet to terminate its execution
spinnman.messages.eieio.command_messages.host_data_read module¶
-
class
spinnman.messages.eieio.command_messages.host_data_read.
HostDataRead
(n_requests, sequence_no, channel, region_id, space_read)[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet sent by the host computer to the SpiNNaker system in the context of the buffering output technique to signal that the host has completed reading data from the output buffer, and that such space can be considered free to use again
-
bytestring
¶
-
n_requests
¶
-
sequence_no
¶
-
spinnman.messages.eieio.command_messages.host_send_sequenced_data module¶
-
class
spinnman.messages.eieio.command_messages.host_send_sequenced_data.
HostSendSequencedData
(region_id, sequence_no, eieio_data_message)[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet sent from the host to the SpiNNaker system in the context of buffering input mechanism to identify packet which needs to be stored in memory for future use
-
bytestring
¶
-
eieio_data_message
¶
-
region_id
¶
-
sequence_no
¶
-
spinnman.messages.eieio.command_messages.notification_protocol_pause_stop module¶
-
class
spinnman.messages.eieio.command_messages.notification_protocol_pause_stop.
NotificationProtocolPauseStop
[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet which indicates that the toolchain has paused or stopped
-
bytestring
¶
-
spinnman.messages.eieio.command_messages.notification_protocol_start_resume module¶
-
class
spinnman.messages.eieio.command_messages.notification_protocol_start_resume.
NotificationProtocolStartResume
[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet which indicates that the toolchain has started or resumed
-
bytestring
¶
-
spinnman.messages.eieio.command_messages.padding_request module¶
-
class
spinnman.messages.eieio.command_messages.padding_request.
PaddingRequest
[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet used to pad space in the buffering area, if needed
spinnman.messages.eieio.command_messages.spinnaker_request_buffers module¶
-
class
spinnman.messages.eieio.command_messages.spinnaker_request_buffers.
SpinnakerRequestBuffers
(x, y, p, region_id, sequence_no, space_available)[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Message used in the context of the buffering input mechanism which is sent by the SpiNNaker system to the host computer to ask for more data to inject during the simulation
-
bytestring
¶
-
p
¶
-
region_id
¶
-
sequence_no
¶
-
space_available
¶
-
x
¶
-
y
¶
-
spinnman.messages.eieio.command_messages.spinnaker_request_read_data module¶
-
class
spinnman.messages.eieio.command_messages.spinnaker_request_read_data.
SpinnakerRequestReadData
(x, y, p, region_id, sequence_no, n_requests, channel, start_address, space_to_be_read)[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Message used in the context of the buffering output mechanism which is sent from the SpiNNaker system to the host computer to signal that some data is available to be read
-
bytestring
¶
-
n_requests
¶
-
p
¶
-
sequence_no
¶
-
x
¶
-
y
¶
-
spinnman.messages.eieio.command_messages.start_requests module¶
-
class
spinnman.messages.eieio.command_messages.start_requests.
StartRequests
[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet used in the context of buffering input for the host computer to signal to the SpiNNaker system that, if needed, it is possible to send more “SpinnakerRequestBuffers” packet
spinnman.messages.eieio.command_messages.stop_requests module¶
-
class
spinnman.messages.eieio.command_messages.stop_requests.
StopRequests
[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet used in the context of buffering input for the host computer to signal to the SpiNNaker system that to stop sending “SpinnakerRequestBuffers” packet
Module contents¶
-
class
spinnman.messages.eieio.command_messages.
DatabaseConfirmation
(database_path=None)[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet which contains the path to the database created by the toolchain which is to be used by any software which interfaces with SpiNNaker
-
bytestring
¶
-
database_path
¶
-
-
class
spinnman.messages.eieio.command_messages.
EIEIOCommandHeader
(command)[source]¶ Bases:
object
EIEIO header for command packets
-
bytestring
¶ Get a bytestring of the header
Return type: str
-
command
¶
-
static
from_bytestring
(data, offset)[source]¶ Read an eieio command header from a bytestring
Parameters: - data (str) – The bytestring to read the data from
- offset (int) – The offset where the valid data starts
Returns: an EIEIO command header
Return type: spinnman.messages.eieio.command_messages.eieio_command_header.EIEIOCommandHeader
Raises: - spinnman.exceptions.SpinnmanIOException – If there is an error reading from the reader
- spinnman.exceptions.SpinnmanInvalidParameterException – If there is an error setting any of the values
-
-
class
spinnman.messages.eieio.command_messages.
EIEIOCommandMessage
(eieio_command_header, data=None, offset=0)[source]¶ Bases:
spinnman.messages.eieio.abstract_messages.eieio_message.AbstractEIEIOMessage
An EIEIO command message
Parameters: - eieio_command_header (
spinnman.messages.eieio.command_messages.eieio_command_header.EIEIOCommandHeader
) – The header of the message - data (str) – Optional incoming data
- offset (int) – Offset into the data where valid data begins
-
bytestring
¶
-
data
¶
-
eieio_header
¶
-
offset
¶
- eieio_command_header (
-
class
spinnman.messages.eieio.command_messages.
EventStopRequest
[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet used for the buffering input technique which causes the parser of the input packet to terminate its execution
-
class
spinnman.messages.eieio.command_messages.
HostDataRead
(n_requests, sequence_no, channel, region_id, space_read)[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet sent by the host computer to the SpiNNaker system in the context of the buffering output technique to signal that the host has completed reading data from the output buffer, and that such space can be considered free to use again
-
bytestring
¶
-
n_requests
¶
-
sequence_no
¶
-
-
class
spinnman.messages.eieio.command_messages.
HostSendSequencedData
(region_id, sequence_no, eieio_data_message)[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet sent from the host to the SpiNNaker system in the context of buffering input mechanism to identify packet which needs to be stored in memory for future use
-
bytestring
¶
-
eieio_data_message
¶
-
region_id
¶
-
sequence_no
¶
-
-
class
spinnman.messages.eieio.command_messages.
NotificationProtocolPauseStop
[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet which indicates that the toolchain has paused or stopped
-
bytestring
¶
-
-
class
spinnman.messages.eieio.command_messages.
NotificationProtocolStartResume
[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet which indicates that the toolchain has started or resumed
-
bytestring
¶
-
-
class
spinnman.messages.eieio.command_messages.
PaddingRequest
[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet used to pad space in the buffering area, if needed
-
class
spinnman.messages.eieio.command_messages.
SpinnakerRequestBuffers
(x, y, p, region_id, sequence_no, space_available)[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Message used in the context of the buffering input mechanism which is sent by the SpiNNaker system to the host computer to ask for more data to inject during the simulation
-
bytestring
¶
-
p
¶
-
region_id
¶
-
sequence_no
¶
-
space_available
¶
-
x
¶
-
y
¶
-
-
class
spinnman.messages.eieio.command_messages.
SpinnakerRequestReadData
(x, y, p, region_id, sequence_no, n_requests, channel, start_address, space_to_be_read)[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Message used in the context of the buffering output mechanism which is sent from the SpiNNaker system to the host computer to signal that some data is available to be read
-
bytestring
¶
-
n_requests
¶
-
p
¶
-
sequence_no
¶
-
x
¶
-
y
¶
-
-
class
spinnman.messages.eieio.command_messages.
StartRequests
[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet used in the context of buffering input for the host computer to signal to the SpiNNaker system that, if needed, it is possible to send more “SpinnakerRequestBuffers” packet
-
class
spinnman.messages.eieio.command_messages.
StopRequests
[source]¶ Bases:
spinnman.messages.eieio.command_messages.eieio_command_message.EIEIOCommandMessage
Packet used in the context of buffering input for the host computer to signal to the SpiNNaker system that to stop sending “SpinnakerRequestBuffers” packet