Skip to main content

BridgeConfig

Struct BridgeConfig 

Source
pub struct BridgeConfig {
    pub close: CloseFrame,
    pub keepalive: Option<KeepAlive>,
    pub control: Option<ControlReceiver>,
    pub on_close: Option<CloseHook>,
    pub on_ping: Option<ControlHook>,
    pub on_pong: Option<ControlHook>,
}
Expand description

Control-frame configuration and hooks for bridge_with / serve_h2_with.

BridgeConfig::default reproduces plain bridge behaviour: wslay auto-answers pings with pongs, a Normal Closure is sent on teardown, no keepalive, and no hooks fire. All fields are opt-in.

Fields§

§close: CloseFrame

Close frame this side sends when it starts the close (e.g. the peer / upstream reached EOF). Defaults to 1000 Normal Closure, empty reason.

§keepalive: Option<KeepAlive>

Server-initiated keepalive (ping-and-timeout). None disables it — send your own pings via control_channel instead.

§control: Option<ControlReceiver>

Receiver from control_channel, to send control frames while running.

§on_close: Option<CloseHook>

Called once when the connection ends, with the close frame describing why: the peer’s Close, the keepalive-timeout close, the teardown close, or 1006 (Abnormal) if the transport dropped without a Close.

§on_ping: Option<ControlHook>

Called when a Ping is received (wslay has already auto-queued the Pong).

§on_pong: Option<ControlHook>

Called when a Pong is received.

Trait Implementations§

Source§

impl Default for BridgeConfig

Source§

fn default() -> BridgeConfig

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more