View source for TIP6Transport

Return to [[Unit_IPv6|Unit IPv6]]


__TOC__

=== Description ===
----

''To be documented''

=== Class definitions ===
----


<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">

<code>TIP6Transport = 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>FNextIP6Id:Word;</code>
| &nbsp;
|-
| <code>FNextIP6Lock:TMutexHandle;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>FFragments:TIP6Buffer;</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>FDefaultAddress:TIn6Addr;</code>
| &nbsp;
|-
| <code>FLoopbackAddress:TIn6Addr;</code>
| &nbsp;
|-
| <code>FBroadcastAddress:TIn6Addr;</code>
| &nbsp;
|-
| <code>FNameservers:TIP6Nameservers;</code>
| (Part of TNetworkList)
|-
| <code>FNameserverLock:TMutexHandle;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>FDefaultHopLimit: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 GetNextIP6Id(AIncrement:Boolean):Word;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function GetIP6Nameserver(ACount:LongWord):TIn6Addr;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function GetAdapterConfigType(const AName:String):Word;</code>
| &nbsp;
|-
| <code>function GetAdapterConfigAddress(const AName:String):TIn6Addr;</code>
| &nbsp;
|-
| <code>function GetAdapterConfigNetmask(const AName:String):TIn6Addr;</code>
| &nbsp;
|-
| <code>function GetAdapterConfigGateway(const AName:String):TIn6Addr;</code>
| &nbsp;
|-
| <code>function GetAdapterConfigServer(const AName:String):TIn6Addr;</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:TIP6Nameservers read FNameservers;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>property DefaultHopLimit:LongWord read FDefaultHopLimit write FDefaultHopLimit;</code>
| &nbsp;
|-
|colspan="2"|&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:TIn6Addr):Boolean;</code>
| &nbsp;
|-
| <code>function RemoveNameserver(const AAddress:TIn6Addr):Boolean;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function GetHostByName(const AName:String; ALock:Boolean):TIP6HostEntry;</code>
| &nbsp;
|-
| <code>function GetHostByAddress(const AAddress:TIn6Addr; ALock:Boolean):TIP6HostEntry;</code>
| &nbsp;
|-
| <code>function GetHostByNext(APrevious:TIP6HostEntry; ALock,AUnlock:Boolean):TIP6HostEntry;</code>
| &nbsp;
|-
| <code>function CheckHost(AHost:TIP6HostEntry; ALock:Boolean):Boolean;</code>
| &nbsp;
|-
| <code>function AddHost(const AAddress:TIn6Addr; const AName:String; AType:Word; ALock:Boolean):TIP6HostEntry;</code>
| &nbsp;
|-
| <code>function RemoveHost(const AAddress:TIn6Addr):Boolean;</code>
| &nbsp;
|-
| <code>procedure FlushHosts(All:Boolean);</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function GetRouteByAddress(const AAddress:TIn6Addr; ALock:Boolean; AState:LongWord):TIP6RouteEntry;</code>
| &nbsp;
|-
| <code>function GetRouteByNetwork(const ANetwork,AAddress:TIn6Addr; ALock:Boolean; AState:LongWord):TIP6RouteEntry;</code>
| &nbsp;
|-
| <code>function GetRouteByNext(APrevious:TIP6RouteEntry; ALock,AUnlock:Boolean; AState:LongWord):TIP6RouteEntry;</code>
| &nbsp;
|-
| <code>function CheckRoute(ARoute:TIP6RouteEntry; ALock:Boolean; AState:LongWord):Boolean;</code>
| &nbsp;
|-
| <code>function AddRoute(const ANetwork,ANetmask,AGateway,AAddress:TIn6Addr; AType:Word; ALock:Boolean; AState:LongWord):TIP6RouteEntry;</code>
| &nbsp;
|-
| <code>function RemoveRoute(const ANetwork,AAddress:TIn6Addr):Boolean;</code>
| &nbsp;
|-
| <code>procedure FlushRoutes(All:Boolean);</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function GetAddressByAddress(const AAddress:TIn6Addr; ALock:Boolean; AState:LongWord):TIP6AddressEntry;</code>
| &nbsp;
|-
| <code>function GetAddressByNext(APrevious:TIP6AddressEntry; ALock,AUnlock:Boolean; AState:LongWord):TIP6AddressEntry;</code>
| &nbsp;
|-
| <code>function CheckAddress(AAddress:TIP6AddressEntry; ALock:Boolean; AState:LongWord):Boolean;</code>
| &nbsp;
|-
| <code>function AddAddress(const AAddress:TIn6Addr; AType:Word; AAdapter:TNetworkAdapter; ALock:Boolean; AState:LongWord):TIP6AddressEntry;</code>
| &nbsp;
|-
| <code>function RemoveAddress(const AAddress:TIn6Addr):Boolean;</code>
| &nbsp;
|-
| <code>procedure FlushAddresses(All:Boolean);</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function GetNetworkByName(const AName:String; ALock:Boolean):TIP6NetworkEntry;</code>
| &nbsp;
|-
| <code>function GetNetworkByAddress(const ANetwork:TIn6Addr; ALock:Boolean):TIP6NetworkEntry;</code>
| &nbsp;
|-
| <code>function AddNetwork(const AName:String; const ANetwork:TIn6Addr; ALock:Boolean):TIP6NetworkEntry;</code>
| &nbsp;
|-
| <code>function RemoveNetwork(const AName:String):Boolean;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function GetServByName(const AName,AProtocol:String; ALock:Boolean):TIP6ServEntry;</code>
| &nbsp;
|-
| <code>function GetServByPort(APort:Word; const AProtocol:String; ALock:Boolean):TIP6ServEntry;</code>
| &nbsp;
|-
| <code>function AddServ(const AName,AProtocol:String; APort:Word; ALock:Boolean):TIP6ServEntry;</code>
| &nbsp;
|-
| <code>function RemoveServ(const AName,AProtocol:String):Boolean;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function GetProtoByName(const AName:String; ALock:Boolean):TIP6ProtoEntry;</code>
| &nbsp;
|-
| <code>function GetProtoByNumber(ANumber:Word; ALock:Boolean):TIP6ProtoEntry;</code>
| &nbsp;
|-
| <code>function AddProto(const AName:String; ANumber:Word; ALock:Boolean):TIP6ProtoEntry;</code>
| &nbsp;
|-
| <code>function RemoveProto(const AName:String):Boolean;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function CompareLocal(const AAddress:TIn6Addr):Boolean;</code>
| &nbsp;
|-
| <code>function CompareDefault(const AAddress:TIn6Addr):Boolean;</code>
| &nbsp;
|-
| <code>function CompareLoopback(const AAddress:TIn6Addr):Boolean;</code>
| &nbsp;
|-
| <code>function CompareDirected(const AAddress:TIn6Addr):Boolean;</code>
| &nbsp;
|-
| <code>function CompareBroadcast(const AAddress:TIn6Addr):Boolean;</code>
| &nbsp;
|-
| <code>function CompareMulticast(const AAddress:TIn6Addr):Boolean;</code>
| &nbsp;
|-
| <code>function CompareAddress(const AAddress1,AAddress2:TIn6Addr):Boolean;</code>
| &nbsp;
|-
| <code>function CompareSubnet(const AAddress,ANetwork,ANetmask:TIn6Addr):Boolean;</code>
| &nbsp;
|-
|}
</div></div>
<br />

