Difference between revisions of "Unit Transport"

From Ultibo.org
Jump to: navigation, search
 
(One intermediate revision by the same user not shown)
Line 5: Line 5:
 
----
 
----
  
'''Ultibo Network Transport interface unit'''
+
'''Ultibo Network Transport Interface unit'''
  
 
''Notes:''
 
''Notes:''
Line 493: Line 493:
  
  
'''Transport manager'''
+
'''Transport specific classes'''
 
+
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
 
+
<code>TTransportManager = 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; AAdapters:TAdapterManager);</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>FAdapters:TAdapterManager;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>FTransports:TNetworkList;</code>
+
| List of TNetworkTransport objects
+
|-
+
| <code>FMonitors:TNetworkList;</code>
+
| List of TNetworkMonitor objects
+
|-
+
| <code>FAuthenticators:TNetworkList;</code>
+
| List of TNetworkAuthenticator 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 Adapters:TAdapterManager read FAdapters;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function AddTransport(ATransport:TNetworkTransport):Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function RemoveTransport(ATransport:TNetworkTransport):Boolean;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function GetTransportByName(const AName:String; ALock:Boolean; AState:LongWord):TNetworkTransport;</code>
+
| &nbsp;
+
|-
+
| <code>function GetTransportByType(AFamily,APacketType:Word; ALock:Boolean; AState:LongWord):TNetworkTransport;</code>
+
| &nbsp;
+
|-
+
| <code>function GetTransportByTransport(ATransport:TNetworkTransport; ALock:Boolean; AState:LongWord):TNetworkTransport;</code>
+
| &nbsp;
+
|-
+
| <code>function GetTransportByNext(APrevious:TNetworkTransport; ALock,AUnlock:Boolean; AState:LongWord):TNetworkTransport;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function AddMonitor(AMonitor:TNetworkMonitor):Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function RemoveMonitor(AMonitor:TNetworkMonitor):Boolean;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function GetMonitorByMonitor(AMonitor:TNetworkMonitor; ALock:Boolean; AState:LongWord):TNetworkMonitor;</code>
+
| &nbsp;
+
|-
+
| <code>function GetMonitorByNext(APrevious:TNetworkMonitor; ALock,AUnlock: Boolean; AState:LongWord):TNetworkMonitor;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function AddAuthenticator(AAuthenticator:TNetworkAuthenticator):Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function RemoveAuthenticator(AAuthenticator:TNetworkAuthenticator):Boolean;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function GetAuthenticatorByType(AAuthType:Word; ALock:Boolean; AState:LongWord):TNetworkAuthenticator;</code>
+
| &nbsp;
+
|-
+
| <code>function GetAuthenticatorByAuthenticator(AAuthenticator:TNetworkAuthenticator; ALock:Boolean; AState:LongWord):TNetworkAuthenticator;</code>
+
| &nbsp;
+
|-
+
| <code>function GetAuthenticatorByNext(APrevious:TNetworkAuthenticator; ALock,AUnlock:Boolean; AState:LongWord):TNetworkAuthenticator;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function StartTransports:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function StopTransports:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function ProcessTransports:Boolean;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function EnumerateTransports(ACallback:TTransportCallback):Boolean;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function BindTransports(AAdapter:TNetworkAdapter):Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function UnbindTransports(AAdapter:TNetworkAdapter):Boolean;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function StartMonitors:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function StopMonitors:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function ProcessMonitors:Boolean;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function EnumerateMonitors(ACallback:TMonitorCallback):Boolean;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function BindMonitors(AAdapter:TNetworkAdapter):Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function UnbindMonitors(AAdapter:TNetworkAdapter):Boolean;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function StartAuthenticators:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function StopAuthenticators:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function ProcessAuthenticators:Boolean;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function EnumerateAuthenticators(ACallback:TAuthenticatorCallback):Boolean;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function BindAuthenticators(AAdapter:TNetworkAdapter):Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function UnbindAuthenticators(AAdapter:TNetworkAdapter):Boolean;</code>
+
| &nbsp;
+
|-
+
|}
+
</div></div>
+
 
+
'''Transport buffer'''
+
 
+
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
 
