//! Simple echo websocket server. //! Open `http://localhost:8080/ws/index.html` in browser //! or [python console client](https://github.com/actix/examples/blob/master/websocket/websocket-client.py) //! could be used for testing. use std::time::{Duration, Instant}; use actix::prelude::*; use actix_files as fs; use actix_web::{middleware, web, App, Error, HttpRequest, HttpResponse, HttpServer}; use actix_web_actors::ws; /// How often heartbeat pings are sent const HEARTBEAT_INTERVAL: Duration = Duration::from_secs(5); /// How long before lack of client response causes a timeout const CLIENT_TIMEOUT: Duration = Duration::from_secs(10); /// do websocket handshake and start `MyWebSocket` actor fn ws_index(r: HttpRequest, stream: web::Payload) -> Result { println!("{:?}", r); let res = ws::start(MyWebSocket::new(), &r, stream); println!("{:?}", res.as_ref().unwrap()); res } /// websocket connection is long running connection, it easier /// to handle with an actor struct MyWebSocket { /// Client must send ping at least once per 10 seconds (CLIENT_TIMEOUT), /// otherwise we drop connection. hb: Instant, } impl Actor for MyWebSocket { type Context = ws::WebsocketContext; /// Method is called on actor start. We start the heartbeat process here. fn started(&mut self, ctx: &mut Self::Context) { self.hb(ctx); } } /// Handler for `ws::Message` impl StreamHandler for MyWebSocket { fn handle(&mut self, msg: ws::Message, ctx: &mut Self::Context) { // process websocket messages println!("WS: {:?}", msg); match msg { ws::Message::Ping(msg) => { self.hb = Instant::now(); ctx.pong(&msg); } ws::Message::Pong(_) => { self.hb = Instant::now(); } ws::Message::Text(text) => ctx.text(text), ws::Message::Binary(bin) => ctx.binary(bin), ws::Message::Close(_) => { ctx.stop(); } } } } impl MyWebSocket { fn new() -> Self { Self { hb: Instant::now() } } /// helper method that sends ping to client every second. /// /// also this method checks heartbeats from client fn hb(&self, ctx: &mut ::Context) { ctx.run_interval(HEARTBEAT_INTERVAL, |act, ctx| { // check client heartbeats if Instant::now().duration_since(act.hb) > CLIENT_TIMEOUT { // heartbeat timed out println!("Websocket Client heartbeat failed, disconnecting!"); // stop actor ctx.stop(); // don't try to send a ping return; } ctx.ping(""); }); } } fn main() -> std::io::Result<()> { std::env::set_var("RUST_LOG", "actix_server=info,actix_web=info"); env_logger::init(); HttpServer::new(|| { App::new() // enable logger .wrap(middleware::Logger::default()) // websocket route .service(web::resource("/ws/").route(web::get().to(ws_index))) // static files .service(fs::Files::new("/", "static/").index_file("index.html")) }) // start http server on 127.0.0.1:8080 .bind("127.0.0.1:8080")? .run() }