View source for ReceiveWebSocket (Socket function)

{{Template:Socket:ReceiveWebSocket subtitle}}

This page is [[under construction]].
==Syntax==
{{Template:Socket:ReceiveWebSocket syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%opCode</th>
<td>op code is a number indicating the type of web socket frame received. Numbers 0-7 are non-control frames. Numbers 8-15 are control frames.
<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 EBCDIC 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. A close frame should be sent in response.</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>
<td>Socket object</td></tr>
<tr><th>string</th>
<td>string</td></tr>
</table>

==Usage notes==
Received data may be masked by the sender. Masked data is always unmasked using the sender's masking key before it is returned to the application.

Sending a control frame always forces a flush of the TCP output buffer. A close or a ping are the only valid control frames.

==Examples==
The following example receives a text message from a WebSocket client.
<p class="code">...
                                                           
%sock = WebSocket                                                              
if %sock is null then                                                          
   audittext Socket closed, status is {$STATUSD}                               
   stop                                                                        
end if   
                                                                      
%op = %sock:ReceiveWebSocket(%wsi)                                             
if %op eq 1 then                                                               
   setText %wso  = Received your text message of {%wsi:length} bytes.          
   %sock:SendWebSocket(%wso, %op, true)                                        
end if                                                                                    
...
</p>

==See also==
{{Template:Socket:ReceiveWebSocket footer}}