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_open.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_open.3')
-rw-r--r-- | bus_open.3 | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/bus_open.3 b/bus_open.3 new file mode 100644 index 0000000..35abb27 --- /dev/null +++ b/bus_open.3 @@ -0,0 +1,59 @@ +.TH BUS_OPEN 3 BUS +.SH NAME +bus_open - Open a bus +.SH SYNOPSIS +.LP +.nf +#include <bus.h> +.P +int bus_open(bus_t *\fIbus\fP, const char *\fIfile\fP, int \fIflags\fP); +.fi +.SH DESCRIPTION +The +.BR bus_open () +function acquires resources required for the process to use the bus +associated with the filename stored in \fIfile\fP. The function also +stores the resources in \fIbus\fP for use by other +.BR bus +functions. +.PP +Values for \fIflags\fP are constructed by a bitwise inclusive OR of +flags from the following list. +.TP +.B BUS_RDONLY +The process will only be using the bus for receiving messages. +.TP +.B BUS_WRONLY +The process will only be using the bus for sending messages. +.TP +.B BUS_RDWR +The process will use the bus for both receiving and sending messages. +.SH RETURN VALUES +Upon successful completion the function returns 0. Otherwise the +function returns -1 and set \fIerrno\fP to indicate the error. +.SH ERRORS +.TP +.B ENOMEM +The process cannot allocate more memory. +.TP +.B EACCES +Operation permission is denied to the calling process. +.TP +.B EINVAL +The described bus does not exist. +.PP +The +.BR bus_open () +function may also fail and set \fIerrno\fP to any of the errors +specified for the routine +.BR open (2). +.SH SEE ALSO +.BR bus-create (1), +.BR bus (5), +.BR libbus (7), +.BR bus_close (3), +.BR bus_unlink (3), +.BR bus_write (3), +.BR bus_read (3), +.BR bus_poll (3), +.BR open (2) |