Difference between revisions of "Unit Protocol"

Revision as of 02:40, 29 May 2017

`constructor Create(ASettings:TNetworkSettings; ATransports:TTransportManager);`
`destructor Destroy; override;`
private
`FLock:TSynchronizerHandle;`
`FSettings:TNetworkSettings;`
`FTransports:TTransportManager;`

`FProtocols:TNetworkList;`	List of TNetworkProtocol objects
`FFilters:TNetworkList;`	List of TNetworkFilter objects
`FConfigs:TNetworkList;`	List of TNetworkConfig objects

`function ReaderLock:Boolean;`
`function ReaderUnlock:Boolean;`
`function WriterLock:Boolean;`
`function WriterUnlock:Boolean;`
public
`property Settings:TNetworkSettings read FSettings;`
`property Transports:TTransportManager read FTransports;`

`function AddProtocol(AProtocol:TNetworkProtocol):Boolean;`
`function RemoveProtocol(AProtocol:TNetworkProtocol):Boolean;`

`function GetProtocolByType(AProtocol,ASocketType:Word; ALock:Boolean; AState:LongWord):TNetworkProtocol;`
`function GetProtocolByProtocol(AProtocol:TNetworkProtocol; ALock:Boolean; AState:LongWord):TNetworkProtocol;`
`function GetProtocolByNext(APrevious:TNetworkProtocol; ALock,AUnlock:Boolean; AState:LongWord):TNetworkProtocol;`

`function AddFilter(AFilter:TNetworkFilter):Boolean;`
`function RemoveFilter(AFilter:TNetworkFilter):Boolean;`

`function GetFilterByProtocol(AProtocol:Word; ALock:Boolean; AState:LongWord):TNetworkFilter;`
`function GetFilterByFilter(AFilter:TNetworkFilter; ALock:Boolean; AState:LongWord):TNetworkFilter;`
`function GetFilterByNext(APrevious:TNetworkFilter; ALock,AUnlock:Boolean; AState:LongWord):TNetworkFilter;`

`function AddConfig(AConfig:TNetworkConfig):Boolean;`
`function RemoveConfig(AConfig:TNetworkConfig):Boolean;`

`function GetConfigByType(AConfigType:Word; ALock:Boolean; AState:LongWord):TNetworkConfig;`
`function GetConfigByConfig(AConfig:TNetworkConfig; ALock:Boolean; AState:LongWord):TNetworkConfig;`
`function GetConfigByNext(APrevious:TNetworkConfig; ALock,AUnlock:Boolean; AState:LongWord):TNetworkConfig;`

`function SetConfigByType(AConfigType:Word; AInitDelay,ARetryCount,ARetryTimeout:LongWord):Boolean;`

`function StartProtocols:Boolean;`
`function StopProtocols:Boolean;`
`function ProcessProtocols:Boolean;`

`function ProcessSockets:Boolean;`

`function EnumerateProtocols(ACallback:TProtocolCallback):Boolean;`

`function BindProtocols(ATransport:TNetworkTransport):Boolean;`
`function UnbindProtocols(ATransport:TNetworkTransport):Boolean;`

`function StartFilters:Boolean;`
`function StopFilters:Boolean;`
`function ProcessFilters:Boolean;`

`function EnumerateFilters(ACallback:TFilterCallback):Boolean;`

`function BindFilters(ATransport:TNetworkTransport):Boolean;`
`function UnbindFilters(ATransport:TNetworkTransport):Boolean;`

`function StartConfigs:Boolean;`
`function StopConfigs:Boolean;`
`function ProcessConfigs:Boolean;`

`function EnumerateConfigs(ACallback:TConfigCallback):Boolean;`

`function BindConfigs(ATransport:TNetworkTransport):Boolean;`
`function UnbindConfigs(ATransport:TNetworkTransport):Boolean;`

`function CheckSocket(ASocket:TSocket; ALock:Boolean; AState:LongWord):Boolean;`

`function Select(ANfds:Integer; AReadfds,AWritefds,AExceptfds:PFDSet; ATimeout:PTimeVal):LongInt;`
`function Socket(AFamily,AStruct,AProtocol:Integer):TSocket;`

Protocol transport

[Expand]

TProtocolTransport = class(TListObject)

Network protocol

[Expand]

TNetworkProtocol = class(TListObject)

`constructor Create(AManager:TProtocolManager; const AName:String);`
`destructor Destroy; override;`
private
`FLock:TSynchronizerHandle;`
protected
`FManager:TProtocolManager;`
`FName:String;`

