TUDPProtocol - Revision history

Ultibo at 01:32, 31 May 2018

2018-05-31T01:32:30Z

Ultibo: Created page with "Return to Unit UDP TOC === Description === ---- ''To be documented'' === Class definitions === ----

2018-05-31T01:31:40Z

Created page with "Return to Unit UDP TOC === Description === ---- ''To be documented'' === Class definitions === ---- <div class="toccolours mw-collapsible mw-collapsed"..."

New page
Return to [[Unit_UDP|Unit UDP]]

TOC

=== Description ===
----

''To be documented''

=== Class definitions ===
----

<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%;"| 
|-
| <code>destructor Destroy; override;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
|-
| <code>FNextPort:Word;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
|-
| <code>function PacketHandler(AHandle:THandle; ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
|-
| <code>function OpenPort(ASocket:TProtocolSocket; APort:Word):Boolean; override;</code>
|  
|-
| <code>function ClosePort(ASocket:TProtocolSocket):Boolean; override;</code>
|  
|-
| <code>function FindPort(APort:Word; AWrite,ALock:Boolean):TProtocolPort; override;</code>
|  
|-
|colspan="2"| 
|-
| <code>function SelectCheck(ASource,ADest:PFDSet; ACode:Integer):Integer; override;</code>
|  
|-
| <code>function SelectWait(ASocket:TProtocolSocket; ACode:Integer; ATimeout:LongWord):Integer; override;</code>
|  
|-
|colspan="2"| 
|-
| <code>function SendPacket(ASocket:TProtocolSocket; ASource,ADest:Pointer; ASourcePort,ADestPort:Word; APacket:PPacketFragment; ASize,AFlags:Integer):Integer; override;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>function Accept(ASocket:TProtocolSocket; ASockAddr:PSockAddr; AAddrLength:PInteger):TProtocolSocket; override;</code>
|  
|-
| <code>function Bind(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; AAddrLength:Integer):Integer; override;</code>
|  
|-
| <code>function CloseSocket(ASocket:TProtocolSocket):Integer; override;</code>
|  
|-
| <code>function Connect(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; AAddrLength:Integer):Integer; override;</code>
|  
|-
| <code>function IoctlSocket(ASocket:TProtocolSocket; ACmd:DWORD; var AArg:u_long):Integer; override;</code>
|  
|-
| <code>function GetPeerName(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; var AAddrLength:Integer):Integer; override;</code>
|  
|-
| <code>function GetSockName(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; var AAddrLength:Integer):Integer; override;</code>
|  
|-
| <code>function GetSockOpt(ASocket:TProtocolSocket; ALevel,AOptName:Integer; AOptValue:PChar; var AOptLength:Integer):Integer; override;</code>
|  
|-
| <code>function Listen(ASocket:TProtocolSocket; ABacklog:Integer):Integer; override;</code>
|  
|-
| <code>function Recv(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer):Integer; override;</code>
|  
|-
| <code>function RecvFrom(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer; var AFromAddr:TSockAddr; var AFromLength:Integer):Integer; override;</code>
|  
|-
| <code>function Select(ANfds:Integer; AReadfds,AWritefds,AExceptfds:PFDSet; ATimeout:PTimeVal):LongInt; override;</code>
|  
|-
| <code>function Send(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer):Integer; override;</code>
|  
|-
| <code>function SendTo(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer; var AToAddr:TSockAddr; AToLength:Integer):Integer; override;</code>
|  
|-
| <code>function SetSockOpt(ASocket:TProtocolSocket; ALevel,AOptName:Integer; AOptValue:PChar; AOptLength:Integer):Integer; override;</code>
|  
|-
| <code>function Shutdown(ASocket:TProtocolSocket; AHow:Integer):Integer; override;</code>
|  
|-
| <code>function Socket(AFamily,AStruct,AProtocol:Integer):TProtocolSocket; override;</code>
|  
|-
|colspan="2"| 
|-
| <code>function AddTransport(ATransport:TNetworkTransport):Boolean; override;</code>
|  
|-
| <code>function RemoveTransport(ATransport:TNetworkTransport):Boolean; override;</code>
|  
|-
|colspan="2"| 
|-
| <code>function FindSocket(AFamily,AStruct,AProtocol:Word; ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast,AListen,ALock:Boolean; AState:LongWord):TProtocolSocket; override;</code>
|  
|-
| <code>procedure FlushSockets(All:Boolean); override;</code>
|  
|-
|colspan="2"| 
|-
| <code>function StartProtocol:Boolean; override;</code>
|  
|-
| <code>function StopProtocol:Boolean; override;</code>
|  
|-
| <code>function ProcessProtocol:Boolean; override;</code>
|  
|-
|}
</div></div>
<br />

