aboutsummaryrefslogtreecommitdiffstats
path: root/doc/afb-events-guide.md
diff options
context:
space:
mode:
authorJosé Bollo <jose.bollo@iot.bzh>2016-09-19 10:54:42 +0200
committerJosé Bollo <jose.bollo@iot.bzh>2016-09-20 14:39:50 +0200
commitc9bb1cec405741d5721dfcafb35b187c6f182a6f (patch)
tree134521beaae17dd2e63462a573bed59e83a3a142 /doc/afb-events-guide.md
parentda7789182cd0a7180bf7057d310cf9ad1cd75fe3 (diff)
Documentation: improvements
- improves formatting of the documentation on events - add documentations of functions in headers Change-Id: Ie39d34fca8bd563a099f6b575c72e314ca08a29d Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'doc/afb-events-guide.md')
-rw-r--r--doc/afb-events-guide.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/afb-events-guide.md b/doc/afb-events-guide.md
index 488c52af..f24bef3f 100644
--- a/doc/afb-events-guide.md
+++ b/doc/afb-events-guide.md
@@ -1,5 +1,5 @@
-Guid for developing with events
--------------------------------
+Guide for developing with events
+================================
Signaling agents are services that send events to any clients that
subscribed for receiving it. The sent events carry any data.
@@ -8,6 +8,9 @@ To have a good understanding of how to write a signaling agent, the
actions of subscribing, unsubscribing, producing, sending, receiving
events must be described and explained.
+Overview of events
+------------------
+
The basis of a signaling agent is shown on the following figure:
![scenario of using events](signaling-basis.svg)