Photon Quantum 3.0.0

Public Member Functions | Public Attributes | List of all members
Photon.Deterministic.Protocol.Serializer Class Reference

The Quantum online protocol serializer. More...

Public Member Functions

 Serializer ()
 Serializer constructor, registers all messages. More...
 
Boolean PackMessages (BitStream stream, Queue< Message > queue)
 Pack messages into a bitstream. More...
 
Boolean ReadNext (BitStream s, out Message msg)
 Dispatching of messages. More...
 

Public Attributes

String ProtocolVersion
 The protocol version set internally. More...
 

Detailed Description

The Quantum online protocol serializer.

Constructor & Destructor Documentation

◆ Serializer()

Photon.Deterministic.Protocol.Serializer.Serializer ( )
inline

Serializer constructor, registers all messages.

Member Function Documentation

◆ ReadNext()

Boolean Photon.Deterministic.Protocol.Serializer.ReadNext ( BitStream  s,
out Message  msg 
)
inline

Dispatching of messages.

Parameters
sBitstream to read from.
msgMessages being read from the stream
Returns
true if all messages have been dispatched

◆ PackMessages()

Boolean Photon.Deterministic.Protocol.Serializer.PackMessages ( BitStream  stream,
Queue< Message queue 
)
inline

Pack messages into a bitstream.

Parameters
streamBitstream to write messages to.
queueQueue of messages to process
Returns
true when queue is empty
Exceptions
InvalidOperationExceptionIs raised when the batch message size limit was exceeded

Member Data Documentation

◆ ProtocolVersion

String Photon.Deterministic.Protocol.Serializer.ProtocolVersion

The protocol version set internally.