Qore WebSocketUtil Module Reference  1.4
 All Classes Namespaces Functions Variables Groups Pages
WebSocketUtil.qm.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
4 /* WebSocketUtil.qm Copyright 2013 - 2017 Qore Technologies, s.r.o.
5 
6  Permission is hereby granted, free of charge, to any person obtaining a
7  copy of this software and associated documentation files (the "Software"),
8  to deal in the Software without restriction, including without limitation
9  the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  and/or sell copies of the Software, and to permit persons to whom the
11  Software is furnished to do so, subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in
14  all copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  DEALINGS IN THE SOFTWARE.
23 */
24 
25 // minimum required Qore version
26 
27 // require type definitions everywhere
28 
29 // enable all warnings
30 
31 // assume local var scope, do not use "$" for vars, members, and method calls
32 
33 
73 namespace WebSocketUtil {
76  const WS_GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
77 
79  const WS_FIN = (1 << 7);
80 
84  const WSOP_Continuation = 0x0;
86 
88  const WSOP_Text = 0x1;
89 
91  const WSOP_Binary = 0x2;
92 
94  const WSOP_Close = 0x8;
95 
97  const WSOP_Ping = 0x9;
98 
100  const WSOP_Pong = 0xa;
101 
103  const WSOPMap = (
104  WSOP_Continuation: "CONTINUATION",
105  WSOP_Text: "TEXT",
106  WSOP_Binary: "BINARY",
107  WSOP_Close: "CLOSE",
108  WSOP_Ping: "PING",
109  WSOP_Pong: "PONG",
110  );
112 
116  const WSCC_NormalClosure = 1000;
118 
120  const WSCC_GoingAway = 1001;
121 
123  const WSCC_ProtocolError = 1002;
124 
126  const WSCC_UnsupportedData = 1003;
127 
129  const WSCC_NoStatusRcvd = 1005;
130 
132  const WSCC_AbnormalClosure = 1006;
133 
135  const WSCC_InvalidData = 1007;
136 
138  const WSCC_PolicyViolation = 1008;
139 
141  const WSCC_MessageTooBig = 1009;
142 
144  const WSCC_MandatoryExt = 1010;
145 
148 
150  const WSCC_TlsHandshake = 1015;
151 
153  const WSCCMap = (
154  WSCC_NormalClosure: "Normal Closure",
155  WSCC_GoingAway: "Going Away",
156  WSCC_ProtocolError: "Protocol Error",
157  WSCC_UnsupportedData: "Unsupported Data",
158  WSCC_NoStatusRcvd: "No Status Rcvd",
159  WSCC_AbnormalClosure: "Abnormal Closure",
160  WSCC_InvalidData: "Invalid Frame Payload Data",
161  WSCC_PolicyViolation: "Policy Violation",
162  WSCC_MessageTooBig: "Message Too Big",
163  WSCC_MandatoryExt: "Mandatory Ext.",
164  WSCC_InternalServerError: "Internal Server Error",
165  WSCC_TlsHandshake: "TLS Handshake",
166  );
168 
170  binary ws_encode_message(data msg, int op = -1, *bool masked);
171 
172 
174 
188  hash ws_read_message(Socket sock, *timeout to);
189 
190 
192 
198  string ws_get_response_key(string key);
199 
200 };
const WSCC_GoingAway
&quot;Going Away&quot; code
Definition: WebSocketUtil.qm.dox.h:120
const WSOPMap
maps from opcodes to text descriptions
Definition: WebSocketUtil.qm.dox.h:103
const WSOP_Continuation
continuation frame opcode
Definition: WebSocketUtil.qm.dox.h:85
binary binary()
const WSOP_Close
connection code opcode
Definition: WebSocketUtil.qm.dox.h:94
const WSOP_Pong
pong opcode
Definition: WebSocketUtil.qm.dox.h:100
const WSCC_NoStatusRcvd
&quot;No Status Rcvd&quot; code
Definition: WebSocketUtil.qm.dox.h:129
const WSCC_MandatoryExt
&quot;Mandatory Ext.&quot; code
Definition: WebSocketUtil.qm.dox.h:144
const WSCC_UnsupportedData
&quot;Unsupported Data&quot; code
Definition: WebSocketUtil.qm.dox.h:126
const WSCC_ProtocolError
&quot;Protocol Error&quot; code
Definition: WebSocketUtil.qm.dox.h:123
const WS_GUID
WebSocket GUID.
Definition: WebSocketUtil.qm.dox.h:76
string ws_get_response_key(string key)
returns a string response key from the binary key and the WebSocket GUID value
const WSCC_InvalidData
&quot;Invalid Frame Payload Data&quot; code
Definition: WebSocketUtil.qm.dox.h:135
const WSCCMap
maps from close codes to text descriptions
Definition: WebSocketUtil.qm.dox.h:153
hash ws_read_message(Socket sock, *timeout to)
read and decode a message from a socket
const WSOP_Binary
binary frame opcode
Definition: WebSocketUtil.qm.dox.h:91
const WSCC_MessageTooBig
&quot;Message Too Big&quot; code
Definition: WebSocketUtil.qm.dox.h:141
const WSOP_Ping
ping opcode
Definition: WebSocketUtil.qm.dox.h:97
binary ws_encode_message(data msg, int op=-1, *bool masked)
encodes a message for sending over a websocket socket
const WSOP_Text
text frame opcode
Definition: WebSocketUtil.qm.dox.h:88
const WSCC_InternalServerError
&quot;Internal Server Error&quot; code
Definition: WebSocketUtil.qm.dox.h:147
const WSCC_TlsHandshake
&quot;TLS Handshake&quot; code
Definition: WebSocketUtil.qm.dox.h:150
const WSCC_AbnormalClosure
&quot;Abnormal Closure&quot; code
Definition: WebSocketUtil.qm.dox.h:132
const WSCC_NormalClosure
&quot;Normal Closure&quot; code
Definition: WebSocketUtil.qm.dox.h:117
hash hash(object obj)
const WS_FIN
the final fragment in a message
Definition: WebSocketUtil.qm.dox.h:79
const WSCC_PolicyViolation
&quot;Policy Violation&quot; code
Definition: WebSocketUtil.qm.dox.h:138