Struct matchbox_signaling::SignalingServerBuilder

pub struct SignalingServerBuilder<Topology, Cb = NoCallbacks, S = NoState>
where
    Topology: SignalingTopology<Cb, S>,
    Cb: SignalingCallbacks,
    S: SignalingState,
{ /* private fields */ }

Builder for SignalingServers.

Begin with SignalingServerBuilder::new and add parameters before calling SignalingServerBuilder::build to produce the desired SignalingServer.

Implementations

impl<Topology, Cb, S> SignalingServerBuilder<Topology, Cb, S>

where Topology: SignalingTopology<Cb, S>, Cb: SignalingCallbacks, S: SignalingState,

pub fn new( socket_addr: impl Into<SocketAddr>, topology: Topology, state: S ) -> Self

Creates a new builder for a SignalingServer.

pub fn mutate_router(self, alter: impl FnMut(Router) -> Router) -> Self

Modify the router with a mutable closure. This is where one may apply middleware or other layers to the Router.

pub fn on_connection_request<F>(self, callback: F) -> Self

where F: FnMut(WsUpgradeMeta) -> Result<bool, Response> + Send + Sync + 'static,

Set a callback triggered before websocket upgrade to determine if the connection is allowed.

pub fn on_id_assignment<F>(self, callback: F) -> Self

where F: FnMut((SocketAddr, PeerId)) + Send + Sync + 'static,

Set a callback triggered when a socket has been assigned an ID. This happens after a connection is allowed, right before finalizing the websocket upgrade.

pub fn cors(self) -> Self

Apply permissive CORS middleware for debug purposes.

pub fn trace(self) -> Self

Apply a default tracing middleware layer for debug purposes.

pub fn build(self) -> SignalingServer

Create a SignalingServer.

impl SignalingServerBuilder<ClientServer, ClientServerCallbacks, ClientServerState>

pub fn on_client_connected<F>(self, callback: F) -> Self

where F: Fn(PeerId) + Send + Sync + 'static,

Set a callback triggered on all client websocket connections.

pub fn on_client_disconnected<F>(self, callback: F) -> Self

where F: Fn(PeerId) + Send + Sync + 'static,

Set a callback triggered on all client websocket disconnections.

pub fn on_host_connected<F>(self, callback: F) -> Self

where F: Fn(PeerId) + Send + Sync + 'static,

Set a callback triggered on host websocket connection.

pub fn on_host_disconnected<F>(self, callback: F) -> Self

where F: Fn(PeerId) + Send + Sync + 'static,

Set a callback triggered on host websocket disconnection.

impl SignalingServerBuilder<FullMesh, FullMeshCallbacks, FullMeshState>

pub fn on_peer_connected<F>(self, callback: F) -> Self

where F: Fn(PeerId) + Send + Sync + 'static,

Set a callback triggered on all websocket connections.

pub fn on_peer_disconnected<F>(self, callback: F) -> Self

where F: Fn(PeerId) + Send + Sync + 'static,

Set a callback triggered on all websocket disconnections.