Difference between revisions of "Unit UDP"

From Ultibo.org
Jump to: navigation, search
Line 143: Line 143:
 
----
 
----
  
−
''To be documented''
+
 
 +
'''UDP protocol transport'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TUDPProtocolTransport = class(TProtocolTransport)</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''UDP protocol'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TUDPProtocol = class(TNetworkProtocol)</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>constructor Create(AManager:TProtocolManager; const AName:String);</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>destructor Destroy; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
| <code>FNextPort:Word;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function PacketHandler(AHandle:THandle; ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
 +
|-
 +
| <code>function AddTransport(ATransport:TNetworkTransport):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RemoveTransport(ATransport:TNetworkTransport):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function OpenPort(ASocket:TProtocolSocket; APort:Word):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ClosePort(ASocket:TProtocolSocket):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function FindPort(APort:Word; AWrite,ALock:Boolean):TProtocolPort; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function FindSocket(AFamily,AStruct,AProtocol:Word; ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast,AListen,ALock:Boolean; AState:LongWord):TProtocolSocket; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure FlushSockets(All:Boolean); override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function SelectCheck(ASource,ADest:PFDSet; ACode:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function SendPacket(ASocket:TProtocolSocket; ASource,ADest:Pointer; ASourcePort,ADestPort:Word; APacket:PPacketFragment; ASize,AFlags:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>function Accept(ASocket:TProtocolSocket; ASockAddr:PSockAddr; AAddrLength:PInteger):TProtocolSocket; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function Bind(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; AAddrLength:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function CloseSocket(ASocket:TProtocolSocket):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function Connect(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; AAddrLength:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function IoctlSocket(ASocket:TProtocolSocket; ACmd:DWORD; var AArg:u_long):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetPeerName(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; var AAddrLength:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetSockName(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; var AAddrLength:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetSockOpt(ASocket:TProtocolSocket; ALevel,AOptName:Integer; AOptValue:PChar; var AOptLength:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function Listen(ASocket:TProtocolSocket; ABacklog:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function Recv(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function RecvFrom(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer; var AFromAddr:TSockAddr; var AFromLength:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function Select(ANfds:Integer; AReadfds,AWritefds,AExceptfds:PFDSet; ATimeout:PTimeVal):LongInt; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function Send(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SendTo(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer; var AToAddr:TSockAddr; AToLength:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SetSockOpt(ASocket:TProtocolSocket; ALevel,AOptName:Integer; AOptValue:PChar; AOptLength:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function Shutdown(ASocket:TProtocolSocket; AHow:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function Socket(AFamily,AStruct,AProtocol:Integer):TProtocolSocket; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function StartProtocol:Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function StopProtocol:Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ProcessProtocol:Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''UDP socket'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TUDPSocket = class(TProtocolSocket)</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|Note: SOCK_DGRAM
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>constructor Create(AProtocol:TNetworkProtocol; ATransport:TNetworkTransport);</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>destructor Destroy; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
| <code>FRecvData:TUDPBuffer;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property RecvData:TUDPBuffer read FRecvData;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetOption(ALevel,AOptName:Integer; AOptValue:PChar; var AOptLength:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SetOption(ALevel,AOptName:Integer; AOptValue:PChar; AOptLength:Integer):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function IoCtl(ACommand:DWORD; var AArgument:u_long):Integer; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function IsConnected(ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast:Boolean):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function IsListening(ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast:Boolean):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''UDP state'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TUDPState = class(TProtocolState)</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>constructor Create;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''UDP buffer'''
 +
 
 +
<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>
 +
 
 +
'''UDP options'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TUDPOptions = class(TProtocolOptions)</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|Note: For Get/Set Options Level = IPPROTO_UDP Option = ????
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>constructor Create;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
| <code>FOptions:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetNoChecksum:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetNoChecksum(ANoChecksum:Boolean);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property NoChecksum:Boolean read GetNoChecksum write SetNoChecksum;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
 
=== Public variables ===
 
=== Public variables ===

Revision as of 23:06, 22 March 2017

Return to Unit Reference


Description

Ultibo UDP (User Datagram Protocol) unit

To be documented

Constants


[Expand]
UDP specific constants UDP_*


[Expand]
UDP socket option constants


[Expand]
UDP port constants UDP_PORT_*


Type definitions


UDP header

[Expand]

PUDPHeader = ^TUDPHeader;

TUDPHeader = packed record

UDP datagram

[Expand]

PUDPDatagram = ^TUDPDatagram;

TUDPDatagram = record


Class definitions


UDP protocol transport

[Expand]

TUDPProtocolTransport = class(TProtocolTransport)

UDP protocol

[Expand]

TUDPProtocol = class(TNetworkProtocol)

UDP socket

[Expand]

TUDPSocket = class(TProtocolSocket)

UDP state

[Expand]

TUDPState = class(TProtocolState)

UDP buffer

[Expand]

TUDPBuffer = class(TSocketBuffer)

UDP options

[Expand]

TUDPOptions = class(TProtocolOptions)


Public variables

None defined

Function declarations


Initialization Functions

[Expand] 
procedure UDPInit;
Description: To be documented


UDP functions

[Expand] 
function CheckUDP(AFamily:Word; ABuffer:Pointer):Boolean;
Description: Verify that the packet is a valid UDP packet


[Expand] 
function GetUDPHeaderOffset(AFamily:Word; ABuffer:Pointer):Word;
Description: To be documented


[Expand] 
function GetUDPHeaderLength(AFamily:Word; ABuffer:Pointer):Word;
Description: To be documented


[Expand] 
function GetUDPDataOffset(AFamily:Word; ABuffer:Pointer):Word;
Description: To be documented


[Expand] 
function GetUDPDataLength(AFamily:Word; ABuffer:Pointer):Word;
Description: To be documented


[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


[Expand] 
function ChecksumUDPSend(AFamily:Word; APseudo:PIPPseudo; AHeader:PUDPHeader; AData:Pointer; ALength:Word):Word;
Description: Checksum the UDP Pseudo, Header and Data on Send


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_UDP&oldid=2640"