+
<code>TTransportBuffer = 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(ATransport:TNetworkTransport);</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>FTransport:TNetworkTransport;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function AcquireLock:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function ReleaseLock:Boolean;</code>
+
| &nbsp;
+
|-
+
|}
+
</div></div>
+
 
+
'''Transport buffer extended'''
+
 
+
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
 
+
<code>TTransportBufferEx = 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(ATransport:TNetworkTransport);</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>FTransport:TNetworkTransport;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function ReaderLock:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function ReaderUnlock:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function ReaderConvert:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function WriterLock:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function WriterUnlock:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function WriterConvert:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function WriterOwner:Boolean;</code>
+
| &nbsp;
+
|-
+
|}
+
</div></div>
+
 
+
'''Transport adapter'''
+
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
 
+
<code>TTransportAdapter = 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
+
|-
+
|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>Name:String;</code>
+
| &nbsp;
+
|-
+
| <code>Index:LongWord;</code>
+
| &nbsp;
+
|-
+
| <code>Handle:THandle;</code>
+
| &nbsp;
+
|-
+
| <code>PacketType:Word;</code>
+
| &nbsp;
+
|-
+
| <code>Adapter:TNetworkAdapter;</code>
+
| &nbsp;
+
|-
+
| <code>Hardware:THardwareAddress;</code>
+
| &nbsp;
+
|-
+
| <code>Broadcast:THardwareAddress;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>MTU:Word;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>ConfigType:Word;</code>
+
| BOOTP/DHCP/RARP/STATIC/PSEUDO/LOOPBACK
+
|-
+
| <code>Configured:Boolean;</code>
+
| Adapter has been configured
+
|-
+
| <code>Configuring:Boolean;</code>
+
| Adapter is being configured
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function ReaderLock:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function ReaderUnlock:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function ReaderConvert:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function WriterLock:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function WriterUnlock:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function WriterConvert:Boolean;</code>
+
| &nbsp;
+
|-
+
|}
+
</div></div>
+
+
'''Transport binding'''
+
 
+
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
 
+
<code>TTransportBinding = 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: Midstream
+
|-
+
|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>Name:String;</code>
+
| &nbsp;
+
|-
+
| <code>Index:LongWord;</code>
+
| &nbsp;
+
|-
+
| <code>Adapter:TTransportAdapter;</code>
+
| &nbsp;
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>ConfigType:Word;</code>
+
| BOOTP/DHCP/RARP/STATIC/PSEUDO/LOOPBACK
+
|-
+
| <code>Configured:Boolean;</code>
+
| Adapter has been configured
+
|-
+
| <code>Configuring:Boolean;</code>
+
| Adapter is being configured
+
|-
+
|colspan="2"|&nbsp;
+
|-
+
| <code>function ReaderLock:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function ReaderUnlock:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function ReaderConvert:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function WriterLock:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function WriterUnlock:Boolean;</code>
+
| &nbsp;
+
|-
+
| <code>function WriterConvert:Boolean;</code>
+
| &nbsp;
+
|-
+
|}
+
</div></div>
+
 
+
'''Transport protocol'''
+
 
+
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
 
+
<code>TTransportProtocol = 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: Upstream
+
|-
+
|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>Protocol:Word;</code>
+
| &nbsp;
+
|-
+
| <code>PacketHandler:TTransportPacketHandler;</code>
+
| &nbsp;
+
|-
+
| <code>ControlHandler:TTransportControlHandler;</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>
+
 
+
'''Transport filter'''
+
 
+
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
 
+
<code>TTransportFilter = 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: Upstream
+
|-
+
|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>Protocol:Word;</code>
+
| &nbsp;
+
|-
+
| <code>FilterHandler:TTransportFilterHandler;</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>
+
 
+
'''Transport configuration'''
+
 
+
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
 
+
<code>TTransportConfig = 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: Upstream
+
|-
+
|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>ConfigType:Word;</code>
+
| BOOTP/DHCP/RARP/STATIC/PSEUDO/LOOPBACK
+
|-
+
| <code>ConfigAuto:Boolean;</code>
+
| Supports Auto Configuration
+
|-
+
| <code>ConfigHandler:TTransportConfigHandler;</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>
+
 
