Class TCPClient

A Client that uses TCP to communicate

Inheritance
TCPClient
Implements
IDisposable
Namespace: VoltRpc.Communication.TCP
Assembly: VoltRpc.dll
Syntax
public sealed class TCPClient : Client, IDisposable

Constructors

| Edit this page View Source

TCPClient(IPEndPoint)

Creates a new TCPClient instance

Declaration
public TCPClient(IPEndPoint endPoint)
Parameters
TypeNameDescription
IPEndPointendPoint

The IPEndPoint to connect to

| Edit this page View Source

TCPClient(IPEndPoint, int)

Creates a new TCPClient instance

Declaration
public TCPClient(IPEndPoint endPoint, int connectionTimeout)
Parameters
TypeNameDescription
IPEndPointendPoint

The IPEndPoint to connect to

intconnectionTimeout

The timeout time for connection

| Edit this page View Source

TCPClient(IPEndPoint, int, int)

Creates a new TCPClient instance

Declaration
public TCPClient(IPEndPoint endPoint, int receiveTimeout, int sendTimeout)
Parameters
TypeNameDescription
IPEndPointendPoint

The IPEndPoint to connect to

intreceiveTimeout

The receive timeout

intsendTimeout

The send timeout

| Edit this page View Source

TCPClient(IPEndPoint, int, int, int, int)

Creates a new TCPClient instance

Declaration
public TCPClient(IPEndPoint endPoint, int bufferSize = 8000, int connectionTimeout = 7000, int receiveTimeout = 600000, int sendTimeout = 600000)
Parameters
TypeNameDescription
IPEndPointendPoint

The IPEndPoint to connect to

intbufferSize

The size of the buffers

intconnectionTimeout

The timeout time for connection

intreceiveTimeout

The receive timeout

intsendTimeout

The send timeout

Fields

| Edit this page View Source

DefaultConnectionTimeout

Default connection timeout time

Declaration
public const int DefaultConnectionTimeout = 7000
Field Value
TypeDescription
int
| Edit this page View Source

DefaultReceiveTimeout

Default receive timeout time

Declaration
public const int DefaultReceiveTimeout = 600000
Field Value
TypeDescription
int
| Edit this page View Source

DefaultSendTimeout

Default send timeout time

Declaration
public const int DefaultSendTimeout = 600000
Field Value
TypeDescription
int

Methods

| Edit this page View Source

Connect()

Connects the Client to a host

Declaration
public override void Connect()
Overrides
Client.Connect()
Exceptions
TypeCondition
TimeoutException

Thrown if a connection timeout occurs

ConnectionFailedException

Thrown if an unknown error occurs while connecting.

| Edit this page View Source

Dispose()

Destroys the Client instance

Declaration
public override void Dispose()
Overrides
Client.Dispose()

Implements

IDisposable