View source for TUDPBuffer

Return to [[Unit_UDP|Unit UDP]]


__TOC__

=== Description ===
----

''To be documented''

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


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

<code>TUDPBuffer = class(TSocketBuffer)</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>constructor Create(ASocket:TTransportSocket);</code>
| style="width: 50%;"|&nbsp;
|-
| <code>destructor Destroy; override;</code>
| &nbsp;
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
|-
| <code>FOffset:Word;</code>
| Offset to RemoteAddress
|-
| <code>FLength:Word;</code>
| Length of RemoteAddress
|-
|colspan="2"|&nbsp;
|-
| <code>FRead:Pointer;</code>
| Pointer to Next Read from Buffer
|-
| <code>FWrite:Pointer;</code>
| Pointer to Next Write to Buffer
|-
|colspan="2"|&nbsp;
|-
| <code>FCount:LongWord;</code>
| Number of Datagrams in Buffer
|-
|colspan="2"|&nbsp;
|-
| <code>FFirst:PUDPDatagram;</code>
| Pointer to First Datagram
|-
| <code>FLast:PUDPDatagram;</code>
| Pointer to Last Datagram
|-
|colspan="2"|&nbsp;
|-
| <code>function AddDatagram(ASize:Integer):Boolean;</code>
| &nbsp;
|-
| <code>function RemoveDatagram:Boolean;</code>
| &nbsp;
|-
| <code>procedure FlushDatagrams;</code>
| &nbsp;
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
|-
| <code>procedure SetSize(ASize:LongWord); override;</code>
| &nbsp;
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>function GetNext:Integer;</code>
| &nbsp;
|-
| <code>function GetCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>function ReadBuffer(var ABuffer; var ASize:Integer; ARemoteAddress:Pointer; ARemotePort:PWORD; AFlags:Integer):Boolean;</code>
| &nbsp;
|-
| <code>function WriteBuffer(var ABuffer; ASize:Integer; ARemoteAddress:Pointer; ARemotePort:PWORD):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 TUDPBuffer.Create(ASocket:TTransportSocket);</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 TUDPBuffer.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 TUDPBuffer.AddDatagram(ASize:Integer):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Adds a new Datagram as the Last datagram in the Buffer</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 TUDPBuffer.RemoveDatagram:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Removes the First datagram from the Buffer</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;">procedure TUDPBuffer.FlushDatagrams;</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;">procedure TUDPBuffer.SetSize(ASize:LongWord);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Setting the Size clears any current Datagrams</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 TUDPBuffer.GetNext:Integer;</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 TUDPBuffer.GetCount:LongWord;</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 TUDPBuffer.ReadBuffer(var ABuffer; var ASize:Integer; ARemoteAddress:Pointer; ARemotePort:PWORD; AFlags:Integer):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Stored Datagram contains the Data without the Headers</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Passed Size contains size of Buffer and should return the size of Datagram
Flags is for MSG_PEEK and MSG_OOB when applicable
|-
|}
</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 TUDPBuffer.WriteBuffer(var ABuffer; ASize:Integer; ARemoteAddress:Pointer; ARemotePort:PWORD):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Supplied Buffer contains the Data without the Headers</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Data that will not fit in the Buffer is simply discarded
|-
|}
</div></div>
<br />

Return to [[Unit_Reference|Unit Reference]]