1
0
mirror of https://github.com/actix/examples synced 2024-12-18 00:13:57 +01:00
examples/websockets/chat-tcp/README.md

39 lines
1.1 KiB
Markdown
Raw Normal View History

2018-05-11 23:35:43 +02:00
# Websocket chat example
2022-03-08 16:49:32 +01:00
This is extension of the [actix chat example](https://github.com/actix/examples/tree/HEAD/websockets/chat)
2018-05-11 23:35:43 +02:00
Added features:
2022-02-18 04:36:04 +01:00
- Browser WebSocket client
- Chat server runs in separate thread
- TCP listener runs in separate thread
2018-05-11 23:35:43 +02:00
## Server
Chat server listens for incoming tcp connections. Server can access several types of message:
2022-02-18 04:36:04 +01:00
- `/list` - list all available rooms
- `/join name` - join room, if room does not exist, create new one
- `/name name` - set session name
- `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
2018-05-11 23:35:43 +02:00
To start server run
```sh
cd websockets/chat-tcp
cargo run --bin websocket-tcp-server`
```
If the current directory is not correct, the server will look for `index.html` in the wrong place.
2018-05-11 23:35:43 +02:00
## Client
Client connects to server. Reads input from stdin and sends to server.
To run client use command: `cargo run --bin websocket-tcp-client`
2018-05-11 23:35:43 +02:00
## WebSocket Browser Client
2022-02-18 04:36:04 +01:00
Open url: <http://localhost:8080>