Struct jamsocket_server::Server

pub struct Server {
    pub heartbeat_interval: Duration,
    pub heartbeat_timeout: Duration,
    pub port: u32,
    pub ip: 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.

port: u32

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

ip: String

The IP to listen on. Defaults to 0.0.0.0.

Implementations

impl Server

pub fn new() -> 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_ip(self, ip: String) -> Self

pub fn serve(
    self,
    service_factory: impl JamsocketServiceFactory<ServiceActorContext>
) -> Result<()>

Start a server given a [JamsocketService].

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.