TWinsock2TCPClient - Revision history

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

2018-06-06T04:14:16Z

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

New page
Return to [[Unit_Winsock2|Unit Winsock2]]

TOC

=== Description ===
----

''To be documented''

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

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

<code>TWinsock2TCPClient = class(TWinsock2TCPSocket)</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|Note: Stream Client classes
|-
|colspan="2"| 
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>constructor Create;</code>
| style="width: 50%;"| 
|-
| <code>destructor Destroy; override;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
|-
| <code>FRemotePort:Word;</code>
|  
|-
| <code>FRemoteHost:String;</code>
|  
|-
| <code>FRemoteAddress:String;</code>
|  
|-
|colspan="2"| 
|-
| <code>procedure SetFamily(AFamily:Integer); override;</code>
|  
|-
|colspan="2"| 
|-
| <code>procedure SetBoundAddress(const ABoundAddress:String); override;</code>
|  
|-
|colspan="2"| 
|-
| <code>procedure SetRemotePort(ARemotePort:Word);</code>
|  
|-
| <code>procedure SetRemoteHost(const ARemoteHost:String);</code>
|  
|-
| <code>procedure SetRemoteAddress(const ARemoteAddress:String);</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
|-
| <code>function AllocateFamily:Boolean; override;</code>
|  
|-
|colspan="2"| 
|-
| <code>function AllocateRemoteAddress(var ALength:Integer):PSockAddr;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>property RemotePort:Word read FRemotePort write SetRemotePort;</code>
|  
|-
| <code>property RemoteHost:String read FRemoteHost write SetRemoteHost;</code>
|  
|-
| <code>property RemoteAddress:String read FRemoteAddress write SetRemoteAddress;</code>
|  
|-
|colspan="2"| 
|-
| <code>function Connect:Boolean; virtual;</code>
|  
|-
| <code>function ConnectEx:Boolean; virtual;</code>
|  
|-
| <code>function Disconnect: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 TWinsock2TCPClient.Create;</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 TWinsock2TCPClient.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 TWinsock2TCPClient.SetFamily(AFamily: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 TWinsock2TCPClient.SetBoundAddress(const ABoundAddress: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;">procedure TWinsock2TCPClient.SetRemotePort(ARemotePort: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 TWinsock2TCPClient.SetRemoteHost(const ARemoteHost: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;">procedure TWinsock2TCPClient.SetRemoteAddress(const ARemoteAddress: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;">function TWinsock2TCPClient.AllocateFamily:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check Family, Bound Address and Remote Address, normalise as needed</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 TWinsock2TCPClient.AllocateRemoteAddress(var ALength:Integer):PSockAddr;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a socket address structure for the remote address and port</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 TWinsock2TCPClient.Connect: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 TWinsock2TCPClient.ConnectEx:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Similar to Connect except will get all addresses for RemoteHost and try each one in turn</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 TWinsock2TCPClient.Disconnect: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 />

Return to [[Unit_Reference|Unit Reference]]