=== Function declarations ===
----

<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;">constructor TUDPProtocol.Create(AManager:TProtocolManager; const AName:String);</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 />
<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;">destructor TUDPProtocol.Destroy;</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 />
<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;">function TUDPProtocol.PacketHandler(AHandle:THandle; ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Process a packet received by a Transport</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Handle
| The Handle of the Protocol Transport the packet was received from
|-
! Source
| The source address of the received packet (Set by Transport)
|-
! Dest
| The destination address of the received packet (Set by Transport)
|-
! Packet
| The received packet (The complete packet including Transport header)
|-
! Size
| The size of the received packet in bytes
|-
! Broadcast
| True if the destination address is a broadcast address
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.OpenPort(ASocket:TProtocolSocket; APort:Word):Boolean;</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
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.ClosePort(ASocket:TProtocolSocket):Boolean;</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
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.FindPort(APort:Word; AWrite,ALock:Boolean):TProtocolPort;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find a protocol port for the specified port number</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Port
| The port number to find
|-
! Write
| If True then use the writer lock
|-
! Lock
| If True then lock the found entry before returning
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.SelectCheck(ASource,ADest:PFDSet; ACode:Integer):Integer;</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;"
|-
! Source
| Source is the working set to check
|-
! Dest
| Dest is the set passed to Select
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.SelectWait(ASocket:TProtocolSocket; ACode:Integer; ATimeout:LongWord):Integer;</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;"
|-
! Socket
| Socket is the single socket to check
|-
! Code
| Code is the type of check
|-
! Timeout
| Timeout is how long to wait
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.SendPacket(ASocket:TProtocolSocket; ASource,ADest:Pointer; ASourcePort,ADestPort:Word; APacket:PPacketFragment; ASize,AFlags:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Send a Packet by adding the Protocol Header and other details to the Data</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to use for sending the packet
|-
! Source
| The source address of the packet (Host Order)
|-
! Dest
| The destination address of the packet (Host Order)
|-
! SourcePort
| The source port of the packet (Host Order)
|-
! DestPort
| The destination port of the packet (Host Order)
|-
! Packet
| The packet data to send
|-
! Size
| The size of the packet data in bytes
|-
! Flags
| Any protocol specific flags for sending
|-
! Note
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.Accept(ASocket:TProtocolSocket; ASockAddr:PSockAddr; AAddrLength:PInteger):TProtocolSocket;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Accept</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to accept from
|-
! SockAddr
| The socket address (Network Order)
|-
! AddrLength
| The socket address length
|-
! Note
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.Bind(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; AAddrLength:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Bind</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to bind
|-
! SockAddr
| The socket address (Network Order)
|-
! AddrLength
| The socket address length
|-
! Note
| Sets the LocalAddress/Port for future Sends and Receives, Address can be specified as INADDR_ANY which allows Listening or auto assignment. If Port is IPPORT_ANY then a dynamic Port will be assigned.
Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.CloseSocket(ASocket:TProtocolSocket):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Close Socket</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to close
|-
! Note
| Closes and removes the socket, does not perform Linger
Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.Connect(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; AAddrLength:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Connect</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to connect
|-
! SockAddr
| The socket address (Network Order)
|-
! AddrLength
| The socket address length
|-
! Note
| Sets the RemoteAddress/Port of future Sends and Receives, if Bind has not been called then the LocalAddress/Port will be set appropriately as well based on the route to the RemoteAddress.
Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.IoctlSocket(ASocket:TProtocolSocket; ACmd:DWORD; var AArg:u_long):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible IO Control Socket</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to control
|-
! Cmd
| The socket command
|-
! Arg
| The command argument
|-
! Note
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.GetPeerName(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; var AAddrLength:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Get Peer Name (Remote)</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to get from
|-
! SockAddr
| The socket address (Network Order)
|-
! AddrLength
| The socket address length
|-
! Note
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.GetSockName(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; var AAddrLength:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Get Sock Name (Local)</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to get from
|-
! SockAddr
| The socket address (Network Order)
|-
! AddrLength
| The socket address length
|-
! Note
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.GetSockOpt(ASocket:TProtocolSocket; ALevel,AOptName:Integer; AOptValue:PChar; var AOptLength:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Get Socket Option</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to get the option from
|-
! Level
| The protocol level for the option
|-
! OptName
| The name of the option to get
|-
! OptValue
| The value of the option
|-
! OptLength
| The length of the option
|-
! Note
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.Listen(ASocket:TProtocolSocket; ABacklog:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Listen</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to listen on
|-
! Backlog
| Queue depth for accepted connections
|-
! Note
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.Recv(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Receive</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to receive from
|-
! Buffer
| Buffer for received data
|-
! Length
| Length of buffer in bytes
|-
! Flags
| Protocol specific receive flags
|-
! Note
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.RecvFrom(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer; var AFromAddr:TSockAddr; var AFromLength:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Receive From</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to receive from
|-
! Buffer
| Buffer for received data
|-
! Length
| Length of buffer in bytes
|-
! Flags
| Protocol specific receive flags
|-
! FromAddr
| The address the data was received from (Network Order)
|-
! FromLength
| The length of the address
|-
! Note
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.Send(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Send</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to send to
|-
! Buffer
| Buffer for data to send
|-
! Length
| Length of buffer in bytes
|-
! Flags
| Protocol specific send flags
|-
! Note
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.SendTo(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer; var AToAddr:TSockAddr; AToLength:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Send To</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to send to
|-
! Buffer
| Buffer for data to send
|-
! Length
| Length of buffer in bytes
|-
! Flags
| Protocol specific send flags
|-
! ToAddr
| The socket address to send to (Network Order)
|-
! ToLength
| The length of the socket address
|-
! Note
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.SetSockOpt(ASocket:TProtocolSocket; ALevel,AOptName:Integer; AOptValue:PChar; AOptLength:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Set Socket Option</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to set the option for
|-
! Level
| The protocol level for the option
|-
! OptName
| The name of the option to set
|-
! OptValue
| The value of the option
|-
! OptLength
| The length of the option
|-
! Note
| Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.Shutdown(ASocket:TProtocolSocket; AHow:Integer):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Shutdown</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Socket
| The socket to shutdown
|-
! How
| The direction to shutdown the socket
|-
! Note
| Shutdown does not result in CloseSocket so Closed must not get set
Caller must hold the Socket lock
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.Socket(AFamily,AStruct,AProtocol:Integer):TProtocolSocket;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' BSD compatible Socket (Create a new socket)</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Family
| Socket address family (eg AF_INET)
|-
! Struct
| Socket type (eg SOCK_DGRAM)
|-
! Protocol
| Socket protocol (eg IPPROTO_UDP)
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.AddTransport(ATransport:TNetworkTransport):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a transport to this protocol</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Transport
| The transport to add
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.RemoveTransport(ATransport:TNetworkTransport):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove a transport from this protocol</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Transport
| The transport to remove
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.FindSocket(AFamily,AStruct,AProtocol:Word; ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast,AListen,ALock:Boolean; AState:LongWord):TProtocolSocket;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find a protocol socket based on all relevant parameters</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Family
| Socket address family (eg AF_INET)
|-
! Struct
| Socket type (eg SOCK_DGRAM)
|-
! Protocol
| Socket protocol (eg IPPROTO_UDP)
|-
! LocalAddress
| Local transport address to match (Host Order)
|-
! RemoteAddress
| Remote transport address to match (Host Order)
|-
! LocalPort
| Local port to match (Host Order)
|-
! RemotePort
| Remote port to match (Host Order)
|-
! Broadcast
| If True then match broadcast addresses
|-
! Listen
| If True then match only listening sockets
|-
! Lock
| If True then lock the found entry before returning
|-
|}
</div></div>
<br />
<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 TUDPProtocol.FlushSockets(All:Boolean);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Flush sockets from the socket cache</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! All
| If True flush all sockets, otherwise flush expired sockets.
|-
|}
</div></div>
<br />
<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;">function TUDPProtocol.StartProtocol:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Start this protocol ready for sending and receiving</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 />
<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;">function TUDPProtocol.StopProtocol:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Stop this protocol ready for removal</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 />
<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;">function TUDPProtocol.ProcessProtocol:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Process periodic tasks for this protocol</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]]