aboutsummaryrefslogtreecommitdiffstats
path: root/doc/examples/timed/README
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-05-17 14:28:20 +0200
committerMattias Andrée <maandree@operamail.com>2015-05-17 14:28:20 +0200
commit0f31d194025df5d63fcee65e32baa90cc5aa0ad6 (patch)
tree83ff9e158ba9df44dc8bb1a3c4ff6304ceb86a29 /doc/examples/timed/README
parentimplemented timed write, read and poll (diff)
downloadbus-0f31d194025df5d63fcee65e32baa90cc5aa0ad6.tar.gz
bus-0f31d194025df5d63fcee65e32baa90cc5aa0ad6.tar.bz2
bus-0f31d194025df5d63fcee65e32baa90cc5aa0ad6.tar.xz
add timed example and fix timed polling
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc/examples/timed/README')
-rw-r--r--doc/examples/timed/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/examples/timed/README b/doc/examples/timed/README
new file mode 100644
index 0000000..b0989bf
--- /dev/null
+++ b/doc/examples/timed/README
@@ -0,0 +1,18 @@
+API usage example
+
+This example shows how to use timed operations.
+
+
+
+First of, run make to build this example.
+
+To start the example run ./init.
+When you are done run ./cleanup.
+
+Running instances of ./poll will wait for new messages
+continuously, but with one second timeouts.
+
+./poll, ./init and ./cleanup are run without any
+additional arguments. ./write is run with the message
+as the second argument.
+