Difference between revisions of "Unit IP"

From Ultibo.org
Jump to: navigation, search
Line 440: Line 440:
 
----
 
----
  
−
''To be documented''
+
 
 +
'''IP buffer'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TIPBuffer = class(TTransportBufferEx)</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|Note: Different to Socket Buffer.
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <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>FFirst:PIPPacket;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FLast:PIPPacket;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetFragment(APacket:PIPPacket; AOffset,ASize:Word):PIPFragment;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function AddFragment(APacket:PIPPacket; AOffset,ASize:Word):PIPFragment;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveFragment(APacket:PIPPacket):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure FlushFragments(APacket:PIPPacket);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>function GetPacket(AId:Word; AProtocol:Byte; const ASource,ADest:TInAddr; ALock:Boolean):PIPPacket;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function AddPacket(AId:Word; AProtocol:Byte; const ASource,ADest:TInAddr; ALock:Boolean):PIPPacket;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemovePacket(APacket:PIPPacket):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function UnlockPacket(APacket:PIPPacket):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure FlushPackets(All:Boolean);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function PutHeader(APacket:PIPPacket; ABuffer:Pointer; ALength:Word):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function PutFragment(APacket:PIPPacket; ABuffer:Pointer; AOffset,ASize,AFlags:Word):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''IP transport adapter'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TIPTransportAdapter = class(TTransportAdapter)</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;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>Address:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Netmask:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Gateway:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Network:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Directed:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>Server:TInAddr;</code>
 +
| DHCP Server
 +
|-
 +
| <code>LeaseTime:LongWord;</code>
 +
| DHCP Lease Time
 +
|-
 +
| <code>RetryTime:Int64;</code>
 +
| DHCP Retry Time
 +
|-
 +
| <code>ExpiryTime:Int64;</code>
 +
| DHCP Expiry Time
 +
|-
 +
| <code>RenewalTime:Int64;</code>
 +
| DHCP Renewal Time
 +
|-
 +
| <code>RebindingTime:Int64;</code>
 +
| DHCP Rebinding Time
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>ConfigDefault:Word;</code>
 +
| BOOTP/DHCP/RARP/STATIC/PSEUDO/LOOPBACK
 +
|-
 +
| <code>ConfigAddress:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>ConfigNetmask:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>ConfigGateway:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>ConfigServer:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''IP transport binding'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TIPTransportBinding = class(TTransportBinding)</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;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>Address:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Netmask:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Gateway:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Network:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Directed:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>Server:TInAddr;</code>
 +
| DHCP Server
 +
|-
 +
| <code>LeaseTime:LongWord;</code>
 +
| DHCP Lease Time
 +
|-
 +
| <code>RetryTime:Int64;</code>
 +
| DHCP Retry Time
 +
|-
 +
| <code>ExpiryTime:Int64;</code>
 +
| DHCP Expiry Time
 +
|-
 +
| <code>RenewalTime:Int64;</code>
 +
| DHCP Renewal Time
 +
|-
 +
| <code>RebindingTime:Int64;</code>
 +
| DHCP Rebinding Time
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>ConfigDefault:Word;</code>
 +
| BOOTP/DHCP/RARP/STATIC/PSEUDO/LOOPBACK
 +
|-
 +
| <code>ConfigAddress:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>ConfigNetmask:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>ConfigGateway:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>ConfigServer:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''IP transport protocol'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TIPTransportProtocol = class(TTransportProtocol)</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>
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''IP transport filter'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TIPTransportFilter = class(TTransportFilter)</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>
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''IP transport configuration'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TIPTransportConfig = class(TTransportConfig)</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>
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''IP transport'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TIPTransport = class(TNetworkTransport)</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>FNextIPId:Word;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FNextIPLock:TMutexHandle;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FARP:TARPTransport;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FRARP:TRARPTransport;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FFragments:TIPBuffer;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FHosts:TNetworkList;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FServs:TNetworkList;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FProtos:TNetworkList;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FRoutes:TNetworkList;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FNetworks:TNetworkList;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FAddresses:TNetworkList;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FNameservers:TIPNameservers;  (Part of TNetworkList)</code>
 +
| &nbsp;
 +
|-
 +
| <code>FNameserverLock:TMutexHandle;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FForwarding:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FDefaultTTL:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FAutoRelease:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function PacketHandler(AHandle:THandle; ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function FragmentHandler(ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function CheckFragment(ABuffer:Pointer):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetNextIPId(AIncrement:Boolean):Word;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetIPNameserver(ACount:LongWord):TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetAdapterConfigType(const AName:String):Word;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetAdapterConfigAddress(const AName:String):TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetAdapterConfigNetmask(const AName:String):TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetAdapterConfigGateway(const AName:String):TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetAdapterConfigServer(const AName:String):TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
 +
|-
 +
| <code>function FilterPacket(ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ForwardPacket(AAdapter:TTransportAdapter; ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property Nameservers:TIPNameservers read FNameservers;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>property Forwarding:LongWord read FForwarding write FForwarding;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property DefaultTTL:LongWord read FDefaultTTL write FDefaultTTL;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property AutoRelease:Boolean read FAutoRelease write FAutoRelease;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AddAdapter(AAdapter:TNetworkAdapter; AConfigType:Word; AAddress,ANetmask,AGateway,AServer:Pointer):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveAdapter(AAdapter:TNetworkAdapter):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AddProtocol(AProtocol:Word; APacketHandler:TTransportPacketHandler; AControlHandler:TTransportControlHandler):THandle; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveProtocol(AHandle:THandle; AProtocol:Word):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AddFilter(AProtocol:Word; AFilterHandler:TTransportFilterHandler):THandle; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveFilter(AHandle:THandle; AProtocol:Word):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AddConfig(AConfigType:Word; AConfigAuto:Boolean; AConfigHandler:TTransportConfigHandler):THandle; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveConfig(AHandle:THandle; AConfigType:Word):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function SendPacket(ASocket:TTransportSocket; ASource,ADest:Pointer; APacket:PPacketFragment; ASize,AFlags:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SendControl(ASource,ADest:Pointer; AProtocol,ACommand,ACode:Word; AAddress,AData:Pointer; ASize:Integer):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetSockOpt(ASocket:TTransportSocket; ALevel,AOptName:Integer; AOptValue:PChar; var AOptLength:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SetSockOpt(ASocket:TTransportSocket; ALevel,AOptName:Integer; AOptValue:PChar; AOptLength:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function StartTransport:Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function StopTransport:Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ProcessTransport:Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function BindTransport(AAdapter:TNetworkAdapter):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function UnbindTransport(AAdapter:TNetworkAdapter):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AddNameserver(const AAddress:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveNameserver(const AAddress:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetHostByName(const AName:String; ALock:Boolean):TIPHostEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetHostByAddress(const AAddress:TInAddr; ALock:Boolean):TIPHostEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetHostByNext(APrevious:TIPHostEntry; ALock,AUnlock:Boolean):TIPHostEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function AddHost(const AAddress:TInAddr; const AName:String; AType:Word; ALock:Boolean):TIPHostEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveHost(const AAddress:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure FlushHosts(All:Boolean);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetRouteByAddress(const AAddress:TInAddr; ALock:Boolean; AState:LongWord):TIPRouteEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetRouteByNetwork(const ANetwork,AAddress:TInAddr; ALock:Boolean; AState:LongWord):TIPRouteEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetRouteByNext(APrevious:TIPRouteEntry; ALock,AUnlock:Boolean; AState:LongWord):TIPRouteEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function AddRoute(const ANetwork,ANetmask,AGateway,AAddress:TInAddr; AType:Word; ALock:Boolean; AState:LongWord):TIPRouteEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveRoute(const ANetwork,AAddress:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure FlushRoutes(All:Boolean);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetAddressByAddress(const AAddress:TInAddr; ALock:Boolean; AState:LongWord):TIPAddressEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetAddressByNext(APrevious:TIPAddressEntry; ALock,AUnlock:Boolean; AState:LongWord):TIPAddressEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function AddAddress(const AAddress:TInAddr; AAdapter:TNetworkAdapter; AType:Word; ALock:Boolean; AState:LongWord):TIPAddressEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveAddress(const AAddress:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure FlushAddresses(All:Boolean);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetNetworkByName(const AName:String; ALock:Boolean):TIPNetworkEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetNetworkByAddress(const ANetwork:TInAddr; ALock:Boolean):TIPNetworkEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function AddNetwork(const AName:String; const ANetwork:TInAddr; ALock:Boolean):TIPNetworkEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveNetwork(const AName:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetServByName(const AName,AProtocol:String; ALock:Boolean):TIPServEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetServByPort(APort:Word; const AProtocol:String; ALock:Boolean):TIPServEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function AddServ(const AName,AProtocol:String; APort:Word; ALock:Boolean):TIPServEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveServ(const AName,AProtocol:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetProtoByName(const AName:String; ALock:Boolean):TIPProtoEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetProtoByNumber(ANumber:Word; ALock:Boolean):TIPProtoEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function AddProto(const AName:String; ANumber:Word; ALock:Boolean):TIPProtoEntry;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveProto(const AName:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function CompareLocal(const AAddress:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function CompareDefault(const AAddress:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function CompareLoopback(const AAddress:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function CompareDirected(const AAddress:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function CompareBroadcast(const AAddress:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function CompareMulticast(const AAddress:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function CompareAddress(const AAddress1,AAddress2:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function CompareSubnet(const AAddress,ANetwork,ANetmask:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''IP state'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TIPState = class(TTransportState)</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;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
| <code>FLocalAddress:TInAddr;</code>
 +
| Host Order
 +
|-
 +
| <code>FRemoteAddress:TInAddr;</code>
 +
| Host Order
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>procedure SetLocalAddress(const ALocalAddress:TInAddr);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetRemoteAddress(const ARemoteAddress:TInAddr);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property LocalAddress:TInAddr read FLocalAddress write SetLocalAddress;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property RemoteAddress:TInAddr read FRemoteAddress write SetRemoteAddress;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''IP options'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TIPOptions = class(TTransportOptions)</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|Note: For Get/Set Options Level = IP_PROTO Option = ???
 +
|-
 +
|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>FMemory:TMemoryStream;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOptions:Pointer;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FLength:Integer;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FTOS:Byte;</code>
 +
| IPTOS_LOWDELAY etc
 +
|-
 +
| <code>FTTL:Byte;</code>
 +
| Time To Live
 +
|-
 +
| <code>FFlags:Word;</code>
 +
| IP_DF etc
 +
|-
 +
| <code>FHeader:Boolean;</code>
 +
| IP_HDRINCL
 +
|-
 +
| <code>FMulticastIF:TInAddr;</code>
 +
| IP_MULTICAST_IF
 +
|-
 +
| <code>FMulticastTTL:Byte;</code>
 +
| IP_MULTICAST_TTL
 +
|-
 +
| <code>FMulticastLOOP:Boolean;</code>
 +
| IP_MULTICAST_LOOP
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>procedure SetTOS(ATOS:Byte);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetTTL(ATTL:Byte);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetFlags(AFlags:Word);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetHeader(AHeader:Boolean);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetMulticastIF(const AMulticastIF:TInAddr);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetMulticastTTL(AMulticastTTL:Byte);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetMulticastLOOP(AMulticastLOOP:Boolean);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>procedure SetLength(ALength:Integer);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property TOS:Byte read FTOS write SetTOS;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property TTL:Byte read FTTL write SetTTL;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Flags:Word read FFlags write SetFlags;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Header:Boolean read FHeader write SetHeader;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property MulticastIF:TInAddr read FMulticastIF write SetMulticastIF;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property MulticastTTL:Byte read FMulticastTTL write SetMulticastTTL;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property MulticastLOOP:Boolean read FMulticastLOOP write SetMulticastLOOP;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>property Options:Pointer read FOptions;</code>
 +
| IP_OPTIONS
 +
|-
 +
| <code>property Length:Integer read FLength write SetLength;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''IP host entry'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TIPHostEntry = class(THostEntry)</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;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
| <code>FAddresses:array[0..MAX_HOST_ALIASES - 1] of TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetAddress:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetAddress(const AAddress:TInAddr);</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetAddresses(Index:Integer):TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property Address:TInAddr read GetAddress write SetAddress;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Addresses[Index:Integer]:TInAddr read GetAddresses;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function FindAddress(const AAddress:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AddAddress(const AAddress:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveAddress(const AAddress:TInAddr):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''IP route entry'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TIPRouteEntry = class(TRouteEntry)</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;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
| <code>FTOS:Byte;</code>
 +
| Default TOS for this Route
 +
|-
 +
| <code>FTTL:Byte;</code>
 +
| Default TTL for this Route
 +
|-
 +
| <code>FNetwork:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FNetmask:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FGateway:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FAddress:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>procedure SetTOS(ATOS:Byte);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetTTL(ATTL:Byte);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetNetwork(const ANetwork:TInAddr);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetNetmask(const ANetmask:TInAddr);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetGateway(const AGateway:TInAddr);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetAddress(const AAddress:TInAddr);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property TOS:Byte read FTOS write SetTOS;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property TTL:Byte read FTTL write SetTTL;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Network:TInAddr read FNetwork write SetNetwork;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Netmask:TInAddr read FNetmask write SetNetmask;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Gateway:TInAddr read FGateway write SetGateway;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Address:TInAddr read FAddress write SetAddress;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''IP address entry'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TIPAddressEntry = class(TAddressEntry)</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|Note: Used for secondary addresses.
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>constructor Create;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
| <code>FAddress:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>procedure SetAddress(const AAddress:TInAddr);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property Address:TInAddr read FAddress write SetAddress;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''IP network entry'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TIPNetworkEntry = class(TNetworkEntry)</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;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
| <code>FNetwork:TInAddr;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>procedure SetNetwork(const ANetwork:TInAddr);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property Network:TInAddr read FNetwork write SetNetwork;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div> 
 +
 
 +
'''IP service entry''' 
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TIPServEntry = class(TServEntry)</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;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 +
'''IP protocol entry'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TIPProtoEntry = class(TProtoEntry)</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;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|}
 +
