Skip to content
This repository was archived by the owner on Mar 5, 2026. It is now read-only.

Commit 8604f67

Browse files
hermme-no-dev
authored andcommitted
Add documentation for AwsFrameInfo. (me-no-dev#240)
1 parent c8c1784 commit 8604f67

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

src/AsyncWebSocket.h

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,26 @@ class AsyncWebSocketClient;
3535
class AsyncWebSocketControl;
3636

3737
typedef struct {
38+
/** Message type as defined by enum AwsFrameType.
39+
* Note: Applications will only see WS_TEXT and WS_BINARY.
40+
* All other types are handled by the library. */
3841
uint8_t message_opcode;
42+
/** Frame number of a fragmented message. */
3943
uint32_t num;
44+
/** Is this the last frame in a fragmented message ?*/
4045
uint8_t final;
46+
/** Is this frame masked? */
4147
uint8_t masked;
48+
/** Message type as defined by enum AwsFrameType.
49+
* This value is the same as message_opcode for non-fragmented
50+
* messages, but may also be WS_CONTINUATION in a fragmented message. */
4251
uint8_t opcode;
52+
/** Length of the current frame.
53+
* This equals the total length of the message if num == 0 && final == true */
4354
uint64_t len;
55+
/** Mask key */
4456
uint8_t mask[4];
57+
/** Offset of the data inside the current frame. */
4558
uint64_t index;
4659
} AwsFrameInfo;
4760

0 commit comments

Comments
 (0)