TROAsyncSocket

 

Creates a new instance.

constructor Create

---

Creates a new instance with a supplied values.

constructor Create(aMode: TROSocketMode)

Parameters:

• aMode: Mode

---

Creates a new instance with a supplied values.

constructor Create(aMode: TROSocketMode; aHandle: THandle)

Parameters:

• aMode:
• aHandle:

---

procedure AbortSocket

---

function Accept: THandle

---

property Active: Boolean read write

---

procedure BeginDisconnect(aCallback: TROSocketCallback; aCallBack_name: string)

Parameters:

• aCallback:
• aCallBack_name:

---

procedure BeginSend(aData: Pointer; aStart: Integer; aLength: Integer; aCallback: TROSocketCallback; aCallBack_name: string)

Parameters:

• aData:
• aStart:
• aLength:
• aCallback:
• aCallBack_name:

---

procedure Bind(IP: string; Port: Word)

Parameters:

• IP:
• Port:

---

function CanRead(aTimeout: Integer): Boolean

Parameters:

• aTimeout:

---

procedure CloseSocket

---

procedure Connect(IP: string; Port: Word)

Parameters:

• IP:
• Port:

---

procedure CreateSocket

---

function EndAccept: TROAsyncSocket

---

Clean up a broken connection.

procedure EndDisconnect

---

If the socket is not buffered (Buffered=False), this method returns the result of calling the instrumental IntEndSend method. Otherwise, it returns the amount of data recorded by the BufferedSendCallback and clears the callback registered by BeginSend.

function EndSend: Integer

---

procedure ExceptCheck(aRaiseExcept: Boolean; aAbortSocket: Boolean)

Parameters:

• aRaiseExcept:
• aAbortSocket:

---

function GetErrorDescEx: string

---

Retrieves the local endpoint of the transport layer.

function GetLocalIp: string

---

Retrieves the numeric value associated with the offered service by the transport layer.

function GetLocalPort: Integer

---

function GetLocalSinIP: string

---

Retrieves the IP of the peer.

function GetRemoteIp: string

---

Gets the port of the peer used for communication.

function GetRemotePort: Integer

---

function GetRemoteSinIP: string

---

procedure GetSins

---

Determines the admissible interval in seconds between send or receive operations.

property IdleTimeout: Integer read write

---

function IsValidSocket: Boolean

---

property LastError: Integer read

---

property LastErrorDesc: string read

---

Establishes a socket to listen for an incoming connection.

procedure Listen(aBacklog: Integer)

Parameters:

• aBacklog: Desired maximum length of the queue of pending connections. This value may be changed by the transport layer.

---

property MaxLineLength: Integer read write

---

property Mode: TROSocketMode read

---