</div></div> 
 +
<br />
  
 
=== Public variables ===
 
=== Public variables ===

Revision as of 04:48, 15 March 2017

Return to Unit Reference


Description

Ultibo IP (Internet Protocol) unit

To be documented

Constants


[Expand]
IP specific constants IP_TRANSPORT_NAME*


[Expand]
IP constants IP_*_SIZE


[Expand]
IP header flags / fragment offset constants IP_*


[Expand]
IP header option constants IPOPT_*


[Expand]
IP offset option constants IPOPT_OFFSET*


[Expand]
IP TS flag option constants IPOPT_TS_*


[Expand]
IP security flag constants IPOPT_SECUR_*


[Expand]
IP type of service constants IPTOS_*


Type definitions


IP header

[Expand]

PIPHeader = ^TIPHeader;

TIPHeader = packed record

IP timestamp address

[Expand]

PIPTimestampAddress = ^TIPTimestampAddress;

TIPTimestampAddress = packed record

IP timestamp

[Expand]

PIPTimestamp = ^TIPTimestamp;

TIPTimestamp = packed record

IP pseudo

[Expand]

PIPPseudo = ^TIPPseudo;

TIPPseudo = packed record

IP fragment

[Expand]

PIPFragment = ^TIPFragment;

TIPFragment = record

