Public Member Functions | Properties

Electrotank.Electroserver5.Core.SocketConnection Class Reference

This class connects to ElectroServer via Socket. More...

Inheritance diagram for Electrotank.Electroserver5.Core.SocketConnection:
Electrotank.Electroserver5.Core.Connection

List of all members.

Public Member Functions

 SocketConnection (AvailableConnection availableConnection, EsEngine engine)
 Creates a new instance of the class and configures it with the connection information passed in.
override void Close ()
 Closes the connection.
override void Connect ()
 Attempts to connect to ElectroServer via Socket using the connection information provided.
void Dispose ()
override void Send (EsMessage message)
 Sends the message to ElectroServer.

Properties

override bool Connected [get, set]
 Returns true if the connection has been established.
EsEngine Engine [get, set]
override Protocol Protocol [get]
 The protocol this Connection implements.
Socket Socket [get, set]

Detailed Description

This class connects to ElectroServer via Socket.


Constructor & Destructor Documentation

Electrotank.Electroserver5.Core.SocketConnection.SocketConnection ( AvailableConnection  availableConnection,
EsEngine  engine 
)

Creates a new instance of the class and configures it with the connection information passed in.

Parameters:
availableConnection The AvailableConnection instance containing the connection information
engine The EsEngine instance.

Member Function Documentation

override void Electrotank.Electroserver5.Core.SocketConnection.Close (  )  [virtual]

Closes the connection.

Implements Electrotank.Electroserver5.Core.Connection.

override void Electrotank.Electroserver5.Core.SocketConnection.Connect (  )  [virtual]

Attempts to connect to ElectroServer via Socket using the connection information provided.

Implements Electrotank.Electroserver5.Core.Connection.

void Electrotank.Electroserver5.Core.SocketConnection.Dispose (  ) 
override void Electrotank.Electroserver5.Core.SocketConnection.Send ( EsMessage  message  )  [virtual]

Sends the message to ElectroServer.

Parameters:
message The message to send.

Implements Electrotank.Electroserver5.Core.Connection.


Property Documentation

override bool Electrotank.Electroserver5.Core.SocketConnection.Connected [get, set]

Returns true if the connection has been established.

Reimplemented from Electrotank.Electroserver5.Core.Connection.

EsEngine Electrotank.Electroserver5.Core.SocketConnection.Engine [get, set]
override Protocol Electrotank.Electroserver5.Core.SocketConnection.Protocol [get]

The protocol this Connection implements.

Reimplemented from Electrotank.Electroserver5.Core.Connection.

Socket Electrotank.Electroserver5.Core.SocketConnection.Socket [get, set]