Controls TCP packet batching (Nagle's algorithm).
TCP normally batches small logical packets into single larger physical packets (by briefly delaying packets) to fill physical network frames with as much data as possible. This is intended to improve network throughput in terminal emulation environments where mostly keystrokes are being sent across the network. Setting NoDelay to true disables TCP packet batching. Disabling TCP packet batching means that packets are sent regardless of size; this increases the volume of network traffic.

property NoDelay: Boolean read write

---

property OnDisconnected: TROSocketCallback read write
delegate:  procedure OnDisconnected(Sender: TROAsyncSocket)

---

property OnNewConnection: TRONewConnection read write
delegate:  procedure OnNewConnection(Sender: TObject; aSocket: TROAsyncSocket)

---

property OnTimeout: TROSocketCallback read write
delegate:  procedure OnTimeout(Sender: TROAsyncSocket)

---

Specifies SSL properties

property OpenSSL: TROOpenSSL read

---

procedure OpenSSL_Connect

---

property PreferIP4: Boolean read write

---

property RaiseExcept: Boolean read write

---

function ReadLine(var aLine: string): Boolean

Parameters:

• aLine:

---

Controls the size of the receiving data buffer of the transport layer. Note that the transport layer may not provide the requested size, so you have to read ReceiverBufferSize to check the buffer size actually provided.

property ReceiverBufferSize: Integer read write

---

function RecvBufferEx(Buffer: Pointer; Len: Integer; aTimeout: Integer): Integer

Parameters:

• Buffer:
• Len:
• aTimeout:

---

procedure ResetLastError

---

function SendBuffer(Buffer: Pointer; Len: Integer): Boolean

Parameters:

• Buffer:
• Len:

---

Controls the size of the sending data buffer of the transport layer. Note that the transport layer may not provide the requested size, so you have to read SendBufferSize to check the buffer size actually provided.

property SendBufferSize: Integer read write

---

function SockCheck(SockResult: Integer): Integer

Parameters:

• SockResult:

---

property Socket: THandle read write

 

property Active: Boolean read write

---

Determines the admissible interval in seconds between send or receive operations.

property IdleTimeout: Integer read write

---

property LastError: Integer read

---

property LastErrorDesc: string read

---

property MaxLineLength: Integer read write

---

property Mode: TROSocketMode read

---

Controls TCP packet batching (Nagle's algorithm).
TCP normally batches small logical packets into single larger physical packets (by briefly delaying packets) to fill physical network frames with as much data as possible. This is intended to improve network throughput in terminal emulation environments where mostly keystrokes are being sent across the network. Setting NoDelay to true disables TCP packet batching. Disabling TCP packet batching means that packets are sent regardless of size; this increases the volume of network traffic.

property NoDelay: Boolean read write

---

Specifies SSL properties

property OpenSSL: TROOpenSSL read

---

property PreferIP4: Boolean read write

---

property RaiseExcept: Boolean read write

---

Controls the size of the receiving data buffer of the transport layer. Note that the transport layer may not provide the requested size, so you have to read ReceiverBufferSize to check the buffer size actually provided.

property ReceiverBufferSize: Integer read write

---

Controls the size of the sending data buffer of the transport layer. Note that the transport layer may not provide the requested size, so you have to read SendBufferSize to check the buffer size actually provided.

property SendBufferSize: Integer read write

---

property Socket: THandle read write

 

Creates a new instance.

constructor Create

---

Creates a new instance with a supplied values.

constructor Create(aMode: TROSocketMode)

Parameters:

• aMode: Mode

---

Creates a new instance with a supplied values.

constructor Create(aMode: TROSocketMode; aHandle: THandle)

Parameters:

• aMode:
• aHandle:

---

procedure AbortSocket

---

function Accept: THandle

---

procedure BeginDisconnect(aCallback: TROSocketCallback; aCallBack_name: string)

Parameters:

• aCallback:
• aCallBack_name:

---

procedure BeginSend(aData: Pointer; aStart: Integer; aLength: Integer; aCallback: TROSocketCallback; aCallBack_name: string)

Parameters:

• aData:
• aStart:
• aLength:
• aCallback:
• aCallBack_name:

---

procedure Bind(IP: string; Port: Word)

Parameters:

• IP:
• Port:

---

function CanRead(aTimeout: Integer): Boolean

Parameters:

• aTimeout:

---

procedure CloseSocket

---

procedure Connect(IP: string; Port: Word)

Parameters:

• IP:
• Port:

---

procedure CreateSocket

---

function EndAccept: TROAsyncSocket

---

Clean up a broken connection.

procedure EndDisconnect

---

If the socket is not buffered (Buffered=False), this method returns the result of calling the instrumental IntEndSend method. Otherwise, it returns the amount of data recorded by the BufferedSendCallback and clears the callback registered by BeginSend.

function EndSend: Integer

---

procedure ExceptCheck(aRaiseExcept: Boolean; aAbortSocket: Boolean)

Parameters:

• aRaiseExcept:
• aAbortSocket:

---

function GetErrorDescEx: string

---

Retrieves the local endpoint of the transport layer.

function GetLocalIp: string

---

Retrieves the numeric value associated with the offered service by the transport layer.

function GetLocalPort: Integer

---

function GetLocalSinIP: string

---

Retrieves the IP of the peer.

function GetRemoteIp: string

---

Gets the port of the peer used for communication.

function GetRemotePort: Integer

---

function GetRemoteSinIP: string

---

procedure GetSins

---

function IsValidSocket: Boolean

---

Establishes a socket to listen for an incoming connection.

procedure Listen(aBacklog: Integer)

Parameters:

• aBacklog: Desired maximum length of the queue of pending connections. This value may be changed by the transport layer.

---

procedure OpenSSL_Connect

---

function ReadLine(var aLine: string): Boolean

Parameters:

• aLine:

---

function RecvBufferEx(Buffer: Pointer; Len: Integer; aTimeout: Integer): Integer

Parameters:

• Buffer:
• Len:
• aTimeout:

---

procedure ResetLastError

---

function SendBuffer(Buffer: Pointer; Len: Integer): Boolean

Parameters:

• Buffer:
• Len:

---

function SockCheck(SockResult: Integer): Integer

Parameters:

• SockResult:

 

property OnDisconnected: TROSocketCallback read write
delegate:  procedure OnDisconnected(Sender: TROAsyncSocket)

---

property OnNewConnection: TRONewConnection read write
delegate:  procedure OnNewConnection(Sender: TObject; aSocket: TROAsyncSocket)

---

property OnTimeout: TROSocketCallback read write
delegate:  procedure OnTimeout(Sender: TROAsyncSocket)