Difference between revisions of "Unit Network"

From Ultibo.org
Jump to: navigation, search
Line 1,426: Line 1,426:
 
----
 
----
  
−
''To be documented''
+
 
 +
'''Adapter manager'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TAdapterManager = 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);</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;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FAdapters:TNetworkList;</code>
 +
| List of TNetworkAdapter 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;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AddAdapter(AAdapter:TNetworkAdapter):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveAdapter(AAdapter:TNetworkAdapter):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetAdapterByType(AAdapterType:Word; ALock:Boolean; AState:LongWord):TNetworkAdapter;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetAdapterByDevice(ADevice:PNetworkDevice; ALock:Boolean; AState:LongWord):TNetworkAdapter;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetAdapterByAdapter(AAdapter:TNetworkAdapter; ALock:Boolean; AState:LongWord):TNetworkAdapter;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetAdapterByNext(APrevious:TNetworkAdapter; ALock,AUnlock:Boolean; AState:LongWord):TNetworkAdapter;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function StartAdapters:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function StopAdapters:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ProcessStatus:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ProcessAdapters:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function EnumerateAdapters(ACallback:TAdapterCallback):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''Adapter transport'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TAdapterTransport = 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>FrameType:Word;</code>
 +
| &nbsp;
 +
|-
 +
| <code>PacketType:Word;</code>
 +
| &nbsp;
 +
|-
 +
| <code>PacketName:String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>PacketHandler:TAdapterPacketHandler;</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>
 +
 
 +
'''Adapter binding'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TAdapterBinding = 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(ATransport:TAdapterTransport);</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>FrameType:Word;</code>
 +
| &nbsp;
 +
|-
 +
| <code>PacketType:Word;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Transport:TAdapterTransport;</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>
 +
 
 +
'''Adapter monitor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TAdapterMonitor = 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>MonitorHandler:TAdapterMonitorHandler;</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>
 +
 +
'''Adapter authenticator'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TAdapterAuthenticator = 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>AuthType:Word;</code>
 +
| EAP/RSN
 +
|-
 +
| <code>AuthenticatorHandler:TAdapterAuthenticatorHandler;</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 list'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TNetworkList = class(TLinkedObjList)</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>
 +
| 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>procedure ClearList;</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;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''Network adapter'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TNetworkAdapter = 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:TAdapterManager; ADevice:PNetworkDevice; 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;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
 +
|-
 +
| <code>FManager:TAdapterManager;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FDevice:PNetworkDevice;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FName:String;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FState:Integer;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FStatus:Integer;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FMediaType:Word;</code>
 +
| Physical Media type (Ethernet/Tokenring etc)
 +
|-
 +
| <code>FAdapterType:Word;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FLastError:Integer;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FThread:TAdapterThread;</code>
 +
| Thread for adapter receiving
 +
|-
 +
| <code>FBindings:TNetworkList;</code>
 +
| List of TAdapterBinding objects
 +
|-
 +
| <code>FTransports:TNetworkList;</code>
 +
| List of TAdapterTransport objects
 +
|-
 +
| <code>FMonitors:TNetworkList;</code>
 +
| List of TAdapterMonitor objects
 +
|-
 +
| <code>FAuthenticators:TNetworkList;</code>
 +
