diff options
| author | Mattias Andrée <maandree@operamail.com> | 2015-04-29 22:30:47 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@operamail.com> | 2015-04-29 22:30:47 +0200 |
| commit | 7754e3c18a7bfed1fea34d286c6f8f8e2f119a0d (patch) | |
| tree | 9c3a8639d49871d7ce6160a25bb19e3ff373e87c /doc/bus_write.3 | |
| parent | ... (diff) | |
| download | bus-7754e3c18a7bfed1fea34d286c6f8f8e2f119a0d.tar.gz bus-7754e3c18a7bfed1fea34d286c6f8f8e2f119a0d.tar.bz2 bus-7754e3c18a7bfed1fea34d286c6f8f8e2f119a0d.tar.xz | |
doc
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc/bus_write.3')
| -rw-r--r-- | doc/bus_write.3 | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/bus_write.3 b/doc/bus_write.3 index e058013..fd758be 100644 --- a/doc/bus_write.3 +++ b/doc/bus_write.3 @@ -4,12 +4,16 @@ bus_write - Broadcast a message a bus .SH SYNOPSIS #include <bus.h> -int bus_write(const bus_t *bus, const char *message); +int bus_write(const bus_t *bus, const char *message, int flags); .SH DESCRIPTION The \fIbus_write()\fP function broadcasts a message on the bus whose information is stored in \fIbus\fP. The message read by the function is stored in the parameter \fImessage\fP. It may not exceeed 2048 bytes, including NUL termination. +.PP +The \fIbus_write()\fP function shall fail, and set \fIerrno\fP to +\fIEAGAIN\fP, if the call would suspend the process and +(\fIflags\fP &BUS_NOWAIT). .SH RETURN VALUES Upon successful completion, the function returns 0. Otherwise the function returns -1 and sets \fIerrno\fP to indicate the error. |