Interface ITransport

Common transport interface. Provides ability to read and write the messages.

Namespace: FixAntenna.FixEngine.Transport

Assembly: FixAntenna.Core.dll

Syntax

public interface ITransport

Properties

IsBlockingSocket

Declaration

bool IsBlockingSocket { get; }

Property Value

Type	Description
System.Boolean

IsOpen

Returns true if transport is open.

Declaration

bool IsOpen { get; }

Property Value

Type	Description
System.Boolean

IsSecured

Returns true, if connected through secured connection.

Declaration

bool IsSecured { get; }

Property Value

Type	Description
System.Boolean

LocalEndPoint

Gets local IPEndPint after the transport connected.

Declaration

IPEndPoint LocalEndPoint { get; }

Property Value

Type	Description
System.Net.IPEndPoint

RemoteEndPoint

Gets the remote IPEndPoint after the transport connected.

Declaration

IPEndPoint RemoteEndPoint { get; }

Property Value

Type	Description
System.Net.IPEndPoint

Methods

Close()

Close the transport.

Declaration

void Close()

Exceptions

Type	Condition
System.IO.IOException	throws if error occurred

Open()

Open the transport.

Declaration

void Open()

Exceptions

Type	Condition
System.IO.IOException	throws if error occurred

Read(ByteBuffer)

Declaration

int Read(ByteBuffer buffer)

Parameters

Type	Name	Description
ByteBuffer	buffer

Returns

Type	Description
System.Int32

Read(ByteBuffer, Int32, Int32)

Declaration

int Read(ByteBuffer buffer, int offset, int length)

Parameters

Type	Name	Description
ByteBuffer	buffer
System.Int32	offset
System.Int32	length

Returns

Type	Description
System.Int32

Read(Byte[])

Transport dependent read method.

Declaration

int Read(byte[] buffer)

Parameters

Type	Name	Description
System.Byte[]	buffer	holder for read bytes

Returns

Type	Description
System.Int32	number of byte actually read

Exceptions

Type	Condition
System.IO.IOException	if unable to read

Read(Byte[], Int32, Int32)

Transport dependent read method.

Declaration

int Read(byte[] buffer, int offset, int length)

Parameters

Type	Name	Description
System.Byte[]	buffer	holder for read bytes
System.Int32	offset	in buffer
System.Int32	length	maximum bytes to be read

Returns

Type	Description
System.Int32	number of byte actually read

Exceptions

Type	Condition
System.IO.IOException	if unable to read

WaitUntilReadyToWrite()

Declaration

void WaitUntilReadyToWrite()

Write(ByteBuffer)

Declaration

int Write(ByteBuffer message)

Parameters

Type	Name	Description
ByteBuffer	message

Returns

Type	Description
System.Int32

Write(ByteBuffer, Int32, Int32)

Declaration

int Write(ByteBuffer message, int offset, int length)

Parameters

Type	Name	Description
ByteBuffer	message
System.Int32	offset
System.Int32	length

Returns

Type	Description
System.Int32

Write(Byte[])

Transport dependent write method.

Declaration

void Write(byte[] message)

Parameters

Type	Name	Description
System.Byte[]	message	actual message

Exceptions

Type	Condition
System.IO.IOException	if unable to write

Write(Byte[], Int32, Int32)

Transport dependent write method.

Declaration

int Write(byte[] message, int offset, int length)

Parameters

Type	Name	Description
System.Byte[]	message	actual message
System.Int32	offset	the offset in buffer
System.Int32	length	the num of bytes to write

Returns

Type	Description
System.Int32

Exceptions

Type	Condition
System.IO.IOException	if unable to write