File: websocket_message_assembler.h

package info (click to toggle)
chromium 145.0.7632.159-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,976,224 kB
  • sloc: cpp: 36,198,469; ansic: 7,634,080; javascript: 3,564,060; python: 1,649,622; xml: 838,470; asm: 717,087; pascal: 185,708; sh: 88,786; perl: 88,718; objc: 79,984; sql: 59,811; cs: 42,452; fortran: 24,101; makefile: 21,144; tcl: 15,277; php: 14,022; yacc: 9,066; ruby: 7,553; awk: 3,720; lisp: 3,233; lex: 1,328; ada: 727; jsp: 228; sed: 36
file content (65 lines) | stat: -rw-r--r-- 2,147 bytes parent folder | download | duplicates (6)
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
62
63
64
65
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef NET_TEST_EMBEDDED_TEST_SERVER_WEBSOCKET_MESSAGE_ASSEMBLER_H_
#define NET_TEST_EMBEDDED_TEST_SERVER_WEBSOCKET_MESSAGE_ASSEMBLER_H_

#include <string_view>
#include <vector>

#include "base/containers/span.h"
#include "base/memory/raw_span.h"
#include "base/types/expected.h"
#include "net/base/net_errors.h"
#include "net/websockets/websocket_frame.h"

namespace net::test_server {

struct Message {
  bool is_text_message;
  // `body` either points into the `payload` passed to `HandleFrame()` or into
  // storage owned by the WebSocketMessageAssembler object. It will be
  // invalidated by the next call to `HandleFrame()`.
  base::raw_span<const uint8_t> body;
};

using MessageOrError = base::expected<Message, net::Error>;

class WebSocketMessageAssembler final {
 public:
  WebSocketMessageAssembler();
  ~WebSocketMessageAssembler();

  // Handles incoming WebSocket frames and assembles messages.
  // If `final` is true and the message is complete, it returns a `Message`.
  // If more frames are expected, it returns `ERR_IO_PENDING`.
  // Possible errors are `ERR_IO_PENDING` and `ERR_WS_PROTOCOL_ERROR`.
  // Note: Validation of text messages as UTF-8 is the responsibility of the
  // client.
  MessageOrError HandleFrame(bool final,
                             WebSocketFrameHeader::OpCode opcode,
                             base::span<const char> payload);

  // Resets internal state when a message is fully processed or in case of
  // errors.
  void Reset();

 private:
  // Buffer to hold partial frames for multi-frame messages.
  std::vector<uint8_t> multi_frame_buffer_;

  // State to track if we are expecting a continuation frame.
  enum class MessageState {
    // kIdle: No message is being processed.
    kIdle,
    kExpectTextContinuation,
    kExpectBinaryContinuation,
    kFinished
  } state_ = MessageState::kIdle;

  bool is_text_message_ = false;
};
}  // namespace net::test_server

#endif  // NET_TEST_EMBEDDED_TEST_SERVER_WEBSOCKET_MESSAGE_ASSEMBLER_H_