View source for TEAPOLTransport

Return to [[Unit_WiFi|Unit WiFi]]


__TOC__

=== Description ===
----

''To be documented''

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


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

<code>TEAPOLTransport = 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;
|-
| destructor Destroy; override;
| &nbsp;
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
|-
| <code>function PacketHandler(AHandle:THandle; ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean;</code>
| &nbsp;
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
|-
|colspan="2"|&nbsp;
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <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 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;
|-
|}
</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 TEAPOLTransport.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 TEAPOLTransport.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 TEAPOLTransport.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
|-
|}
</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 TEAPOLTransport.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 TEAPOLTransport.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 TEAPOLTransport.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 TEAPOLTransport.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 TEAPOLTransport.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 TEAPOLTransport.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 TEAPOLTransport.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 />

Return to [[Unit_Reference|Unit Reference]]