Struct WebSocketConfig 

pub struct WebSocketConfig<B>
where
    B: BroadcastTypeTrait,
{ /* private fields */ }

Configuration for a WebSocket connection.

This struct encapsulates all necessary parameters for setting up and managing a WebSocket connection, including context, buffer sizes, capacity, broadcast type, and hook handlers for different lifecycle events.

Type Parameters

• B: The type used for broadcast keys, which must implement BroadcastTypeTrait.

Implementations

impl<B> WebSocketConfig<B>

where B: BroadcastTypeTrait,

pub fn new() -> WebSocketConfig<B>

Creates a new WebSocket configuration with default values.

Returns

• WebSocketConfig<B> - A new WebSocket configuration instance.

impl<B> WebSocketConfig<B>

where B: BroadcastTypeTrait,

pub fn set_buffer_size(self, buffer_size: usize) -> WebSocketConfig<B>

Sets the buffer size for the WebSocket connection.

Arguments

• usize - The desired buffer size in bytes.

Returns

• WebSocketConfig<B> - The modified WebSocket configuration instance.

pub fn set_capacity(self, capacity: usize) -> WebSocketConfig<B>

Sets the capacity for the broadcast sender.

Arguments

• Capacity - The desired capacity.

Returns

• WebSocketConfig<B> - The modified WebSocket configuration instance.

pub fn set_context(self, context: Context) -> WebSocketConfig<B>

Sets the context for the WebSocket connection.

Arguments

• Context - The context object to associate with the WebSocket.

Returns

• WebSocketConfig<B> - The modified WebSocket configuration instance.

pub fn set_broadcast_type( self, broadcast_type: BroadcastType<B>, ) -> WebSocketConfig<B>

Sets the broadcast type for the WebSocket connection.

Arguments

• BroadcastType<B> - The broadcast type to use for this WebSocket.

Returns

• WebSocketConfig<B> - The modified WebSocket configuration instance.

pub fn get_context(&self) -> &Context

Retrieves a reference to the context associated with this configuration.

Returns

• &Context - A reference to the context object.

pub fn get_buffer_size(&self) -> usize

Retrieves the buffer size configured for the WebSocket connection.

Returns

• usize - The buffer size in bytes.

pub fn get_capacity(&self) -> usize

Retrieves the capacity configured for the broadcast sender.

Returns

• Capacity - The capacity.

pub fn get_broadcast_type(&self) -> &BroadcastType<B>

Retrieves a reference to the broadcast type configured for this WebSocket.

Returns

• &BroadcastType<B> - A reference to the broadcast type object.

pub fn set_connected_hook<S>(self) -> WebSocketConfig<B>

where S: ServerHook,

Sets the connected hook handler.

This hook is executed when the WebSocket connection is established.

Type Parameters

• S: The hook type, which must implement ServerHook.

Returns

The modified WebSocketConfig instance.

Examples

struct MyConnectedHook;
impl ServerHook for MyConnectedHook {
    async fn new(_ctx: &Context) -> Self { Self }
    async fn handle(self, ctx: &Context) { /* ... */ }
}

let config = WebSocketConfig::new()
    .set_connected_hook::<MyConnectedHook>();

pub fn set_request_hook<S>(self) -> WebSocketConfig<B>

where S: ServerHook,

Sets the request hook handler.

This hook is executed when a new request is received on the WebSocket.

Type Parameters

• S: The hook type, which must implement ServerHook.

Returns

The modified WebSocketConfig instance.

Examples

struct MyRequestHook;
impl ServerHook for MyRequestHook {
    async fn new(_ctx: &Context) -> Self { Self }
    async fn handle(self, ctx: &Context) { /* ... */ }
}

let config = WebSocketConfig::new()
    .set_request_hook::<MyRequestHook>();

pub fn set_sended_hook<S>(self) -> WebSocketConfig<B>

where S: ServerHook,

Sets the sended hook handler.

This hook is executed after a message has been successfully sent over the WebSocket.

Type Parameters

• S: The hook type, which must implement ServerHook.

Returns

The modified WebSocketConfig instance.

Examples

struct MySendedHook;
impl ServerHook for MySendedHook {
    async fn new(_ctx: &Context) -> Self { Self }
    async fn handle(self, ctx: &Context) { /* ... */ }
}

let config = WebSocketConfig::new()
    .set_sended_hook::<MySendedHook>();

pub fn set_closed_hook<S>(self) -> WebSocketConfig<B>

where S: ServerHook,

Sets the closed hook handler.

This hook is executed when the WebSocket connection is closed.

Type Parameters

• S: The hook type, which must implement ServerHook.

Returns

The modified WebSocketConfig instance.

Examples

struct MyClosedHook;
impl ServerHook for MyClosedHook {
    async fn new(_ctx: &Context) -> Self { Self }
    async fn handle(self, ctx: &Context) { /* ... */ }
}

let config = WebSocketConfig::new()
    .set_closed_hook::<MyClosedHook>();

pub fn get_connected_hook( &self, ) -> &Arc<dyn Fn(&Context) -> Pin<Box<dyn Future<Output = ()> + Send>> + Send + Sync>

Retrieves a reference to the connected hook handler.

Returns

• &ServerHookHandler - A reference to the connected hook handler.

pub fn get_request_hook( &self, ) -> &Arc<dyn Fn(&Context) -> Pin<Box<dyn Future<Output = ()> + Send>> + Send + Sync>

Retrieves a reference to the request hook handler.

Returns

• &ServerHookHandler - A reference to the request hook handler.

pub fn get_sended_hook( &self, ) -> &Arc<dyn Fn(&Context) -> Pin<Box<dyn Future<Output = ()> + Send>> + Send + Sync>

Retrieves a reference to the sended hook handler.

Returns

• &ServerHookHandler - A reference to the sended hook handler.

pub fn get_closed_hook( &self, ) -> &Arc<dyn Fn(&Context) -> Pin<Box<dyn Future<Output = ()> + Send>> + Send + Sync>

Retrieves a reference to the closed hook handler.

Returns

• &ServerHookHandler - A reference to the closed hook handler.

Trait Implementations

impl<B> Clone for WebSocketConfig<B>

where B: Clone + BroadcastTypeTrait,

fn clone(&self) -> WebSocketConfig<B>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<B> Default for WebSocketConfig<B>

where B: BroadcastTypeTrait,

Implements the Default trait for WebSocketConfig.

Provides a default configuration for WebSocket connections, including default hook types that do nothing.

Type Parameters

• B: The type parameter for WebSocketConfig, which must implement BroadcastTypeTrait.

fn default() -> WebSocketConfig<B>

Returns the “default value” for a type.