1
0
Fork 0
mirror of https://github.com/actix/actix-web.git synced 2024-12-04 23:36:34 +00:00
actix-web/examples/websocket-chat/README.md

33 lines
982 B
Markdown
Raw Normal View History

2017-10-21 06:12:36 +00:00
# Websocket chat example
2017-12-30 15:50:49 +00:00
This is extension of the
2017-10-23 04:52:01 +00:00
[actix chat example](https://github.com/actix/actix/tree/master/examples/chat)
2017-10-21 06:12:36 +00:00
2017-10-21 09:08:07 +00:00
Added features:
* Browser WebSocket client
* Chat server runs in separate thread
* Tcp listener runs in separate thread
2017-10-21 06:12:36 +00:00
## Server
Chat server listens for incoming tcp connections. Server can access several types of message:
2017-12-30 15:50:49 +00:00
* `\list` - list all available rooms
* `\join name` - join room, if room does not exist, create new one
* `\name name` - set session name
2018-01-16 18:59:33 +00:00
* `some message` - just string, send message to all peers in same room
* client has to send heartbeat `Ping` messages, if server does not receive a heartbeat message for 10 seconds connection gets dropped
2017-12-30 15:50:49 +00:00
2017-10-21 06:12:36 +00:00
To start server use command: `cargo run --bin server`
## Client
Client connects to server. Reads input from stdin and sends to server.
To run client use command: `cargo run --bin client`
## WebSocket Browser Client
2017-12-30 15:50:49 +00:00
Open url: [http://localhost:8080/](http://localhost:8080/)