mirror of
https://github.com/tokio-rs/axum.git
synced 2024-11-22 07:08:16 +01:00
Fix some comments in websockets example (#1702)
This commit is contained in:
parent
7ecf8bd6cf
commit
6d815e2b0a
1 changed files with 11 additions and 9 deletions
|
@ -1,15 +1,19 @@
|
||||||
//! Example websocket server.
|
//! Example websocket server.
|
||||||
//!
|
//!
|
||||||
//! Run the server with
|
//! Run the server with
|
||||||
//!
|
|
||||||
//! ```not_rust
|
//! ```not_rust
|
||||||
//! cargo run -p example-websockets
|
//! cargo run -p example-websockets --bin example-websockets
|
||||||
|
//! ```
|
||||||
|
//!
|
||||||
|
//! Run a browser client with
|
||||||
|
//! ```not_rust
|
||||||
//! firefox http://localhost:3000
|
//! firefox http://localhost:3000
|
||||||
//! ```
|
//! ```
|
||||||
//!
|
//!
|
||||||
//! Alternatively you can run the rust client with
|
//! Alternatively you can run the rust client (showing two
|
||||||
|
//! concurrent websocket connections being established) with
|
||||||
//! ```not_rust
|
//! ```not_rust
|
||||||
//! cargo run -p example-client
|
//! cargo run -p example-websockets --bin example-client
|
||||||
//! ```
|
//! ```
|
||||||
|
|
||||||
use axum::{
|
use axum::{
|
||||||
|
@ -63,8 +67,6 @@ async fn main() {
|
||||||
)
|
)
|
||||||
}),
|
}),
|
||||||
)
|
)
|
||||||
// routes are matched from bottom to top, so we have to put `nest` at the
|
|
||||||
// top since it matches all routes
|
|
||||||
.route("/ws", get(ws_handler))
|
.route("/ws", get(ws_handler))
|
||||||
// logging so we can see whats going on
|
// logging so we can see whats going on
|
||||||
.layer(
|
.layer(
|
||||||
|
@ -82,7 +84,7 @@ async fn main() {
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The handler for the HTTP request (this gets called when the HTTP GET lands at the start
|
/// The handler for the HTTP request (this gets called when the HTTP GET lands at the start
|
||||||
/// of websocket negotiation. After this completes, the actual switching from HTTP to
|
/// of websocket negotiation). After this completes, the actual switching from HTTP to
|
||||||
/// websocket protocol will occur.
|
/// websocket protocol will occur.
|
||||||
/// This is the last point where we can extract TCP/IP metadata such as IP address of the client
|
/// This is the last point where we can extract TCP/IP metadata such as IP address of the client
|
||||||
/// as well as things from HTTP headers such as user-agent of the browser etc.
|
/// as well as things from HTTP headers such as user-agent of the browser etc.
|
||||||
|
@ -114,7 +116,7 @@ async fn handle_socket(mut socket: WebSocket, who: SocketAddr) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
// receive single message form a client (we can either receive or send with socket).
|
// receive single message from a client (we can either receive or send with socket).
|
||||||
// this will likely be the Pong for our Ping or a hello message from client.
|
// this will likely be the Pong for our Ping or a hello message from client.
|
||||||
// waiting for message from a client will block this task, but will not block other client's
|
// waiting for message from a client will block this task, but will not block other client's
|
||||||
// connections.
|
// connections.
|
||||||
|
@ -131,7 +133,7 @@ async fn handle_socket(mut socket: WebSocket, who: SocketAddr) {
|
||||||
|
|
||||||
// Since each client gets individual statemachine, we can pause handling
|
// Since each client gets individual statemachine, we can pause handling
|
||||||
// when necessary to wait for some external event (in this case illustrated by sleeping).
|
// when necessary to wait for some external event (in this case illustrated by sleeping).
|
||||||
// Waiting for this client to finish getting his greetings does not prevent other clients form
|
// Waiting for this client to finish getting its greetings does not prevent other clients from
|
||||||
// connecting to server and receiving their greetings.
|
// connecting to server and receiving their greetings.
|
||||||
for i in 1..5 {
|
for i in 1..5 {
|
||||||
if socket
|
if socket
|
||||||
|
|
Loading…
Reference in a new issue