rflow 0.1.2

Text protocol for embedded apps
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

# Protocol description

RFlow is a text-based protocol that is used to communicate between the client
and the server. The protocol is designed to be simple and easy to implement.

## Server greeting

When the client connects to the server, the server sends a greeting message:

```
RFLOW/1
[optional headers]
---
```

* `RFLOW/1` is the protocol name and current version.
* `[optional headers]` is a list of optional headers that the server can send
  (HEADER: VALUE).
* `---` header transmission separator.

## Client to server messages

All messages SHOULD be sent as a single line. Messages from clients to server
are sent as-is.

## Server to client messages

All messages SHOULD be sent as a single line. Messages from server to clients
are prefixed as:

* `<<<` a message, sent by the server itself
* `>>>` a message, sent by the current (echo) or another client

## End of connection

When the client disconnects, the connection is closed.