Struct WscallServer 

pub struct WscallServer { /* private fields */ }

Main server type used to register routes, filters, and event handlers.

Implementations

impl WscallServer

pub fn new() -> Self

pub fn with_ecdh(self) -> Self

Enables ECDH dynamic key agreement.

Instead of a pre-shared symmetric key, each connection performs an X25519 handshake right after the WebSocket upgrade. The negotiated 32-byte session key is used with ChaCha20-Poly1305 for all subsequent frames. This is mutually exclusive with with_chacha20_key / with_aes256_key.

pub fn with_chacha20_key(self, key: [u8; 32]) -> Self

pub fn with_aes256_key(self, key: [u8; 32]) -> Self

pub fn with_max_connections(self, max: usize) -> Self

Caps the number of concurrently accepted connections.

When the cap is reached, new accept calls block until an existing connection drops, providing natural backpressure against connection flooding instead of spawning unbounded tasks.

pub fn with_max_in_flight(self, max: usize) -> Self

Caps the number of concurrently in-flight request/event handlers per single connection, bounding per-connection CPU and memory usage.

pub fn with_max_frame_bytes(self, max: usize) -> Self

Sets the maximum total frame size (including the 4-byte length prefix).

Frames exceeding this limit cause the server to send a 413 error response frame (request_id=0, code="frame_too_large"); the connection stays open. Default: 100 MiB.

pub fn handle(&self) -> ServerHandle

pub fn route<F, Fut>(&mut self, route: impl Into<String>, handler: F)

where F: Fn(ApiContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, ApiError>> + Send + 'static,

pub fn typed_route<T, F, Fut>(&mut self, route: impl Into<String>, handler: F)

where T: DeserializeOwned + Send + 'static, F: Fn(ApiContext, T) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, ApiError>> + Send + 'static,

pub fn validated_route<T, F, Fut>( &mut self, route: impl Into<String>, handler: F, )

where T: DeserializeOwned + Validate + Send + 'static, F: Fn(ApiContext, T) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, ApiError>> + Send + 'static,

pub fn filter<F, Fut>(&mut self, filter: F)

where F: Fn(ApiContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<ApiContext, ApiError>> + Send + 'static,

pub fn event_handler<F, Fut>(&mut self, name: impl Into<String>, handler: F)

where F: Fn(EventContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, ApiError>> + Send + 'static,

pub fn on_connected<F, Fut>(&mut self, handler: F)

where F: Fn(ServerConnectionContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

pub fn on_disconnected<F, Fut>(&mut self, handler: F)

where F: Fn(ServerDisconnectContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

pub fn exception_handler<F, Fut>(&mut self, handler: F)

where F: Fn(ExceptionContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = ErrorPayload> + Send + 'static,

pub async fn listen(self, address: &str) -> Result<(), ServerError>

Trait Implementations

impl Default for WscallServer

fn default() -> Self

Returns the “default value” for a type.