diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/bus_write.3 | 6 | ||||
| -rw-r--r-- | doc/libbus.7 | 5 |
2 files changed, 7 insertions, 4 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. diff --git a/doc/libbus.7 b/doc/libbus.7 index c3f14e6..4b0ead4 100644 --- a/doc/libbus.7 +++ b/doc/libbus.7 @@ -10,9 +10,8 @@ But we need broadcasting rather than anycasting, so we have a fast, simple and daemonless system for announcing events to any processes that might be interested. .SH FUTURE DIRECTION -Perhaps the ability to have groups and other permissions on bus, so they -can be shared among users and be system-wide. Private and abstract -buses might be interesting too, as well as timed out read and writes. +Private and abstract buses might be interesting. Timed out read and +writes might be too. .SH SEE ALSO bus(1), bus(5), bus_create(3), bus_unlink(3), bus_open(3), bus_close(3), bus_read(3), bus_write(3) |