C# Класс OpenNos.Core.Networking.Communication.Scs.Client.ScsClientBase

This class provides base functionality for client Classs.
Наследование: IScsClient
Показать файл Открыть проект

Открытые методы

Метод Описание
ClearLowPriorityQueue ( ) : System.Threading.Tasks.Task
Connect ( ) : void

Connects to server.

Disconnect ( ) : void

Disconnects from server. Does nothing if already disconnected.

Dispose ( ) : void

Disposes this object and closes underlying connection.

SendMessage ( IScsMessage message, byte priority ) : void

Sends a message to the server.

Защищенные методы

Метод Описание
CreateCommunicationChannel ( ) : ICommunicationChannel

This method is implemented by derived Classs to create appropriate communication channel.

Dispose ( bool disposing ) : void
OnConnected ( ) : void

Raises Connected event.

OnDisconnected ( ) : void

Raises Disconnected event.

OnMessageReceived ( IScsMessage message ) : void

Raises MessageReceived event.

OnMessageSent ( IScsMessage message ) : void

Raises MessageSent event.

ScsClientBase ( ) : OpenNos.Core.Networking.Communication.Scs.Communication

Constructor.

Приватные методы

Метод Описание
CommunicationChannel_Disconnected ( object sender, EventArgs e ) : void

Handles Disconnected event of _communicationChannel object.

CommunicationChannel_MessageReceived ( object sender, MessageEventArgs e ) : void

Handles MessageReceived event of _communicationChannel object.

CommunicationChannel_MessageSent ( object sender, MessageEventArgs e ) : void

Handles MessageSent event of _communicationChannel object.

PingTimer_Elapsed ( object sender, EventArgs e ) : void

Handles Elapsed event of _pingTimer to send PingMessage messages to server.

Описание методов

ClearLowPriorityQueue() публичный Метод

public ClearLowPriorityQueue ( ) : System.Threading.Tasks.Task
Результат System.Threading.Tasks.Task

Connect() публичный Метод

Connects to server.
public Connect ( ) : void
Результат void

CreateCommunicationChannel() защищенный абстрактный Метод

This method is implemented by derived Classs to create appropriate communication channel.
protected abstract CreateCommunicationChannel ( ) : ICommunicationChannel
Результат ICommunicationChannel

Disconnect() публичный Метод

Disconnects from server. Does nothing if already disconnected.
public Disconnect ( ) : void
Результат void

Dispose() публичный Метод

Disposes this object and closes underlying connection.
public Dispose ( ) : void
Результат void

Dispose() защищенный Метод

protected Dispose ( bool disposing ) : void
disposing bool
Результат void

OnConnected() защищенный Метод

Raises Connected event.
protected OnConnected ( ) : void
Результат void

OnDisconnected() защищенный Метод

Raises Disconnected event.
protected OnDisconnected ( ) : void
Результат void

OnMessageReceived() защищенный Метод

Raises MessageReceived event.
protected OnMessageReceived ( IScsMessage message ) : void
message IScsMessage Received message
Результат void

OnMessageSent() защищенный Метод

Raises MessageSent event.
protected OnMessageSent ( IScsMessage message ) : void
message IScsMessage Received message
Результат void

ScsClientBase() защищенный Метод

Constructor.
protected ScsClientBase ( ) : OpenNos.Core.Networking.Communication.Scs.Communication
Результат OpenNos.Core.Networking.Communication.Scs.Communication

SendMessage() публичный Метод

Sends a message to the server.
/// Throws a CommunicationStateException if client is not connected to the server. ///
public SendMessage ( IScsMessage message, byte priority ) : void
message IScsMessage Message to be sent
priority byte
Результат void