From c9bb1cec405741d5721dfcafb35b187c6f182a6f Mon Sep 17 00:00:00 2001 From: José Bollo Date: Mon, 19 Sep 2016 10:54:42 +0200 Subject: Documentation: improvements MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - improves formatting of the documentation on events - add documentations of functions in headers Change-Id: Ie39d34fca8bd563a099f6b575c72e314ca08a29d Signed-off-by: José Bollo --- doc/afb-events-guide.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'doc/afb-events-guide.md') 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) -- cgit 1.2.3-korg