websocket.h

Go to the documentation of this file.

// Copyright 2026 The Symbian SDK Authors.
// Licensed under the Apache License, Version 2.0.
#ifndef SYMBIAN_WEBSOCKET_WEBSOCKET_H_
#define SYMBIAN_WEBSOCKET_WEBSOCKET_H_
 
#include <array>
#include <cstddef>
#include <cstdint>
#include <functional>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
 
#include "absl/status/status.h"
#include "absl/status/statusor.h"
 
namespace symbian::websocket {
 
enum class Role { kClient, kServer };
 
struct Options {
  // Required for clients; invoked only by native work on the owner thread.
  std::function<absl::StatusOr<std::array<std::uint8_t, 4>>()> mask_provider;
  std::string path = "/symbian-agent";
  std::string authority = "symbian";
  std::size_t maximum_message_bytes = 4100;
  std::size_t maximum_buffered_bytes = 65536;
};
 
class WebSocket {
 public:
  static absl::StatusOr<std::unique_ptr<WebSocket>> Create(
      Role role, Options options = {});
  ~WebSocket();
  WebSocket(const WebSocket&) = delete;
  WebSocket& operator=(const WebSocket&) = delete;
 
  absl::Status Feed(std::string_view bytes);
  absl::StatusOr<std::string> TakeOutput();
  absl::Status Send(std::string_view message);
  absl::StatusOr<std::optional<std::string>> Receive();
  absl::Status Close();
  void Abort();
  bool open() const;
  bool closed() const;
  std::size_t buffered_amount() const;
 
 private:
  struct State;
  explicit WebSocket(std::unique_ptr<State> state);
  std::unique_ptr<State> state_;
};
 
}  // namespace symbian::websocket
#endif  // SYMBIAN_WEBSOCKET_WEBSOCKET_H_