ReceiveWebSocket (Socket function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
 
Line 6: Line 6:
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%opCode</th><td>number</td></tr>
<tr><th>%opCode</th>
<td>number is an op code indicating the type of web socket frame. Numbers 0-7 are non-control frames. Numbers 8-15 are control frames. Control frames are always sent immediately and cannot be fragmented. Specifying a reserved code will cause immediate request cancellation.
<table>
<tr><th>0</th>
<td>A continuation frame. A continuation frame is treated as text or binary based on the op code of the first frame.</td></tr>
<tr><th>1</th>
<td>A text frame. Text frames are are translated to ASCII with the translate table in effect for the port.</td></tr>
<tr><th>2</th>
<td>A binary frame. No translation is done for binary frames.</td></tr>
<tr><th>3-7</th>
<td>Reserved for future use.</td></tr>
<tr><th>8</th>
<td>Connection close frame.</td></tr>
<tr><th>9</th>
<td>Ping. The receiver should respond with a Pong frame, unless a close frame has been received.</td></tr>
<tr><th>10</th>
<td>Pong. This is sent as a response to a Ping frame.</td></tr>
<tr><th>11-15</th>
<td>Reserved for future use.</td></tr>
<tr><th>128</th>
<td>This value is added to the frame op code to indicate the final fragment of a non-control message. The first fragment may also be the final fragment.</td></tr>
</table></td></tr>
 
<tr><th>socket</th>
<tr><th>socket</th>
<td>Socket object</td></tr>
<td>Socket object</td></tr>
Line 12: Line 34:
<td>string</td></tr>
<td>string</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==
==Examples==
==Examples==
==See also==
==See also==
{{Template:Socket:ReceiveWebSocket footer}}
{{Template:Socket:ReceiveWebSocket footer}}

Revision as of 17:14, 13 August 2019

Receive Web Socket framed message (Socket class)

[Introduced in Model 204 7.8 βeta]


This page is under construction.

Syntax

%opCode = socket:ReceiveWebSocket( string)

Syntax terms

%opCode number is an op code indicating the type of web socket frame. Numbers 0-7 are non-control frames. Numbers 8-15 are control frames. Control frames are always sent immediately and cannot be fragmented. Specifying a reserved code will cause immediate request cancellation.
0 A continuation frame. A continuation frame is treated as text or binary based on the op code of the first frame.
1 A text frame. Text frames are are translated to ASCII with the translate table in effect for the port.
2 A binary frame. No translation is done for binary frames.
3-7 Reserved for future use.
8 Connection close frame.
9 Ping. The receiver should respond with a Pong frame, unless a close frame has been received.
10 Pong. This is sent as a response to a Ping frame.
11-15 Reserved for future use.
128 This value is added to the frame op code to indicate the final fragment of a non-control message. The first fragment may also be the final fragment.
socket Socket object
string string

Usage notes

Examples

See also