Struct WebSocketConfig

Source

pub struct WebSocketConfig<'a, B: BroadcastTypeTrait> {
    pub stream: &'a mut Stream,
    pub context: &'a mut Context,
    pub capacity: Capacity,
    pub broadcast_type: BroadcastType<B>,
    pub connected_hook: ServerHookHandler,
    pub request_hook: ServerHookHandler,
    pub sended_hook: ServerHookHandler,
    pub closed_hook: ServerHookHandler,
}

Expand description

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.

Fields§

§stream: &'a mut Stream

The underlying stream for this WebSocket connection.

§context: &'a mut Context

The Hyperlane context.

This context is associated with this WebSocket connection.

§capacity: Capacity

The capacity.

This is the capacity of the broadcast sender channel.

§broadcast_type: BroadcastType

The broadcast type.

This defines the type of broadcast this WebSocket connection will participate in (point-to-point or point-to-group).

§connected_hook: ServerHookHandler

The connected hook handler.

This hook is executed when the WebSocket connection is established.

§request_hook: ServerHookHandler

The request hook handler.

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

§sended_hook: ServerHookHandler

The sended hook handler.

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

§closed_hook: ServerHookHandler

The closed hook handler.

This hook is executed when the WebSocket connection is closed.

Implementations§

Source §

impl<'a, B> WebSocketConfig<'a, B>
where B: BroadcastTypeTrait,

Source

pub fn new(stream: &'a mut Stream, context: &'a mut Context) -> Self

Creates a new WebSocket configuration with the given context.

§Arguments

&'a mut Stream - The stream object serving this WebSocket.
&'a mut Context - The context object to associate with the WebSocket.

§Returns

WebSocketConfig - A new WebSocket configuration instance.

Source §

impl<'a, B> WebSocketConfig<'a, B>
where B: BroadcastTypeTrait,

Source

pub fn set_capacity(self, capacity: Capacity) -> Self

Sets the capacity for the broadcast sender.

§Arguments

Capacity - The desired capacity.

§Returns

WebSocketConfig - The modified WebSocket configuration instance.

Source

pub fn set_context(self, context: &'a mut Context) -> Self

Sets the context for the WebSocket connection.

§Arguments

&'a mut Context - The context object to associate with the WebSocket.

§Returns

WebSocketConfig - The modified WebSocket configuration instance.

Source

pub fn set_broadcast_type(self, broadcast_type: BroadcastType) -> Self

Sets the broadcast type for the WebSocket connection.

§Arguments

BroadcastType - The broadcast type to use for this WebSocket.

§Returns

WebSocketConfig - The modified WebSocket configuration instance.

Source

pub fn set_connected_hook<S>(self) -> Self
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>();

Source

pub fn set_request_hook<S>(self) -> Self
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>();

Source

pub fn set_sended_hook<S>(self) -> Self
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>();

Source

pub fn set_closed_hook<S>(self) -> Self
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>();