Socket.IO Controllers
In Sword, a Socket.IO controller is a struct annotated with #[controller(kind = Controller::SocketIo, namespace = "...")], and its methods handle events declared with #[on("...")].
Define a controller
rust
use sword::prelude::*;
use sword::socketio::*;
#[controller(kind = Controller::SocketIo, namespace = "/chat")]
pub struct ChatController;
impl ChatController {
#[on("connection")]
async fn on_connect(&self, socket: SocketContext) {
println!("Client connected: {}", socket.id());
let query: Option<MyQuery> = socket.query().unwrap();
println!("Query params: {:?}", query);
}
#[on("message")]
async fn on_message(&self, socket: SocketContext) {
let Ok(message) = socket.try_data::<String>() else {
return;
};
socket.emit("message", &message).ok();
}
}Reading Query Parameters
The socket.query::<T>() method deserializes query parameters from the connection URL:
rust
#[on("connection")]
async fn on_connect(&self, socket: SocketContext) {
let query: Option<MyQuery> = socket.query().unwrap();
}Supported events
Special events
#[on("connection")]#[on("disconnection")]#[on("fallback")]
Custom events
#[on("message")]#[on("chat-message")]#[on("room:join")]
Register in a module
rust
use sword::prelude::*;
pub struct ChatModule;
impl Module for ChatModule {
fn register_controllers(controllers: &ControllerRegistry) {
controllers.register::<ChatController>();
}
}