aboutsummaryrefslogtreecommitdiffstats
path: root/doc/bus_poll.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-05-15 15:04:25 +0200
committerMattias Andrée <maandree@operamail.com>2015-05-15 15:04:25 +0200
commit40341a0eec50588f574199a3ee213dbb97b576e5 (patch)
treedcf36c75385bb593086c10c7cf0a502d6f5311c8 /doc/bus_poll.3
parentupdate examples (diff)
downloadbus-40341a0eec50588f574199a3ee213dbb97b576e5.tar.gz
bus-40341a0eec50588f574199a3ee213dbb97b576e5.tar.bz2
bus-40341a0eec50588f574199a3ee213dbb97b576e5.tar.xz
fix nowait for polling + add nonblocking example
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to '')
-rw-r--r--doc/bus_poll.38
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/bus_poll.3 b/doc/bus_poll.3
index 857ea20..7962082 100644
--- a/doc/bus_poll.3
+++ b/doc/bus_poll.3
@@ -6,9 +6,9 @@ bus_poll - Wait a message to be broadcasted
.nf
#include <bus.h>
.P
-int bus_poll_start(bus_t *bus);
+int bus_poll_start(bus_t *bus, int flags);
int bus_poll_stop(const bus_t *bus);
-const char * bus_poll(bus_t *bus, int flags);
+const char * bus_poll(bus_t *bus);
.fi
.SH DESCRIPTION
The
@@ -16,7 +16,9 @@ The
function waits for a message to broadcasted on the \fIbus\fP, and return
the message it receives. The function fails if there is not already a
message waiting on the bus when the function is called and (\fIflags\fP
-&BUS_NOWAIT). Received messages shall be copied and parsed, and acted
+&BUS_NOWAIT) was used the last time
+.BR bus_poll_start(3)
+was called. Received messages shall be copied and parsed, and acted
upon, in a separate thread, and
.BR bus_poll(3)
or