Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mnxn/chat
IRC-like relayed TCP chat protocol
https://github.com/mnxn/chat
chat go tcp
Last synced: 19 days ago
JSON representation
IRC-like relayed TCP chat protocol
- Host: GitHub
- URL: https://github.com/mnxn/chat
- Owner: mnxn
- License: agpl-3.0
- Created: 2023-02-27T23:08:59.000Z (almost 2 years ago)
- Default Branch: trunk
- Last Pushed: 2023-10-18T06:18:58.000Z (about 1 year ago)
- Last Synced: 2024-10-28T16:51:39.877Z (2 months ago)
- Topics: chat, go, tcp
- Language: Go
- Homepage:
- Size: 123 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Introduction
This project contains both the server and client implementations of a custom TCP
chat protocol.
Users can either send chat messages to other users or "rooms." Sending a chat
message to a room notifies every other user that is connected to the room.
Servers only act as relays and forward chat messages between clients. The server
maintains lists of rooms and users while clients can display message history.
Clients only interact with the server and are not made aware of other clients'
IP addresses. Clients can create, join, and leave rooms. The server shall
fulfill queries for lists of rooms and connected users.
## Usage
```
Usage of chat-client.exe:
-host string
chat server hostname (default "localhost")
-keepalive int
how often to send keepalive request to the server in seconds (default 15)
-name string
display name
-port int
chat server port number (default 5555)
```
```
Usage of chat-server.exe:
-port int
chat server port number (default 5555)
```
## Instructions
Build all or specific executables:
- `make`
- `make all`
- `make chat-client.exe`
- `make chat-server.exe`
Run protocol unit tests:
- `make test`
Run protocol fuzzing tests
- `make fuzz`
Clean files:
- `make clean`
Run with race detector:
- `make RACE=y run-client`
- `make RACE=y run-server`
# Protocol
Documentation for the protocol can be found here:
https://pkg.go.dev/github.com/mnxn/chat/protocol