Struct DashboardServer 

pub struct DashboardServer { /* private fields */ }

SSE streaming dashboard server.

Pushes DashboardEvents to all connected HTTP clients that opened GET /events. Events are first written to an internal LockFreeRingBuffer and then forwarded to each client through a tokio::sync::broadcast channel.

Thread safety

The server is Send + Sync. push_event may be called from any thread or async task.

Implementations

impl DashboardServer

pub fn new(config: DashboardConfig) -> Result<Self>

Creates a new server but does not start listening yet.

Call start to begin accepting connections.

Errors

Returns an error if event_buffer_size is 0.

Example

use trustformers_debug::dashboard_ws::websocket::{DashboardConfig, DashboardServer};

let cfg = DashboardConfig {
    bind_addr: "127.0.0.1:0".parse().unwrap(),
    max_clients: 4,
    event_buffer_size: 32,
};
let server = DashboardServer::new(cfg).unwrap();
assert!(!server.is_running());

pub fn is_running(&self) -> bool

Returns true if start has been called.

pub fn push_event(&self, event: DashboardEvent) -> Result<()>

Pushes a DashboardEvent to all connected clients.

The event is serialised to JSON and written to the internal ring buffer as a sequence of bytes (the SSE-framed JSON string length is stored as an index rather than raw bytes — see implementation notes).

If no clients are connected the broadcast send silently drops the message (all receivers have been dropped), which is acceptable behaviour for a monitoring stream.

Errors

Returns an error if JSON serialisation fails.

Example

server.push_event(DashboardEvent::Custom {
    name: "epoch_end".to_string(),
    value: serde_json::json!({"epoch": 1}),
}).unwrap();

pub async fn start(&self) -> Result<()>

Starts the SSE server in a background tokio task.

The method binds the TCP listener immediately (so binding errors are returned synchronously) and then spawns a task to accept connections.

Errors

Returns an error if the TCP listener cannot bind to config.bind_addr.

Example

use trustformers_debug::dashboard_ws::websocket::{DashboardConfig, DashboardServer};

let cfg = DashboardConfig {
    bind_addr: "127.0.0.1:0".parse()?,
    max_clients: 2,
    event_buffer_size: 16,
};
let server = DashboardServer::new(cfg)?;
server.start().await?;

pub fn stop(&self) -> Result<()>

Signals the server to stop accepting new connections.

Already-running client handler tasks are left to drain and close naturally.

Errors

Currently infallible; returns Ok(()) always.