TROServerSocket

 

Creates a new instance.

constructor Create

---

Creates a new instance with a supplied value.

constructor Create(aMode: TROSocketMode = rsmUnspecified)

Parameters:

• aMode: Mode

---

procedure AbortSocket

---

function Accept: THandle

---

Reports if the server is now active or controls the server's state. If the server activates its binds socket with BindList addresses, it sets a socket in Listen mode and creates a thread to accept incoming connections.

property Active: Boolean read write

---

procedure Bind(IP: string; Port: Word)

Parameters:

• IP:
• Port:

---

List of IP addresses on which the server accepts connections.

property BindList: TStrings read

---

function CanRead(aTimeout: Integer): Boolean

Parameters:

• aTimeout:

---

procedure CloseSocket

---

procedure Connect(IP: string; Port: Word)

Parameters:

• IP:
• Port:

---

procedure CreateSocket

---

procedure ExceptCheck(aRaiseExcept: Boolean; aAbortSocket: Boolean)

Parameters:

• aRaiseExcept:
• aAbortSocket:

---

function GetErrorDescEx: string

---

function GetLocalSinIP: string

---

function GetRemoteSinIP: string

---

procedure GetSins

---

function IsValidSocket: Boolean

---

property LastError: Integer read

---

property LastErrorDesc: string read

---

Establishes a socket to listen for an incoming connection.

procedure Listen(aBacklog: Integer = $7FFFFFFF)

Parameters:

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

---

Size of listen queue, by default = 15.

property ListenQueue: Cardinal read write default 15

---

Restricts the maximum connection (client threads) count (100 by default).

property MaxThreads: Integer read write default 0

---

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

---

Fires when an incoming connection is rejected due to the exceedance of the MaxThreads.

property OnMaxThreadLimitReached: TThreadMethod read write

---

Fires when a new client thread is started.

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

---

Fires when the server accepts a connection and allows to use a custom descendant of the TROSocket class to serve the client connection.

property OnNewSocket: TRONewSocketEvent read write
delegate:  function OnNewSocket(Sender: TObject; aSock: THandle): TROSocket

---

Specifies SSL properties

property OpenSSL: TROOpenSSL read

---

procedure OpenSSL_Connect

---

Used when the BindList is empty to bind to a Port on a default interface.

property Port: Integer read write

---

property PreferIP4: Boolean read write default True

---

property RaiseExcept: Boolean read write default True

---

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

Parameters:

• Buffer:
• Len:
• aTimeout:

---

procedure ResetLastError

---

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

Parameters:

• Buffer:
• Len:

---

function SockCheck(SockResult: Integer = Integer(SOCKET_ERROR)): Integer

Parameters:

• SockResult:

---

property Socket: THandle read write

 

Reports if the server is now active or controls the server's state. If the server activates its binds socket with BindList addresses, it sets a socket in Listen mode and creates a thread to accept incoming connections.

property Active: Boolean read write

---

List of IP addresses on which the server accepts connections.

property BindList: TStrings read

---

property LastError: Integer read

---

property LastErrorDesc: string read

---

Size of listen queue, by default = 15.

property ListenQueue: Cardinal read write default 15

---

Restricts the maximum connection (client threads) count (100 by default).

property MaxThreads: Integer read write default 0

---

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

---

Fires when an incoming connection is rejected due to the exceedance of the MaxThreads.

property OnMaxThreadLimitReached: TThreadMethod read write

---

Specifies SSL properties

property OpenSSL: TROOpenSSL read

---

Used when the BindList is empty to bind to a Port on a default interface.

property Port: Integer read write

---

property PreferIP4: Boolean read write default True

---

property RaiseExcept: Boolean read write default True

---

property Socket: THandle read write

 

Creates a new instance.

constructor Create

---

Creates a new instance with a supplied value.

constructor Create(aMode: TROSocketMode = rsmUnspecified)

Parameters:

• aMode: Mode

---

procedure AbortSocket

---

function Accept: THandle

---

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

---

procedure ExceptCheck(aRaiseExcept: Boolean; aAbortSocket: Boolean)

Parameters:

• aRaiseExcept:
• aAbortSocket:

---

function GetErrorDescEx: string

---

function GetLocalSinIP: string

---

function GetRemoteSinIP: string

---

procedure GetSins

---

function IsValidSocket: Boolean

---

Establishes a socket to listen for an incoming connection.

procedure Listen(aBacklog: Integer = $7FFFFFFF)

Parameters:

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

---

procedure OpenSSL_Connect

---

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

Parameters:

• Buffer:
• Len:
• aTimeout:

---

procedure ResetLastError

---

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

Parameters:

• Buffer:
• Len:

---

function SockCheck(SockResult: Integer = Integer(SOCKET_ERROR)): Integer

Parameters:

• SockResult:

 

Fires when a new client thread is started.

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

---

Fires when the server accepts a connection and allows to use a custom descendant of the TROSocket class to serve the client connection.

property OnNewSocket: TRONewSocketEvent read write
delegate:  function OnNewSocket(Sender: TObject; aSock: THandle): TROSocket