`FProtocol:Word;`
`FSocketType:Word;`
`FTransports:TNetworkList;`	List of TProtocolTransport objects

`FTimer:TSocketTimer;`	Timer for socket processing
`FThread:TSocketThread;`	Thread for socket processing
`FPorts:TNetworkList;`	List of TProtocolPort objects
`FSockets:TNetworkList;`	List of TProtocolSocket objects

`FStatistics:TProtocolStatistics;`

`function GetTransportByHandle(AHandle:THandle; ALock:Boolean; AState:LongWord):TProtocolTransport;`
`function GetTransportByFamily(AFamily:Word; ALock:Boolean; AState:LongWord):TProtocolTransport;`
`function GetTransportByTransport(ATransport:TNetworkTransport; ALock:Boolean; AState:LongWord):TProtocolTransport;`
`function GetTransportByNext(APrevious:TProtocolTransport; ALock,AUnlock:Boolean; AState:LongWord):TProtocolTransport;`

`function AddTransport(ATransport:TNetworkTransport):Boolean; virtual;`
`function RemoveTransport(ATransport:TNetworkTransport):Boolean; virtual;`

`function OpenPort(ASocket:TProtocolSocket; APort:Word):Boolean; virtual;`
`function ClosePort(ASocket:TProtocolSocket):Boolean; virtual;`
`function FindPort(APort:Word; AWrite,ALock:Boolean):TProtocolPort; virtual;`

`function GetSocketByNext(APrevious:TProtocolSocket; ALock,AUnlock:Boolean; AState:LongWord):TProtocolSocket;`
`function CheckSocket(ASocket:TProtocolSocket; ALock:Boolean; AState:LongWord):Boolean; virtual;`
`function FindSocket(AFamily,AStruct,AProtocol:Word; ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast,AListen,ALock:Boolean; AState:LongWord):TProtocolSocket; virtual;`
`procedure FlushSockets(All:Boolean); virtual;`

`function SelectStart(ASource,ADest:PFDSet):Boolean; virtual;`
`function SelectCheck(ASource,ADest:PFDSet;ACode:Integer):Integer; virtual;`

`function SendPacket(ASocket:TProtocolSocket; ASource,ADest:Pointer; ASourcePort,ADestPort:Word; APacket:PPacketFragment; ASize,AFlags:Integer):Integer; virtual;`
public
`property Manager:TProtocolManager read FManager;`
`property Name:String read FName;`

`property Protocol:Word read FProtocol;`
`property SocketType:Word read FSocketType;`

`function Accept(ASocket:TProtocolSocket; ASockAddr:PSockAddr; AAddrLength:PInteger):TProtocolSocket; virtual;`
`function Bind(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; AAddrLength:Integer):Integer; virtual;`
`function CloseSocket(ASocket:TProtocolSocket):Integer; virtual;`
`function Connect(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; AAddrLength:Integer):Integer; virtual;`
`function IoctlSocket(ASocket:TProtocolSocket; ACmd:DWORD; var AArg:u_long):Integer; virtual;`
`function GetPeerName(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; var AAddrLength:Integer):Integer; virtual;`
`function GetSockName(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; var AAddrLength:Integer):Integer; virtual;`
`function GetSockOpt(ASocket:TProtocolSocket; ALevel,AOptName:Integer; AOptValue:PChar; var AOptLength:Integer):Integer; virtual;`
`function Listen(ASocket:TProtocolSocket; ABacklog:Integer):Integer; virtual;`
`function Recv(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer):Integer; virtual;`
`function RecvFrom(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer; var AFromAddr:TSockAddr; var AFromLength:Integer):Integer; virtual;`
`function Select(ANfds:Integer; AReadfds,AWritefds,AExceptfds:PFDSet; ATimeout:PTimeVal):LongInt; virtual;`
`function Send(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer):Integer; virtual;`
`function SendTo(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer; var AToAddr:TSockAddr; AToLength:Integer):Integer; virtual;`
`function SetSockOpt(ASocket:TProtocolSocket; ALevel,AOptName:Integer; AOptValue:PChar; AOptLength:Integer):Integer; virtual;`
`function Shutdown(ASocket:TProtocolSocket; AHow:Integer):Integer; virtual;`
`function Socket(AFamily,AStruct,AProtocol:Integer):TProtocolSocket; virtual;`

`function ReaderLock:Boolean;`
`function ReaderUnlock:Boolean;`
`function WriterLock:Boolean;`
`function WriterUnlock:Boolean;`

`function GetStatistics:TProtocolStatistics; virtual;`

`function StartProtocol:Boolean; virtual;`
`function StopProtocol:Boolean; virtual;`
`function ProcessProtocol:Boolean; virtual;`

