TTCPSocket - Revision history

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

2018-05-30T01:43:20Z

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

New page
Return to [[Unit_TCP|Unit TCP]]

TOC

=== Description ===
----

''To be documented''

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

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">

<code>TTCPSocket = 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_STREAM
|-
|colspan="2"| 
|-
| <code>constructor Create(AProtocol:TNetworkProtocol; ATransport:TNetworkTransport);</code>
| style="width: 50%;"| 
|-
| <code>destructor Destroy; override;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
|-
| <code>FBackLog:Integer;</code>
| Backlog size of Listen/Accept Queue
|-
| <code>FListener:TProtocolSocket;</code>
| The Listener socket for this socket (If applicable)
|-
| <code>FAcceptQueue:TSocketList;</code>
| Sockets waiting for connection Accept
|-
| <code>FReceiveQueue:TSocketList;</code>
| Sockets waiting for SYN/ACK handshake
|-
|colspan="2"| 
|-
| <code>FSendData:TTCPSendBuffer;</code>
|  
|-
| <code>FRecvData:TTCPRecvBuffer;</code>
|  
|-
|colspan="2"| 
|-
| <code>procedure SetBackLog(ABackLog:Integer);</code>
|  
|-
| <code>procedure SetListener(AListener:TProtocolSocket);</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>property BackLog:Integer read FBackLog write SetBackLog;</code>
|  
|-
| <code>property Listener:TProtocolSocket read FListener write SetListener;</code>
|  
|-
| <code>property AcceptQueue:TSocketList read FAcceptQueue;</code>
|  
|-
| <code>property ReceiveQueue:TSocketList read FReceiveQueue;</code>
|  
|-
|colspan="2"| 
|-
| <code>property SendData:TTCPSendBuffer read FSendData;</code>
|  
|-
| <code>property RecvData:TTCPRecvBuffer read FRecvData;</code>
|  
|-
|colspan="2"| 
|-
| <code>function GetOption(ALevel,AOptName:Integer; AOptValue:PChar; var AOptLength:Integer):Integer; override;</code>
|  
|-
| <code>function SetOption(ALevel,AOptName:Integer; AOptValue:PChar; AOptLength:Integer):Integer; override;</code>
|  
|-
| <code>function IoCtl(ACommand:DWORD; var AArgument:u_long):Integer; override;</code>
|  
|-
|colspan="2"| 
|-
| <code>function IsConnected(ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast:Boolean):Boolean; override;</code>
|  
|-
| <code>function IsListening(ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast:Boolean):Boolean; override;</code>
|  
|-
|colspan="2"| 
|-
| <code>function Listen:Boolean;</code>
|  
|-
| <code>function Connect:Boolean;</code>
|  
|-
| <code>function Reconnect:Boolean;</code>
|  
|-
| <code>function Disconnect:Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function Accept(APeek,ALock:Boolean; AState:LongWord):TTCPSocket;</code>
|  
|-
|colspan="2"| 
|-
| <code>function RecvSegment(ASequence,AAcknowledge:LongWord; AWindow,AUrgent:Word; AFlags:Byte; AData:Pointer; ASize:Word):Boolean;</code>
|  
|-
| <code>function SendSegment(var ASequence,AAcknowledge:LongWord; var AWindow,AUrgent:Word; var AFlags:Byte; var AData:Pointer; var ASize:Word):Boolean;</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 TTCPSocket.Create(AProtocol:TNetworkProtocol; ATransport:TNetworkTransport);</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 TTCPSocket.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;">procedure TTCPSocket.SetBackLog(ABackLog: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;"
|-
! 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;">procedure TTCPSocket.SetListener(AListener:TProtocolSocket);</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 TTCPSocket.GetOption(ALevel,AOptName:Integer; AOptValue:PChar; var AOptLength: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;"
|-
! Note
| With Socket Options that are Boolean 0 is False and > 0 is True
|-
|}
</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 TTCPSocket.SetOption(ALevel,AOptName:Integer; AOptValue:PChar; AOptLength: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;"
|-
! Note
| With Socket Options that are Boolean 0 is False and > 0 is True
|-
|}
</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 TTCPSocket.IoCtl(ACommand:DWORD; var AArgument:u_long):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;"
|-
! 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 TTCPSocket.IsConnected(ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast:Boolean):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check if this TCP Socket is Connected to the Host specified by RemoteAddress/Port</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| A connected Socket will have a Bound LocalAddress/Port and a Connected RemoteAddress/Port
|-
|}
</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 TTCPSocket.IsListening(ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast:Boolean):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check if this TCP Socket is Listening on the LocalAddress/Port specified</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| A listening Socket may or may not have a Bound LocalAddress/Port and will have a default (INADDR_ANY/IPPORT_ANY) RemoteAddress/Port
|-
|}
</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 TTCPSocket.Listen:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Used by Listen to setup the listening state</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Initiate listening for connections
|-
|}
</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 TTCPSocket.Connect:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Used by Connect to initiate outbound connection and Used by RecvSegment to respond to inbound connection</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Initiate a connection handshake (SYN/SYNACK/ACK)
|-
|}
</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 TTCPSocket.Reconnect:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Used by Connect to retry outbound connection</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Retry the connection handshake (SYN/SYNACK/ACK)
|-
|}
</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 TTCPSocket.Disconnect:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Used by CloseSocket/Shutdown to terminate outbound connection</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Initiate a disconnection handshake (FIN/ACK)
|-
|}
</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 TTCPSocket.Accept(APeek,ALock:Boolean; AState:LongWord):TTCPSocket;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Used by Accept/Select to receive an inbound connection</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Return the first Connected socket in the Accept Queue
|-
|}
</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 TTCPSocket.RecvSegment(ASequence,AAcknowledge:LongWord; AWindow,AUrgent:Word; AFlags:Byte; AData:Pointer; ASize:Word):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Used by Segment Handler to feed segments/acks to the Buffers</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| ACK/SEQ have passed initial check by the Segment Handler
Flags have passed a validity check by the Segment Handler
<br />Size can be zero, Data will then point to invalid or nil
<br />State transition and simultaneous Connect are done here
|-
|}
</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 TTCPSocket.SendSegment(var ASequence,AAcknowledge:LongWord; var AWindow,AUrgent:Word; var AFlags:Byte; var AData:Pointer; var ASize:Word):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Used by Process Socket to get segments/acks for Sending</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Size can return zero and Data can return nil
|-
|}
</div></div>
<br />

Return to [[Unit_Reference|Unit Reference]]