Difference between revisions of "Unit IP"

From Ultibo.org
Jump to: navigation, search
Line 217: Line 217:
  
 
=== Type definitions ===
 
=== Type definitions ===
 +
----
 +
 +
''To be documented''
 +
 +
=== Class definitions ===
 
----
 
----
  

Revision as of 01:11, 20 January 2017

Return to Unit Reference


Description


Ultibo IP (Internet Protocol) unit

To be documented

Constants



[Expand]
IP specific constants IP_TRANSPORT_NAME*


[Expand]
IP constants IP_*_SIZE


[Expand]
IP header flags / fragment offset constants IP_*


[Expand]
IP header option constants IPOPT_*


[Expand]
IP offset option constants IPOPT_OFFSET*


[Expand]
IP TS flag option constants IPOPT_TS_*


[Expand]
IP security flag constants IPOPT_SECUR_*


[Expand]
IP type of service constants IPTOS_*


Type definitions


To be documented

Class definitions


To be documented

Public variables


None defined

Function declarations



Initialization functions

[Expand]
procedure IPInit;
Description: To be documented


IP functions

[Expand]
function CheckIP(ABuffer:Pointer):Boolean;
Description: Verify that the packet is a valid IP packet


[Expand]
function GetIPHeaderOffset(ABuffer:Pointer):Word;
Description: Return Start of the IP Header (Start of Packet)


[Expand]
function GetIPHeaderLength(ABuffer:Pointer):Word;
Description: Return Size of IP Header (Including Options)


[Expand]
function GetIPOptionsLength(ABuffer:Pointer):Word;
Description: Return Size of IP Options (Header - IP_HEADER_SIZE)


[Expand]
function GetIPDataOffset(ABuffer:Pointer):Word;
Description: Return Start of IP Packet Data (Length of IP Header)


[Expand]
function GetIPDataLength(ABuffer:Pointer):Word;
Description: Return Size of IP Packet Data (IP TotalLength - IP Header)


[Expand]
function ChecksumIPRecv(ABuffer:Pointer; AOffset,ALength:Word):Word;
Description: Validate the IP Header and Options Checksum on Receive


[Expand]
function ChecksumIPSend(AHeader,AOptions:Pointer; ALength:Word):Word;
Description: Checksum the IP Header and Options on Send


Return to Unit Reference