Socket methods syntax: Difference between revisions
m (Automatically generated page update) |
m (Automatically generated page update) |
||
Line 16: | Line 16: | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal"> =</span> <span class="literal">%(Socket):[[Num (Socket function)|Num]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal"> =</span> <span class="literal">%(Socket):[[Num (Socket function)|Num]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="literal">%(Socket):[[OnReset (Socket function)|OnReset]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">label</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="literal">%(Socket):[[OnReset (Socket function)|OnReset]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">label</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%bytesReceived</span><span class="literal"> =</span> <span class="term">socket</span><span class="literal">:[[Receive (Socket function)|Receive]]</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="String">Target=</span><span class="squareb">]</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="Number">MaxBytes=</span><span class="squareb">]</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="Number">MinBytes=</span><span class="squareb">]</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="String">Options=</span><span class="squareb">]</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span></p> | <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="Number">MinBytes=</span><span class="squareb">]</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="String">Options=</span><span class="squareb">]</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%bytesReceived</span><span class="literal"> =</span> <span class="term">socket</span><span class="literal">:[[ReceiveAndParse (Socket function)|ReceiveAndParse]]</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="String">Target=</span><span class="squareb">]</span> <span class="term" title="String">string</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="Number">MaxBytes=</span><span class="squareb">]</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> - | <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="Number">MaxBytes=</span><span class="squareb">]</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="Number">ParseTokenIndex=</span><span class="squareb">]</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> - | <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="Number">ParseTokenIndex=</span><span class="squareb">]</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="String">Options=</span><span class="squareb">]</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span></p> | <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="String">Options=</span><span class="squareb">]</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%bytesReceived</span><span class="literal"> =</span> <span class="term">socket</span><span class="literal">:[[ReceiveAsynchronous (Socket function)|ReceiveAsynchronous]]</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="String">Target=</span><span class="squareb">]</span> <span class="term" title="String">string</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="Number">MaxBytes=</span><span class="squareb">]</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> - | <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="Number">MaxBytes=</span><span class="squareb">]</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="String">Options=</span><span class="squareb">]</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="comma">,</span> - | <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="String">Options=</span><span class="squareb">]</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="Boolean">Wait=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="literal">)</span></p> | <span class="squareb">[</span><span class="literal" title="Boolean">Wait=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="literal">)</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%receivedFin</span><span class="literal"> =</span> <span class="term">socket</span><span class="literal">:[[ReceivedFin (Socket function)|ReceivedFin]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">socket</span><span class="literal">:[[SSLOn (Socket function)|SSLOn]]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">socket</span><span class="literal">:[[SSLOn (Socket function)|SSLOn]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">socket</span><span class="literal">:[[Send (Socket function)|Send]]</span><span class="literal">(</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="String">Options=</span><span class="squareb">]</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">socket</span><span class="literal">:[[Send (Socket function)|Send]]</span><span class="literal">(</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="String">Options=</span><span class="squareb">]</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span></p> |
Revision as of 15:03, 11 November 2012
The syntax for each of the Socket class methods is shown below.
Square brackets indicate optional elements of the method invocation. See also the notation conventions for methods and the List of Socket methods.
[%string =] socket:Capture( string)
%string = socket:CertInfo( string, [number])
%number = socket:CertLevels
%string = socket:Certificate[( [RequestCertificate= boolean])]
[%number =] socket:Close
%string = %(Socket):ErrInfo( string)
%number = socket:GetSocketNumber
%socket = [%(Socket):]GetSocketObject( number)
%string = socket:Info( string)
%socket = [%(Socket):]New[( [[ClientPort=] string], [[Host=] string], - [[Port=] number], [[SSL=] string], - [TcpKeepAlive= boolean])]
%string = %(Socket):Num[( [string])]
[%number =] %(Socket):OnReset[( [label])]
%bytesReceived = socket:Receive( [Target=] string, [[MaxBytes=] number], - [[MinBytes=] number], [[Options=] string])
%bytesReceived = socket:ReceiveAndParse( [Target=] string, - [[MaxBytes=] number], - [[ParseTokenIndex=] number], - [[Options=] string])
%bytesReceived = socket:ReceiveAsynchronous( [Target=] string, - [[MaxBytes=] number], - [[Options=] string], - [Wait= boolean])
%receivedFin = socket:ReceivedFin
[%number =] socket:SSLOn
[%number =] socket:Send( string, [[Options=] string])
[%number =] socket:SendWithLineEnd( string, [[Options=] string])
%socket = [%(Socket):]ServerSocket
[%string =] socket:Set( keyword, [value])
%string = socket:TranIn( string)
%string = socket:TranOut( string)
%string = socket:URLEncode( string)