Package uk.ac.manchester.spinnaker.messages

Interface SerializableMessage

All Known Subinterfaces:
ConnectionAwareMessage, EIEIOHeader, EIEIOMessage<Header>, NotificationMessage
All Known Implementing Classes:
AbstractNotificationMessage, ApplicationRun, ApplicationStop, BMPReadMemory, BMPRequest, BMPSetLED, BMPWriteMemory, BootMessage, ClearIOBUF, ClearMessage, ClearReinjectionQueue, CountState, DatabaseConfirmation, EIEIOCommandMessage, EIEIOCommandMessage.Header, EIEIODataMessage, EIEIODataMessage.Header, EraseFlash, EventStopRequest, FECRequest, FillRequest, FixedRouteInitialise, FixedRouteRead, FloodFillData, FloodFillEnd, FloodFillStart, GatherProtocolMessage, GetBMPVersion, GetChipInfo, GetFPGAResetStatus, GetReinjectionStatus, GetVersion, HostDataRead, HostDataReadAck, HostSendSequencedData, InitFPGA, IPTagClear, IPTagGet, IPTagGetInfo, IPTagSet, IPTagSetTTO, LoadApplicationRoutes, LoadSystemRoutes, MissingSequenceNumbersMessage, PaddingRequest, PauseStop, ReadADC, ReadCANStatus, ReadFPGARegister, ReadIPAddress, ReadLink, ReadMemory, ReadSerialFlash, ReadSerialFlashCRC, ReadSerialVector, ReinjectorRequest, ResetFPGA, ResetReinjectionCounters, ReverseIPTagSet, RouterAlloc, RouterClear, RouterInit, RouterTableRequest, SaveApplicationRoutes, SCPRequest, SCPRequestHeader, SDPHeader, SDPMessage, SDRAMAlloc, SDRAMDeAlloc, SendSignal, SetLED, SetPower, SetReinjectionPacketTypes, SetRouterEmergencyTimeout, SetRouterTimeout, SpinnakerRequest, SpinnakerRequestBuffers, SpinnakerRequestReadData, StartRequests, StartResume, StartSendingMessage, StopRequests, SystemVariableBootValues, UpdateFlash, UpdateProvenanceAndExit, UpdateRuntime, WriteFlashBuffer, WriteFPGAData, WriteFPGARegister, WriteLink, WriteMemory, WriteSerialFlash
public interface SerializableMessage
Represents a serializable message or a piece of a serializable message.

Concrete classes that implement this interface that also wish to be deserializable should also support the reverse operation by creating a constructor that takes a single (little-endian) ByteBuffer as its only argument.

  • Method Summary

    Modifier and Type Method Description
    void addToBuffer​(ByteBuffer buffer)
    Writes this message into the given buffer as a contiguous range of bytes.

  • Method Details

    • addToBuffer

      void addToBuffer​(ByteBuffer buffer)
      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.

      Parameters:
      buffer - The buffer to write into.