IP packet

[Expand]

PIPPacket = ^TIPPacket;

TIPPacket = record


Class definitions


IP buffer

[Expand]

TIPBuffer = class(TTransportBufferEx)

IP transport adapter

[Expand]

TIPTransportAdapter = class(TTransportAdapter)

IP transport binding

[Expand]

TIPTransportBinding = class(TTransportBinding)

IP transport protocol

[Expand]

TIPTransportProtocol = class(TTransportProtocol)

IP transport filter

[Expand]

TIPTransportFilter = class(TTransportFilter)

IP transport configuration

[Expand]

TIPTransportConfig = class(TTransportConfig)

IP transport

[Expand]

TIPTransport = class(TNetworkTransport)

IP state

[Expand]

TIPState = class(TTransportState)

IP options

[Expand]

TIPOptions = class(TTransportOptions)

IP host entry

[Expand]

TIPHostEntry = class(THostEntry)

IP route entry

[Expand]

TIPRouteEntry = class(TRouteEntry)

IP address entry

[Expand]

TIPAddressEntry = class(TAddressEntry)

IP network entry

[Expand]

TIPNetworkEntry = class(TNetworkEntry)

IP service entry

[Expand]

TIPServEntry = class(TServEntry)

IP protocol entry

[Expand]

TIPProtoEntry = class(TProtoEntry)


