Server.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Povl Filip Sonne-Frederiksen
//
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
// The `rux gui` HTTP + WebSocket server (#265, Phase 1).
//
// Implements docs/gui/openapi.yaml over one `.rux` project, serves the frontend
// bundle as static files, and streams pipeline job progress over
// /api/v1/events.
//
// Crow is an implementation detail: this header is pimpl'd so crow.h never
// reaches the rest of the app or the tests. The handler logic itself lives in
// gui/api.hpp, which is framework-free.
 
#include <cstdint>
#include <filesystem>
#include <memory>
#include <string>
#include <vector>
 
namespace rux::gui {

struct ServerOptions {
  std::filesystem::path project;

  std::string bind_address = "127.0.0.1";

  uint16_t port = 8420;

  unsigned threads = 0;

  std::vector<std::string> allowed_origins;

  std::filesystem::path asset_dir;

  bool open_browser = true;
};

class Server {
    public:
  explicit Server(ServerOptions options);
  ~Server();
 
  Server(const Server &) = delete;
  Server &operator=(const Server &) = delete;

  const ServerOptions &options() const noexcept;

  std::string url() const;

  bool has_assets() const noexcept;

  int run();

  void stop();
 
    private:
  class Impl;
  std::unique_ptr<Impl> impl_;
};
 
} // namespace rux::gui