+
'''Network transport'''
+
 
+
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
 
+
<code>TNetworkTransport = 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:TTransportManager; const AName:String);</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:TTransportManager;</code>
+
| &nbsp;
+
|-
+
| <code>FName:String;</code>
+
| &nbsp;
+
|-'''Transport specific classes'''
+
  
 
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"

Latest revision as of 05:32, 31 August 2021

Return to Unit Reference


Description


Ultibo Network Transport Interface unit

Notes:

Includes all global transport definitions plus base class for Network transports.

Currently supported transports are IP, ARP, RARP, IPX and IP6.

All HostToNetwork swaps occur at the level where they are appropriate (ie the level of their header).

Bindings is provided to support Transports (such as IP) which can provide multiple addresses on a single adapter. It is not used by the Protocol or Winsock layer and is only used by the transport where appropriate. In such cases the ConfigType in the Adapter object is not used and the Binding is used instead.

Constants



Transport specific constants *_TYPE_*
HOST_TYPE_DYNAMIC = 0;  
HOST_TYPE_STATIC = 1;  
HOST_TYPE_LOOPBACK = 2;  
 
ROUTE_TYPE_DYNAMIC = 0;  
ROUTE_TYPE_STATIC = 1;  
ROUTE_TYPE_LOOPBACK = 2; Loopback Route
ROUTE_TYPE_GATEWAY = 3; Default Route
ROUTE_TYPE_MULTICAST = 4; Multicast Route
ROUTE_TYPE_BROADCAST = 5; Broadcast Route
 
ADDRESS_TYPE_DYNAMIC = 0; Remote Dynamic Address
ADDRESS_TYPE_STATIC = 1; Remote Static Address
ADDRESS_TYPE_LOCAL = 2; Local Address (ARP/RARP Only)
ADDRESS_TYPE_LOOPBACK = 3; Local Loopback
ADDRESS_TYPE_MULTICAST = 4; Local Multicast
ADDRESS_TYPE_BROADCAST = 5; Local Broadcast
 
ADDRESS_TYPE_PRIMARY = 6; Same as Local but used by IP/IP6
ADDRESS_TYPE_SECONDARY = 7; Same as Local but used by IP/IP6


Host constants *_HOST_*
MAX_HOST_LIFE = 600000; 10 Minute Host lifespan


Route constants *_ROUTE_*
MAX_ROUTE_LIFE = 600000; 10 min Route lifespan


Address constants *_ADDRESS_*
MAX_ADDRESS_LIFE = 300000; 5 min Address (ARP) lifespan
IP_ADDRESS_SIZE = 4; SizeOf(TInAddr)
IP6_ADDRESS_SIZE = 16; SizeOf(TIn6Addr)
IPX_ADDRESS_SIZE = 12; SizeOf(TIpxAddr)


Transport socket TTL_*
TTL_DEFAULT = 128; Default to 128 Seconds/Hops (Defined as 64)
TOS_DEFAULT = 0;  
HOPLIMIT_DEFAULT = 255; Default to 255 Hops (Defined as 64)
ID_INCREMENT = 1; Default Increment for ID Numbers
TTL_DECREMENT = 1; Default Decrement for TTL when Forwarding
SEND_TIMEOUT = 0; Default to wait forever on Send
RECV_TIMEOUT = 0; Default to wait forever on Recv
CLOSE_TIMEOUT = 3000; Time that Socket is kept before destruction
LINGER_TIMEOUT = 60000; Time that Socket goes into Linger state for
CONNECT_TIMEOUT = 5000; Time that Socket waits for connect completion
TIMEWAIT_TIMEOUT = 240000; Time that Socket goes into TimeWait state for (2 x MSL)


Shutdown constants SHUTDOWN_*
SHUTDOWN_RECV = 0;  
SHUTDOWN_SEND = 1;  
SHUTDOWN_BOTH = 2;  


Select constants SELECT_*
SELECT_READ = 0;  
SELECT_WRITE = 1;  
SELECT_ERROR = 2;  
 
SELECT_UNKNOWN = -1;  


