websockets/json-structure/websocket-message-structure.json at main · api-evangelist/websockets · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
{
  "title": "WebSocket Message Structure",
  "description": "Structure documentation for a WebSocket message as defined by RFC 6455. A message is composed of one or more frames with the same opcode.",
  "type": "object",
  "fields": [
    {
      "name": "opcode",
      "type": "integer",
      "required": true,
      "description": "Frame opcode: 0=continuation, 1=text, 2=binary, 8=close, 9=ping, 10=pong"
    },
    {
      "name": "fin",
      "type": "boolean",
      "required": true,
      "description": "Final frame flag — true if this is the last fragment of a message"
    },
    {
      "name": "masked",
      "type": "boolean",
      "required": true,
      "description": "Whether the payload is masked (required for client-to-server messages)"
    },
    {
      "name": "payloadLength",
      "type": "integer",
      "required": true,
      "description": "Length of the payload in bytes (7-bit, 16-bit, or 64-bit value)"
    },
    {
      "name": "maskingKey",
      "type": "string",
      "required": false,
      "description": "4-byte masking key (present only when masked=true)"
    },
    {
      "name": "payload",
      "type": "string",
      "required": false,
      "description": "Frame payload data (UTF-8 text for text frames, binary for binary frames)"
    },
    {
      "name": "rsv1",
      "type": "boolean",
      "required": false,
      "description": "Reserved bit 1 — used by extensions (e.g., permessage-deflate)"
    },
    {
      "name": "rsv2",
      "type": "boolean",
      "required": false,
      "description": "Reserved bit 2 — reserved for future use"
    },
    {
      "name": "rsv3",
      "type": "boolean",
      "required": false,
      "description": "Reserved bit 3 — reserved for future use"
    }
  ]
}