ICommunicator Interface Reference

Interface for a Communicator More...

Public Member Functions
bool	Poll ()
	Check if there are data package to be retrieved More...
void	PushPackage (int senderActor, int eventCode, object data)
	Push a new Package into the communicator queues More...
int	ReceivePackage (out int senderActor, byte *buffer, int bufferLength)
	Retrieve a Data Package More...
void	RegisterPackageCallback< T > (Action< int, T > callback)
	Register a callback for a specific Message Type More...
void	SendMessage (int targetActor, IMessage message)
	Send a Protocol Message using the communicator system More...
bool	SendPackage (byte code, int targetActor, bool reliable, byte *buffer, int bufferLength)
	Sends a package data using the communication system More...
void	Service ()
	Step the Communicator internals More...

Properties
int	CommunicatorID [get]
	Represents the current ID of the communicator. More...

Detailed Description

Interface for a Communicator

Member Function Documentation

Poll()

bool Poll

(

)

Check if there are data package to be retrieved

Returns

True if the internal buffer has pendind data

PushPackage()

void PushPackage	(	int	senderActor,
		int	eventCode,
		object	data
	)

Push a new Package into the communicator queues

Parameters

senderActor	Data Sender Actor
eventCode	Event Code of the Package
data	Package

ReceivePackage()

int ReceivePackage	(	out int	senderActor,
		byte *	buffer,
		int	bufferLength
	)

Retrieve a Data Package

Parameters

senderActor	Data Package Sender
buffer	Buffer to be filled with the Data
bufferLength	Buffer length

Returns

Total number of bytes written to buffer

RegisterPackageCallback< T >()

void RegisterPackageCallback< T >

(

Action< int, T >

callback

)

Register a callback for a specific Message Type

Template Parameters

T	Message Type

Parameters

callback

Callback to be invoked when a Message of type T is received

Type Constraints

T

:

IMessage

SendMessage()

void SendMessage	(	int	targetActor,
		IMessage	message
	)

Send a Protocol Message using the communicator system

Parameters

targetActor	Target Actor of the Protocol Message
message	Protocol Message to be sent

SendPackage()

bool SendPackage	(	byte	code,
		int	targetActor,
		bool	reliable,
		byte *	buffer,
		int	bufferLength
	)

Sends a package data using the communication system

Parameters

code	Event Code used to send the Package
targetActor	Target Actor of the Package
reliable	Flag if this Package should be sent reliably
buffer	Data Buffer
bufferLength	Buffer Length

Service()

void Service

(

)

Step the Communicator internals

Property Documentation

CommunicatorID

int CommunicatorID

get

Represents the current ID of the communicator.