=== Function declarations ===
----


<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">constructor TIP6Transport.Create(AManager:TTransportManager; const AName:String);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">destructor TIP6Transport.Destroy;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.PacketHandler(AHandle:THandle; ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Process a packet received by an Adapter</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Handle
| The Handle of the Transport Adapter the packet was received from
|-
! Source
| The source hardware address of the received packet (Set by Adapter)
|-
! Dest
| The destination hardware address of the received packet (Set by Adapter)
|-
! Packet
| The received packet (The complete packet without Adapter header)
|-
! Size
| The size of the received packet in bytes
|-
! Broadcast
| True if the destination address is a broadcast address
|-
! Note
| The first protocol handler to accept the packet causes processing to cease
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.FragmentHandler(ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Process a received fragment by adding it to the buffer and if completed process the packet</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Source
| The source IP6 address of the received fragment (Set by Packet Handler)
|-
! Dest
| The destination IP6 address of the received fragment (Set by Packet Handler)
|-
! Packet
| The received fragment (The complete packet without Adapter header)
|-
! Size
| The size of the received fragment in bytes
|-
! Broadcast
| True if the destination address is a broadcast address
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.CheckFragment(ABuffer:Pointer):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check if a packet is a fragment and return True if it is</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Buffer
| The packet to check (The complete packet without Adapter header)
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetNextIP6Id(AIncrement:Boolean):Word;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the next IP6 packet id number</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Increment
| If True increment the next id
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetIP6Nameserver(ACount:LongWord):TIn6Addr;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the nameserver address from the network settings</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetAdapterConfigType(const AName:String):Word;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the adapter config type from the network settings</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetAdapterConfigAddress(const AName:String):TIn6Addr;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the adapter address from the network settings</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetAdapterConfigNetmask(const AName:String):TIn6Addr;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the adapter netmask from the network settings</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetAdapterConfigGateway(const AName:String):TIn6Addr;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the adapter gateway from the network settings</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetAdapterConfigServer(const AName:String):TIn6Addr;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the adapter server from the network settings</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.FilterPacket(ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Filter a received packet</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Source
| The source IP6 address of the received fragment (Set by Packet or Fragment Handler)
|-
! Dest
| The destination IP6 address of the received fragment (Set by Packet or Fragment Handler)
|-
! Packet
| The received packet (The complete packet without Adapter header)
|-
! Size
| The size of the received packet in bytes
|-
! Broadcast
| True if the destination address is a broadcast address
|-
! Note
| If Filter returns True the Packet should be discarded
The first filter handler to reject the packet causes filtering to cease
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.ForwardPacket(AAdapter:TTransportAdapter; ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Forward a received packet</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Adapter
| The adapter the packet was received on
|-
! Source
| The source IP6 address of the received fragment (Set by Packet Handler)
|-
! Dest
| The destination IP6 address of the received fragment (Set by Packet Handler)
|-
! Packet
| The received packet (The complete packet without Adapter header)
|-
! Size
| The size of the received packet in bytes
|-
! Broadcast
| True if the destination address is a broadcast address
|-
! Note
| Caller must hold Adapter lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.AddAdapter(AAdapter:TNetworkAdapter; AConfigType:Word; AAddress,ANetmask,AGateway,AServer:Pointer):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add an adapter to this transport</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Adapter
| The adapter to add
|-
! ConfigType
| The configuration type to use for configuring the adapter (eg CONFIG_TYPE_AUTO)
|-
! Address
| The transport address to use for this adapter (or nil if supplied during configuration)
|-
! Netmask
| The transport netmask to use for this adapter (or nil if supplied during configuration)
|-
! Gateway
| The transport default gateway to use for this adapter (or nil if supplied during configuration)
|-
! Server
| The transport configuration server to use for this adapter (or nil if supplied during configuration)
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.RemoveAdapter(AAdapter:TNetworkAdapter):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove an adapter from this transport</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Adapter
| The adapter to remove
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.AddProtocol(AProtocol:Word; APacketHandler:TTransportPacketHandler; AControlHandler:TTransportControlHandler):THandle;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a protocol to this transport</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Protocol
| The protocol type to add
|-
! PacketHandler
| Packet handler to call on matching protocol type
|-
! ControlHandler
| Control handler to call on error condition
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.RemoveProtocol(AHandle:THandle; AProtocol:Word):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove a protocol from this transport</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Handle
| Handle of the protocol to remove
|-
! Protocol
| The protocol type to remove
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.AddFilter(AProtocol:Word; AFilterHandler:TTransportFilterHandler):THandle;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a filter to this transport</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Protocol
| The protocol type of the filter to add
|-
! FilterHandler
| Filter handler to call on matching protocol type
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.RemoveFilter(AHandle:THandle; AProtocol:Word):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove a filter from this transport</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Handle
| Handle of the filter to remove
|-
! Protocol
| The protocol type of the filter to remove
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.AddConfig(AConfigType:Word; AConfigAuto:Boolean; AConfigHandler:TTransportConfigHandler):THandle;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a config to this transport</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! ConfigType
| The config type to add
|-
! ConfigAuto
| True if this config supports auto configuration type
|-
! ConfigHandler
| Config handler to call on matching config type
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.RemoveConfig(AHandle:THandle; AConfigType:Word):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove a config from this transport</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Handle
| Handle of the config to remove
|-
! ConfigType
| The config type to remove
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.SendPacket(ASocket:TTransportSocket; ASource,ADest:Pointer; APacket:PPacketFragment; ASize,AFlags:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Send a Packet by adding the Transport Header and other details to the Data</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Source
| The source IP6 address of the packet
|-
! Dest
| The destination IP6 address of the packet
|-
! Packet
| The packet data to send
|-
! Note
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.SendControl(ASource,ADest:Pointer; AProtocol,ACommand,ACode:Word; AAddress,AData:Pointer; ASize:Integer):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| The first control handler to accept the packet causes sending to cease
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetSockOpt(ASocket:TTransportSocket; ALevel,AOptName:Integer; AOptValue:PChar; var AOptLength:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Get Socket Option</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to get the option from
|-
! Level
| The protocol level for the option
|-
! OptName
| The name of the option to get
|-
! OptValue
| The value of the option
|-
! OptLength
| The length of the option
|-
! Note
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.SetSockOpt(ASocket:TTransportSocket; ALevel,AOptName:Integer; AOptValue:PChar; AOptLength:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Set Socket Option</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to set the option for
|-
! Level
| The protocol level for the option
|-
! OptName
| The name of the option to set
|-
! OptValue
| The value of the option
|-
! OptLength
| The length of the option
|-
! Note
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.StartTransport:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Start this transport ready for sending and receiving</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.StopTransport:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Stop this transport ready for removal</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.ProcessTransport:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Process periodic tasks for this transport</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.BindTransport(AAdapter:TNetworkAdapter):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Bind this transport to an adapter if appropriate</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Adapter
| The adapter to bind to
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.UnbindTransport(AAdapter:TNetworkAdapter):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Unbind this transport from an adapter if appropriate</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Adapter
| The adapter to unbind from
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.AddNameserver(const AAddress:TIn6Addr):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a nameserver IP6 address to the list of available nameservers</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The IP6 address to add
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.RemoveNameserver(const AAddress:TIn6Addr):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove a nameserver IP6 address from the list of available nameservers</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The IP6 address to remove
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetHostByName(const AName:String; ALock:Boolean):TIP6HostEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find the name in the host cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Name
| The name to find
|-
! Lock
| If True then lock the found entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetHostByAddress(const AAddress:TIn6Addr; ALock:Boolean):TIP6HostEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find the IP6 address in the host cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The IP6 address to find
|-
! Lock
| If True then lock the found entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetHostByNext(APrevious:TIP6HostEntry; ALock,AUnlock:Boolean):TIP6HostEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.CheckHost(AHost:TIP6HostEntry; ALock:Boolean):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check a host entry in the host cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Host
| The host entry to check
|-
! Lock
| If True then lock the found entry before returning
|-
! Note
| This allows safely obtaining a lock on an existing object in case it has been freed
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.AddHost(const AAddress:TIn6Addr; const AName:String; AType:Word; ALock:Boolean):TIP6HostEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add an IP6 address and name to the host cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The IP6 address of the entry to add
|-
! Name
| The name of the entry to add
|-
! Type
| The type of the added entry (eg HOST_TYPE_DYNAMIC)
|-
! Lock
| If True then lock the added entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.RemoveHost(const AAddress:TIn6Addr):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove an IP6 address from the host cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The IP6 address to remove
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TIP6Transport.FlushHosts(All:Boolean);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Flush hosts from the host cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! All
| If True flush all hosts, otherwise flush expired hosts.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetRouteByAddress(const AAddress:TIn6Addr; ALock:Boolean; AState:LongWord):TIP6RouteEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find the IP6 route in the route cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The IP6 address to find the route for
|-
! Lock
| If True then lock the found entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetRouteByNetwork(const ANetwork,AAddress:TIn6Addr; ALock:Boolean; AState:LongWord):TIP6RouteEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find the IP6 network and address in the route cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Network
| The network address of the entry to find
|-
! Address
| The IP6 address of the entry to find
|-
! Lock
| If True then lock the found entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetRouteByNext(APrevious:TIP6RouteEntry; ALock,AUnlock:Boolean; AState:LongWord):TIP6RouteEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.CheckRoute(ARoute:TIP6RouteEntry; ALock:Boolean; AState:LongWord):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check a route entry in the route cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Route
| The route entry to check
|-
! Lock
| If True then lock the found entry before returning
|-
! State
| The lock type if Lock is True (NETWORK_LOCK_READ or NETWORK_LOCK_WRITE)
|-
! Note
| This allows safely obtaining a lock on an existing object in case it has been freed
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.AddRoute(const ANetwork,ANetmask,AGateway,AAddress:TIn6Addr; AType:Word; ALock:Boolean; AState:LongWord):TIP6RouteEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add an IP6 route to the route cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Network
| The network address of the entry to add
|-
! Netmask
| The netmask of the entry to add
|-
! Gateway
| The gateway of the entry to add
|-
! Address
| The IP6 address of the entry to add
|-
! Type
| The type of the added entry (eg ROUTE_TYPE_DYNAMIC)
|-
! Lock
| If True then lock the added entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.RemoveRoute(const ANetwork,AAddress:TIn6Addr):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove an IP6 route from the route cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Network
| The network address of the entry to remove
|-
! Address
| The IP6 address of the entry to remove
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TIP6Transport.FlushRoutes(All:Boolean);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Flush routes from the route cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! All
| If True flush all routes, otherwise flush expired routes.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetAddressByAddress(const AAddress:TIn6Addr; ALock:Boolean; AState:LongWord):TIP6AddressEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find the IP6 address in the address cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The IP6 address to find
|-
! Lock
| If True then lock the found entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetAddressByNext(APrevious:TIP6AddressEntry; ALock,AUnlock:Boolean; AState:LongWord):TIP6AddressEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.CheckAddress(AAddress:TIP6AddressEntry; ALock:Boolean; AState:LongWord):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check an address entry in the address cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The address entry to check
|-
! Lock
| If True then lock the found entry before returning
|-
! State
| The lock type if Lock is True (NETWORK_LOCK_READ or NETWORK_LOCK_WRITE)
|-
! Note
| This allows safely obtaining a lock on an existing object in case it has been freed
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.AddAddress(const AAddress:TIn6Addr; AType:Word; AAdapter:TNetworkAdapter; ALock:Boolean; AState:LongWord):TIP6AddressEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add an IP6 address to the address cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The IP6 address to add
|-
! Adapter
| The adapter the address is on
|-
! Type
| The type of the added entry (eg ADDRESS_TYPE_PRIMARY)
|-
! Lock
| If True then lock the added entry before returning
|-
! Note
| The handling of Secondary addresses should probably change in future to use a Binding type mechanism (eg AddBinding/RemoveBinding)
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.RemoveAddress(const AAddress:TIn6Addr):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove an IP6 address from the address cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The IP6 address to remove
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure TIP6Transport.FlushAddresses(All:Boolean);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Flush addresses from the adresses cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! All
| If True flush all addresses, otherwise flush invalid addresses.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetNetworkByName(const AName:String; ALock:Boolean):TIP6NetworkEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find the name in the network cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Name
| The name to find
|-
! Lock
| If True then lock the found entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetNetworkByAddress(const ANetwork:TIn6Addr; ALock:Boolean):TIP6NetworkEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find the network address in the network cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Network
| The network address to find
|-
! Lock
| If True then lock the found entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.AddNetwork(const AName:String; const ANetwork:TIn6Addr; ALock:Boolean):TIP6NetworkEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a network address and name to the network cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Name
| The name of the entry to add
|-
! Network
| The network address of the entry to add
|-
! Lock
| If True then lock the added entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.RemoveNetwork(const AName:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove a network from the network cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Name
| The name of the network to remove
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetServByName(const AName,AProtocol:String; ALock:Boolean):TIP6ServEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find the name in the service cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Name
| The name to find
|-
! Protocol
| The protocol to find
|-
! Lock
| If True then lock the found entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetServByPort(APort:Word; const AProtocol:String; ALock:Boolean):TIP6ServEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find the port in the service cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Port
| The port to find
|-
! Protocol
| The protocol to find
|-
! Lock
| If True then lock the found entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.AddServ(const AName,AProtocol:String; APort:Word; ALock:Boolean):TIP6ServEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a service to the service cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Name
| None documented
|-
! Protocol
| The protocol of the entry to add
|-
! Port
| The port of the entry to add
|-
! Lock
| If True then lock the added entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.RemoveServ(const AName,AProtocol:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove a service from the service cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Name
| The name of the entry to remove
|-
! Protocol
| The protocol of the entry to remove
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetProtoByName(const AName:String; ALock:Boolean):TIP6ProtoEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find the name in the protocol cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Name
| The name to find
|-
! Lock
| If True then lock the found entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.GetProtoByNumber(ANumber:Word; ALock:Boolean):TIP6ProtoEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find the protocol number in the protocol cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Number
| The protocol number to find
|-
! Lock
| If True then lock the found entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.AddProto(const AName:String; ANumber:Word; ALock:Boolean):TIP6ProtoEntry;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a protocol to the protocol cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Name
| The name of the entry to add
|-
! Number
| The protocol number of the entry to add
|-
! Lock
| If True then lock the added entry before returning
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.RemoveProto(const AName:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove a protocol from the protocol cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Name
| The name of the entry to remove
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.CompareLocal(const AAddress:TIn6Addr):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Compare the supplied address with the local IP6 addresses</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.CompareDefault(const AAddress:TIn6Addr):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Compare the supplied address with the default IP6 address</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.CompareLoopback(const AAddress:TIn6Addr):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Compare the supplied address with the loopback IP6 address</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.CompareDirected(const AAddress:TIn6Addr):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Compare the supplied address with the directed broadcast IP6 addresses</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.CompareBroadcast(const AAddress:TIn6Addr):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Compare the supplied address with the broadcast IP6 address</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.CompareMulticast(const AAddress:TIn6Addr):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Compare the supplied address with the multicast IP6 address</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.CompareAddress(const AAddress1,AAddress2:TIn6Addr):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Compare the supplied addresses to see if they are the same</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TIP6Transport.CompareSubnet(const AAddress,ANetwork,ANetmask:TIn6Addr):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Compare the supplied address to see if it is in the supplied subnet</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />

Return to [[Unit_Reference|Unit Reference]]