Socket state SS_*
SS_NOFDREF = $0001; no file table ref any more
SS_UNCONNECTED = SS_NOFDREF; or just created socket
SS_ISCONNECTED = $0002; socket connected to a peer
SS_ISCONNECTING = $0004; in process of connecting
SS_ISDISCONNECTING = $0008; in process of disconnecting
SS_CANTSENDMORE = $0010; can't send more data
SS_CANTRCVMORE = $0020; can't receive more data
SS_RCVATMARK = $0040; at mark on input
 
SS_PRIV = $0080; privileged for broadcast
SS_NBIO = $0100; non-blocking ops
SS_ASYNC = $0200; async i/o notify
SS_ISCONFIRMING = $0400; accepting connection req
SS_ISLISTENING = SS_ISCONFIRMING; non standard
 
SS_LOCAL_ADDR = $0800; has local address/port (not used)
SS_REMOTE_ADDR = $1000; has remote address/port (not used)
SS_CONN_REFUSED = $2000; connection refused (ICMP_UNREACH)
SS_CLOSED = $4000; socket has been closed


IPv4 transport IP_*
IP_LOOPBACK_ADDRESS:TInAddr = (S_addr: $7F000001); 127.0.0.1
IP_LOOPBACK_NETWORK:TInAddr = (S_addr: $7F000000); 127.0.0.0
IP_LOOPBACK_NETMASK:TInAddr = (S_addr: $FF000000); 255.0.0.0
IP_BROADCAST_ADDRESS:TInAddr = (S_addr: $FFFFFFFF); 255.255.255.255
IP_BROADCAST_NETWORK:TInAddr = (S_addr: $FFFFFFFF); 255.255.255.255
IP_BROADCAST_NETMASK:TInAddr = (S_addr: $FFFFFFFF); 255.255.255.255
IP_DEFAULT_ADDRESS:TInAddr = (S_addr: $00000000); 0.0.0.0
IP_DEFAULT_NETWORK:TInAddr = (S_addr: $00000000); 0.0.0.0
IP_DEFAULT_NETMASK:TInAddr = (S_addr: $00000000); 0.0.0.0
IP_MULTICAST_HOSTS:TInAddr = (S_addr: $E0000001); 224.0.0.1 (All Hosts)
IP_MULTICAST_ROUTERS:TInAddr = (S_addr: $E0000002); 224.0.0.2 (All Routers)
IP_MULTICAST_NETWORK:TInAddr = (S_addr: $E0000000); 224.0.0.0
IP_MULTICAST_NETMASK:TInAddr = (S_addr: $F0000000); 240.0.0.0
Note: The recommended range for general use is 234.0.0.0 to 238.255.255.255
 
IP_CLASSA_NETMASK:TInAddr = (S_addr: $FF000000); 255.0.0.0
IP_CLASSB_NETMASK:TInAddr = (S_addr: $FFFF0000); 255.255.0.0
IP_CLASSC_NETMASK:TInAddr = (S_addr: $FFFFFF00); 255.255.255.0
IP_CLASSD_NETMASK:TInAddr = (S_addr: $F0000000); 240.0.0.0
IP_CLASSE_NETMASK:TInAddr = (S_addr: $F0000000); 240.0.0.0


IPv6 transport IP6_*
IP6_LOOPBACK_ADDRESS:TIn6Addr = (S6_addr: ($00,$00,$00,$00,$00,$00,$00,$00,$00,$00,$00,$00,$00,$00,$00,$01));  
IP6_DEFAULT_ADDRESS:TIn6Addr = (S6_addr: ($00,$00,$00,$00,$00,$00,$00,$00,$00,$00,$00,$00,$00,$00,$00,$00));  


Type definitions



Transport statistics

PTransportStatistics = ^TTransportStatistics;

TTransportStatistics = record

Note: Generic Transport
PacketsIn:Int64;  
PacketsOut:Int64;  
BytesIn:Int64;  
BytesOut:Int64;  
ErrorsIn:Int64;  
ErrorsOut:Int64;  
PacketsLost:Int64;  

IPv4 nameservers

PIPNameservers = ^TIPNameservers;

TIPNameservers = array[0..MAX_NAME_SERVERS - 1] of TInAddr;

Note: IP4 Transport
   

IPv6 nameservers

