Difference between revisions of "Unit Protocol"

Revision as of 01:40, 24 April 2018 (view source) Ultibo (Talk | contribs) ← Older edit		Latest revision as of 05:29, 31 August 2021 (view source) Ultibo (Talk | contribs)
(One intermediate revision by the same user not shown)
Line 5:		Line 5:
	----		----
−	'''Ultibo Network Protocol interface unit'''	+	'''Ultibo Network Protocol Interface unit'''
−		+
−	''To be documented''	+
	=== Constants ===		=== Constants ===
Line 317:		Line 315:
−	'''Protocol manager'''	+	'''Protocol specific classes'''
−	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">	+	{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−		+
−	<code>TProtocolManager = class(TObject)</code>	+
−	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">	+
−	{| class="wikitable" style="font-size: 14px; background: white;"	+
	|-		|-
−	| <code>constructor Create(ASettings:TNetworkSettings; ATransports:TTransportManager);</code>	+	| [[TProtocolManager|<code>TProtocolManager = class(TObject)</code>]]
−	| style="width: 50%;"|&nbsp;	+
−	|-	+
−	| <code>destructor Destroy; override;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>	+
−	|-	+
−	| <code>FLock:TSynchronizerHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FSettings:TNetworkSettings;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FTransports:TTransportManager;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>FProtocols:TNetworkList;</code>	+
−	| List of TNetworkProtocol objects	+
−	|-	+
−	| <code>FFilters:TNetworkList;</code>	+
−	| List of TNetworkFilter objects	+
−	|-	+
−	| <code>FConfigs:TNetworkList;</code>	+
−	| List of TNetworkConfig objects	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ReaderLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ReaderUnlock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterUnlock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>	+
−	|-	+
−	| <code>property Settings:TNetworkSettings read FSettings;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>property Transports:TTransportManager read FTransports;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function AddProtocol(AProtocol:TNetworkProtocol):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function RemoveProtocol(AProtocol:TNetworkProtocol):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function GetProtocolByName(const AName:String; ALock:Boolean; AState:LongWord):TNetworkProtocol;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetProtocolByType(AProtocol,ASocketType:Word; ALock:Boolean; AState:LongWord):TNetworkProtocol;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetProtocolByProtocol(AProtocol:TNetworkProtocol; ALock:Boolean; AState:LongWord):TNetworkProtocol;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetProtocolBySocket(ASocket:TProtocolSocket; ALock:Boolean; AState:LongWord):TNetworkProtocol;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetProtocolByNext(APrevious:TNetworkProtocol; ALock,AUnlock:Boolean; AState:LongWord):TNetworkProtocol;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function AddFilter(AFilter:TNetworkFilter):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function RemoveFilter(AFilter:TNetworkFilter):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function GetFilterByProtocol(AProtocol:Word; ALock:Boolean; AState:LongWord):TNetworkFilter;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetFilterByFilter(AFilter:TNetworkFilter; ALock:Boolean; AState:LongWord):TNetworkFilter;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetFilterByNext(APrevious:TNetworkFilter; ALock,AUnlock:Boolean; AState:LongWord):TNetworkFilter;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function AddConfig(AConfig:TNetworkConfig):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function RemoveConfig(AConfig:TNetworkConfig):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function GetConfigByType(AConfigType:Word; ALock:Boolean; AState:LongWord):TNetworkConfig;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetConfigByConfig(AConfig:TNetworkConfig; ALock:Boolean; AState:LongWord):TNetworkConfig;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetConfigByNext(APrevious:TNetworkConfig; ALock,AUnlock:Boolean; AState:LongWord):TNetworkConfig;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function SetConfigByType(AConfigType:Word; AInitDelay,ARetryCount,ARetryTimeout:LongWord):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function StartProtocols:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function StopProtocols:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ProcessProtocols:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ProcessSockets:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function EnumerateProtocols(ACallback:TProtocolCallback):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function BindProtocols(ATransport:TNetworkTransport):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function UnbindProtocols(ATransport:TNetworkTransport):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function StartFilters:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function StopFilters:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ProcessFilters:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function EnumerateFilters(ACallback:TFilterCallback):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function BindFilters(ATransport:TNetworkTransport):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function UnbindFilters(ATransport:TNetworkTransport):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function StartConfigs:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function StopConfigs:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ProcessConfigs:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function EnumerateConfigs(ACallback:TConfigCallback):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function BindConfigs(ATransport:TNetworkTransport):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function UnbindConfigs(ATransport:TNetworkTransport):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function CheckSocket(ASocket:TSocket; ALock:Boolean; AState:LongWord):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function Select(ANfds:Integer; AReadfds,AWritefds,AExceptfds:PFDSet; ATimeout:PTimeVal):LongInt;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function Socket(AFamily,AStruct,AProtocol:Integer):TSocket;</code>	+
−	| &nbsp;	+
	|-		|-
	|}		|}
