Unit IP
From Ultibo.org
Return to Unit Reference
Contents
Description
Ultibo IP (Internet Protocol) unit
To be documented
Constants
IP specific constants
IP_TRANSPORT_NAME* IP_TRANSPORT_NAME = 'IP';
|
IP size
IP_*_SIZE MIN_IP_PACKET = 20;
|
Not Counting Adapter Header |
MAX_IP_PACKET = 65536;
|
Not Counting Adapter Header |
MAX_FRAG_LIFE = 32000;
|
Only wait 32 seconds for the rest of the packet |
IP_HEADER_SIZE = 20;
|
SizeOf(TIPHeader); (Does Not Allow for Options) |
IP_OPTIONS_SIZE = 40;
|
Maximum Allowed Options |
IP_PSEUDO_SIZE = 12;
|
SizeOf(TPseudoHeader); |
IP_PACKET_SIZE = 56;
|
SizeOf(TIPPacket); (Previously 46) |
IP_FRAGMENT_SIZE = 12;
|
SizeOf(TIPFragment); |
IP header flags/fragment offset
IP_* IP_CE = $8000;
|
Congestion Experienced |
IP_DF = $4000;
|
1 = Don't Fragment 0 = May Fragment |
IP_MF = $2000;
|
1 = More Fragments 0 = Last Fragment |
IP_OFFMASK = $1FFF;
|
Fragment Offset Mask |
IP header options
IPOPT_* IPOPT_EOL = 0;
|
end-of-option list |
IPOPT_NOP = 1;
|
no-operation |
IPOPT_RR = 7;
|
record packet route |
IPOPT_TS = 68;
|
timestamp |
IPOPT_SECURITY = 130;
|
provide s,c,h,tcc |
IPOPT_LSRR = 131;
|
loose source route |
IPOPT_SATID = 136;
|
satnet Id |
IPOPT_SSRR = 137;
|
strict source route |
IPOPT_RA = 148;
|
router alert |
IP offset options
IPOPT_OFFSET* | Offsets to fields in IP Options other than EOL and NOP | |
IPOPT_OPTVAL = 0;
|
option ID |
IPOPT_OLEN = 1;
|
option length |
IPOPT_OFFSET = 2;
|
offset within option |
IPOPT_MINOFF = 4;
|
min value of above |
IP TS flag options
IPOPT_TS_* | Flags for IPOPT_TS Flags | |
IPOPT_TS_TSONLY = 0;
|
timestamps only |
IPOPT_TS_TSANDADDR = 1;
|
timestamps and addresses |
IPOPT_TS_PRESPEC = 3;
|
specified modules only |
IP security flag
IPOPT_SECUR_* | Flags for IPOPT_SECURITY Flags (Network Order) | |
IPOPT_SECUR_UNCLASS = $0000;
|
|
IPOPT_SECUR_CONFID = $F135;
|
|
IPOPT_SECUR_EFTO = $789A;
|
|
IPOPT_SECUR_MMMM = $BC4D;
|
|
IPOPT_SECUR_RESTR = $AF13;
|
|
IPOPT_SECUR_SECRET = $D788;
|
|
IPOPT_SECUR_TOPSECRET = $6BC5;
|
|
IP type of service
IPTOS_* IPTOS_LOWDELAY = $10;
|
|
IPTOS_THROUGHPUT = $08;
|
|
IPTOS_RELIABILITY = $04;
|
|
IPTOS_MINCOST = $02;
|
Type definitions
IP header
PIPHeader = ^TIPHeader;
TIPHeader = packed record
| Note: 20 Bytes unless IP Options are added | |
VersionLength:Byte;
|
$45 for IPv4 and 20-byte header |
TOS:Byte;
|
throughput type of service |
TotalLength:Word;
|
Total Size of the Packet (Max 65535) (Network Order) |
Id:Word;
|
Incremented with each Packet (Network Order) |
FragOffset:Word;
|
and IP Header Flags DF, MF etc (Network Order) |
TTL:Byte;
|
Time to Live Seconds/Hops |
Protocol:Byte;
|
IPPROTO_IP, IPPROTO_TCP etc |
Checksum:Word;
|
1s Compliment checksum |
SourceIP:TInAddr;
|
Source IP (Network Order) |
DestIP:TInAddr;
|
Destination IP (Network Order) |
IP timestamp address
PIPTimestampAddress = ^TIPTimestampAddress;
TIPTimestampAddress = packed record
Address:TInAddr;
|
|
Timestamp:LongWord;
|
IP timestamp
PIPTimestamp = ^TIPTimestamp;
TIPTimestamp = packed record
Code:Byte;
|
IPOPT_TS |
Length:Byte;
|
Size of structure (Variable) |
Index:Byte;
|
Index of current entry |
FlagsOverflow:Byte;
|
Flags (4 Bits) Overflow counter (4 Bits) |
case Integer of
|
|
0:(Timestamp:LongWord);
|
|
1:(TimestampAddress:TIPTimestampAddress);
|
IP pseudo
PIPPseudo = ^TIPPseudo;
TIPPseudo = packed record
| Note: 12 Bytes (Used by UDP/TCP Checksum) | |
SourceIP:TInAddr;
|
Source IP Network Order |
DestIP:TInAddr;
|
Destination IP Network Order |
Mbz:Byte;
|
Must Be Zero |
Protocol:Byte;
|
IP Protocol Type IPPROTO_UDP, IPPROTO_TCP etc |
Length:Word;
|
Length of UDP/TCP Header and Data |
IP fragment
PIPFragment = ^TIPFragment;
TIPFragment = record
| Note: 12 Bytes (Used by Fragment Buffer) | |
Offset:Word;
|
Offset of this Fragment in the Packet |
Size:Word;
|
Size of this Fragment |
Prev:PIPFragment;
|
Pointer to Prev Fragment |
Next:PIPFragment;
|
Pointer to Next Fragment |
IP packet
PIPPacket = ^TIPPacket;
TIPPacket = record
| Note: 56 Bytes (Used by Fragment Buffer) | |
Lock:TMutexHandle;
|
Packet Lock |
Id:Word;
|
IP Id |
Protocol:Word;
|
IP Protocol |
Dest:TInAddr;
|
IP Dest |
Source:TInAddr;
|
IP Source |
Data:Pointer;
|
Pointer to Data |
Timeout:Int64;
|
Packet Timeout |
Total:Word;
|
IP Total Length |
Length:Word;
|
IP Header Length |
Received:Word;
|
Received Bytes |
Prev:PIPPacket;
|
Pointer to Prev Packet |
Next:PIPPacket;
|
Pointer to Next Packet |
First:PIPFragment;
|
Pointer to First Fragment |
Last:PIPFragment;
|
Pointer to Last Fragment |
Class definitions
IP specific classes
TIPBuffer = class(TTransportBufferEx)
|
TIPTransportAdapter = class(TTransportAdapter)
|
TIPTransportBinding = class(TTransportBinding)
|
TIPTransportProtocol = class(TTransportProtocol)
|
TIPTransportFilter = class(TTransportFilter)
|
TIPTransportConfig = class(TTransportConfig)
|
TIPTransport = class(TNetworkTransport)
|
TIPState = class(TTransportState)
|
TIPOptions = class(TTransportOptions)
|
TIPHostEntry = class(THostEntry)
|
TIPRouteEntry = class(TRouteEntry)
|
TIPAddressEntry = class(TAddressEntry)
|
TIPNetworkEntry = class(TNetworkEntry)
|
TIPServEntry = class(TServEntry)
|
TIPProtoEntry = class(TProtoEntry)
|
Public variables
None defined
Function declarations
Initialization functions
procedure IPInit;
Description: To be documented
| Note | None documented |
|---|
IP functions
function CheckIP(ABuffer:Pointer):Boolean;
Description: Verify that the packet is a valid IP packet
| Buffer | Complete packet without Adapter header |
|---|
function GetIPHeaderOffset(ABuffer:Pointer):Word;
Description: Return Start of the IP Header (Start of Packet)
| Buffer | Complete packet including Transport header |
|---|
function GetIPHeaderLength(ABuffer:Pointer):Word;
Description: Return Size of IP Header (Including Options)
| Buffer | Complete packet including Transport header |
|---|
function GetIPOptionsLength(ABuffer:Pointer):Word;
Description: Return Size of IP Options (Header - IP_HEADER_SIZE)
| Buffer | Complete packet including Transport header |
|---|
function GetIPDataOffset(ABuffer:Pointer):Word;
Description: Return Start of IP Packet Data (Length of IP Header)
| Buffer | Complete packet including Transport header |
|---|
function GetIPDataLength(ABuffer:Pointer):Word;
Description: Return Size of IP Packet Data (IP TotalLength - IP Header)
| Buffer | Complete packet including Transport header |
|---|
function ChecksumIPRecv(ABuffer:Pointer; AOffset,ALength:Word):Word;
Description: Validate the IP Header and Options Checksum on Receive
| Buffer | Complete packet including Transport header |
|---|
function ChecksumIPSend(AHeader,AOptions:Pointer; ALength:Word):Word;
Description: Checksum the IP Header and Options on Send
| Buffer | Complete packet including Transport header |
|---|
Return to Unit Reference
