Unit UDP

Return to Unit Reference

Description

---

Ultibo UDP (User Datagram Protocol) unit

To be documented

Constants

---

[Expand]

UDP specific constants UDP_*

Note: Some UDP definitions are in the Protocol or IP modules
UDP_PROTOCOL_NAME = 'UDP';
MIN_UDP_PACKET = 8;	Not Counting Adapter and Transport Header
MAX_UDP_PACKET = 8192;	Not Counting Adapter and Transport Header
UDP_TIMEOUT = 0;	Wait forever on a UDP Read
UDP_BUFFER_SIZE = 65536;	UDP Receive Buffer Size
UDP_MAX_PORT = 65536;
UDP_HEADER_SIZE = 8;	SizeOf(TUDPHeader);
UDP_DATAGRAM_SIZE = 8;	SizeOf(TUDPDatagram)

[Expand]

UDP socket option constants

See Sockets.pas

[Expand]

UDP port constants UDP_PORT_*

UDP_PORT_START = 49152;	First dynamic port (Previously 1024) As per IANA assignment
UDP_PORT_STOP = 65534;	Last dynamic port (Previously 5000) Short of IANA assignment to allow for rollover

Type definitions

---

To be documented

Class definitions

---

To be documented

Public variables

---

None defined

Function declarations

---

Initialization Functions

[Expand]

procedure UDPInit;

Description: To be documented

Note	None documented

UDP functions

[Expand]

function CheckUDP(AFamily:Word; ABuffer:Pointer):Boolean;

Description: Verify that the packet is a valid UDP packet

Buffer	The complete packet including Transport header
Note	If checksum is zero then no checksum was added, return True

[Expand]

function GetUDPHeaderOffset(AFamily:Word; ABuffer:Pointer):Word;

Description: To be documented

Buffer	The complete packet including Transport header

[Expand]

function GetUDPHeaderLength(AFamily:Word; ABuffer:Pointer):Word;

Description: To be documented

Buffer	The complete packet including Transport header

[Expand]

function GetUDPDataOffset(AFamily:Word; ABuffer:Pointer):Word;

Description: To be documented

Buffer	The complete packet including Transport header

[Expand]

function GetUDPDataLength(AFamily:Word; ABuffer:Pointer):Word;

Description: To be documented

Buffer	The complete packet including Transport header

[Expand]

function ChecksumUDPRecv(AFamily:Word; APseudo:PIPPseudo; ABuffer:Pointer; AOffset,ALength:Word):Word;

Description: Validate the Checksum of UDP Pseudo, Header and Data on Receive

Note	None documented

[Expand]

function ChecksumUDPSend(AFamily:Word; APseudo:PIPPseudo; AHeader:PUDPHeader; AData:Pointer; ALength:Word):Word;

Description: Checksum the UDP Pseudo, Header and Data on Send

Note	None documented

Return to Unit Reference