Difference between revisions of "Unit RAW"

From Ultibo.org
Jump to: navigation, search
(Created page with "Return to Unit Reference === Description === ---- ''To be documented'' === Constants === ---- ''To be documented'' === Type definitions === ---- ''To...")
 
 
(11 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
----
 
----
  
''To be documented''
+
'''Ultibo Raw Socket Protocol unit'''
  
 
=== Constants ===
 
=== Constants ===
 
----
 
----
  
''To be documented''
+
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Raw specific constants''' <code> RAW_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|Note: Some RAW definitions are in the Protocol or IP modules
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>IP_PROTOCOL_NAME = 'IP';</code>
 +
| &nbsp;
 +
|-
 +
| <code>RAW_PROTOCOL_NAME = 'RAW';</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>RAW_TIMEOUT = 0;</code>
 +
| Wait forever on a RAW Read
 +
|-
 +
| <code>RAW_BUFFER_SIZE = 65536;</code>
 +
| RAW Receive Buffer Size
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>RAW_HEADER_SIZE = 0;</code>
 +
| No Header for RAW
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>RAW_PACKET_SIZE = 8;</code>
 +
| SizeOf(TRAWPacket)
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
 
=== Type definitions ===
 
=== Type definitions ===
 
----
 
----
  
''To be documented''
+
 
 +
'''Raw packet'''
 +
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PRAWPacket = ^TRAWPacket;</code>
 +
 
 +
<code>TRAWPacket = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|Note: Some RAW definitions are in the Protocol or IP modules
 +
|-
 +
|colspan="2"|Note: 8 Bytes (Used by RAWBuffer)
 +
|-
 +
| <code>Size:LongWord;</code>
 +
| LongWord to keep size even
 +
|-
 +
| <code>Next:PRAWPacket;</code>
 +
| Followed by RemoteAddress (4 or 16 Bytes)
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
 
 +
=== Class definitions ===
 +
----
 +
 
 +
 
 +
'''Raw specific classes
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| [[TRAWProtocolTransport|<code>TRAWProtocolTransport = class(TProtocolTransport)</code>]]
 +
|-
 +
|}
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| [[TRAWProtocol|<code>TRAWProtocol = class(TNetworkProtocol)</code>]]
 +
|-
 +
|}
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| [[TRAWSocket|<code>TRAWSocket = class(TProtocolSocket)</code>]]
 +
|-
 +
|}
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| [[TRAWBuffer|<code>TRAWBuffer = class(TSocketBuffer)</code>]]
 +
|-
 +
|}
 +
<br />
  
 
=== Public variables ===
 
=== Public variables ===
 
----
 
----
  
''To be documented''
+
''None defined''
  
 
=== Function declarations ===
 
=== Function declarations ===
 
----
 
----
  
''To be documented''
 
  
 +
'''Initialization functions'''
 +
 +
<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 RAWInit;</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 />
  
 
Return to [[Unit_Reference|Unit Reference]]
 
Return to [[Unit_Reference|Unit Reference]]

Latest revision as of 05:29, 31 August 2021

Return to Unit Reference


Description


Ultibo Raw Socket Protocol unit

Constants



Raw specific constants RAW_*
Note: Some RAW definitions are in the Protocol or IP modules
 
IP_PROTOCOL_NAME = 'IP';  
RAW_PROTOCOL_NAME = 'RAW';  
 
RAW_TIMEOUT = 0; Wait forever on a RAW Read
RAW_BUFFER_SIZE = 65536; RAW Receive Buffer Size
 
RAW_HEADER_SIZE = 0; No Header for RAW
 
RAW_PACKET_SIZE = 8; SizeOf(TRAWPacket)


Type definitions



Raw packet

PRAWPacket = ^TRAWPacket;

TRAWPacket = record

Note: Some RAW definitions are in the Protocol or IP modules
Note: 8 Bytes (Used by RAWBuffer)
Size:LongWord; LongWord to keep size even
Next:PRAWPacket; Followed by RemoteAddress (4 or 16 Bytes)


Class definitions



Raw specific classes

TRAWProtocolTransport = class(TProtocolTransport)
TRAWProtocol = class(TNetworkProtocol)
TRAWSocket = class(TProtocolSocket)
TRAWBuffer = class(TSocketBuffer)


Public variables


None defined

Function declarations



Initialization functions

procedure RAWInit;
Description: To be documented
Note None documented


Return to Unit Reference