Class HostSendSequencedData

java.lang.Object
uk.ac.manchester.spinnaker.messages.eieio.EIEIOCommandMessage
uk.ac.manchester.spinnaker.messages.eieio.HostSendSequencedData
All Implemented Interfaces:
EIEIOMessage<EIEIOCommandMessage.Header>, SerializableMessage

public class HostSendSequencedData extends 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.
  • Field Details

    • regionID

      public final int regionID
      What region will be moved.
    • sequenceNum

      public final int sequenceNum
      The message sequence number.
    • eieioDataMessage

      public final EIEIODataMessage eieioDataMessage
      The data.
  • Constructor Details

    • HostSendSequencedData

      public HostSendSequencedData(byte regionID, byte sequenceNum, EIEIODataMessage eieioDataMessage)
      Create a message.
      Parameters:
      regionID - The region ID
      sequenceNum - The sequence number
      eieioDataMessage - The payload data.
  • Method Details

    • minPacketLength

      public int minPacketLength()
      Specified by:
      minPacketLength in interface EIEIOMessage<EIEIOCommandMessage.Header>
      Overrides:
      minPacketLength in class EIEIOCommandMessage
      Returns:
      the minimum length of a message instance in bytes.
    • addToBuffer

      public void addToBuffer(ByteBuffer buffer)
      Description copied from interface: SerializableMessage
      Writes this message into the given buffer as a contiguous range of bytes. This is so that a message can be sent. Implementors may assume that the buffer has been configured to be little-endian and that its position is at the point where they should begin writing. Once it has finished, the position should be immediately after the last byte written by this method.

      Calling this method should not update the internal state of the message. It should be possible to add the message to multiple buffers without special precautions by the caller.

      Specified by:
      addToBuffer in interface SerializableMessage
      Overrides:
      addToBuffer in class EIEIOCommandMessage
      Parameters:
      buffer - The buffer to write into.