actix/actix-website
1
0
Fork 0
mirror of https://github.com/actix/actix-website synced 2025-06-29 08:14:58 +02:00
Code Issues Releases Wiki Activity

Websockets chapter done-ish.

Browse Source
This commit is contained in:
Cameron Dershem
2019-06-26 12:55:12 -04:00
parent 4436eff7de
commit 387807ee6e
3 changed files with 47 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
content/docs/websockets.md
View File

@ -4,10 +4,10 @@ menu: docs_proto
weight: 240
---
Actix supports WebSockets out-of-the-box. It is possible to convert a request's `Payload`
to a stream of [*ws::Message*][message] with a [*ws::WsStream*][wsstream] and then use stream
combinators to handle actual messages, but it is simpler to handle websocket communications
with an http actor.
Actix-web supports WebSockets with the `actix-web-actors` crate. It is possible to convert a
request's `Payload` to a stream of [*ws::Message*][message] with a [*web::Payload*][payload]
and then use stream combinators to handle actual messages, but it is simpler to handle
websocket communications with an http actor.
The following is an example of a simple websocket echo server:
@ -18,7 +18,7 @@ The following is an example of a simple websocket echo server:
> An example chat server with the ability to chat over a websocket or tcp connection
> is available in [websocket-chat directory][chat]
[message]: ../../actix-web/actix_web/ws/enum.Message.html
[wsstream]: ../../actix-web/actix_web/ws/struct.WsStream.html
[message]: https://docs.rs/actix-web-actors/1.0.0/actix_web_actors/ws/enum.Message.html
[payload]: https://docs.rs/actix-web/1.0.2/actix_web/web/struct.Payload.html
[examples]: https://github.com/actix/examples/tree/master/websocket/
[chat]: https://github.com/actix/examples/tree/master/websocket-chat/