View source for TBOOTPConfig

Return to [[Unit_DHCP|Unit DHCP]]


__TOC__

=== Description ===
----

''To be documented''

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


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

<code>TBOOTPConfig = class(TNetworkConfig)</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:TProtocolManager);</code>
| style="width: 50%;"|&nbsp;
|-
| <code>destructor Destroy; override;</code>
| &nbsp;
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
|-
| <code>FARP:TARPTransport;</code>
| &nbsp;
|-
| <code>FUDP:TUDPProtocol;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function ConfigHandler(AHandle:THandle; AAdapter:TTransportAdapter; ACommand:Word):Boolean;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function CreateBOOTPRequest(AHeader:PBOOTPHeader; ATransport:TBOOTPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACount:Word):Boolean;</code>
| &nbsp;
|-
| <code>function CheckBOOTPReply(AHeader:PBOOTPHeader; ATransport:TBOOTPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord):Boolean;</code>
| &nbsp;
|-
| <code>function HandleBOOTPReply(AHeader:PBOOTPHeader; ATransport:TBOOTPConfigTransport; AAdapter:TTransportAdapter):Boolean;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function SendBOOTPRequest(ASocket:TProtocolSocket; ATransport:TBOOTPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACount:Word):Boolean;</code>
| &nbsp;
|-
| <code>function RecvBOOTPReply(ASocket:TProtocolSocket; ATransport:TBOOTPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord):Boolean;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function ExtractBOOTPOption(AOption:Byte; AHeader:PBOOTPHeader; AValue:Pointer; var ASize:Integer):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 AddTransport(ATransport:TNetworkTransport):Boolean; override;</code>
| &nbsp;
|-
| <code>function RemoveTransport(ATransport:TNetworkTransport):Boolean; override;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function StartConfig:Boolean; override;</code>
| &nbsp;
|-
| <code>function StopConfig:Boolean; override;</code>
| &nbsp;
|-
| <code>function ProcessConfig:Boolean; override;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function SetConfig(AInitDelay,ARetryCount,ARetryTimeout:LongWord):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 TBOOTPConfig.Create(AManager:TProtocolManager);</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 TBOOTPConfig.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 TBOOTPConfig.ConfigHandler(AHandle:THandle; AAdapter:TTransportAdapter; ACommand:Word):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Process a network config request from a Transport</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 Config Transport the request is from
|-
! Adapter
| The transport adapter to perform configuration on
|-
! Command
| The configuration command to perform
|-
! Note
| Caller must hold the 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 TBOOTPConfig.CreateBOOTPRequest(AHeader:PBOOTPHeader; ATransport:TBOOTPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACount:Word):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
| Caller must hold the Transport and Adapter locks
|-
|}
</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 TBOOTPConfig.CheckBOOTPReply(AHeader:PBOOTPHeader; ATransport:TBOOTPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord):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
| Caller must hold the Transport and Adapter locks
|-
|}
</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 TBOOTPConfig.HandleBOOTPReply(AHeader:PBOOTPHeader; ATransport:TBOOTPConfigTransport; AAdapter:TTransportAdapter):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
| Caller must hold the Transport and Adapter locks
|-
|}
</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 TBOOTPConfig.SendBOOTPRequest(ASocket:TProtocolSocket; ATransport:TBOOTPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACount:Word):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
| Caller must hold the Socket, Transport and Adapter locks.
|-
|}
</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 TBOOTPConfig.RecvBOOTPReply(ASocket:TProtocolSocket; ATransport:TBOOTPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord):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
| Caller must hold the Socket, Transport and Adapter locks.
|-
|}
</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 TBOOTPConfig.ExtractBOOTPOption(AOption:Byte; AHeader:PBOOTPHeader; AValue:Pointer; var 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 four octets of the 'vendordata' field of the BOOTP message contain the (decimal) values 99, 130, 83 and 99, respectively.
This is the same magic cookie as is defined in RFC 1497 [17]
|-
|}
</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 TBOOTPConfig.AddTransport(ATransport:TNetworkTransport):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a transport to this config</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Transport
| The transport 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 TBOOTPConfig.RemoveTransport(ATransport:TNetworkTransport):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove a transport from this config</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Transport
| The transport 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 TBOOTPConfig.StartConfig:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Start this config ready for use</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 TBOOTPConfig.StopConfig:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Stop this config 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 TBOOTPConfig.ProcessConfig:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Process periodic tasks for this config</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 TBOOTPConfig.SetConfig(AInitDelay,ARetryCount,ARetryTimeout:LongWord):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set Delay, Retry and Timeout for this config</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]]