Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
olksdr committed Dec 27, 2022
1 parent c2d6fa2 commit dd9f998
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions relay-server/src/actors/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
//! Actors require an actix system to run, see [`relay_system`] and particularly
//! [`Controller`](relay_system::Controller) for more information.
//!
//! The web server is wrapped by the [`Server`](server::Server) actor. It starts the actix http web
//! The web server is wrapped by the [`ServerService`](server::ServerService) actor. It starts the actix http web
//! server and relays the graceful shutdown signal. Internally, it creates several other actors
//! comprising the service state:
//!
Expand All @@ -25,7 +25,10 @@
//! use relay_server::controller::Controller;
//! use relay_server::server::Server;
//!
//! Controller::run(|| Server::start())
//! let rt = tokio::runtime::Runtime::new().unwrap();
//! let sys = actix::System::new("my-system");
//!
//! Controller::run(rt.handle(), sys, || Server::start())
//! .expect("failed to start relay");
//! ```
pub mod envelopes;
Expand Down

0 comments on commit dd9f998

Please sign in to comment.