`function ProcessSockets:Boolean; virtual;`
`function ProcessSocket(ASocket:TProtocolSocket):Boolean; virtual;`

`function BindProtocol(ATransport:TNetworkTransport):Boolean; virtual;`
`function UnbindProtocol(ATransport:TNetworkTransport):Boolean; virtual;`

`function CheckTimer:Boolean; virtual;`
`function ProcessTimer:Boolean; virtual;`

`function SendSocket(ASocket:TProtocolSocket):Boolean; virtual;`

`function ScheduleSocket(ASocket:TProtocolSocket; ATimeout:LongWord):Boolean; virtual;`
`function UnscheduleSocket(ASocket:TProtocolSocket):Boolean; virtual;`

`function ScheduleSocketItem(ASocket:TProtocolSocket; AItem:PSocketTimerItem; ATimeout:LongWord):Boolean; virtual;`
`function UnscheduleSocketItem(ASocket:TProtocolSocket; AItem:PSocketTimerItem):Boolean; virtual;`

Socket timer

[Expand]

TSocketTimer = class(TObject)

Socket thread

[Expand]

TSocketThread = class(TThread)

Protocol port

[Expand]

TProtocolPort = class(TListObject)

Protocol socket

[Expand]

TProtocolSocket = class(TTransportSocket)

Protocol state

[Expand]

TProtocolState = class(TObject)

Protocol options

[Expand]

TProtocolOptions = class(TObject)

Filter transport

[Expand]

TFilterTransport = class(TListObject)

Network filter

[Expand]

TNetworkFilter = class(TListObject)

Configuration transport

[Expand]

TConfigTransport = class(TListObject)

Network configuration

[Expand]

TNetworkConfig = class(TListObject)

Network client

[Expand]

TNetworkClient = class(TListObject)

Public variables

Protocol specific variables

`ProtocolManager:TProtocolManager;`

Function declarations

Initialization functions

[Expand]

procedure ProtocolInit;

Description: To be documented

[Expand]

function ProtocolStart:LongWord;

Description: To be documented

[Expand]

function ProtocolStop:LongWord;

Description: To be documented

Protocol helper functions

[Expand]

procedure ProtocolCheckTimer(Data:Pointer);

Description: To be documented

Return to Unit Reference

@@ Line 1,598: / Line 1,598: @@
 ----
-''None defined''
+'''Protocol specific variables'''
+{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
+|-
+| <code>ProtocolManager:TProtocolManager;</code>
+| style="width: 40%;"|
+|-
+|}
+<br />
 === Function declarations ===

`PROTOCOL_THREAD_NAME = 'Network Protocol';`	Thread name for Network protocol threads
`PROTOCOL_THREAD_PRIORITY = THREAD_PRIORITY_HIGHER;`	Thread priority for Network protocol threads

`SOCKET_TIMER_FLAG_NONE = $00000000;`
`SOCKET_TIMER_FLAG_ACTIVE = $00000001;`	The socket timer item is active in a timer
`SOCKET_TIMER_FLAG_DYNAMIC = $00000002;`	The socket timer item was allocated dynamically

`ICMP_ECHOREPLY = 0;`	echo reply
`ICMP_UNREACH = 3;`	dest unreachable
`ICMP_SOURCEQUENCH = 4;`	packet lost, slow down
`ICMP_REDIRECT = 5;`	shorter route
`ICMP_ECHO = 8;`	echo service
`ICMP_ROUTERADVERT = 9;`	router advertisement
`ICMP_ROUTERSOLICIT = 10;`	router solicitation
`ICMP_TIMXCEED = 11;`	time exceeded
`ICMP_PARAMPROB = 12;`	ip header bad
`ICMP_TSTAMP = 13;`	timestamp request
`ICMP_TSTAMPREPLY = 14;`	timestamp reply
`ICMP_IREQ = 15;`	information request
`ICMP_IREQREPLY = 16;`	information reply
`ICMP_MASKREQ = 17;`	address mask request
`ICMP_MASKREPLY = 18;`	address mask reply

