View source for TRARPConfig

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>TRARPConfig = 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>FRARP:TRARPTransport;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function ConfigHandler(AHandle:THandle; AAdapter:TTransportAdapter; ACommand:Word):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;
|-
|}
</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 TRARPConfig.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 TRARPConfig.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 TRARPConfig.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 TRARPConfig.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 TRARPConfig.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 TRARPConfig.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 TRARPConfig.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 TRARPConfig.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 />

Return to [[Unit_Reference|Unit Reference]]