Class Client

Namespace

QuickLink

Assembly

QuickLink.dll

Represents a client that connects to a server using TCP/IP.

public class Client : IClient, IDisposable

Inheritance

object

Client

Implements

IClient

IDisposable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Fields

Connected

Event that is raised when the client successfully connects to the server.

public EventPublisher Connected

Field Value

EventPublisher

ConnectionState

Current state of the client's TCP connection.

public ConnectionState ConnectionState

Field Value

ConnectionState

Disconnected

Event that is raised when the client disconnects from the server.

public EventPublisher Disconnected

Field Value

EventPublisher

Properties

MessageReceived

Event that is raised when a message is received from the server.

public MessagePublisher MessageReceived { get; }

Property Value

MessagePublisher

Methods

Connect(string, int)

Connects the client to the specified host and port.

public Task Connect(string host, int port)

Parameters

host string

The host name or IP address of the server.

port int

The port number to connect to.

Returns

Task

Exceptions

ArgumentNullException

ArgumentOutOfRangeException

SocketException

ObjectDisposedException

Dispose()

Releases the resources used by the Client object.

public void Dispose()

Dispose(bool)

Releases the unmanaged resources used by the Client object and optionally releases the managed resources.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

~Client()

Finalizes an instance of the Client class.

protected ~Client()

SendToServer(MessageWriter)

Sends a message to the server.

public void SendToServer(MessageWriter message)

Parameters

message MessageWriter

The message to send.

Exceptions

ObjectDisposedException

SemaphoreFullException