2018-05-22 23:15:08 +02:00
|
|
|
---
|
|
|
|
|
title: Websockets
|
|
|
|
|
menu: docs_proto
|
|
|
|
|
weight: 240
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
Actix supports WebSockets out-of-the-box. It is possible to convert a request's `Payload`
|
2019-06-25 05:36:32 +02:00
|
|
|
to a stream of [*ws::Message*][message] with a [*ws::WsStream*][wsstream] and then use stream
|
2018-05-22 23:15:08 +02:00
|
|
|
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:
|
|
|
|
|
|
2019-06-18 00:07:57 +02:00
|
|
|
{{< include-example example="websockets" file="main.rs" section="websockets" >}}
|
2018-05-22 23:15:08 +02:00
|
|
|
|
2019-06-25 05:36:32 +02:00
|
|
|
> A simple websocket echo server example is available in the [examples directory][examples].
|
2018-05-22 23:15:08 +02:00
|
|
|
|
|
|
|
|
> An example chat server with the ability to chat over a websocket or tcp connection
|
2019-06-25 05:36:32 +02:00
|
|
|
> 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/
|