PIP6Nameservers = ^TIP6Nameservers;

TIP6Nameservers = array[0..MAX_NAME_SERVERS - 1] of TIn6Addr;

Note: IP6 Transport
   

Transport callback

TTransportCallback = function(ATransport:TNetworkTransport):Boolean of object;

Monitor callback

TMonitorCallback = function(AMonitor:TNetworkMonitor):Boolean of object;

Authenticator callback

TAuthenticatorCallback = function(AAuthenticator:TNetworkAuthenticator):Boolean of object;

Transport packet handler

TTransportPacketHandler = function(AHandle:THandle; ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean of object;

Transport control handler

TTransportControlHandler = function(AHandle:THandle; ASource,ADest:Pointer; AProtocol,ACommand,ACode:Word; AAddress,AData:Pointer; ASize:Integer):Boolean of object;

Transport filter handler

TTransportFilterHandler = function(AHandle:THandle; ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean of object;

Transport configuration handler

TTransportConfigHandler = function(AHandle:THandle; AAdapter:TTransportAdapter; ACommand:Word):Boolean of object;


Class definitions



Transport specific classes

TTransportManager = class(TObject)
TTransportBuffer = class(TObject)
TTransportBufferEx = class(TObject)
TTransportAdapter = class(TListObject)
TTransportBinding = class(TListObject)
TTransportProtocol = class(TListObject)
TTransportFilter = class(TListObject)
TTransportConfig = class(TListObject)
TNetworkTransport = class(TListObject)
TMonitorAdapter = class(TListObject)
TNetworkMonitor = class(TListObject)
TAuthenticatorAdapter = class(TListObject)
TNetworkAuthenticator = class(TListObject)
TTransportSocket = class(TListObject)
TSocketList = class(TObject)
TSocketState = class(TObject)
TSocketBuffer = class(TObject)
TSocketOptions = class(TObject)
TTransportState = class(TObject)
TTransportOptions = class(TObject)
THostEntry = class(TListObject)
TRouteEntry = class(TListObject)
TAddressEntry = class(TListObject)
TNetworkEntry = class(TListObject)
TServEntry = class(TListObject)
TProtoEntry = class(TListObject)


Public variables



Transport specific variables

TransportManager:TTransportManager;


Function declarations



Initialization functions

procedure TransportInit;
Description: To be documented
Note None documented


function TransportStart:LongWord;
Description: To be documented
Note None documented


function TransportStop:LongWord;
Description: To be documented
Note None documented


function TransportBind:LongWord;
Description: To be documented
Note None documented


function TransportUnbind:LongWord;
Description: To be documented
Note None documented


Transport functions

function InAddrToHost(const AAddress:TInAddr):TInAddr; inline;
Description: Convert an InAddr in Network order to Host order
Note None documented


function InAddrToNetwork(const AAddress:TInAddr):TInAddr; inline;
Description: Convert an InAddr in Host order to Network order
Note None documented


function InAddrToString(const AAddress:TInAddr):String;
Description: Convert an InAddr to a String
Note Expects Address to be in Network order


function StringToInAddr(const AAddress:String):TInAddr;
Description: Convert a String to an InAddr
Note Returns Address in Network order


function InAddrIsEqual(const AAddress1,AAddress2:TInAddr):Boolean;
Description: Check the supplied addresses to see if they are the same
Note Expects Address to be in Host order


function InAddrIsNone(const AAddress:TInAddr):Boolean;
Description: Check the supplied address to see if it is equal to INADDR_NONE
Note Expects Address to be in Host order


function InAddrIsDefault(const AAddress:TInAddr):Boolean;
Description: Check the supplied address to see if it is the default address
Note Expects Address to be in Host order


function InAddrIsLoopback(const AAddress:TInAddr):Boolean;
Description: Check the supplied address to see if it is a loopback address
Note Expects Address to be in Host order


function InAddrIsBroadcast(const AAddress:TInAddr):Boolean;
Description: Check the supplied address to see if it is the broadcast address
Note Expects Address to be in Host order


function InAddrIsMulticast(const AAddress:TInAddr):Boolean;
Description: Check the supplied address to see if it is a multicast address
Note Expects Address to be in Host order


function In6AddrToString(const AAddress:TIn6Addr):String;
Description: To be documented
Note None documented


function StringToIn6Addr(const AAddress:String):TIn6Addr;
Description: To be documented
Note None documented


function In6AddrIsEqual(const AAddress1,AAddress2:TIn6Addr):Boolean;
Description: Check the supplied addresses to see if they are the same
Note None documented


function In6AddrIsDefault(const AAddress:TIn6Addr):Boolean;
Description: Check the supplied address to see if it is the default address
Note None documented


function In6AddrIsLoopback(const AAddress:TIn6Addr):Boolean;
Description: Check the supplied address to see if it is a loopback address
Note None documented


function In6AddrIsLinkLocal(const AAddress:TIn6Addr):Boolean;
Description: Check the supplied address to see if it is a link local address
Note None documented


function In6AddrIsSiteLocal(const AAddress:TIn6Addr):Boolean;
Description: Check the supplied address to see if it is a site local address
Note None documented


function In6AddrIsV4Mapped(const AAddress:TIn6Addr):Boolean;
Description: Check the supplied address to see if it is a V4 mapped address
Note None documented


function In6AddrIsV4Compatible(const AAddress:TIn6Addr):Boolean;
Description: Check the supplied address to see if it is a V4 compatible address
Note None documented


function In6AddrIsMulticast(const AAddress:TIn6Addr):Boolean;
Description: Check the supplied address to see if it is a multicast address
Note None documented


function In6AddrIsMulticastNodeLocal(const AAddress:TIn6Addr):Boolean;
Description: Check the supplied address to see if it is a multicast node local address
Note None documented


function In6AddrIsMulticastLinkLocal(const AAddress:TIn6Addr):Boolean;
Description: Check the supplied address to see if it is a multicast link local address
Note None documented


function In6AddrIsMulticastSiteLocal(const AAddress:TIn6Addr):Boolean;
Description: Check the supplied address to see if it is a multicast site local address
Note None documented


function In6AddrIsMulticastOrgLocal(const AAddress:TIn6Addr):Boolean;
Description: Check the supplied address to see if it is a multicast org local address
Note None documented


function In6AddrIsMulticastGlobal(const AAddress:TIn6Addr):Boolean;
Description: Check the supplied address to see if it is a multicast global address
Note None documented


function IpxAddrToString(const AAddress:TIpxAddr):String;
Description: To be documented
Note None documented


function StringToIpxAddr(const AAddress:String):TIpxAddr;
Description: To be documented
Note None documented


function GetChecksum(ABuffer:Pointer; AOffset,ALength:Word):Word;
Description: Calculate the 1s Compliment Checksum of the Supplied Buffer
Note None documented


function GetChecksum2(APseudo,ABuffer:Pointer; APseudoLength,ABufferOffset,ABufferLength:Word):Word;
Description: Calculate the 1s Compliment Checksum of the Supplied Pseudo and Buffer
Note Pseudo is expected to start from Offset 0


function GetChecksum3(APseudo,AHeader,AData:Pointer; APseudoLength,AHeaderLength,ADataOffset,ADataLength:Word):Word;
Description: Calculate the 1s Compliment Checksum of the Supplied Pseudo, Header and Data
Note Pseudo and Header are expected to start from Offset 0


function GetChecksum4(APseudo,AHeader,AOptions,AData:Pointer; APseudoLength,AHeaderLength,AOptionsLength,ADataOffset,ADataLength:Word):Word;
Description: Calculate the 1s Compliment Checksum of the Supplied Pseudo, Header, Options and Data
Note Pseudo, Header and Options are expected to start from Offset 0.


Transport helper functions

function HostTypeToString(AType:Word):String;
Description: To be documented
Note None documented


function RouteTypeToString(AType:Word):String;
Description: To be documented
Note None documented


function AddressTypeToString(AType:Word):String;
Description: To be documented
Note None documented


function ProtocolToString(AProtocol:Word):String;
Description: To be documented
Note None documented


function SocketTypeToString(ASocketType:Word):String;
Description: To be documented
Note None documented


function AddressFamilyToString(AFamily:Word):String;
Description: To be documented
Note None documented


Return to Unit Reference