diff options
author | Mattias Andrée <maandree@kth.se> | 2017-12-11 23:13:37 +0100 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2017-12-11 23:13:37 +0100 |
commit | e35ba8684be9951fa2129503477ccd5ed6e4e5fc (patch) | |
tree | 756292d5a18ad6011a9311fdea8159f474385b65 /bus_write.3 | |
parent | typo (diff) | |
download | bus-e35ba8684be9951fa2129503477ccd5ed6e4e5fc.tar.gz bus-e35ba8684be9951fa2129503477ccd5ed6e4e5fc.tar.bz2 bus-e35ba8684be9951fa2129503477ccd5ed6e4e5fc.tar.xz |
Simplify, do not install examples or info manual, and change license3.1.7
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'bus_write.3')
-rw-r--r-- | bus_write.3 | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/bus_write.3 b/bus_write.3 new file mode 100644 index 0000000..833396e --- /dev/null +++ b/bus_write.3 @@ -0,0 +1,56 @@ +.TH BUS_WRITE 3 BUS +.SH NAME +bus_write, bus_write_timed - Broadcast a message a bus +.SH SYNOPSIS +.LP +.nf +#include <bus.h> +.P +int bus_write(const bus_t *\fIbus\fP, const char *\fImessage\fP, int \fIflags\fP); +int bus_write_timed(const bus_t *\fIbus\fP, const char *\fImessage\fP, + const struct timespec *\fItimeout\fP, clockid_t \fIclockid\fP); +.fi +.SH DESCRIPTION +The +.BR bus_write () +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 NULL termination. +.PP +The +.BR bus_write () +function shall fail, and set \fIerrno\fP to \fIEAGAIN\fP, if the call +would suspend the process and (\fIflags\fP &BUS_NOWAIT). +.PP +The +.BR bus_write_timed () +function behaves like +.BR bus_write (), +except if it is not able to write the \fImessage\fP within the specified +time, it will fail and set \fIerrno\fP to \fBEAGAIN\fP. The time is +specified as an absolute time using the parameter \fItimeout\fP. The +behaviour is unspecified if \fItimeout\fP is \fINULL\fP. \fItimeout\fP +is measured with the clock whose ID is specified by the \fIclockid\fP +parameter. This clock must be a predicitable clock. +.SH RETURN VALUES +Upon successful completion, these functions returns 0. Otherwise the +function returns -1 and sets \fIerrno\fP to indicate the error. +.SH ERRORS +The +.BR bus_write (3) +function may fail and set \fIerrno\fP to any of the errors specified for +.BR semop (3). +The +.BR bus_write_timed (3) +function may also set \fIerrno\fP to any of the errors specified for +.BR clock_gettime (3). +.SH SEE ALSO +.BR bus-create (1), +.BR bus (5), +.BR libbus (7), +.BR bus_open (3), +.BR bus_read (3), +.BR bus_poll (3), +.BR bus_chown (3), +.BR bus_chmod (3), +.BR clock_gettime (3) |