Socket methods syntax: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
(Automatically generated page update)
 
(2 intermediate revisions by the same user not shown)
Line 27: Line 27:
                                             <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">%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="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="term">%opCode</span><span class="literal"> =</span> <span class="term">socket</span><span class="literal">:[[ReceiveWebSocket (Socket function)|ReceiveWebSocket]]</span><span class="literal">(</span> <span class="term" title="String">string</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>
<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">:[[SendWebSocket (Socket function)|SendWebSocket]]</span><span class="literal">(</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="term" title="Number">number</span><span class="comma">,</span> <span class="term" title="Boolean">boolean</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">:[[SendWithLineEnd (Socket function)|SendWithLineEnd]]</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">:[[SendWithLineEnd (Socket function)|SendWithLineEnd]]</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="term">%socket</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Socket):</span><span class="squareb">]</span><span class="literal">[[ServerSocket (Socket function)|ServerSocket]]</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">%socket</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Socket):</span><span class="squareb">]</span><span class="literal">[[ServerSocket (Socket function)|ServerSocket]]</span></p>
Line 35: Line 37:
<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="term">socket</span><span class="literal">:[[TranOut (Socket function)|TranOut]]</span><span class="literal">(</span> <span class="term" title="String">string</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">%string</span><span class="literal"> =</span> <span class="term">socket</span><span class="literal">:[[TranOut (Socket function)|TranOut]]</span><span class="literal">(</span> <span class="term" title="String">string</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">%string</span><span class="literal"> =</span> <span class="term">socket</span><span class="literal">:[[URLEncode (Socket function)|URLEncode]]</span><span class="literal">(</span> <span class="term" title="String">string</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">%string</span><span class="literal"> =</span> <span class="term">socket</span><span class="literal">:[[URLEncode (Socket function)|URLEncode]]</span><span class="literal">(</span> <span class="term" title="String">string</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">%socket</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Socket):</span><span class="squareb">]</span><span class="literal">[[WebSocket (Socket function)|WebSocket]]</span></p>

Latest revision as of 17:24, 12 August 2019

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:Certificate[( [RequestCertificate= boolean])]

%string = socket:CertInfo( string, [number])

%number = socket:CertLevels

[%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

%opCode = socket:ReceiveWebSocket( string)

[%number =] socket:Send( string, [[Options=] string])

[%number =] socket:SendWebSocket( string, number, boolean)

[%number =] socket:SendWithLineEnd( string, [[Options=] string])

%socket = [%(Socket):]ServerSocket

[%string =] socket:Set( keyword, [value])

[%number =] socket:SSLOn

%string = socket:TranIn( string)

%string = socket:TranOut( string)

%string = socket:URLEncode( string)

%socket = [%(Socket):]WebSocket