Qore WebSocketUtil Module Reference  1.1
WebSocketUtil.qm.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
4 /* WebSocketUtil.qm Copyright 2013 - 2015 Qore Technologies, sro
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 
34 /* Version History
35  * 2013-10-04 v1.1: David Nichols <david@qore.org>
36  + converted to new-style
37 
38  * 2013-10-04 v1.0: David Nichols <david@qore.org>
39  + the initial version of the WebSocketUtil module
40 */
41 
60 namespace WebSocketUtil {
63  const WS_GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
64 
66  const WS_FIN = (1 << 7);
67 
71  const WSOP_Continuation = 0x0;
73 
75  const WSOP_Text = 0x1;
76 
78  const WSOP_Binary = 0x2;
79 
81  const WSOP_Close = 0x8;
82 
84  const WSOP_Ping = 0x9;
85 
87  const WSOP_Pong = 0xa;
88 
90  const WSOPMap = (
91  WSOP_Continuation: "CONTINUATION",
92  WSOP_Text: "TEXT",
93  WSOP_Binary: "BINARY",
94  WSOP_Close: "CLOSE",
95  WSOP_Ping: "PING",
96  WSOP_Pong: "PONG",
97  );
99 
103  const WSCC_NormalClosure = 1000;
105 
107  const WSCC_GoingAway = 1001;
108 
110  const WSCC_ProtocolError = 1002;
111 
113  const WSCC_UnsupportedData = 1003;
114 
116  const WSCC_NoStatusRcvd = 1005;
117 
119  const WSCC_AbnormalClosure = 1006;
120 
122  const WSCC_InvalidData = 1007;
123 
125  const WSCC_PolicyViolation = 1008;
126 
128  const WSCC_MessageTooBig = 1009;
129 
131  const WSCC_MandatoryExt = 1010;
132 
135 
137  const WSCC_TlsHandshake = 1015;
138 
140  const WSCCMap = (
141  WSCC_NormalClosure: "Normal Closure",
142  WSCC_GoingAway: "Going Away",
143  WSCC_ProtocolError: "Protocol Error",
144  WSCC_UnsupportedData: "Unsupported Data",
145  WSCC_NoStatusRcvd: "No Status Rcvd",
146  WSCC_AbnormalClosure: "Abnormal Closure",
147  WSCC_InvalidData: "Invalid Frame Payload Data",
148  WSCC_PolicyViolation: "Policy Violation",
149  WSCC_MessageTooBig: "Message Too Big",
150  WSCC_MandatoryExt: "Mandatory Ext.",
151  WSCC_InternalServerError: "Internal Server Error",
152  WSCC_TlsHandshake: "TLS Handshake",
153  );
155 
157  binary ws_encode_message(data msg, int op = -1, *bool masked);
158 
159 
161 
175  hash ws_read_message(Socket sock, *timeout to);
176 
177 };
const WSCC_GoingAway
"Going Away" code
Definition: WebSocketUtil.qm.dox.h:107
const WSOPMap
maps from opcodes to text descriptions
Definition: WebSocketUtil.qm.dox.h:90
const WSOP_Continuation
continuation frame opcode
Definition: WebSocketUtil.qm.dox.h:72
binary binary()
const WSOP_Close
connection code opcode
Definition: WebSocketUtil.qm.dox.h:81
const WSOP_Pong
pong opcode
Definition: WebSocketUtil.qm.dox.h:87
const WSCC_NoStatusRcvd
"No Status Rcvd" code
Definition: WebSocketUtil.qm.dox.h:116
const WSCC_MandatoryExt
"Mandatory Ext." code
Definition: WebSocketUtil.qm.dox.h:131
const WSCC_UnsupportedData
"Unsupported Data" code
Definition: WebSocketUtil.qm.dox.h:113
const WSCC_ProtocolError
"Protocol Error" code
Definition: WebSocketUtil.qm.dox.h:110
const WS_GUID
WebSocket GUID.
Definition: WebSocketUtil.qm.dox.h:63
const WSCC_InvalidData
"Invalid Frame Payload Data" code
Definition: WebSocketUtil.qm.dox.h:122
const WSCCMap
maps from close codes to text descriptions
Definition: WebSocketUtil.qm.dox.h:140
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:78
const WSCC_MessageTooBig
"Message Too Big" code
Definition: WebSocketUtil.qm.dox.h:128
const WSOP_Ping
ping opcode
Definition: WebSocketUtil.qm.dox.h:84
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:75
const WSCC_InternalServerError
"Internal Server Error" code
Definition: WebSocketUtil.qm.dox.h:134
const WSCC_TlsHandshake
"TLS Handshake" code
Definition: WebSocketUtil.qm.dox.h:137
const WSCC_AbnormalClosure
"Abnormal Closure" code
Definition: WebSocketUtil.qm.dox.h:119
const WSCC_NormalClosure
"Normal Closure" code
Definition: WebSocketUtil.qm.dox.h:104
the WebSocketUtil namespace contains all the definitions in the WebSocketUtil module ...
Definition: WebSocketUtil.qm.dox.h:61
hash hash(object obj)
const WS_FIN
the final fragment in a message
Definition: WebSocketUtil.qm.dox.h:66
const WSCC_PolicyViolation
"Policy Violation" code
Definition: WebSocketUtil.qm.dox.h:125