1
0
mirror of https://github.com/deavminet/dnetd synced 2024-09-21 09:43:37 +02:00
dnetd_old/protocol.md

123 lines
1.6 KiB
Markdown
Raw Normal View History

2020-09-23 09:37:18 +02:00
dnet protocol specification
===========================
2020-09-23 10:33:19 +02:00
## Preamble
Every command starts with a 1 byte code specifying the command.
```
|-- command (1 byte) --|-- dependant on command (n bytes) --|
```
## Command listing (client/server->server)
1. `auth` - authenticate a new client
2. `link` - authenticate a new server
## Client/Server types (server->server/client)
1. `msg` - new message
## Commands
### `auth`
2020-09-23 13:14:55 +02:00
Request format:
2020-09-23 10:33:19 +02:00
```
2020-09-23 10:52:00 +02:00
|-- 0 --|-- usernameLength (1 byte) --|-- username --|-- password --|
2020-09-23 10:33:19 +02:00
```
2020-09-23 13:14:55 +02:00
Reply format:
```
2020-09-24 12:31:53 +02:00
|-- status (1 byte) --|
2020-09-23 13:14:55 +02:00
```
2020-09-23 10:33:19 +02:00
### `link`
```
2020-09-24 12:31:53 +02:00
|-- 1 --|-- todo
2020-09-23 10:33:19 +02:00
```
2020-09-23 09:37:18 +02:00
2020-09-24 12:31:53 +02:00
### `reg`
2
### `join`
Request format:
TODO: Allow multiple joins
```
|-- 3 --|-- channelToJoin(CSV) --|
```
Reply format:
```
|-- status (1 byte) --|
```
TODO: Support redirects?
### `part`
Request format:
```
|-- 4 --|-- channelToPart(CSV) --|
```
Reply format:
```
|-- status (1 byte) --|
```
### `msg`
5
### `list`
Request format:
```
|-- 6 --|
```
Reply format:
```
|-- status (1 byte) --|-- channelnames(CSV) --|
```
2020-09-24 13:28:17 +02:00
### `msg`
Request format:
```
|-- 7 --|-- type (1 byte) --|-- channel/person name (null terminated) --|-- message --|
```
* `type`, `0` - to user, `1` to channel
2020-09-24 12:31:53 +02:00
### `chanprop`
2020-09-25 19:32:06 +02:00
---
Anything that isn't a command above will return with `2` which means _unknown command_.
`0` generally means that everything went well but commands can send more data after it,
it depends, and `1` means error - also more data may follow.
## notifications
We know as tristanable tag 1, but then _types_ of notifications is the important factor described here.
### TODO: message receive format
```
|-- notifyTYpe (1 byte) --|-- ..
```