~kt/udprelay

udprelay/udprelay.7.scd -rw-r--r-- 2.3 KiB
7ef0adeaKatie Wolfe Add note about -timeout parsing specifics 11 months ago
                                                                                
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
udprelay(7) "udprelay v1.0.1"

# NAME

udprelay \- protocol for additional functionality implemented by *udprelay*(1)

# COMMANDS

Packets beginning with the string _udprelay!_ are interpreted as commands and
are not forwarded to other peers. Each commands has a _head_ and a _body_. The
_head_ is a sequence of lowercase alphabetical characters identifying the
command to be executed. The _body_ is information passed to the command. The
_body_ may contain any characters, but any spacing characters (one of 0x09,
0x0A, 0x0B, 0x0C, 0x0D, or 0x20) at the beginning or end of the body will be
trimmed and ignored. The _head_ and _body_ are separated by one of the
aforementioned spacing characters. If the _body_ is empty, you may omit the
space and only send the _head_. The following are examples of valid command
calls:

	udprelay!channel Example

	udprelay!echo

	udprelay!echo Hello, world.

A packet starting with the string _udprelay!_ will never be relayed to other
peers. If a call is made to a command that doesn't exist, it is ignored.

## channel

The *channel* command switches the peer to a different channel identified by the
first string of non-spacing-characters in the command's _body_. If the _body_ is
empty, the peer is switched to the default unnamed channel. Peers will only
receive and send messages sent by and to peers who have connected to the same
channel. After switching the peer's channel, the server will respond with the
string _udprelay!channel_ followed by a space (0x20) and the same channel
identifier that was sent to the server.

If a spacing character follows the channel identifier, the data following the
spacing character will be sent to that channel as if it had been sent in its own
packet. If no data follows the spacing character, an empty packet will be sent.

## echo

Upon receiving an *echo* command, udprelay will resend the command's packet to
its originator unchanged. Anything or nothing may be passed as arguments to this
command; it will not interpret any of the remaining data in the packet.

# SEE ALSO

*udprelay*(1)

# AUTHORS

udprelay is maintained by Katie Wolfe <wolfe@katie.host>. Its source is located
at https://git.sr.ht/~kt/udprelay. Questions about the project, bugs, and
patches may be submitted to the mailing list at ~kt/udprelay@lists.sr.ht or
directly to the author at wolfe@katie.host.