Struct tungstenite::handshake::server::ServerHandshake

[+] Show declaration

pub struct ServerHandshake<S, C> { /* fields omitted */ }

[−] Expand description

Server handshake role.

Implementations

impl<S: Read + Write, C: Callback> ServerHandshake<S, C>[−]

pub fn start(
    stream: S,
    callback: C,
    config: Option<WebSocketConfig>
) -> MidHandshake<Self>[−]

Start server handshake. callback specifies a custom callback which the user can pass to the handshake, this callback will be called when the a websocket client connnects to the server, you can specify the callback if you want to add additional header to the client upon join based on the incoming headers.

Trait Implementations

impl<S: Debug, C: Debug> Debug for ServerHandshake<S, C>[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter<'_>) -> Result[−]

Formats the value using the given formatter.

impl<S: Read + Write, C: Callback> HandshakeRole for ServerHandshake<S, C>[+]

[+] Show hidden undocumented items

type IncomingData = Request

type InternalStream = S

type FinalResult = WebSocket<S>

fn stage_finished(
    &mut self,
    finish: StageResult<Self::IncomingData, Self::InternalStream>
) -> Result<ProcessingResult<Self::InternalStream, Self::FinalResult>>