TROBaseServerSocket

Overview

Represents a base server-side socket

Location


 

constructor Create    (declared in TROSocket)

Creates a new instance.

constructor Create

AbortSocket    (declared in TROSocket)

procedure AbortSocket

Accept

Begins an asynchronous operation to accept an incoming connection attempt.

function Accept: THandle

Bind    (declared in TROSocket)

Associates a socket with ip and port

procedure Bind(IP: string; Port: Word)

Parameters:

  • IP: IP address to assign to this socket
  • Port: Numeric value of the offered service

CanRead  virtual    (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:

CreateOpenSSL  protected override

Creates OpenSSL properties

procedure CreateOpenSSL

CreateSocket    (declared in TROSocket)

procedure CreateSocket

ExceptCheck    (declared in TROSocket)

procedure ExceptCheck(aRaiseExcept: Boolean; aAbortSocket: Boolean)

Parameters:

  • aRaiseExcept:
  • aAbortSocket:

GetErrorDescEx    (declared in TROSocket)

function GetErrorDescEx: string

GetLocalSinIP    (declared in TROSocket)

function GetLocalSinIP: string

GetRemoteSinIP    (declared in TROSocket)

function GetRemoteSinIP: string

GetServerOpenSSL  protected

Returns OpenSSL properties

function GetServerOpenSSL: TROServerSocketOpenSSL

GetSins    (declared in TROSocket)

procedure GetSins

IsValidSocket    (declared in TROSocket)

function IsValidSocket: Boolean

LastError    (declared in TROSocket)

property LastError: Integer read

LastErrorDesc    (declared in TROSocket)

property LastErrorDesc: string read

Listen

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.

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)

Specifies SSL properties

property OpenSSL: TROOpenSSL read

OpenSSL_Connect    (declared in TROSocket)

procedure OpenSSL_Connect

PreferIP4    (declared in TROSocket)

property PreferIP4: Boolean read write default True

RaiseExcept    (declared in TROSocket)

property RaiseExcept: Boolean read write default True

RecvBufferEx  virtual    (declared in TROSocket)

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

Parameters:

  • Buffer:
  • Len:
  • aTimeout:

ResetLastError    (declared in TROSocket)

procedure ResetLastError

SendBuffer    (declared in TROSocket)

Sends data to a connected Socket object.

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

Parameters:

  • Buffer:
  • Len:

SockCheck    (declared in TROSocket)

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

Parameters:

  • SockResult:

Socket    (declared in TROSocket)

property Socket: THandle read write

 

LastError    (declared in TROSocket)

property LastError: Integer read

LastErrorDesc    (declared in TROSocket)

property LastErrorDesc: string read

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)

Specifies SSL properties

property OpenSSL: TROOpenSSL read

PreferIP4    (declared in TROSocket)

property PreferIP4: Boolean read write default True

RaiseExcept    (declared in TROSocket)

property RaiseExcept: Boolean read write default True

Socket    (declared in TROSocket)

property Socket: THandle read write

 

constructor Create    (declared in TROSocket)

Creates a new instance.

constructor Create

AbortSocket    (declared in TROSocket)

procedure AbortSocket

Accept

Begins an asynchronous operation to accept an incoming connection attempt.

function Accept: THandle

Bind    (declared in TROSocket)

Associates a socket with ip and port

procedure Bind(IP: string; Port: Word)

Parameters:

  • IP: IP address to assign to this socket
  • Port: Numeric value of the offered service

CanRead  virtual    (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:

CreateOpenSSL  protected override

Creates OpenSSL properties

procedure CreateOpenSSL

CreateSocket    (declared in TROSocket)

procedure CreateSocket

ExceptCheck    (declared in TROSocket)

procedure ExceptCheck(aRaiseExcept: Boolean; aAbortSocket: Boolean)

Parameters:

  • aRaiseExcept:
  • aAbortSocket:

GetErrorDescEx    (declared in TROSocket)

function GetErrorDescEx: string

GetLocalSinIP    (declared in TROSocket)

function GetLocalSinIP: string

GetRemoteSinIP    (declared in TROSocket)

function GetRemoteSinIP: string

GetServerOpenSSL  protected

Returns OpenSSL properties

function GetServerOpenSSL: TROServerSocketOpenSSL

GetSins    (declared in TROSocket)

procedure GetSins

IsValidSocket    (declared in TROSocket)

function IsValidSocket: Boolean

Listen

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.

OpenSSL_Connect    (declared in TROSocket)

procedure OpenSSL_Connect

RecvBufferEx  virtual    (declared in TROSocket)

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

Parameters:

  • Buffer:
  • Len:
  • aTimeout:

ResetLastError    (declared in TROSocket)

procedure ResetLastError

SendBuffer    (declared in TROSocket)

Sends data to a connected Socket object.

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

Parameters:

  • Buffer:
  • Len:

SockCheck    (declared in TROSocket)

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

Parameters:

  • SockResult: