TEAPOLTransport
From Ultibo.org
Revision as of 03:12, 5 June 2018 by Ultibo (Talk | contribs) (Created page with "Return to Unit WiFi __TOC__ === Description === ---- ''To be documented'' === Class definitions === ---- <div class="toccolours mw-collapsible mw-collapse...")
Return to Unit WiFi
Description
To be documented
Class definitions
TEAPOLTransport = class(TNetworkTransport)
constructor Create(AManager:TTransportManager; const AName:String);
|
|
destructor Destroy; override; | |
private
| |
function PacketHandler(AHandle:THandle; ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean;
|
|
protected
| |
public
| |
function AddAdapter(AAdapter:TNetworkAdapter; AConfigType:Word; AAddress,ANetmask,AGateway,AServer:Pointer):Boolean; override;
|
|
function RemoveAdapter(AAdapter:TNetworkAdapter):Boolean; override;
|
|
function StartTransport:Boolean; override;
|
|
function StopTransport:Boolean; override;
|
|
function ProcessTransport:Boolean; override;
|
|
function BindTransport(AAdapter:TNetworkAdapter):Boolean; override;
|
|
function UnbindTransport(AAdapter:TNetworkAdapter):Boolean; override;
|
Function declarations
constructor TEAPOLTransport.Create(AManager:TTransportManager; const AName:String);
Description: To be documented
Note | None documented |
---|
destructor TEAPOLTransport.Destroy;
Description: To be documented
Note | None documented |
---|
function TEAPOLTransport.PacketHandler(AHandle:THandle; ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean;
Description: Process a packet received by an Adapter
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 |
function TEAPOLTransport.AddAdapter(AAdapter:TNetworkAdapter; AConfigType:Word; AAddress,ANetmask,AGateway,AServer:Pointer):Boolean;
Description: Add an adapter to this transport
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) |
function TEAPOLTransport.RemoveAdapter(AAdapter:TNetworkAdapter):Boolean;
Description: Remove an adapter from this transport
Adapter | The adapter to remove |
---|
function TEAPOLTransport.StartTransport:Boolean;
Description: Start this transport ready for sending and receiving
Note | None documented |
---|
function TEAPOLTransport.StopTransport:Boolean;
Description: Stop this transport ready for removal
Note | None documented |
---|
function TEAPOLTransport.ProcessTransport:Boolean;
Description: Process periodic tasks for this transport
Note | None documented |
---|
function TEAPOLTransport.BindTransport(AAdapter:TNetworkAdapter):Boolean;
Description: Bind this transport to an adapter if appropriate
Adapter | The adapter to bind to |
---|
function TEAPOLTransport.UnbindTransport(AAdapter:TNetworkAdapter):Boolean;
Description: Unbind this transport from an adapter if appropriate
Adapter | The adapter to unbind from |
---|
Return to Unit Reference