event: add ability to get the event name
[src/app-framework-binder.git] / doc / afb-daemon-vocabulary.html
index d2d4f51..5a585c2 100644 (file)
@@ -7,20 +7,21 @@
   <meta name="author" content="José Bollo">
   <title>Vocabulary for AFB-DAEMON</title>
   <style type="text/css">code{white-space: pre;}</style>
+  <link rel="stylesheet" href="doc.css">
   <!--[if lt IE 9]>
-    <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
   <![endif]-->
-  <link rel="stylesheet" href="doc.css">
 </head>
 <body>
 <header>
 <h1 class="title">Vocabulary for AFB-DAEMON</h1>
 <h2 class="author">José Bollo</h2>
-<h3 class="date">27 mai 2016</h3>
+<h3 class="date">24 juin 2016</h3>
 </header>
 <nav id="TOC">
 <ul>
 <li><a href="#vocabulary-for-afb-daemon">Vocabulary for AFB-DAEMON</a><ul>
+<li><a href="#binding">Binding</a></li>
 <li><a href="#event">Event</a></li>
 <li><a href="#level-of-assurance-loa">Level of assurance (LOA)</a></li>
 <li><a href="#plugin">Plugin</a></li>
@@ -37,9 +38,9 @@
 </ul>
 </nav>
 <h1 id="vocabulary-for-afb-daemon">Vocabulary for AFB-DAEMON</h1>
-<pre><code>version: 1
-Date:    27 mai 2016
-Author:  José Bollo</code></pre>
+<h2 id="binding">Binding</h2>
+<p>A shared library object intended to be add a functionnality to an afb-daemon instance. It implements an API. It may provide a service.</p>
+<p>Binding made for services can have specific entry point called after initialisation and before serving.</p>
 <h2 id="event">Event</h2>
 <p>Message with data propagated from the services to the client and not expecting any reply.</p>
 <p>The current implementation allows to widely broadcast events to all clients.</p>
@@ -47,14 +48,14 @@ Author:  José Bollo</code></pre>
 <p>This level that can be from 0 to 3 represent the level of assurance that the services can expect from the session.</p>
 <p>The exact definition of the meaning of this levels and of how to use it remains to be achived.</p>
 <h2 id="plugin">Plugin</h2>
-<p>A shared library object intended to be plug to an afb-daemon instance to implement an API.</p>
+<p>Old name for binding, see binding.</p>
 <h2 id="request">Request</h2>
-<p>A request is an invocation by a client to a method of a plugin using a message transfered through some protocol: HTTP, WebSocket, DBUS... served by afb-daemon</p>
+<p>A request is an invocation by a client to a method of a binding using a message transfered through some protocol: HTTP, WebSocket, DBUS... served by afb-daemon</p>
 <h2 id="replyresponse">Reply/Response</h2>
 <p>This is a message sent to client as the result of the request.</p>
 <h2 id="service">Service</h2>
-<p>Service are made of plugins runnning by their side on their binder. It can serve many client. Each one being attached to one session.</p>
-<p>The framework establishes the connection between the services and the clients. Using DBus currently.</p>
+<p>Service are made of binding runnning by their side on their binder. It can serve many client. Each one being attached to one session.</p>
+<p>The framework establishes the connection between the services and the clients. Using DBus currently but other protocols are considered.</p>
 <h2 id="session">Session</h2>
 <p>A session is meant to be the unic context of an instance of client, identifying that instance across requests.</p>
 <p>Each session has an identifier. Session identifier generated by afb-daemon are UUIDs.</p>