Public variables

None defined

Function declarations


Initialization functions

[Expand] 
procedure IPInit;
Description: To be documented


IP functions

[Expand] 
function CheckIP(ABuffer:Pointer):Boolean;
Description: Verify that the packet is a valid IP packet


[Expand] 
function GetIPHeaderOffset(ABuffer:Pointer):Word;
Description: Return Start of the IP Header (Start of Packet)


[Expand] 
function GetIPHeaderLength(ABuffer:Pointer):Word;
Description: Return Size of IP Header (Including Options)


[Expand] 
function GetIPOptionsLength(ABuffer:Pointer):Word;
Description: Return Size of IP Options (Header - IP_HEADER_SIZE)


[Expand] 
function GetIPDataOffset(ABuffer:Pointer):Word;
Description: Return Start of IP Packet Data (Length of IP Header)


[Expand] 
function GetIPDataLength(ABuffer:Pointer):Word;
Description: Return Size of IP Packet Data (IP TotalLength - IP Header)


[Expand] 
function ChecksumIPRecv(ABuffer:Pointer; AOffset,ALength:Word):Word;
Description: Validate the IP Header and Options Checksum on Receive


[Expand] 
function ChecksumIPSend(AHeader,AOptions:Pointer; ALength:Word):Word;
Description: Checksum the IP Header and Options on Send


Return to Unit Reference

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