MTSC  1.0.5
Build TCP servers out of modules with handlers for communication, exception and logging.
MTSC.Common.WebSockets.ClientModules.IWebsocketModule Interface Reference

Interface for websocket modules. More...

Inheritance diagram for MTSC.Common.WebSockets.ClientModules.IWebsocketModule:
MTSC.Common.WebSockets.ClientModules.ChatModule

Public Member Functions

void ConnectionInitialized (Client.Client client, WebsocketHandler handler)
 Called when a new websocket connection has been initialized. More...
 
bool HandleReceivedMessage (Client.Client client, WebsocketHandler handler, WebsocketMessage messageBytes)
 Handle received message. More...
 
void ConnectionClosed (Client.Client client, WebsocketHandler handler)
 Called when an existing websocket connection is being closed. More...
 

Detailed Description

Interface for websocket modules.

Definition at line 11 of file IWebsocketModule.cs.

Member Function Documentation

◆ ConnectionClosed()

void MTSC.Common.WebSockets.ClientModules.IWebsocketModule.ConnectionClosed ( Client.Client  client,
WebsocketHandler  handler 
)

Called when an existing websocket connection is being closed.

Parameters
clientClient object.
handlerHandler that closes the connection.

◆ ConnectionInitialized()

void MTSC.Common.WebSockets.ClientModules.IWebsocketModule.ConnectionInitialized ( Client.Client  client,
WebsocketHandler  handler 
)

Called when a new websocket connection has been initialized.

Parameters
clientClient object.
handlerHandler that performed the initialization.

◆ HandleReceivedMessage()

bool MTSC.Common.WebSockets.ClientModules.IWebsocketModule.HandleReceivedMessage ( Client.Client  client,
WebsocketHandler  handler,
WebsocketMessage  messageBytes 
)

Handle received message.

Parameters
clientClient object.
handlerHandler currently processing the message.
messageBytesArray containing the message.
Returns
True if no other module should handle this message.

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