Struct jamsocket_server::Server

pub struct Server {
    pub heartbeat_interval: Duration,
    pub heartbeat_timeout: Duration,
    pub room_id_strategy: RoomIdStrategy,
    pub port: u32,
    pub shutdown_policy: ServiceShutdownPolicy,
    pub static_path: Option<String>,
    pub client_path: Option<String>,
}

Settings used by the server.

Fields

heartbeat_interval: Duration

The duration of time between server-initiated WebSocket heartbeats.

Defaults to 30 seconds.

heartbeat_timeout: Duration

The minimum amount of time between client heartbeats before a connection is dropped.

Defaults to 5 minutes.

room_id_strategy: RoomIdStrategy

The method by which new rooms are created and assigned names.

port: u32

The port to run the server on. Defaults to 8080.

shutdown_policy: ServiceShutdownPolicy

How the server decides to shut down a room once it is empty.

static_path: Option<String>

A local filesystem path to serve static files from, or None (default).

client_path: Option<String>

A local filesystem path to serve from /client, or None (default).

Implementations

impl Server

pub fn new() -> Self

pub fn with_static_path(self, static_path: Option<String>) -> Self

pub fn with_client_path(self, client_path: Option<String>) -> Self

pub fn with_heartbeat_interval(self, duration_seconds: u64) -> Self

pub fn with_heartbeat_timeout(self, duration_seconds: u64) -> Self

pub fn with_port(self, port: u32) -> Self

pub fn with_room_id_strategy(self, room_id_strategy: RoomIdStrategy) -> Self

pub fn with_shutdown_policy(
    self,
    shutdown_policy: ServiceShutdownPolicy
) -> Self

pub fn serve_default<F: SimpleJamsocketService>(self) -> Result<()>

pub fn serve<F: JamsocketServiceFactory<ServiceActorContext>>(
    self,
    host_factory: F
) -> Result<()>

Start a server given a cloneable [JamsocketServiceBuilder].

This function blocks until the server is terminated. While it is running, the following endpoints are available:

• / (GET): return HTTP 200 if the server is running (useful as a baseline status check)
• /new_room (POST): create a new room, if not in explicit room creation mode.
• /ws/{room_id} (GET): initiate a WebSocket connection to the given room. If the room does not exist and the server is in implicit room creation mode, it will be created.

Trait Implementations

impl Default for Server

fn default() -> Self

Returns the “default value” for a type.