| List of TAdapterAuthenticator objects
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FStatistics:TAdapterStatistics;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetThreadID:TThreadID;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetTransportByHandle(AHandle:THandle; ALock:Boolean; AState:LongWord):TAdapterTransport;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetTransportByType(APacketType,AFrameType:Word; ALock:Boolean; AState:LongWord):TAdapterTransport;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetTransportByTransport(ATransport:TAdapterTransport; ALock:Boolean; AState:LongWord):TAdapterTransport;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetTransportByNext(APrevious:TAdapterTransport; ALock,AUnlock:Boolean; AState:LongWord):TAdapterTransport;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetBindingByHandle(AHandle:THandle; ALock:Boolean; AState:LongWord):TAdapterBinding;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetBindingByType(ATransport:TAdapterTransport; APacketType,AFrameType:Word; ALock:Boolean; AState:LongWord):TAdapterBinding;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetBindingByTransport(ATransport:TAdapterTransport; ALock:Boolean; AState:LongWord):TAdapterBinding;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetBindingByBinding(ABinding:TAdapterBinding; ALock:Boolean; AState:LongWord):TAdapterBinding;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetBindingByNext(APrevious:TAdapterBinding; ALock,AUnlock:Boolean; AState:LongWord):TAdapterBinding;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetMonitorByHandle(AHandle:THandle; ALock:Boolean; AState:LongWord):TAdapterMonitor;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetMonitorByMonitor(AMonitor:TAdapterMonitor; ALock:Boolean; AState:LongWord):TAdapterMonitor;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetMonitorByNext(APrevious:TAdapterMonitor; ALock,AUnlock:Boolean; AState:LongWord):TAdapterMonitor;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetAuthenticatorByHandle(AHandle:THandle; ALock:Boolean; AState:LongWord):TAdapterAuthenticator;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetAuthenticatorByType(AAuthType:Word; ALock:Boolean; AState:LongWord):TAdapterAuthenticator;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetAuthenticatorByAuthenticator(AAuthenticator:TAdapterAuthenticator; ALock:Boolean; AState:LongWord):TAdapterAuthenticator;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetAuthenticatorByNext(APrevious:TAdapterAuthenticator; ALock,AUnlock:Boolean; AState:LongWord):TAdapterAuthenticator;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AddBinding(ATransport:TAdapterTransport; APacketType,AFrameType:Word):THandle; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveBinding(AHandle:THandle; APacketType:Word):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property Manager:TAdapterManager read FManager;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Device:PNetworkDevice read FDevice;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Name:String read FName;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>property State:Integer read FState;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Status:Integer read FStatus;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property MediaType:Word read FMediaType;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property AdapterType:Word read FAdapterType;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property LastError:Integer read FLastError;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property ThreadID:TThreadID read GetThreadID;</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 AddTransport(APacketType,AFrameType:Word; const APacketName:String; APacketHandler:TAdapterPacketHandler):THandle; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveTransport(AHandle:THandle; APacketType:Word):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AddMonitor(AMonitorHandler:TAdapterMonitorHandler):THandle; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveMonitor(AHandle:THandle):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AddAuthenticator(AAuthType:Word; AAuthenticatorHandler:TAdapterAuthenticatorHandler):THandle; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveAuthenticator(AHandle:THandle; AAuthType:Word):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetMTU(AHandle:THandle):Word; virtual;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function SendPacket(AHandle:THandle; ADest:Pointer; APacket:PPacketFragment; ASize:Integer):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function ResetInterface(AHandle:THandle):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function TerminateDriver(AHandle:THandle):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetReceiveMode(AHandle:THandle):Word; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SetReceiveMode(AHandle:THandle; AMode:Word):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetAdapterParams(AHandle:THandle):TAdapterParams; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetNetworkParams(AHandle:THandle):TNetworkParams; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetStatistics(AHandle:THandle):TAdapterStatistics; virtual;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetDefaultAddress(AHandle:THandle):THardwareAddress; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetHardwareAddress(AHandle:THandle):THardwareAddress; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SetHardwareAddress(AHandle:THandle; const AAddress:THardwareAddress):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetBroadcastAddress(AHandle:THandle):THardwareAddress; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetMulticastAddresses(AHandle:THandle):TMulticastAddresses; virtual;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;;
 +
|-
 +
| <code>function AddMulticastAddress(AHandle:THandle; const AAddress:THardwareAddress):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveMulticastAddress(AHandle:THandle; const AAddress:THardwareAddress):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function StartAdapter:Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function StopAdapter:Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ProcessStatus:Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ProcessAdapter:Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function CompareAddress(const AAddress1,AAddress2:THardwareAddress):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function CompareDefault(AHandle:THandle; const AAddress:THardwareAddress):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function CompareHardware(AHandle:THandle; const AAddress:THardwareAddress):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function CompareBroadcast(AHandle:THandle; const AAddress:THardwareAddress):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function CompareMulticast(AHandle:THandle; const AAddress:THardwareAddress):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''Adapter thread'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TAdapterThread = 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(AAdapter:TNetworkAdapter);</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
 +
|-
 +
| <code>FAdapter:TNetworkAdapter;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>procedure Execute; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>function SendHandle(AHandle:THandle):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ReceiveHandle:THandle;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''Adapter buffer'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TAdapterBuffer = 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: Ring buffer for Packets.
 +
|-
 +
