actix-website/content/docs/websockets.md

title	menu	weight
Websockets	docs_proto	240

Actix supports WebSockets out-of-the-box. It is possible to convert a request's Payload to a stream of ws::Message with a ws::WsStream and then use stream combinators to handle actual messages, but it is simpler to handle websocket communications with an http actor.

The following is an example of a simple websocket echo server:

use actix::*;
use actix_web::*;

/// Define http actor
struct Ws;

impl Actor for Ws {
    type Context = ws::WebsocketContext<Self>;
}

/// Handler for ws::Message message
impl StreamHandler<ws::Message, ws::ProtocolError> for Ws {

    fn handle(&mut self, msg: ws::Message, ctx: &mut Self::Context) {
        match msg {
            ws::Message::Ping(msg) => ctx.pong(&msg),
            ws::Message::Text(text) => ctx.text(text),
            ws::Message::Binary(bin) => ctx.binary(bin),
            _ => (),
        }
    }
}

fn main() {
    App::new()
      .resource("/ws/", |r| r.f(|req| ws::start(req, Ws)))
      .finish();
}

A simple websocket echo server example is available in the examples directory.

An example chat server with the ability to chat over a websocket or tcp connection is available in websocket-chat directory