MTSC.Client.Handlers.IHandler Interface Reference

Handler interface for client communication. More...

Inheritance diagram for MTSC.Client.Handlers.IHandler:

Public Member Functions
bool	InitializeConnection (Client client)
	Called when the connection is being initialized. More...
bool	HandleSendMessage (Client client, ref Message message)
	Called when a message is being sent to the server. More...
bool	PreHandleReceivedMessage (Client client, ref Message message)
	Called before the message is handled. Use this method to modify the message if necesarry. More...
bool	HandleReceivedMessage (Client client, Message message)
	Called when a message has been received. More...
void	Tick (Client client)
	Called every cycle. This method should perform regular actions on the connection. More...
void	Disconnected (Client client)
	Called when the client is disconnected. More...

Detailed Description

Handler interface for client communication.

Definition at line 11 of file IHandler.cs.

Member Function Documentation

Disconnected()

void MTSC.Client.Handlers.IHandler.Disconnected

(

Client

client

)

Called when the client is disconnected.

Parameters

client

Client object.

HandleReceivedMessage()

bool MTSC.Client.Handlers.IHandler.HandleReceivedMessage	(	Client	client,
		Message	message
	)

Called when a message has been received.

Parameters

client	Client object.
message	Message to be handled.

Returns

True if the message has been handled and no other handler should process it.

HandleSendMessage()

bool MTSC.Client.Handlers.IHandler.HandleSendMessage	(	Client	client,
		ref Message	message
	)

Called when a message is being sent to the server.

Parameters

client	Client socket.
message	Message to be sent.

Returns

InitializeConnection()

bool MTSC.Client.Handlers.IHandler.InitializeConnection

(

Client

client

)

Called when the connection is being initialized.

Parameters

client

Client object.

Returns

True if the initialization is successful.

If this method returns false, the connection will fail and return false.

PreHandleReceivedMessage()

bool MTSC.Client.Handlers.IHandler.PreHandleReceivedMessage	(	Client	client,
		ref Message	message
	)

Called before the message is handled. Use this method to modify the message if necesarry.

Parameters

client	Client object.
message	Message to be preprocessed.

Returns

True if the message has been preprocessed and no other handler should modify the message.

Tick()

void MTSC.Client.Handlers.IHandler.Tick

(

Client

client

)

Called every cycle. This method should perform regular actions on the connection.

Parameters

client

Client object.

---

The documentation for this interface was generated from the following file:

• D:/Projects/MTSC/MTSC/Client/Handlers/IHandler.cs