Skip to content
This repository was archived by the owner on Oct 25, 2021. It is now read-only.

Commit a5a0e9d

Browse files
author
Thomas Scholtes
committedFeb 27, 2013
Added Doxygen documenation for QWsFrame
1 parent 2354bca commit a5a0e9d

File tree

3 files changed

+1824
-3
lines changed

3 files changed

+1824
-3
lines changed
 

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -113,3 +113,6 @@ Log.txt
113113
# Vim backup and swap files:
114114
*~
115115
*.swp
116+
117+
# Generated documentation
118+
doc/

‎Doxyfile

+1,792
Large diffs are not rendered by default.

‎QtWebsocket/QWsFrame.h

+29-3
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,44 @@
55

66
#include <QByteArray>
77

8+
/*!
9+
* Represents a frame sent over the the WebSocket connection.
10+
*
11+
* See also [RFC 6455, Section 5](http://tools.ietf.org/html/rfc6455#section-5).
12+
*/
813
class QWsFrame
914
{
10-
1115
public:
12-
1316
QWsFrame();
17+
18+
19+
/*!
20+
* Clears the payload
21+
*/
1422
void clear();
15-
QByteArray data() const;
23+
24+
25+
/*!
26+
* Performs various checks on the integrity of the frame as required by
27+
* RFC 6455
28+
*/
1629
bool valid() const;
30+
31+
/*!
32+
* Returns the unmaksed payload
33+
*/
1734
QByteArray unmask() const;
35+
36+
37+
/*!
38+
* Returns true if the opcode is a control code
39+
*/
1840
bool controlFrame() const;
1941

42+
43+
/*!
44+
* Tells us how many of the data fields have already been initialized
45+
*/
2046
QWsSocket::EReadingState readingState;
2147

2248
bool final;

0 commit comments

Comments
 (0)
This repository has been archived.