|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>FSize:Integer;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FCount:Integer;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FNextRead:Integer;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FNextWrite:Integer;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FList:TList;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FMemory:TMemoryStream;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AcquireLock:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ReleaseLock:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>procedure SetSize(ASize:Integer);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property Size:Integer read FSize write SetSize;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function ReadNext:Pointer;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function WriteNext:Pointer;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''Wired adapter'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TWiredAdapter = class(TNetworkAdapter)</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:TAdapterManager; ADevice:PNetworkDevice; const AName:String);</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
| <code>FDefaultAddress:THardwareAddress;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FHardwareAddress:THardwareAddress;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FBroadcastAddress:THardwareAddress;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FMulticastAddresses:TMulticastAddresses;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>function AddTransport(APacketType,AFrameType:Word; const APacketName:String; APacketHandler:TAdapterPacketHandler):THandle; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveTransport(AHandle:THandle; APacketType:Word):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetMTU(AHandle:THandle):Word; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function SendPacket(AHandle:THandle; ADest:Pointer; APacket:PPacketFragment; ASize:Integer):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetDefaultAddress(AHandle:THandle):THardwareAddress; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetHardwareAddress(AHandle:THandle):THardwareAddress; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SetHardwareAddress(AHandle:THandle; const AAddress:THardwareAddress):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetBroadcastAddress(AHandle:THandle):THardwareAddress; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetMulticastAddresses(AHandle:THandle):TMulticastAddresses; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AddMulticastAddress(AHandle:THandle; const AAddress:THardwareAddress):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveMulticastAddress(AHandle:THandle; const AAddress:THardwareAddress):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function StartAdapter:Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function StopAdapter:Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ProcessAdapter:Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''Network setting'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TNetworkSetting = 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"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
| <code>FName:String;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>FValue:String;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FHash:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>procedure SetName(const AName:String);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property Name:String read FName write SetName;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Value:String read FValue write FValue;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>property Hash:LongWord read FHash;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''Network settings'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TNetworkSettings = 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>
 +
| 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"|&nbsp;
 +
|-
 +
