aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: 5c6d5adace7beb031b1c238cf29fc542c90c0d94 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
A simple daemonless system for broadcasting messages locally.
bus is a light-weight alternative to a two-phase flexible barrier.

bus uses a System V semaphore array and System V shared memory.
Buses are named; the key of the semaphore array and the
shared memory is stored in a regular file.

The shared memory used by bus is always 2048 bytes. Additionally
all messages should be encoded in UTF-8 and not contain any NULL
characters, except they MUST always end with a zero byte.
Furthermore messages should be prefixed with the process
identifer of the process whence the message originated, followed
by a space. If the process is ephemeral, 0 should be used instead
of the process identifier.

Communication over bus is synchronous. The broadcast call does
not return until all listeners have received (and copyied)
the message. A malfunctioning program can lock to bus.

The software package contains a C library and a command line
utility. The package python-bus provides a Python 3 module.