summaryrefslogtreecommitdiffstats
path: root/doc/afb-events-guide.html
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.html
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.html')
-rw-r--r--doc/afb-events-guide.html13
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/afb-events-guide.html b/doc/afb-events-guide.html
index aa606400..c554feab 100644
--- a/doc/afb-events-guide.html
+++ b/doc/afb-events-guide.html
@@ -5,7 +5,7 @@
<meta name="generator" content="pandoc">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<meta name="author" content="José Bollo">
- <title>Guid for developing with events</title>
+ <title>Guide for developing with events</title>
<style type="text/css">code{white-space: pre;}</style>
<style type="text/css">
div.sourceCode { overflow-x: auto; }
@@ -51,13 +51,14 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf
</head>
<body>
<header>
-<h1 class="title">Guid for developing with events</h1>
+<h1 class="title">Guide for developing with events</h1>
<h2 class="author">José Bollo</h2>
-<h3 class="date">16 septembre 2016</h3>
+<h3 class="date">19 septembre 2016</h3>
</header>
<nav id="TOC">
<ul>
-<li><a href="#guid-for-developing-with-events">Guid for developing with events</a><ul>
+<li><a href="#guide-for-developing-with-events">Guide for developing with events</a><ul>
+<li><a href="#overview-of-events">Overview of events</a><ul>
<li><a href="#subscribing-and-unsubscribing">Subscribing and unsubscribing</a></li>
<li><a href="#generating-and-pushing-signals-and-data">Generating and pushing signals and data</a></li>
<li><a href="#receiving-the-signals">Receiving the signals</a></li>
@@ -76,11 +77,13 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf
<li><a href="#strict-separation">Strict separation</a></li>
<li><a href="#soft-composition">Soft composition</a></li>
</ul></li>
+</ul></li>
</ul>
</nav>
-<h2 id="guid-for-developing-with-events">Guid for developing with events</h2>
+<h1 id="guide-for-developing-with-events">Guide for developing with events</h1>
<p>Signaling agents are services that send events to any clients that subscribed for receiving it. The sent events carry any data.</p>
<p>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.</p>
+<h2 id="overview-of-events">Overview of events</h2>
<p>The basis of a signaling agent is shown on the following figure:</p>
<figure>
<img src="signaling-basis.svg" alt="scenario of using events" /><figcaption>scenario of using events</figcaption>