−	</div></div>	+	{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−		+
−	'''Protocol transport'''	+
−		+
−	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">	+
−		+
−	<code>TProtocolTransport = class(TListObject)</code>	+
−	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">	+
−	{| class="wikitable" style="font-size: 14px; background: white;"	+
	|-		|-
−	|colspan="2"|Note: Downstream	+	| [[TProtocolTransport|<code>TProtocolTransport = class(TListObject)</code>]]
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>constructor Create;</code>	+
−	| style="width: 50%;"|&nbsp;	+
−	|-	+
−	| <code>destructor Destroy; override;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>	+
−	|-	+
−	| <code>FLock:TSynchronizerHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>	+
−	|-	+
−	| <code>Handle:THandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>Protocol:Word;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>Transport:TNetworkTransport;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ReaderLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ReaderUnlock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterUnlock:Boolean;</code>	+
−	| &nbsp;	+
	|-		|-
	|}		|}
−	</div></div>	+	{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−		+
−	'''Network protocol'''	+
−		+
−	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">	+
−		+
−	<code>TNetworkProtocol = class(TListObject)</code>	+
−	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">	+
−	{| class="wikitable" style="font-size: 14px; background: white;"	+
	|-		|-
−	| <code>constructor Create(AManager:TProtocolManager; const AName:String);</code>	+	| [[TNetworkProtocol|<code>TNetworkProtocol = class(TListObject)</code>]]
−	| style="width: 50%;"|&nbsp;	+
−	|-	+
−	| <code>destructor Destroy; override;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>	+
−	|-	+
−	| <code>FLock:TSynchronizerHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FLocalLock:TMutexHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>	+
−	|-	+
−	| <code>FManager:TProtocolManager;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FName:String;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>FProtocol:Word;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FSocketType:Word;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FTransports:TNetworkList;</code>	+
−	| List of TProtocolTransport objects	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>FTimer:TSocketTimer;</code>	+
−	| Timer for socket processing	+
−	|-	+
−	| <code>FThread:TSocketThread;</code>	+
−	| Thread for socket processing	+
−	|-	+
−	| <code>FPorts:TNetworkList;</code>	+
−	| List of TProtocolPort objects	+
−	|-	+
−	| <code>FSockets:TNetworkList;</code>	+
−	| List of TProtocolSocket objects	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>FStatistics:TProtocolStatistics;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function GetName:String;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function AcquireLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ReleaseLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function OpenPort(ASocket:TProtocolSocket; APort:Word):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ClosePort(ASocket:TProtocolSocket):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function FindPort(APort:Word; AWrite,ALock:Boolean):TProtocolPort; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function SelectGet(AReadfds,AWritefds,AExceptfds:PFDSet; var ACode:Integer):TProtocolSocket; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function SelectStart(ASource,ADest:PFDSet):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function SelectCheck(ASource,ADest:PFDSet;ACode:Integer):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function SelectWait(ASocket:TProtocolSocket; ACode:Integer; ATimeout:LongWord):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function SendPacket(ASocket:TProtocolSocket; ASource,ADest:Pointer; ASourcePort,ADestPort:Word; APacket:PPacketFragment; ASize,AFlags:Integer):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>	+
−	|-	+
−	| <code>property Manager:TProtocolManager read FManager;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>property Name:String read FName; </code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>property Protocol:Word read FProtocol;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>property SocketType:Word read FSocketType;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function Accept(ASocket:TProtocolSocket; ASockAddr:PSockAddr; AAddrLength:PInteger):TProtocolSocket; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function Bind(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; AAddrLength:Integer):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function CloseSocket(ASocket:TProtocolSocket):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function Connect(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; AAddrLength:Integer):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function IoctlSocket(ASocket:TProtocolSocket; ACmd:DWORD; var AArg:u_long):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetPeerName(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; var AAddrLength:Integer):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetSockName(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; var AAddrLength:Integer):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetSockOpt(ASocket:TProtocolSocket; ALevel,AOptName:Integer; AOptValue:PChar; var AOptLength:Integer):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function Listen(ASocket:TProtocolSocket; ABacklog:Integer):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function Recv(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function RecvFrom(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer; var AFromAddr:TSockAddr; var AFromLength:Integer):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function Select(ANfds:Integer; AReadfds,AWritefds,AExceptfds:PFDSet; ATimeout:PTimeVal):LongInt; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function Send(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function SendTo(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer; var AToAddr:TSockAddr; AToLength:Integer):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function SetSockOpt(ASocket:TProtocolSocket; ALevel,AOptName:Integer; AOptValue:PChar; AOptLength:Integer):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function Shutdown(ASocket:TProtocolSocket; AHow:Integer):Integer; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function Socket(AFamily,AStruct,AProtocol:Integer):TProtocolSocket; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ReaderLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ReaderUnlock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterUnlock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function GetStatistics:TProtocolStatistics; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function GetTransportByHandle(AHandle:THandle; ALock:Boolean; AState:LongWord):TProtocolTransport;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetTransportByFamily(AFamily:Word; ALock:Boolean; AState:LongWord):TProtocolTransport;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetTransportByTransport(ATransport:TNetworkTransport; ALock:Boolean; AState:LongWord):TProtocolTransport;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetTransportByNext(APrevious:TProtocolTransport; ALock,AUnlock:Boolean; AState:LongWord):TProtocolTransport;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function AddTransport(ATransport:TNetworkTransport):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function RemoveTransport(ATransport:TNetworkTransport):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function GetSocketByNext(APrevious:TProtocolSocket; ALock,AUnlock:Boolean; AState:LongWord):TProtocolSocket;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function CheckSocket(ASocket:TProtocolSocket; ALock:Boolean; AState:LongWord):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function FindSocket(AFamily,AStruct,AProtocol:Word; ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast,AListen,ALock:Boolean; AState:LongWord):TProtocolSocket; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>procedure FlushSockets(All:Boolean); virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function StartProtocol:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function StopProtocol:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ProcessProtocol:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ProcessSockets:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ProcessSocket(ASocket:TProtocolSocket):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function BindProtocol(ATransport:TNetworkTransport):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function UnbindProtocol(ATransport:TNetworkTransport):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function CheckTimer:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ProcessTimer:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function SendSocket(ASocket:TProtocolSocket):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ScheduleSocket(ASocket:TProtocolSocket; ATimeout:LongWord):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function UnscheduleSocket(ASocket:TProtocolSocket):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ScheduleSocketItem(ASocket:TProtocolSocket; AItem:PSocketTimerItem; ATimeout:LongWord):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function UnscheduleSocketItem(ASocket:TProtocolSocket; AItem:PSocketTimerItem):Boolean; virtual;</code>	+
−	| &nbsp;	+
	|-		|-
	|}		|}
−	</div></div>	+	{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−		+
−	'''Socket timer'''	+
−		+
−	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">	+
−		+
−	<code>TSocketTimer = class(TObject)</code>	+
−	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">	+
−	{| class="wikitable" style="font-size: 14px; background: white;"	+
	|-		|-
−	| <code>constructor Create(AProtocol:TNetworkProtocol);</code>	+	| [[TSocketTimer|<code>TSocketTimer = class(TObject)</code>]]
−	| style="width: 50%;"|&nbsp;	+
−	|-	+
−	| <code>destructor Destroy; override;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>	+
−	|-	+
−	| <code>FProtocol:TNetworkProtocol;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>FLock:TMutexHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FInterval:LongWord;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FCheckTimer:TTimerHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FProcessSemaphore:TSemaphoreHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>FCount:LongWord;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FMaxCount:LongWord;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>FFirst:PSocketTimerItem;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FLast:PSocketTimerItem;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function AcquireLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ReleaseLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function Dequeue(AMax:Integer):TProtocolSocket;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function FirstKey:Integer;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function InsertKey(ASocket:TProtocolSocket; AItem:PSocketTimerItem; AKey:Integer):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function DeleteKey(ASocket:TProtocolSocket; AItem:PSocketTimerItem):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function DecrementKey:Integer;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>	+
−	|-	+
−	| <code>property Count:LongWord read FCount;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>property MaxCount:LongWord read FMaxCount;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function StartTimer(AInterval:LongWord):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function StopTimer:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function CheckTimer:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ProcessTimer:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ScheduleSocket(ASocket:TProtocolSocket; ATimeout:LongWord):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function UnscheduleSocket(ASocket:TProtocolSocket):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ScheduleSocketItem(ASocket:TProtocolSocket; AItem:PSocketTimerItem; ATimeout:LongWord):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function UnscheduleSocketItem(ASocket:TProtocolSocket; AItem:PSocketTimerItem):Boolean; virtual;</code>	+
−	| &nbsp;	+
	|-		|-
	|}		|}
−	</div></div>	+	{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−		+
−	'''Socket thread'''	+
−		+
−	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">	+
−		+
−	<code>TSocketThread = class(TThread)</code>	+
−	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">	+
−	{| class="wikitable" style="font-size: 14px; background: white;"	+
	|-		|-
−	| <code>constructor Create(AProtocol:TNetworkProtocol);</code>	+	| [[TSocketThread|<code>TSocketThread = class(TThread)</code>]]
−	| style="width: 50%;"|&nbsp;	+
−	|-	+
−	| <code>destructor Destroy; override;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>	+
−	|-	+
−	| <code>FProtocol:TNetworkProtocol;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>procedure Execute; override;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>	+
−	|-	+
−	| <code>function SendSocket(ASocket:TProtocolSocket):Boolean;</code>	+
−	| &nbsp;	+
	|-		|-
	|}		|}
−	</div></div>	+	{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−		+
−	'''Protocol port'''	+
−		+
−	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">	+
−		+
−	<code>TProtocolPort = class(TListObject)</code>	+
−	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">	+
−	{| class="wikitable" style="font-size: 14px; background: white;"	+
	|-		|-
−	| <code>constructor Create;</code>	+	| [[TProtocolPort|<code>TProtocolPort = class(TListObject)</code>]]
−	| style="width: 50%;"|&nbsp;	+
−	|-	+
−	| <code>destructor Destroy; override;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>	+
−	|-	+
−	| <code>FLock:TMutexHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>	+
−	|-	+
−	| <code>Port:Word;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>Sockets:TList;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function AcquireLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ReleaseLock:Boolean;</code>	+
−	| &nbsp;	+
	|-		|-
	|}		|}
−	</div></div>	+	{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−		+
−	'''Protocol socket'''	+
−		+
−	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">	+
−		+
−	<code>TProtocolSocket = class(TTransportSocket)</code>	+
−	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">	+
−	{| class="wikitable" style="font-size: 14px; background: white;"	+
	|-		|-
−	| <code>constructor Create(AProtocol:TNetworkProtocol; ATransport:TNetworkTransport);</code>	+	| [[TProtocolSocket|<code>TProtocolSocket = class(TTransportSocket)</code>]]
−	| style="width: 50%;"|&nbsp;	+
−	|-	+
−	| <code>destructor Destroy; override;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>	+
−	|-	+
−	| <code>FSocketChange:TEventHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>	+
−	|-	+
−	| <code>FProtocol:TNetworkProtocol;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>FProtocolState:TProtocolState;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FProtocolOptions:TProtocolOptions;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function CheckSocket(ASocket:TProtocolSocket; ALock:Boolean; AState:LongWord):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>	+
−	|-	+
−	| <code>property ProtocolState:TProtocolState read FProtocolState;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>property ProtocolOptions:TProtocolOptions read FProtocolOptions;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>property Protocol:TNetworkProtocol read FProtocol;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function WaitChange:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WaitChangeEx(ATimeout:LongWord):Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function SignalChange:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function SendSocket:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ScheduleSocket(ATimeout:LongWord):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function UnscheduleSocket:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ScheduleSocketItem(AItem:PSocketTimerItem; ATimeout:LongWord):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function UnscheduleSocketItem(AItem:PSocketTimerItem):Boolean; virtual;</code>	+
−	| &nbsp;	+
	|-		|-
	|}		|}
−	</div></div>	+	{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−		+
−	'''Protocol state'''	+
−		+
−	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">	+
−		+
−	<code>TProtocolState = class(TObject)</code>	+
−	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">	+
−	{| class="wikitable" style="font-size: 14px; background: white;"	+
	|-		|-
−	| <code>constructor Create;</code>	+	| [[TProtocolState|<code>TProtocolState = class(TObject)</code>]]
−	| style="width: 50%;"|&nbsp;	+
−	|-	+
−	| <code>destructor Destroy; override;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>	+
−	|-	+
−	| <code>FLock:TCriticalSectionHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>	+
−	|-	+
−	| <code>FLocalPort:Word;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FRemotePort:Word;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function AcquireLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ReleaseLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>procedure SetLocalPort(ALocalPort:Word);</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>procedure SetRemotePort(ARemotePort:Word);</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>	+
−	|-	+
−	| <code>property LocalPort:Word read FLocalPort write SetLocalPort;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>property RemotePort:Word read FRemotePort write SetRemotePort;</code>	+
−	| &nbsp;	+
	|-		|-
	|}		|}
−	</div></div>	+	{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−		+
−	'''Protocol options'''	+
−		+
−	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">	+
−		+
−	<code>TProtocolOptions = class(TObject)</code>	+
−	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">	+
−	{| class="wikitable" style="font-size: 14px; background: white;"	+
	|-		|-
−	|colspan="2"|Note: For Get/Set Options at the Protocol Level (eg IPPROTO_TCP, IPPROTO_UDP)	+	| [[TProtocolOptions|<code>TProtocolOptions = class(TObject)</code>]]
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>constructor Create;</code>	+
−	| style="width: 50%;"|&nbsp;	+
−	|-	+
−	| <code>destructor Destroy; override;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>	+
−	|-	+
−	| <code>FLock:TCriticalSectionHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>	+
−	|-	+
−	| <code>function AcquireLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ReleaseLock:Boolean;</code>	+
−	| &nbsp;	+
	|-		|-
	|}		|}
−	</div></div>	+	{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−		+
−	'''Filter transport'''	+
−		+
−	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">	+
−		+
−	<code>TFilterTransport = class(TListObject)</code>	+
−	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">	+
−	{| class="wikitable" style="font-size: 14px; background: white;"	+
	|-		|-
−	|colspan="2"|Note: Downstream	+	| [[TFilterTransport|<code>TFilterTransport = class(TListObject)</code>]]
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>constructor Create;</code>	+
−	| style="width: 50%;"|&nbsp;	+
−	|-	+
−	| <code>destructor Destroy; override;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>	+
−	|-	+
−	| <code>FLock:TSynchronizerHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>	+
−	|-	+
−	| <code>Handle:THandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>Protocol:Word;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>Transport:TNetworkTransport;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ReaderLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ReaderUnlock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterUnlock:Boolean;</code>	+
−	| &nbsp;	+
	|-		|-
	|}		|}
−	</div></div>	+	{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−		+
−	'''Network filter'''	+
−		+
−	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">	+
−		+
−	<code>TNetworkFilter = class(TListObject)</code>	+
−	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">	+
−	{| class="wikitable" style="font-size: 14px; background: white;"	+
	|-		|-
−	|colspan="2"|Note: eg IP Filter	+	| [[TNetworkFilter|<code>TNetworkFilter = class(TListObject)</code>]]
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>constructor Create(AManager:TProtocolManager);</code>	+
−	| style="width: 50%;"|&nbsp;	+
−	|-	+
−	| <code>destructor Destroy; override;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>	+
−	|-	+
−	| <code>FLock:TSynchronizerHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>	+
−	|-	+
−	| <code>FManager:TProtocolManager;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>FProtocol:Word;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FTransports:TNetworkList;</code>	+
−	| List of TFilterTransport objects	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>	+
−	|-	+
−	| <code>property Manager:TProtocolManager read FManager;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>property Protocol:Word read FProtocol;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ReaderLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ReaderUnlock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterUnlock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function GetTransportByHandle(AHandle:THandle; ALock:Boolean; AState:LongWord):TFilterTransport;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetTransportByFamily(AFamily:Word; ALock:Boolean; AState:LongWord):TFilterTransport;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetTransportByTransport(ATransport:TNetworkTransport; ALock:Boolean; AState:LongWord):TFilterTransport;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetTransportByNext(APrevious:TFilterTransport; ALock,AUnlock:Boolean; AState:LongWord):TFilterTransport;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function AddTransport(ATransport:TNetworkTransport):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function RemoveTransport(ATransport:TNetworkTransport):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function StartFilter:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function StopFilter:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ProcessFilter:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function BindFilter(ATransport:TNetworkTransport):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function UnbindFilter(ATransport:TNetworkTransport):Boolean; virtual;</code>	+
−	| &nbsp;	+
	|-		|-
	|}		|}
−	</div></div>	+	{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−		+
−	'''Configuration transport'''	+
−		+
−	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">	+
−		+
−	<code>TConfigTransport = class(TListObject)</code>	+
−	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">	+
−	{| class="wikitable" style="font-size: 14px; background: white;"	+
	|-		|-
−	|colspan="2"|Note: Downstream	+	| [[TConfigTransport|<code>TConfigTransport = class(TListObject)</code>]]
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>constructor Create;</code>	+
−	| style="width: 50%;"|&nbsp;	+
−	|-	+
−	| <code>destructor Destroy; override;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>	+
−	|-	+
−	| <code>FLock:TSynchronizerHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>	+
−	|-	+
−	| <code>Handle:THandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>ConfigType:Word;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>Transport:TNetworkTransport;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ReaderLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ReaderUnlock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterUnlock:Boolean;</code>	+
−	| &nbsp;	+
	|-		|-
	|}		|}
−	</div></div>	+	{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−		+
−	'''Network configuration'''	+
−		+
−	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">	+
−		+
−	<code>TNetworkConfig = class(TListObject)</code>	+
−	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">	+
−	{| class="wikitable" style="font-size: 14px; background: white;"	+
	|-		|-
−	|colspan="2"|Note: eg DHCP/BOOTP/RARP/STATIC/PSEUDO	+	| [[TNetworkConfig|<code>TNetworkConfig = class(TListObject)</code>]]
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>constructor Create(AManager:TProtocolManager);</code>	+
−	| style="width: 50%;"|&nbsp;	+
−	|-	+
−	| <code>destructor Destroy; override;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>	+
−	|-	+
−	| <code>FLock:TSynchronizerHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>	+
−	|-	+
−	| <code>FManager:TProtocolManager;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>FConfigType:Word;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FInitDelay:LongWord;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FRetryCount:LongWord;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FRetryTimeout:LongWord;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>FTransports:TNetworkList;</code>	+
−	| List of TConfigTransport objects	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>	+
−	|-	+
−	| <code>property Manager:TProtocolManager read FManager;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>property ConfigType:Word read FConfigType;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>property InitDelay:LongWord read FInitDelay;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>property RetryCount:LongWord read FRetryCount;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>property RetryTimeout:LongWord read FRetryTimeout;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ReaderLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ReaderUnlock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterUnlock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function GetTransportByHandle(AHandle:THandle; ALock:Boolean; AState:LongWord):TConfigTransport;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetTransportByFamily(AFamily:Word; ALock:Boolean; AState:LongWord):TConfigTransport;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetTransportByTransport(ATransport:TNetworkTransport; ALock:Boolean; AState:LongWord):TConfigTransport;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function GetTransportByNext(APrevious:TConfigTransport; ALock,AUnlock:Boolean; AState:LongWord):TConfigTransport;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function AddTransport(ATransport:TNetworkTransport):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function RemoveTransport(ATransport:TNetworkTransport):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function StartConfig:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function StopConfig:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ProcessConfig:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function BindConfig(ATransport:TNetworkTransport):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function UnbindConfig(ATransport:TNetworkTransport):Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function SetConfig(AInitDelay,ARetryCount,ARetryTimeout:LongWord):Boolean; virtual;</code>	+
−	| &nbsp;	+
	|-		|-
	|}		|}
−	</div></div>	+	{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−		+
−	'''Network client'''	+
−		+
−	<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">	+
−		+
−	<code>TNetworkClient = class(TListObject)</code>	+
−	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">	+
−	{| class="wikitable" style="font-size: 14px; background: white;"	+
	|-		|-
−	|colspan="2"|Note: eg DNS/WINS	+	| [[TNetworkClient|<code>TNetworkClient = class(TListObject)</code>]]
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>constructor Create(AProtocol:TNetworkProtocol);</code>	+
−	| style="width: 50%;"|&nbsp;	+
−	|-	+
−	| <code>destructor Destroy; override;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>	+
−	|-	+
−	| <code>FLock:TSynchronizerHandle;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>	+
−	|-	+
−	| <code>FProtocol:TNetworkProtocol;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>	+
−	|-	+
−	| <code>property Protocol:TNetworkProtocol read FProtocol;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function ReaderLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function ReaderUnlock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterLock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function WriterUnlock:Boolean;</code>	+
−	| &nbsp;	+
−	|-	+
−	|colspan="2"|&nbsp;	+
−	|-	+
−	| <code>function StartClient:Boolean; virtual;</code>	+
−	| &nbsp;	+
−	|-	+
−	| <code>function StopClient:Boolean; virtual;</code>	+
−	| &nbsp;	+
	|-		|-
	|}		|}
−	</div></div>
	<br />		<br />

---

Latest revision as of 05:29, 31 August 2021

Return to Unit Reference

Description

---

Ultibo Network Protocol Interface unit

Constants

---

Type definitions

---

Protocol statistics

Socket timer item

Protocol callback

TProtocolCallback = function(AProtocol:TNetworkProtocol):Boolean of object;

Filter callback

TFilterCallback = function(AFilter:TNetworkFilter):Boolean of object;

Configuration callback

TConfigCallback = function(AConfig:TNetworkConfig):Boolean of object;

Class definitions

---

Protocol specific classes

TProtocolManager = class(TObject)

TProtocolTransport = class(TListObject)

TNetworkProtocol = class(TListObject)

TSocketTimer = class(TObject)

TSocketThread = class(TThread)

TProtocolPort = class(TListObject)

TProtocolSocket = class(TTransportSocket)

TProtocolState = class(TObject)

TProtocolOptions = class(TObject)

TFilterTransport = class(TListObject)

TNetworkFilter = class(TListObject)

TConfigTransport = class(TListObject)

TNetworkConfig = class(TListObject)

TNetworkClient = class(TListObject)

Public variables

---

Protocol specific variables

ProtocolManager:TProtocolManager;

Function declarations

---

Initialization functions

Protocol helper functions

Return to Unit Reference