NES::Network::Messages Namespace Reference

Classes
class	EventBufferMessage
	This a payload message with an event. More...
class	MessageHeader
	this is the pramble of each message that is sent via the network More...
class	ExchangeMessage
	This is the base class for all messages that can be sent in NES. More...
class	ClientAnnounceMessage
	This message is sent when a client announces itself to a server. It's the first message that is sent. More...
class	ServerReadyMessage
	This message is sent back to a client when a server is ready to receive data. More...
class	EndOfStreamMessage
	This message is sent to notify end-of-stream. More...
class	ReconfigurationEventMessage
	This message contains a reconfiguration event which is propagated along the data stream. More...
class	ErrorMessage
	This message represent an error that is sent from the client to the server or vice versa. More...
class	DataBufferMessage
	This is the payload with tuples. More...

Typedefs
using	nes_magic_number_t = uint64_t
	This magic number is written as first 64bits of every NES network message. We use this as a checksum to validate that we are not transferring garbage data. More...

Enumerations
enum class	MessageType : uint8_t {   ClientAnnouncement , ServerReady , DataBuffer , ErrorMessage ,   EndOfStream , EventBuffer }
enum class	ErrorType : uint8_t {   PartitionNotRegisteredError , UnknownPartitionError , DeletedPartitionError , VersionMismatchError ,   UnknownError }
	this enum defines the errors that can occur in the network stack logic More...
enum class	ChannelType : uint8_t { DataChannel , EventOnlyChannel }

Typedef Documentation

nes_magic_number_t

using NES::Network::Messages::nes_magic_number_t = typedef uint64_t

This magic number is written as first 64bits of every NES network message. We use this as a checksum to validate that we are not transferring garbage data.

Enumeration Type Documentation

ChannelType

enum NES::Network::Messages::ChannelType : uint8_t

strong

Enumerator
DataChannel	data channel: allows sending data and event buffers
EventOnlyChannel	event-only channel: allows sending event buffers only

ErrorType

enum NES::Network::Messages::ErrorType : uint8_t

strong

this enum defines the errors that can occur in the network stack logic

Enumerator
PartitionNotRegisteredError	error raised when requesting a partition that is not registered
UnknownPartitionError	error raised when a data/event buffer arrives for a partition that is not known on the current node
DeletedPartitionError	error raised when requesting a partition that has been previously deleted
VersionMismatchError	error raised when the version expected by the receiver does not match the one in the client anouncement
UnknownError	error raised when there is no known reason

MessageType

enum NES::Network::Messages::MessageType : uint8_t

strong

Enumerator
ClientAnnouncement	message type that the client uses to announce itself to the server
ServerReady	message type that the servers uses to reply to the client regarding the availability of a partition
DataBuffer	message type of a data buffer
ErrorMessage	type of a message that contains an error
EndOfStream	type of a message that marks a source subpartition as finished, i.e., no more records are expected
EventBuffer	message type of an event buffer