Show / Hide Table of Contents

Class TcpClient

TcpClient class. Used to manage the TCP connection to a server.

Inheritance

System.Object

TcpClient

Implements

System.IDisposable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Cosmos.System.Network.IPv4.TCP

Assembly: Cosmos.System2.dll

Syntax

public class TcpClient : IDisposable

Constructors

| Improve this Doc View Source

TcpClient(Address, Int32)

Create new instance of the TcpClient class.

Declaration

public TcpClient(Address dest, int destPort)

Parameters

Type	Name	Description
Address	dest	Destination address.
System.Int32	destPort	Destination port.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Thrown on fatal error (contact support).
System.ArgumentException	Thrown if TcpClient with localPort 0 exists.

| Improve this Doc View Source

TcpClient(Int32)

Create new instance of the TcpClient class.

Declaration

public TcpClient(int localPort)

Parameters

Type	Name	Description
System.Int32	localPort	Local port.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Thrown on fatal error (contact support).
System.ArgumentException	Thrown if localPort already exists.

Fields

| Improve this Doc View Source

StateMachine

Tcp State machine.

Declaration

public Tcp StateMachine

Field Value

Type	Description
Tcp

Properties

| Improve this Doc View Source

LocalEndPoint

Get local computer EndPoint (IP adress and port).

Declaration

public EndPoint LocalEndPoint { get; }

Property Value

Type	Description
EndPoint	Remote EndPoint.

| Improve this Doc View Source

RemoteEndPoint

Get distant computer EndPoint (IP adress and port).

Declaration

public EndPoint RemoteEndPoint { get; }

Property Value

Type	Description
EndPoint	Remote EndPoint.

Methods

| Improve this Doc View Source

Close()

Close connection.

Declaration

public void Close()

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Thrown on fatal error (contact support).
System.Exception	Thrown if TCP Status is CLOSED.

| Improve this Doc View Source

Connect(Address, Int32, Int32)

Connect to client.

Declaration

public void Connect(Address dest, int destPort, int timeout = 5000)

Parameters

Type	Name	Description
Address	dest	Destination address.
System.Int32	destPort	Destination port.
System.Int32	timeout

Exceptions

Type	Condition
System.Exception	Thrown if TCP Status is not CLOSED.

| Improve this Doc View Source

Dispose()

Close Client

Declaration

public void Dispose()

| Improve this Doc View Source

IsConnected()

Is TCP Connected.

Declaration

public bool IsConnected()

Returns

Type	Description
System.Boolean	Boolean value.

| Improve this Doc View Source

NonBlockingReceive(ref EndPoint)

Receive data from end point.

Declaration

public byte[] NonBlockingReceive(ref EndPoint source)

Parameters

Type	Name	Description
EndPoint	source	Source end point.

Returns

Type	Description
System.Byte[]	byte array value.

Exceptions

Type	Condition
System.InvalidOperationException	Thrown on fatal error (contact support).
System.Exception	Thrown if TCP Status is not ESTABLISHED.

| Improve this Doc View Source

Receive(ref EndPoint)

Receive data from end point.

Declaration

public byte[] Receive(ref EndPoint source)

Parameters

Type	Name	Description
EndPoint	source	Source end point.

Returns

Type	Description
System.Byte[]	byte array value.

Exceptions

Type	Condition
System.InvalidOperationException	Thrown on fatal error (contact support).
System.Exception	Thrown if TCP Status is not ESTABLISHED.

| Improve this Doc View Source

Send(Byte[])

Send data to client.

Declaration

public void Send(byte[] data)

Parameters

Type	Name	Description
System.Byte[]	data	Data array to send.

Exceptions

Type	Condition
System.Exception	Thrown if destination is null or destinationPort is 0.
System.ArgumentException	Thrown on fatal error (contact support).
System.OverflowException	Thrown if data array length is greater than Int32.MaxValue.
System.Exception	Thrown if TCP Status is not ESTABLISHED.

Implements

System.IDisposable