TROAsyncSocket
Overview
Location
- Unit: uROAsyncSocket.pas
- Ancestry: TROSocket | TROAsyncSocket
constructor Create (declared in TROSocket)
constructor Create
constructor Create (TROSocketMode) overload
constructor Create(aMode: TROSocketMode)
Parameters:
- aMode:
constructor Create (TROSocketMode, THandle) overload
constructor Create(aMode: TROSocketMode; aHandle: THandle)
Parameters:
- aMode:
- aHandle:
AbortSocket (declared in TROSocket)
procedure AbortSocket
Accept (declared in TROSocket)
function Accept: THandle
BeginAccept
procedure BeginAccept(aCallback: TROSocketCallback; aCallBack_name: string)
Parameters:
- aCallback:
- aCallBack_name:
BeginConnect
procedure BeginConnect(const aIp: string; aPort: Integer; aCallback: TROSocketCallback; aCallBack_name: string)
Parameters:
- aIp:
- aPort:
- aCallback:
- aCallBack_name:
BeginDisconnect
procedure BeginDisconnect(aCallback: TROSocketCallback; aCallBack_name: string)
Parameters:
- aCallback:
- aCallBack_name:
BeginReadLine
procedure BeginReadLine(aCallback: TROSocketCallback; aCallBack_name: string)
Parameters:
- aCallback:
- aCallBack_name:
BeginReceive
procedure BeginReceive(aData: Pointer; aStart: Integer; aLength: Integer; aCallback: TROSocketCallback; aCallBack_name: string)
Parameters:
- aData:
- aStart:
- aLength:
- aCallback:
- aCallBack_name:
BeginSend
procedure BeginSend(aData: Pointer; aStart: Integer; aLength: Integer; aCallback: TROSocketCallback; aCallBack_name: string)
Parameters:
- aData:
- aStart:
- aLength:
- aCallback:
- aCallBack_name:
Bind (declared in TROSocket)
procedure Bind(IP: string; Port: Word)
Parameters:
- IP:
- Port:
Buffered
property Buffered: Boolean read write
BufferReadLine
function BufferReadLine(var aLine: TBytes): Boolean
Parameters:
- aLine:
CanRead (declared in TROSocket)
function CanRead(aTimeout: Integer): Boolean
Parameters:
- aTimeout:
CloseSocket (declared in TROSocket)
procedure CloseSocket
Connect (declared in TROSocket)
procedure Connect(IP: string; Port: Word)
Parameters:
- IP:
- Port:
CreateSocket (declared in TROSocket)
procedure CreateSocket
EndAccept
function EndAccept: TROAsyncSocket
EndConnect
function EndConnect: Boolean
EndDisconnect
procedure EndDisconnect
EndReadLine
function EndReadLine(var aLine: string): Boolean
Parameters:
- aLine:
EndReceive
function EndReceive: Integer
EndSend
function EndSend: Integer
ExceptCheck (declared in TROSocket)
procedure ExceptCheck(aRaiseExcept: Boolean; aAbortSocket: Boolean)
Parameters:
- aRaiseExcept:
- aAbortSocket:
GetErrorDescEx (declared in TROSocket)
function GetErrorDescEx: string
GetLocalIp
function GetLocalIp: string
GetLocalPort
function GetLocalPort: Integer
GetLocalSinIP (declared in TROSocket)
function GetLocalSinIP: string
GetRemoteIp
function GetRemoteIp: string
GetRemotePort
function GetRemotePort: Integer
GetRemoteSinIP (declared in TROSocket)
function GetRemoteSinIP: string
GetSins (declared in TROSocket)
procedure GetSins
IdleTimeout
property IdleTimeout: Integer read write
LastError (declared in TROSocket)
property LastError: Integer read
LastErrorDesc (declared in TROSocket)
property LastErrorDesc: string read
Listen (declared in TROSocket)
procedure Listen(aBacklog: Integer)
Parameters:
- aBacklog:
MaxLineLength
property MaxLineLength: Integer read write
Mode (declared in TROSocket)
property Mode: TROSocketMode read
NoDelay (declared in TROSocket)
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
OnDisconnected
property OnDisconnected: TROSocketCallback read write
delegate: procedure OnDisconnected(Sender: TROAsyncSocket)
OnTimeout
property OnTimeout: TROSocketCallback read write
delegate: procedure OnTimeout(Sender: TROAsyncSocket)
OpenSSL (declared in TROSocket)
property OpenSSL: TROOpenSSL read
OpenSSL_Connect (declared in TROSocket)
procedure OpenSSL_Connect
PreferIP4 (declared in TROSocket)
property PreferIP4: Boolean read write
RaiseExcept (declared in TROSocket)
property RaiseExcept: Boolean read write
ReceiverBufferSize
property ReceiverBufferSize: Integer read write
RecvBufferEx (declared in TROSocket)
function RecvBufferEx(Buffer: Pointer; Len: Integer; aTimeout: Integer): Integer
Parameters:
- Buffer:
- Len:
- aTimeout:
ResetLastError (declared in TROSocket)
procedure ResetLastError
SendBuffer (declared in TROSocket)
function SendBuffer(Buffer: Pointer; Len: Integer): Boolean
Parameters:
- Buffer:
- Len:
SendBufferSize
property SendBufferSize: Integer read write
SockCheck (declared in TROSocket)
function SockCheck(SockResult: Integer): Integer
Parameters:
- SockResult:
Socket (declared in TROSocket)
property Socket: THandle read write
Buffered
property Buffered: Boolean read write
IdleTimeout
property IdleTimeout: Integer read write
LastError (declared in TROSocket)
property LastError: Integer read
LastErrorDesc (declared in TROSocket)
property LastErrorDesc: string read
MaxLineLength
property MaxLineLength: Integer read write
Mode (declared in TROSocket)
property Mode: TROSocketMode read
NoDelay (declared in TROSocket)
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
OpenSSL (declared in TROSocket)
property OpenSSL: TROOpenSSL read
PreferIP4 (declared in TROSocket)
property PreferIP4: Boolean read write
RaiseExcept (declared in TROSocket)
property RaiseExcept: Boolean read write
ReceiverBufferSize
property ReceiverBufferSize: Integer read write
SendBufferSize
property SendBufferSize: Integer read write
Socket (declared in TROSocket)
property Socket: THandle read write
constructor Create (declared in TROSocket)
constructor Create
constructor Create (TROSocketMode) overload
constructor Create(aMode: TROSocketMode)
Parameters:
- aMode:
constructor Create (TROSocketMode, THandle) overload
constructor Create(aMode: TROSocketMode; aHandle: THandle)
Parameters:
- aMode:
- aHandle:
AbortSocket (declared in TROSocket)
procedure AbortSocket
Accept (declared in TROSocket)
function Accept: THandle
BeginAccept
procedure BeginAccept(aCallback: TROSocketCallback; aCallBack_name: string)
Parameters:
- aCallback:
- aCallBack_name:
BeginConnect
procedure BeginConnect(const aIp: string; aPort: Integer; aCallback: TROSocketCallback; aCallBack_name: string)
Parameters:
- aIp:
- aPort:
- aCallback:
- aCallBack_name:
BeginDisconnect
procedure BeginDisconnect(aCallback: TROSocketCallback; aCallBack_name: string)
Parameters:
- aCallback:
- aCallBack_name:
BeginReadLine
procedure BeginReadLine(aCallback: TROSocketCallback; aCallBack_name: string)
Parameters:
- aCallback:
- aCallBack_name:
BeginReceive
procedure BeginReceive(aData: Pointer; aStart: Integer; aLength: Integer; aCallback: TROSocketCallback; aCallBack_name: string)
Parameters:
- aData:
- aStart:
- aLength:
- aCallback:
- aCallBack_name:
BeginSend
procedure BeginSend(aData: Pointer; aStart: Integer; aLength: Integer; aCallback: TROSocketCallback; aCallBack_name: string)
Parameters:
- aData:
- aStart:
- aLength:
- aCallback:
- aCallBack_name:
Bind (declared in TROSocket)
procedure Bind(IP: string; Port: Word)
Parameters:
- IP:
- Port:
BufferReadLine
function BufferReadLine(var aLine: TBytes): Boolean
Parameters:
- aLine:
CanRead (declared in TROSocket)
function CanRead(aTimeout: Integer): Boolean
Parameters:
- aTimeout:
CloseSocket (declared in TROSocket)
procedure CloseSocket
Connect (declared in TROSocket)
procedure Connect(IP: string; Port: Word)
Parameters:
- IP:
- Port:
CreateSocket (declared in TROSocket)
procedure CreateSocket
EndAccept
function EndAccept: TROAsyncSocket
EndConnect
function EndConnect: Boolean
EndDisconnect
procedure EndDisconnect
EndReadLine
function EndReadLine(var aLine: string): Boolean
Parameters:
- aLine:
EndReceive
function EndReceive: Integer
EndSend
function EndSend: Integer
ExceptCheck (declared in TROSocket)
procedure ExceptCheck(aRaiseExcept: Boolean; aAbortSocket: Boolean)
Parameters:
- aRaiseExcept:
- aAbortSocket:
GetErrorDescEx (declared in TROSocket)
function GetErrorDescEx: string
GetLocalIp
function GetLocalIp: string
GetLocalPort
function GetLocalPort: Integer
GetLocalSinIP (declared in TROSocket)
function GetLocalSinIP: string
GetRemoteIp
function GetRemoteIp: string
GetRemotePort
function GetRemotePort: Integer
GetRemoteSinIP (declared in TROSocket)
function GetRemoteSinIP: string
GetSins (declared in TROSocket)
procedure GetSins
Listen (declared in TROSocket)
procedure Listen(aBacklog: Integer)
Parameters:
- aBacklog:
OpenSSL_Connect (declared in TROSocket)
procedure OpenSSL_Connect
RecvBufferEx (declared in TROSocket)
function RecvBufferEx(Buffer: Pointer; Len: Integer; aTimeout: Integer): Integer
Parameters:
- Buffer:
- Len:
- aTimeout:
ResetLastError (declared in TROSocket)
procedure ResetLastError
SendBuffer (declared in TROSocket)
function SendBuffer(Buffer: Pointer; Len: Integer): Boolean
Parameters:
- Buffer:
- Len:
SockCheck (declared in TROSocket)
function SockCheck(SockResult: Integer): Integer
Parameters:
- SockResult:
OnDisconnected
property OnDisconnected: TROSocketCallback read write
delegate: procedure OnDisconnected(Sender: TROAsyncSocket)
OnTimeout
property OnTimeout: TROSocketCallback read write
delegate: procedure OnTimeout(Sender: TROAsyncSocket)