1
0
mirror of https://github.com/actix/actix-website synced 2024-11-30 19:14:36 +01:00
actix-website/content/docs/websockets.md

25 lines
989 B
Markdown

---
title: Websockets
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.
The following is an example of a simple websocket echo server:
{{< include-example example="websockets" file="main.rs" section="websockets" >}}
> A simple websocket echo server example is available in the [examples directory][examples].
> 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
[examples]: https://github.com/actix/examples/tree/master/websocket/
[chat]: https://github.com/actix/examples/tree/master/websocket-chat/