Ultibo at 05:39, 30 May 2018

2018-05-30T05:39:49Z

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

2018-05-30T05:38:48Z

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

New page

Return to [[Unit_Transport|Unit Transport]]

TOC

=== Description ===
----

''To be documented''

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

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

<code>TTransportSocket = class(TListObject)</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>constructor Create(ATransport:TNetworkTransport);</code>
| style="width: 50%;"| 
|-
| <code>destructor Destroy; override;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
|-
| <code>FLock:TSynchronizerHandle;</code>
|  
|-
| <code>FLocalLock:TMutexHandle;</code>
|  
|-
|colspan="2"| 
|-
| <code>procedure SetFamily(AFamily:Word);</code>
|  
|-
| <code>procedure SetStruct(AStruct:Word);</code>
|  
|-
| <code>procedure SetProto(AProto:Word);</code>
|  
|-
| <code>procedure SetOwner(AOwner:TSocketList);</code>
|  
|-
|colspan="2"| 
|-
| <code>procedure SetSocketError(ASocketError:Integer);</code>
|  
|-
| <code>procedure SetOpenTime(const AOpenTime:Int64);</code>
|  
|-
| <code>procedure SetCloseTime(const ACloseTime:Int64);</code>
|  
|-
| <code>procedure SetLingerTime(const ALingerTime:Int64);</code>
|  
|-
| <code>procedure SetTimewaitTime(const ATimewaitTime:Int64);</code>
|  
|-
| <code>procedure SetKeepAliveTime(const AKeepAliveTime:Int64);</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
|-
| <code>FTransport:TNetworkTransport;</code>
|  
|-
|colspan="2"| 
|-
| <code>FFamily:Word;</code>
| AF_INET, AF_INET6, AF_IPX etc
|-
| <code>FStruct:Word;</code>
| SOCK_STREAM, SOCK_DGRAM etc
|-
| <code>FProto:Word;</code>
| IPPROTO_UDP, IPPROTO_TCP etc
|-
| <code>FOwner:TSocketList;</code>
| List that this Socket belongs to (eg AcceptQueue)
|-
|colspan="2"| 
|-
| <code>FSocketError:Integer;</code>
| CONN_REFUSED etc
|-
| <code>FSocketState:TSocketState;</code>
| SS_UNCONNECTED, SS_ISCONNECTED etc
|-
| <code>FSocketOptions:TSocketOptions;</code>
| SO_ACCEPTCONN, SO_BROADCAST etc
|-
| <code>FOpenTime:Int64;</code>
| Socket was Opened ar [msec] (TCP_STATE_ESTAB)
|-
| <code>FCloseTime:Int64;</code>
| Socket was Closed at [msec] (TCP_STATE_CLOSED)
|-
| <code>FLingerTime:Int64;</code>
| Went into Linger at [msec]
|-
| <code>FTimewaitTime:Int64;</code>
| Went into Timewait at [msec] (TCP_STATE_TIMEWAIT)
|-
| <code>FKeepAliveTime:Int64;</code>
| Last KeepAlive Packet at [msec]
|-
|colspan="2"| 
|-
| <code>FTransportState:TTransportState;</code>
|  
|-
| <code>FTransportOptions:TTransportOptions;</code>
|  
|-
|colspan="2"| 
|-
| <code>function AcquireLock:Boolean;</code>
|  
|-
| <code>function ReleaseLock:Boolean;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>property Family:Word read FFamily write SetFamily;</code>
|  
|-
| <code>property Struct:Word read FStruct write SetStruct;</code>
|  
|-
| <code>property Proto:Word read FProto write SetProto;</code>
|  
|-
| <code>property Owner:TSocketList read FOwner write SetOwner;</code>
|  
|-
|colspan="2"| 
|-
| <code>property SocketError:Integer read FSocketError write SetSocketError;</code>
|  
|-
| <code>property SocketState:TSocketState read FSocketState;</code>
|  
|-
| <code>property SocketOptions:TSocketOptions read FSocketOptions;</code>
|  
|-
| <code>property OpenTime:Int64 read FOpenTime write SetOpenTime;</code>
|  
|-
| <code>property CloseTime:Int64 read FCloseTime write SetCloseTime;</code>
|  
|-
| <code>property LingerTime:Int64 read FLingerTime write SetLingerTime;</code>
|  
|-
| <code>property TimewaitTime:Int64 read FTimewaitTime write SetTimewaitTime;</code>
|  
|-
| <code>property KeepAliveTime:Int64 read FKeepAliveTime write SetKeepAliveTime;</code>
|  
|-
|colspan="2"| 
|-
| <code>property TransportState:TTransportState read FTransportState;</code>
|  
|-
| <code>property TransportOptions:TTransportOptions read FTransportOptions;</code>
|  
|-
|colspan="2"| 
|-
| <code>property Transport:TNetworkTransport read FTransport;</code>
|  
|-
|colspan="2"| 
|-
| <code>function GetOption(ALevel,AOptName:Integer; AOptValue:PChar; var AOptLength:Integer):Integer; virtual;</code>
|  
|-
| <code>function SetOption(ALevel,AOptName:Integer; AOptValue:PChar; AOptLength:Integer):Integer; virtual;</code>
|  
|-
| <code>function IoCtl(ACommand:DWORD; var AArgument:u_long):Integer; virtual;</code>
|  
|-
|colspan="2"| 
|-
| <code>function IsConnected(ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast:Boolean):Boolean; virtual;</code>
|  
|-
| <code>function IsListening(ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast:Boolean):Boolean; virtual;</code>
|  
|-
|colspan="2"| 
|-
| <code>function ReaderLock:Boolean;</code>
|  
|-
| <code>function ReaderUnlock:Boolean;</code>
|  
|-
| <code>function ReaderConvert:Boolean;</code>
|  
|-
| <code>function WriterLock:Boolean;</code>
|  
|-
| <code>function WriterUnlock:Boolean;</code>
|  
|-
| <code>function WriterConvert: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 TTransportSocket.Create(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 TTransportSocket.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 TTransportSocket.SetFamily(AFamily:Word);</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 TTransportSocket.SetStruct(AStruct:Word);</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 TTransportSocket.SetProto(AProto:Word);</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 TTransportSocket.SetOwner(AOwner:TSocketList);</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 TTransportSocket.SetSocketError(ASocketError: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 TTransportSocket.SetOpenTime(const AOpenTime:Int64);</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 TTransportSocket.SetCloseTime(const ACloseTime:Int64);</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 TTransportSocket.SetLingerTime(const ALingerTime:Int64);</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 TTransportSocket.SetTimewaitTime(const ATimewaitTime:Int64);</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 TTransportSocket.SetKeepAliveTime(const AKeepAliveTime:Int64);</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 TTransportSocket.AcquireLock: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
| 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 TTransportSocket.ReleaseLock: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
| 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 TTransportSocket.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 TTransportSocket.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 TTransportSocket.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 TTransportSocket.IsConnected(ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast:Boolean):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
| 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 TTransportSocket.IsListening(ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast:Boolean):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
| 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 TTransportSocket.ReaderLock: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
| 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 TTransportSocket.ReaderUnlock: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
| 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 TTransportSocket.ReaderConvert:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a Reader lock to a Writer lock</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 TTransportSocket.WriterLock: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
| 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 TTransportSocket.WriterUnlock: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
| 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 TTransportSocket.WriterConvert:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a Writer lock to a Reader lock</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]]

TTransportSocket - Revision history

Ultibo at 05:39, 30 May 2018