guest_control.h

Go to the documentation of this file.

// Copyright 2026 The Symbian SDK Authors.
// Licensed under the Apache License, Version 2.0.
 
#ifndef SYMBIAN_AGENT_GUEST_CONTROL_H_
#define SYMBIAN_AGENT_GUEST_CONTROL_H_
 
#include <cstdint>
#include <optional>
#include <string>
#include <string_view>
 
#include "absl/status/statusor.h"
#include "symbian/agent/guest_files.h"
#include "symbian/agent/guest_log.h"
 
namespace symbian::agent {
 
struct GuestControlRequest {
  std::uint64_t request_id = 0;
  std::uint8_t kind = 0;  // 1: hello, 2: status, 6: logs, 7: workspace list.
  std::uint64_t deadline_millis = 0;
  std::uint64_t page_after = 0;
  std::uint8_t page_limit = 0;
  // Complete MessagePack key/value pairs for unknown top-level fields.
  std::string extensions;
  std::uint8_t extension_count = 0;
};
 
struct GuestTickSnapshot {
  std::uint32_t count = 0;
  std::uint64_t period_microseconds = 0;
};
 
struct GuestDisplaySnapshot {
  std::uint32_t width_pixels = 0;
  std::uint32_t height_pixels = 0;
};
 
struct GuestStatusSnapshot {
  std::optional<GuestTickSnapshot> tick;
  std::optional<GuestDisplaySnapshot> display;
  bool logs_available = false;
  bool workspace_available = false;
};
 
absl::StatusOr<GuestControlRequest> ParseGuestControl(std::string_view payload);
 
absl::StatusOr<std::string> PackGuestResult(const GuestControlRequest& request);
 
absl::StatusOr<std::string> PackGuestResult(
    const GuestControlRequest& request, const GuestStatusSnapshot& snapshot);
 
absl::StatusOr<std::string> PackGuestHelloResult(
    const GuestControlRequest& request, bool logs_available,
    std::uint8_t maximum_requests, bool workspace_available = false);
 
absl::StatusOr<std::string> PackGuestLogResult(
    const GuestControlRequest& request, const AgentLogPage& page);
 
absl::StatusOr<std::string> PackGuestWorkspaceResult(
    const GuestControlRequest& request, const GuestFilePage& page);
 
}  // namespace symbian::agent
 
#endif  // SYMBIAN_AGENT_GUEST_CONTROL_H_