summaryrefslogtreecommitdiff
path: root/src/websockets/qwebsocketprotocol.cpp
diff options
context:
space:
mode:
authorKurt Pattyn <pattyn.kurt@gmail.com>2014-01-13 11:28:21 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-01-13 12:18:10 +0100
commitc15e979b02bec88baecb464b8e526e7d876d30e1 (patch)
tree6b9e37cfbe8fdd7a651054a01d3c5cd773ffcf57 /src/websockets/qwebsocketprotocol.cpp
parent2160f1215533130d0bfa16ad7b7bf20c88ac8028 (diff)
downloadqtwebsockets-c15e979b02bec88baecb464b8e526e7d876d30e1.tar.gz
Update documentation
Change-Id: I98cab390cbb0f19741d6fa4ae5b0ada8d19d1f5f Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
Diffstat (limited to 'src/websockets/qwebsocketprotocol.cpp')
-rw-r--r--src/websockets/qwebsocketprotocol.cpp27
1 files changed, 27 insertions, 0 deletions
diff --git a/src/websockets/qwebsocketprotocol.cpp b/src/websockets/qwebsocketprotocol.cpp
index cd95438..3b5c52d 100644
--- a/src/websockets/qwebsocketprotocol.cpp
+++ b/src/websockets/qwebsocketprotocol.cpp
@@ -115,6 +115,33 @@ QT_BEGIN_NAMESPACE
*/
/*!
+ \enum QWebSocketProtocol::OpCode
+
+ \inmodule QtWebSockets
+
+ The frame opcodes as defined by the WebSockets standard
+
+ \value OC_CONTINUE Continuation frame
+ \value OC_TEXT Text frame
+ \value OC_BINARY Binary frame
+ \value OC_RESERVED_3 Reserved
+ \value OC_RESERVED_4 Reserved
+ \value OC_RESERVED_5 Reserved
+ \value OC_RESERVED_6 Reserved
+ \value OC_RESERVED_7 Reserved
+ \value OC_CLOSE Close frame
+ \value OC_PING Ping frame
+ \value OC_PONG Pong frame
+ \value OC_RESERVED_B Reserved
+ \value OC_RESERVED_C Reserved
+ \value OC_RESERVED_D Reserved
+ \value OC_RESERVED_E Reserved
+ \value OC_RESERVED_F Reserved
+
+ \internal
+*/
+
+/*!
\fn QWebSocketProtocol::isOpCodeReserved(OpCode code)
Checks if \a code is a valid OpCode