From be448e668988a19a9c257b69f469eb82395fff7a Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sat, 25 Apr 2015 14:18:44 +0200 Subject: add message length restriction and message format to readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- README | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'README') diff --git a/README b/README index bd71e2e..3069d86 100644 --- a/README +++ b/README @@ -4,6 +4,14 @@ 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. -- cgit v1.2.3-70-g09d2