search

Totodore / socketioxide

A socket.io server implementation in Rust that integrates with the Tower ecosystem and the Tokio stack.
https://docs.rs/socketioxide
MIT License
1.13k stars 48 forks source link
axum hyper rust socket-io tokio tower

readme

Socketioxide 🚀🦀

A socket.io server implementation in Rust that integrates with the Tower ecosystem and the Tokio stack. It integrates with any server framework based on tower like Axum, Warp, Salvo, Viz or Hyper. Add any other tower based middleware on top of socketioxide such as CORS, authorization, compression, etc with tower-http.

⚠️ This crate is under active development and the API is not yet stable.

Crates.io Documentation CI

Features :

Planned features :

Examples :

Chat app 💬 (see full example here) ```rust io.ns("/", |s: SocketRef| { s.on("new message", |s: SocketRef, Data::(msg)| { let username = s.extensions.get::().unwrap().clone(); let msg = Res::Message { username, message: msg, }; s.broadcast().emit("new message", msg).ok(); }); s.on( "add user", |s: SocketRef, Data::(username), user_cnt: State| { if s.extensions.get::().is_some() { return; } let num_users = user_cnt.add_user(); s.extensions.insert(Username(username.clone())); s.emit("login", Res::Login { num_users }).ok(); let res = Res::UserEvent { num_users, username: Username(username), }; s.broadcast().emit("user joined", res).ok(); }, ); s.on("typing", |s: SocketRef| { let username = s.extensions.get::().unwrap().clone(); s.broadcast() .emit("typing", Res::Username { username }) .ok(); }); s.on("stop typing", |s: SocketRef| { let username = s.extensions.get::().unwrap().clone(); s.broadcast() .emit("stop typing", Res::Username { username }) .ok(); }); s.on_disconnect(|s: SocketRef, user_cnt: State| { if let Some(username) = s.extensions.get::() { let num_users = user_cnt.remove_user(); let res = Res::UserEvent { num_users, username: username.clone(), }; s.broadcast().emit("user left", res).ok(); } }); }); ```
Echo implementation with Axum 🏓 ```rust use axum::routing::get; use serde_json::Value; use socketioxide::{ extract::{AckSender, Bin, Data, SocketRef}, SocketIo, }; use tracing::info; use tracing_subscriber::FmtSubscriber; fn on_connect(socket: SocketRef, Data(data): Data) { info!("Socket.IO connected: {:?} {:?}", socket.ns(), socket.id); socket.emit("auth", data).ok(); socket.on( "message", |socket: SocketRef, Data::(data), Bin(bin)| { info!("Received event: {:?} {:?}", data, bin); socket.bin(bin).emit("message-back", data).ok(); }, ); socket.on( "message-with-ack", |Data::(data), ack: AckSender, Bin(bin)| { info!("Received event: {:?} {:?}", data, bin); ack.bin(bin).send(data).ok(); }, ); } #[tokio::main] async fn main() -> Result<(), Box> { tracing::subscriber::set_global_default(FmtSubscriber::default())?; let (layer, io) = SocketIo::new_layer(); io.ns("/", on_connect); io.ns("/custom", on_connect); let app = axum::Router::new() .route("/", get(|| async { "Hello, World!" })) .layer(layer); info!("Starting server"); let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap(); axum::serve(listener, app).await.unwrap(); Ok(()) } ```

Other examples are available in the example folder

Contributions and Feedback / Questions :

Any contribution is welcome, feel free to open an issue or a PR. If you want to contribute but don't know where to start, you can check the issues.

If you have any question or feedback, please open a thread on the discussions page.

License 🔐

This project is licensed under the MIT license.