`ICMP_UNREACH_NET = 0;`	bad net
`ICMP_UNREACH_HOST = 1;`	bad host
`ICMP_UNREACH_PROTOCOL = 2;`	bad protocol
`ICMP_UNREACH_PORT = 3;`	bad port
`ICMP_UNREACH_NEEDFRAG = 4;`	IP_DF caused drop
`ICMP_UNREACH_SRCFAIL = 5;`	src route failed
`ICMP_UNREACH_NET_UNKNOWN = 6;`	unknown net
`ICMP_UNREACH_HOST_UNKNOWN = 7;`	unknown host
`ICMP_UNREACH_ISOLATED = 8;`	src host isolated
`ICMP_UNREACH_NET_PROHIB = 9;`	prohibited access
`ICMP_UNREACH_HOST_PROHIB = 10;`	ditto
`ICMP_UNREACH_TOSNET = 11;`	bad tos for net
`ICMP_UNREACH_TOSHOST = 12;`	bad tos for host
`ICMP_UNREACH_FILTER_PROHIB = 13;`	admin prohib
`ICMP_UNREACH_HOST_PRECEDENCE = 14;`	host prec vio.
`ICMP_UNREACH_PRECEDENCE_CUTOFF = 15;`	prec cutoff

`ICMP_REDIRECT_NET = 0;`	for network
`ICMP_REDIRECT_HOST = 1;`	for host
`ICMP_REDIRECT_TOSNET = 2;`	for tos and net
`ICMP_REDIRECT_TOSHOST = 3;`	for tos and host

`ICMP_TIMXCEED_INTRANS = 0;`	ttl=0 in transit
`ICMP_TIMXCEED_REASS = 1;`	ttl=0 in reassembly

`ICMP_PARAMPROB_OPTABSENT = 1;`	req. opt. absent

Difference between revisions of "Unit Protocol"

Revision as of 02:40, 29 May 2017

Contents

Description

Constants

Type definitions

Class definitions

Public variables

Function declarations

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools

`SOCKET_TIMER_KEY_NONE = TIMER_KEY_NONE;`
`SOCKET_TIMER_KEY_MAX = TIMER_KEY_MAX;`
`SOCKET_TIMER_KEY_MIN = TIMER_KEY_MIN;`

`IGMP_VERSION = 2;`
`IGMP_QUERY = $0011;`
`IGMP_REPORTV1 = $0012;`
`IGMP_REPORTV2 = $0016;`
`IGMP_LEAVE = $0017;`

`PacketsIn:Int64;`
`PacketsOut:Int64;`
`BytesIn:Int64;`
`BytesOut:Int64;`
`ErrorsIn:Int64;`
`ErrorsOut:Int64;`
`PacketsLost:Int64;`

`Key:Integer;`	Ordering key for timer list
`Flags:LongWord;`	Flags for this timer item
`Socket:TObject;`	The socket referenced by this timer list item
`Prev:PSocketTimerItem;`	Previous item in timer list
`Next:PSocketTimerItem;`	Next item in timer list

Note: Downstream

`constructor Create;`
`destructor Destroy; override;`
private
`FLock:TSynchronizerHandle;`
public
`Handle:THandle;`
`Protocol:Word;`
`Transport:TNetworkTransport;`

`function ReaderLock:Boolean;`
`function ReaderUnlock:Boolean;`
`function WriterLock:Boolean;`
`function WriterUnlock:Boolean;`

`constructor Create(AProtocol:TNetworkProtocol);`
`destructor Destroy; override;`
protected
`FProtocol:TNetworkProtocol;`

`FLock:TMutexHandle;`
`FInterval:LongWord;`
`FCheckTimer:TTimerHandle;`
`FProcessSemaphore:TSemaphoreHandle;`

`FCount:LongWord;`
`FMaxCount:LongWord;`

`FFirst:PSocketTimerItem;`
`FLast:PSocketTimerItem;`

`function AcquireLock:Boolean;`
`function ReleaseLock:Boolean;`

`function Dequeue(AMax:Integer):TProtocolSocket;`

`function FirstKey:Integer;`
`function InsertKey(ASocket:TProtocolSocket; AItem:PSocketTimerItem; AKey:Integer):Boolean;`
`function DeleteKey(ASocket:TProtocolSocket; AItem:PSocketTimerItem):Boolean;`
`function DecrementKey:Integer;`
public
`property Count:LongWord read FCount;`
`property MaxCount:LongWord read FMaxCount;`

`function StartTimer(AInterval:LongWord):Boolean; virtual;`
`function StopTimer:Boolean; virtual;`

`function CheckTimer:Boolean; virtual;`
`function ProcessTimer:Boolean; virtual;`

`function ScheduleSocket(ASocket:TProtocolSocket; ATimeout:LongWord):Boolean; virtual;`
`function UnscheduleSocket(ASocket:TProtocolSocket):Boolean; virtual;`

`function ScheduleSocketItem(ASocket:TProtocolSocket; AItem:PSocketTimerItem; ATimeout:LongWord):Boolean; virtual;`
`function UnscheduleSocketItem(ASocket:TProtocolSocket; AItem:PSocketTimerItem):Boolean; virtual;`

