Struct mech_server::client::ClientHandler

pub struct ClientHandler {
    pub client_name: String,
    pub running: RunLoop,
    pub input: HashSet<u64>,
    // some fields omitted
}

Fields

client_name: String

running: RunLoop

input: HashSet<u64>

Methods

impl ClientHandler

pub fn new(
    client_name: &str,
    out: Option<WSSender>,
    mech_paths: Option<&Vec<&str>>,
    persistence_path: Option<&str>
) -> ClientHandler

Trait Implementations

impl Handler for ClientHandler

fn on_open(&mut self, handshake: Handshake) -> Result<(), Error>

Called when the WebSocket handshake is successful and the connection is open for sending and receiving messages.

fn on_request(&mut self, req: &Request) -> Result<Response, Error>

A method for handling the low-level workings of the request portion of the WebSocket handshake.

fn on_message(&mut self, msg: Message) -> Result<(), Error>

Called on incoming messages.

fn on_close(&mut self, code: CloseCode, reason: &str)

Called any time this endpoint receives a close control frame. This may be because the other endpoint is initiating a closing handshake, or it may be the other endpoint confirming the handshake initiated by this endpoint.

fn on_shutdown(&mut self)

Called when a request to shutdown all connections has been received.

fn on_error(&mut self, err: Error)

Called when an error occurs on the WebSocket.

fn on_response(&mut self, res: &Response) -> Result<(), Error>

A method for handling the low-level workings of the response portion of the WebSocket handshake.

fn on_timeout(&mut self, event: Token) -> Result<(), Error>

Called when a timeout is triggered.

fn on_new_timeout(&mut self, Token, Timeout) -> Result<(), Error>

Called when a timeout has been scheduled on the eventloop.

fn on_frame(&mut self, frame: Frame) -> Result<Option<Frame>, Error>

A method for handling incoming frames.

fn on_send_frame(&mut self, frame: Frame) -> Result<Option<Frame>, Error>

A method for handling outgoing frames.

fn build_request(&mut self, url: &Url) -> Result<Request, Error>

A method for creating the initial handshake request for WebSocket clients.