| <code>FHostName:String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FDomainName:String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FList:TLinkedObjList;</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 AcquireLock:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ReleaseLock:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetHostName:String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetHostName(const AHostName:String);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetDomainName:String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetDomainName(const ADomainName:String);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function ExtractName(const AValue,AToken:String):String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ExtractValue(const AValue,AToken:String):String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ExtractPrefix(const AValue:String):String;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function SplitName(const AName:String):String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SplitPrefix(const AName:String):String;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function MergePrefix(const APrefix,AName:String):String;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function TranslateString(const AValue,ADefault:String):String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function TranslateInteger(const AValue:String; ADefault:Integer):Integer;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function TranslateBoolean(const AValue:String; ADefault:Boolean):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetFromList(const AName:String):TNetworkSetting;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function FindFromList(const AName:String):String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function FindFromEnvironment(const AName:String):String;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property HostName:String read GetHostName write SetHostName;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property DomainName:String read GetDomainName write SetDomainName;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetString(const AName:String):String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetStringDefault(const AName,ADefault:String):String;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetInteger(const AName:String):Integer;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetIntegerDefault(const AName:String; ADefault:Integer):Integer;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetBoolean(const AName:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetBooleanDefault(const AName:String; ADefault:Boolean):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AddString(const AName,AValue:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function AddInteger(const AName:String; AValue:Integer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function AddBoolean(const AName:String; AValue:Boolean):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function Remove(const AName:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function LoadFromFile(const AFileName:String; AFlat:Boolean):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function LoadFromStream(AStream:TStream; AFlat:Boolean):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function LoadFromStrings(AStrings:TStrings; AFlat:Boolean):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function SaveToFile(const AFileName:String; AFlat:Boolean):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SaveToStream(AStream:TStream; AFlat:Boolean):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SaveToStrings(AStrings:TStrings; AFlat:Boolean):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function LoadFromEnvironment:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div> 
 +
 
 +
'''Service set'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TServiceSet = 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>
 +
| 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"|&nbsp;
 +
|-
 +
| <code>function GetName:String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetName(const AName:String);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetServiceSetType(AServiceSetType:LongWord);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetServiceSetTime(const AServiceSetTime:Int64);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetAddress(const AAddress:THardwareAddress);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetAdapter(AAdapter:TNetworkAdapter);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
 +
|-
 +
| <code>FName:String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FServiceSetType:LongWord;</code>
 +
| BSS/ESS/IBSS
 +
|-
 +
| <code>FServiceSetTime:Int64;</code>
 +
| Flush time
 +
|-
 +
| <code>FAddress:THardwareAddress;</code>
 +
| Address of service set
 +
|-
 +
| <code>FAdapter:TNetworkAdapter;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AcquireLock:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ReleaseLock:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property Name:String read GetName write SetName;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property ServiceSetType:LongWord read FServiceSetType write SetServiceSetType;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property ServiceSetTime:Int64 read FServiceSetTime write SetServiceSetTime;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Address:THardwareAddress read FAddress write SetAddress;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Adapter:TNetworkAdapter read FAdapter write SetAdapter;</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;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
 
=== Public variables ===
 
=== Public variables ===

Revision as of 02:30, 16 March 2017

Return to Unit Reference


Description

Ultibo Network interface unit

To be documented

Constants


[Expand]
Network specific constants NETWORK_*


[Expand]
Network device type constants NETWORK_TYPE_*


[Expand]
Network device state constants NETWORK_STATE_*


[Expand]
Network device status constants NETWORK_STATUS_*


[Expand]
Network device flag constants NETWORK_FLAG_*


[Expand]
Network device control code constants NETWORK_CONTROL_*


[Expand]
Network lock state constants NETWORK_LOCK_*


[Expand]
Network buffer size constants NETWORK_BUFFER_*


[Expand]
Network event constants NETWORK_EVENT_*


[Expand]
Network event signature constants NETWORK_EVENT_SIGNATURE*


[Expand]
Network event state constants NETWORK_EVENT_STATE_*


[Expand]
Network event flag constants NETWORK_EVENT_FLAG_*


[Expand]
Adapter type constants ADAPTER_TYPE_*


[Expand]
Adapter thread constants ADAPTER_THREAD_*


[Expand]
Adapter state constants ADAPTER_STATE_*


[Expand]
Adapter status constants ADAPTER_STATUS_*


[Expand]
Configuration type constants CONFIG_TYPE_*


[Expand]
Authentication type constants AUTH_TYPE_*


[Expand]
Frame type constants FRAME_TYPE_*


[Expand]
Configuration command constants CONFIG_*


[Expand]
Authentication command constants AUTH_COMMAND_*


[Expand]
Multicast addressing constants MAX_MULTICAST_*


[Expand]
Hardware addressing constants HARDWARE_ADDRESS_*


[Expand]
Media type constants MEDIA_TYPE_*


[Expand]
Packet type constants PACKET_TYPE_*


[Expand]
Ethernet network constants *_ETHERNET_PACKET


[Expand]
Ethernet 802.3 network constants LLC_HEADER_*


[Expand]
Ethernet SNAP network constants SNAP_HEADER_*


[Expand]
Service set constants SERVICE_SET_*


[Expand]
Network logging constants NETWORK_LOG_*


[Expand]
Ethernet specific constants ETHERNET_*


[Expand]
Ethernet specific size constants ETHERNET_*_SIZE*


[Expand]
Network specific constants


[Expand]
Ethernet specific constants


Type definitions


Hardware address

[Expand]

PHardwareAddress = ^THardwareAddress;

THardwareAddress = array[0..HARDWARE_ADDRESS_SIZE - 1] of Byte;

Hardware addresses

[Expand]

PHardwareAddresses = ^THardwareAddresses;

THardwareAddresses = array[0..0] of THardwareAddress;

Multicast addresses

[Expand]

PMulticastAddresses = ^TMulticastAddresses;

TMulticastAddresses = array[0..MAX_MULTICAST_ADDRESS - 1] of THardwareAddress;

Network packet

[Expand]

PNetworkPacket = ^TNetworkPacket;

TNetworkPacket = record

Network Buffer

[Expand]

PNetworkBuffer = ^TNetworkBuffer;

TNetworkBuffer = record

Network entry

[Expand]

PNetworkEntry = ^TNetworkEntry;

TNetworkEntry = record

Network queue

[Expand]

PNetworkQueue = ^TNetworkQueue;

TNetworkQueue = record

Network enumeration callback

TNetworkEnumerate = function(Network:PNetworkDevice; Data:Pointer):LongWord;

Network notification callback

TNetworkNotification = function(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;

Network device open

TNetworkDeviceOpen = function(Network:PNetworkDevice):LongWord;

Network device close

TNetworkDeviceClose = function(Network:PNetworkDevice):LongWord;

Network device read

TNetworkDeviceRead = function(Network:PNetworkDevice; Buffer:Pointer; Size:LongWord; var Length:LongWord):LongWord;

Network device write

TNetworkDeviceWrite = function(Network:PNetworkDevice; Buffer:Pointer; Size:LongWord; var Length:LongWord):LongWord;

Network device control

TNetworkDeviceControl = function(Network:PNetworkDevice; Request:Integer; Argument1:PtrUInt; var Argument2:PtrUInt):LongWord;

Network buffer allocate

TNetworkBufferAllocate = function(Network:PNetworkDevice; var Entry:PNetworkEntry):LongWord;

Network buffer release

TNetworkBufferRelease = function(Network:PNetworkDevice; Entry:PNetworkEntry):LongWord;

Network buffer receive

TNetworkBufferReceive = function(Network:PNetworkDevice; var Entry:PNetworkEntry):LongWord;

Network buffer transmit

TNetworkBufferTransmit = function(Network:PNetworkDevice; Entry:PNetworkEntry):LongWord;

Network device types

[Expand]

PNetworkDevice = ^TNetworkDevice;

TNetworkDevice = record

Network event callback

TNetworkEventCallback = function(Data:Pointer; Event:LongWord):LongWord;

Network Event

[Expand]

PNetworkEvent = ^TNetworkEvent;

TNetworkEvent = record

Packet fragment

[Expand]

PPacketFragment = ^TPacketFragment;

TPacketFragment = packed record

Ethernet 802.3 network

[Expand]

PLLCHeader = ^TLLCHeader;

TLLCHeader = packed record

Ethernet SNAP network

[Expand]

PSNAPHeader = ^TSNAPHeader;

TSNAPHeader = packed record

Token ring network

[Expand]

PTokenRingAddress = ^TTokenRingAddress;

TTokenRingAddress = array[0..5] of Byte;

Token ring header

[Expand]

PTokenRingHeader = ^TTokenRingHeader;

TTokenRingHeader = packed record

Adapter params

[Expand]

PAdapterParams = ^TAdapterParams;

TAdapterParams = packed record

Network params

[Expand]

PNetworkParams = ^TNetworkParams;

TNetworkParams = packed record

Adapter statistics

[Expand]

PAdapterStatistics = ^TAdapterStatistics;

TAdapterStatistics = record

Ethernet address

[Expand]

PEthernetAddress = ^TEthernetAddress;

TEthernetAddress = array[0..ETHERNET_ADDRESS_SIZE - 1] of Byte;

Ethernet header

[Expand]

PEthernetHeader = ^TEthernetHeader;

TEthernetHeader = packed record

Adapter callback

TAdapterCallback = function(AAdapter:TNetworkAdapter):Boolean of object;

Adapter packet handler

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

Adapter monitor handler

TAdapterMonitorHandler = function(AHandle:THandle; APacket:Pointer; ASize:Integer; AStatus:Pointer):Boolean of object;

Adapter authenticator handler

TAdapterAuthenticatorHandler = function(AHandle:THandle; ACommand:Word):Boolean of object;


Class definitions


Adapter manager

[Expand]

TAdapterManager = class(TObject)

Adapter transport

[Expand]

TAdapterTransport = class(TListObject)

Adapter binding

[Expand]

TAdapterBinding = class(TListObject)

Adapter monitor

[Expand]

TAdapterMonitor = class(TListObject)

Adapter authenticator

[Expand]

TAdapterAuthenticator = class(TListObject)

Network list

[Expand]

TNetworkList = class(TLinkedObjList)

Network adapter

[Expand]

TNetworkAdapter = class(TListObject)

Adapter thread

[Expand]

TAdapterThread = class(TThread)

Adapter buffer

[Expand]

TAdapterBuffer = class(TObject)

Wired adapter

[Expand]

TWiredAdapter = class(TNetworkAdapter)

Network setting

[Expand]

TNetworkSetting = class(TListObject)

Network settings

[Expand]

TNetworkSettings = class(TObject)

Service set

[Expand]

TServiceSet = class(TListObject)


Public variables


Network logging

NETWORK_DEFAULT_LOG_LEVEL:LongWord = NETWORK_LOG_LEVEL_DEBUG; Minimum level for Network messages. Only messages with level greater than or equal to this will be printed.
NETWORK_LOG_ENABLED:Boolean;


Function declarations

Initialization functions

[Expand] 
procedure NetworkInit;
Description: To be documented


[Expand] 
function NetworkStart:LongWord;
Description: To be documented


[Expand] 
function NetworkStop:LongWord;
Description: To be documented


[Expand] 
function NetworkStartCompleted:Boolean;
Description: To be documented


Network functions

[Expand] 
function NetworkDeviceOpen(Network:PNetworkDevice):LongWord;
Description: To be documented


[Expand] 
function NetworkDeviceClose(Network:PNetworkDevice):LongWord;
Description: To be documented


[Expand] 
function NetworkDeviceRead(Network:PNetworkDevice; Buffer:Pointer; Size:LongWord; var Length:LongWord):LongWord;
Description: To be documented


[Expand] 
function NetworkDeviceWrite(Network:PNetworkDevice; Buffer:Pointer; Size:LongWord; var Length:LongWord):LongWord;
Description: To be documented


[Expand] 
function NetworkDeviceControl(Network:PNetworkDevice; Request:Integer; Argument1:PtrUInt; var Argument2:PtrUInt):LongWord;
Description: To be documented


[Expand] 
function NetworkBufferAllocate(Network:PNetworkDevice; var Entry:PNetworkEntry):LongWord;
Description: Allocate a transmit buffer from the specified network device, the returned entry will include a buffer for writing data to as well as an offfset value to allow the driver data to be written to the start of the buffer. When the data has been copied to the buffer, pass the entry to NetworkBufferTransmit.


[Expand] 
function NetworkBufferRelease(Network:PNetworkDevice; Entry:PNetworkEntry):LongWord;
Description: Release a receive buffer to the specified network device, the entry must have been returned from NetworkBufferReceive


[Expand] 
function NetworkBufferReceive(Network:PNetworkDevice; var Entry:PNetworkEntry):LongWord;
Description: Receive a completed receive buffer from the specified network device. The returned entry will contain a one or more packets of data to read from. When the data has been processed pass the returned buffer to NetworkBufferRelease.


[Expand] 
function NetworkBufferTransmit(Network:PNetworkDevice; Entry:PNetworkEntry):LongWord;
Description: Transmit a completed transmit buffer to the specified network device. The entry must have been allocated using NetworkBufferAllocate.


[Expand] 
function NetworkDeviceSetState(Network:PNetworkDevice; State:LongWord):LongWord;
Description: Set the state of the specified network and send a notification


[Expand] 
function NetworkDeviceSetStatus(Network:PNetworkDevice; Status:LongWord):LongWord;
Description: Set the status of the specified network and send a notification


[Expand] 
function NetworkDeviceCreate:PNetworkDevice;
Description: Create a new Network entry


[Expand] 
function NetworkDeviceCreateEx(Size:LongWord):PNetworkDevice;
Description: Create a new Network entry


[Expand] 
function NetworkDeviceDestroy(Network:PNetworkDevice):LongWord;
Description: Destroy an existing Network entry


[Expand] 
function NetworkDeviceRegister(Network:PNetworkDevice):LongWord;
Description: Register a new Network in the Network table


[Expand] 
function NetworkDeviceDeregister(Network:PNetworkDevice):LongWord;
Description: Deregister a Network from the Network table


[Expand] 
function NetworkDeviceFind(NetworkId:LongWord):PNetworkDevice;
Description: To be documented


[Expand] 
function NetworkDeviceFindByName(const Name:String):PNetworkDevice; inline;
Description: To be documented


[Expand] 
function NetworkDeviceFindByDescription(const Description:String):PNetworkDevice; inline;
Description: To be documented


[Expand] 
function NetworkDeviceEnumerate(Callback:TNetworkEnumerate; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function NetworkDeviceNotification(Network:PNetworkDevice; Callback:TNetworkNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


[Expand] 
function NetworkEventAllocate(Callback:TNetworkEventCallback; Data:Pointer; Event:LongWord):PNetworkEvent;
Description: Create and Register a new Event entry in the Event table


[Expand] 
function NetworkEventRelease(Event:PNetworkEvent):LongWord;
Description: Deregister and Destroy a Event from the Event table


[Expand] 
function NetworkEventRegister(Callback:TNetworkEventCallback; Data:Pointer; Event:LongWord):THandle;
Description: Register a callback for one or more network events


[Expand] 
function NetworkEventDeregister(Handle:THandle):LongWord;
Description: Deregister a network event callback


[Expand] 
function NetworkEventNotify(Event:LongWord):LongWord;
Description: To be documented


RTL network functions

[Expand] 
function SysHostGetName:String;
Description: To be documented


[Expand] 
function SysHostSetName(const AName:String):Boolean;
Description: To be documented


[Expand] 
function SysHostGetDomain:String;
Description: To be documented


[Expand] 
function SysHostSetDomain(const ADomain:String):Boolean;
Description: To be documented


Network helper functions

[Expand] 
function NetworkGetCount:LongWord; inline;
Description: Get the current network count


[Expand] 
function NetworkDeviceCheck(Network:PNetworkDevice):PNetworkDevice;
Description: Check if the supplied Network is in the network table


[Expand] 
function NetworkDeviceTypeToString(NetworkType:LongWord):String;
Description: To be documented


[Expand] 
function NetworkDeviceStateToString(NetworkState:LongWord):String;
Description: To be documented


[Expand] 
function NetworkDeviceStatusToString(NetworkStatus:LongWord):String;
Description: To be documented


[Expand] 
function NetworkDeviceStateToNotification(State:LongWord):LongWord;
Description: Convert a Network state value into the notification code for device notifications


[Expand] 
function NetworkDeviceStatusToNotification(Status:LongWord):LongWord;
Description: Convert a Network status value into the notification code for device notifications


[Expand] 
function NetworkEventCheck(Event:PNetworkEvent):PNetworkEvent;
Description: Check if the supplied Event is in the event table


[Expand] 
procedure NetworkLog(Level:LongWord; Network:PNetworkDevice; const AText:String);
Description: To be documented


[Expand] 
procedure NetworkLogInfo(Network:PNetworkDevice; const AText:String);
Description: To be documented


[Expand] 
procedure NetworkLogError(Network:PNetworkDevice; const AText:String);
Description: To be documented


[Expand] 
procedure NetworkLogDebug(Network:PNetworkDevice; const AText:String);
Description: To be documented


[Expand] 
function HardwareAddressToString(const AAddress:THardwareAddress):String;
Description: To be documented


[Expand] 
function StringToHardwareAddress(const AAddress:String):THardwareAddress;
Description: To be documented


[Expand] 
function CompareHardwareAddress(const AAddress1,AAddress2:THardwareAddress):Boolean;
Description: To be documented


[Expand] 
function CompareHardwareDefault(const AAddress:THardwareAddress):Boolean;
Description: To be documented


[Expand] 
function CompareHardwareBroadcast(const AAddress:THardwareAddress):Boolean;
Description: To be documented


[Expand] 
function CompareHardwareMulticast(const AAddress:THardwareAddress):Boolean;
Description: To be documented


[Expand] 
function AdapterTypeToString(AType:Word):String;
Description: To be documented


[Expand] 
function AdapterModeToString(AMode:Word):String;
Description: To be documented


[Expand] 
function AdapterConfigToString(AConfig:Word):String;
Description: To be documented


[Expand] 
function AdapterStateToString(AState:Integer):String;
Description: To be documented


[Expand] 
function AdapterStatusToString(AStatus:Integer):String;
Description: To be documented


[Expand] 
function FrameTypeToString(AType:Word):String;
Description: To be documented


[Expand] 
function MediaTypeToString(AType:Word):String;
Description: To be documented


[Expand] 
function PacketTypetoString(AType:Word):String;
Description: To be documented


[Expand] 
function ConfigTypeToString(AType:Word):String;
Description: To be documented


[Expand] 
function ConfigCommandToString(ACommand:Word):String;
Description: To be documented


[Expand] 
function AuthTypeToString(AType:Word):String;
Description: To be documented


[Expand] 
function AuthCommandToString(ACommand:Word):String;
Description: To be documented


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_Network&oldid=2624"