Note: For Get/Set Options at the Protocol Level (eg IPPROTO_TCP, IPPROTO_UDP)

`constructor Create;`
`destructor Destroy; override;`
private
`FLock:TCriticalSectionHandle;`
protected
`function AcquireLock:Boolean;`
`function ReleaseLock:Boolean;`

Note: eg IP Filter

`constructor Create(AManager:TProtocolManager);`
`destructor Destroy; override;`
private
`FLock:TSynchronizerHandle;`
protected
`FManager:TProtocolManager;`

`FProtocol:Word;`
`FTransports:TNetworkList;`	List of TFilterTransport objects

`function GetTransportByHandle(AHandle:THandle; ALock:Boolean; AState:LongWord):TFilterTransport;`
`function GetTransportByFamily(AFamily:Word; ALock:Boolean; AState:LongWord):TFilterTransport;`
`function GetTransportByTransport(ATransport:TNetworkTransport; ALock:Boolean; AState:LongWord):TFilterTransport;`
`function GetTransportByNext(APrevious:TFilterTransport; ALock,AUnlock:Boolean; AState:LongWord):TFilterTransport;`

`function AddTransport(ATransport:TNetworkTransport):Boolean; virtual;`
`function RemoveTransport(ATransport:TNetworkTransport):Boolean; virtual;`
public
`property Manager:TProtocolManager read FManager;`
`property Protocol:Word read FProtocol;`

`function ReaderLock:Boolean;`
`function ReaderUnlock:Boolean;`
`function WriterLock:Boolean;`
`function WriterUnlock:Boolean;`

`function StartFilter:Boolean; virtual;`
`function StopFilter:Boolean; virtual;`
`function ProcessFilter:Boolean; virtual;`

`function BindFilter(ATransport:TNetworkTransport):Boolean; virtual;`
`function UnbindFilter(ATransport:TNetworkTransport):Boolean; virtual;`

Note: eg DHCP/BOOTP/RARP/STATIC/PSEUDO

`constructor Create(AManager:TProtocolManager);`
`destructor Destroy; override;`
private
`FLock:TSynchronizerHandle;`
protected
`FManager:TProtocolManager;`

`FConfigType:Word;`
`FInitDelay:LongWord;`
`FRetryCount:LongWord;`
`FRetryTimeout:LongWord;`
`FTransports:TNetworkList;`	List of TConfigTransport objects

`function GetTransportByHandle(AHandle:THandle; ALock:Boolean; AState:LongWord):TConfigTransport;`
`function GetTransportByFamily(AFamily:Word; ALock:Boolean; AState:LongWord):TConfigTransport;`
`function GetTransportByTransport(ATransport:TNetworkTransport; ALock:Boolean; AState:LongWord):TConfigTransport;`
`function GetTransportByNext(APrevious:TConfigTransport; ALock,AUnlock:Boolean; AState:LongWord):TConfigTransport;`

`function AddTransport(ATransport:TNetworkTransport):Boolean; virtual;`
`function RemoveTransport(ATransport:TNetworkTransport):Boolean; virtual;`
public
`property Manager:TProtocolManager read FManager;`
`property ConfigType:Word read FConfigType;`
`property InitDelay:LongWord read FInitDelay;`
`property RetryCount:LongWord read FRetryCount;`
`property RetryTimeout:LongWord read FRetryTimeout;`

`function ReaderLock:Boolean;`
`function ReaderUnlock:Boolean;`
`function WriterLock:Boolean;`
`function WriterUnlock:Boolean;`

`function StartConfig:Boolean; virtual;`
`function StopConfig:Boolean; virtual;`
`function ProcessConfig:Boolean; virtual;`

`function BindConfig(ATransport:TNetworkTransport):Boolean; virtual;`
`function UnbindConfig(ATransport:TNetworkTransport):Boolean; virtual;`

`function SetConfig(AInitDelay,ARetryCount,ARetryTimeout:LongWord):Boolean; virtual;`

Note: eg DNS/WINS

`constructor Create(AProtocol:TNetworkProtocol);`
`destructor Destroy; override;`
private
`FLock:TSynchronizerHandle;`
protected
`FProtocol:TNetworkProtocol;`
public
`property Protocol:TNetworkProtocol read FProtocol;`

`function ReaderLock:Boolean;`
`function ReaderUnlock:Boolean;`
`function WriterLock:Boolean;`
`function WriterUnlock:Boolean;`

`function StartClient:Boolean; virtual;`
`function StopClient:Boolean; virtual;`