actix-ws

WebSockets for Actix Web, without actors.

Example

use actix_web::{middleware::Logger, web, App, HttpRequest, HttpServer, Responder};
use actix_ws::Message;

async fn ws(req: HttpRequest, body: web::Payload) -> actix_web::Result<impl Responder> {
    let (response, mut session, mut msg_stream) = actix_ws::handle(&req, body)?;

    actix_web::rt::spawn(async move {
        while let Some(Ok(msg)) = msg_stream.recv().await {
            match msg {
                Message::Ping(bytes) => {
                    if session.pong(&bytes).await.is_err() {
                        return;
                    }
                }
                Message::Text(msg) => println!("Got text: {msg}"),
                _ => break,
            }
        }

        let _ = session.close(None).await;
    });

    Ok(response)
}

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    HttpServer::new(move || {
        App::new()
            .wrap(Logger::default())
            .route("/ws", web::get().to(ws))
    })
    .bind("127.0.0.1:8080")?
    .run()
    .await?;

    Ok(())
}

Typed Messages (Optional)

Enable the serde-json feature to send/receive typed messages using serde_json.

See examples/json.rs and run it with:

cargo run -p actix-ws --features serde-json --example json

WebSocket Sub-Protocols

Use handle_with_protocols when your server supports one or more Sec-WebSocket-Protocol values.

let (response, session, msg_stream) = actix_ws::handle_with_protocols(
    &req,
    body,
    &["graphql-transport-ws", "graphql-ws"],
)?;

When there is an overlap, the first protocol offered by the client that the server supports is returned in the handshake response.

Resources

• API Documentation
• Example Chat Project
• Minimum Supported Rust Version (MSRV): 1.88

License

This project is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.