vocabulary: moving from 'plugin' to 'binding'
[src/app-framework-binder.git] / doc / afb-overview.html
index e8050f9..23ca6e9 100644 (file)
@@ -16,7 +16,7 @@
 <header>
 <h1 class="title">Overview of AFB-DAEMON</h1>
 <h2 class="author">José Bollo</h2>
-<h3 class="date">30 mai 2016</h3>
+<h3 class="date">23 juin 2016</h3>
 </header>
 <nav id="TOC">
 <ul>
@@ -27,7 +27,7 @@
 <li><a href="#adding-native-features-to-html5qml-applications">Adding native features to HTML5/QML applications</a></li>
 <li><a href="#offering-services-to-the-system">Offering services to the system</a></li>
 </ul></li>
-<li><a href="#the-plugins-of-the-binder-afb-daemon">The plugins of the binder afb-daemon</a></li>
+<li><a href="#the-bindings-of-the-binder-afb-daemon">The bindings of the binder afb-daemon</a></li>
 <li><a href="#launching-the-binder-afb-daemon">Launching the binder afb-daemon</a></li>
 <li><a href="#future-development-of-afb-daemon">Future development of afb-daemon</a></li>
 </ul></li>
@@ -59,7 +59,7 @@ Figure: binder afb-daemon, basis
 .   +-------------------+----------------------+  .
 .   |                            :             |  .
 .   |        b i n d e r         :             |  .
-.   |    A F B - D A E M O N     :   PLUGINS   |  .
+.   |    A F B - D A E M O N     :  BINDINGS   |  .
 .   |                            :             |  .
 .   +-------------------+----------------------+  .
 .                       |                         .
@@ -106,7 +106,7 @@ Figure: binder afb-daemon and remotely running application
 .                           |                           .
 .       +-------------------+----------------------+    .
 .       |                            :             |    .
-.       |    A F B - D A E M O N     :   PLUGINS   |    .
+.       |    A F B - D A E M O N     :   BINDINGS  |    .
 .       |                            :             |    .
 .       +-------------------+----------------------+    .
 .                           |                           .
@@ -115,9 +115,9 @@ Figure: binder afb-daemon and remotely running application
                             v
                        AGL SYSTEM</code></pre>
 <h3 id="adding-native-features-to-html5qml-applications">Adding native features to HTML5/QML applications</h3>
-<p>Applications can provide with their packaged delivery a plugin. That plugin will be instanciated for each application instance. The methods of the plugin will be accessible by applications and will be excuted within the security context.</p>
+<p>Applications can provide with their packaged delivery a binding. That binding will be instanciated for each application instance. The methods of the binding will be accessible by applications and will be excuted within the security context.</p>
 <h3 id="offering-services-to-the-system">Offering services to the system</h3>
-<p>It is possible to run the binder afb-daemon as a daemon that provides the API of its plugins.</p>
+<p>It is possible to run the binder afb-daemon as a daemon that provides the API of its bindings.</p>
 <p>This will be used for:</p>
 <ol type="1">
 <li><p>offering common APIs</p></li>
@@ -142,7 +142,7 @@ Figure: binder afb-daemon for services
 . +-----------------+------------------+  .     . +------------------------------------+  .
 . |                        :           |  .     . |                        :           |  .
 . |      b i n d e r       :           |  .     . |      b i n d e r       :  service  |  .
-. |  A F B - D A E M O N   :  PLUGINS  |  .     . |  A F B - D A E M O N   :  PLUGINS  |  .
+. |  A F B - D A E M O N   : BINDINGS  |  .     . |  A F B - D A E M O N   : BINDINGS  |  .
 . |                        :           |  .     . |                        :     A     |  .
 . +-----------------+------------------+  .     . +-----------------+------------------+  .
 .                   |                     .     .                   |                     .
@@ -159,22 +159,22 @@ Figure: binder afb-daemon for services
 . +-----------------+------------------+  .     . +-----------------+------------------+  .
 . |                        :           |  .     . |                        :           |  .
 . |      b i n d e r       :  service  |  .     . |      b i n d e r       :  service  |  .
-. |  A F B - D A E M O N   :  PLUGINS  |  .     . |  A F B - D A E M O N   :  PLUGINS  |  .
+. |  A F B - D A E M O N   : BINDINGS  |  .     . |  A F B - D A E M O N   : BINDINGS  |  .
 . |                        :     B     |  .     . |                        :     C     |  .
 . +------------------------------------+  .     . +------------------------------------+  .
 .                                         .     .                                         .
 .        Isolated security context B      .     .        Isolated security context C      .
 . . . . . . . . . . . . . . . . . . . . . .     . . . . . . . . . . . . . . . . . . . . . .</code></pre>
-<p>For this case, the binder afb-daemon takes care to attribute one single session context to each client instance. It allows plugins to store and retrieve data associated to each of its client.</p>
-<h2 id="the-plugins-of-the-binder-afb-daemon">The plugins of the binder afb-daemon</h2>
-<p>The binder can instanciate plugins. The primary use of plugins is to add native methods that can be accessed by applications written with any language through web technologies ala JSON RPC.</p>
+<p>For this case, the binder afb-daemon takes care to attribute one single session context to each client instance. It allows bindings to store and retrieve data associated to each of its client.</p>
+<h2 id="the-bindings-of-the-binder-afb-daemon">The bindings of the binder afb-daemon</h2>
+<p>The binder can instanciate bindings. The primary use of bindings is to add native methods that can be accessed by applications written with any language through web technologies ala JSON RPC.</p>
 <p>This simple idea is declined to serves multiple purposes:</p>
 <ol type="1">
 <li><p>add native feature to applications</p></li>
 <li><p>add common API available by any applications</p></li>
 <li><p>provide customers services</p></li>
 </ol>
-<p>A specific document explains how to write an afb-daemon binder plugin: <a href="afb-plugin-writing.html">HOWTO WRITE a PLUGIN for AFB-DAEMON</a></p>
+<p>A specific document explains how to write an afb-daemon binder binding: <a href="afb-binding-writing.html">HOWTO WRITE a BINDING for AFB-DAEMON</a></p>
 <h2 id="launching-the-binder-afb-daemon">Launching the binder afb-daemon</h2>
 <p>The launch options for binder <strong>afb-daemon</strong> are:</p>
 <pre><code>  --help
@@ -209,7 +209,7 @@ Figure: binder afb-daemon for services
 
     HTML Root API URL [default /api]
 
-    The plugins are available within that url.
+    The bindings are available within that url.
 
   --alias=xxxx
 
@@ -224,7 +224,7 @@ Figure: binder afb-daemon for services
 
   --apitimeout=xxxx
 
-    Plugin API timeout in seconds [default 20]
+    binding API timeout in seconds [default 20]
 
     Defines how many seconds maximum a method is allowed to run.
     0 means no limit.
@@ -247,19 +247,19 @@ Figure: binder afb-daemon for services
 
   --ldpaths=xxxx
 
-    Load Plugins from given paths separated by colons
-    as for dir1:dir2:plugin1.so:... [default = $libdir/afb]
+    Load bindings from given paths separated by colons
+    as for dir1:dir2:binding1.so:... [default = $libdir/afb]
 
-    You can mix path to directories and to plugins.
+    You can mix path to directories and to bindings.
     The sub-directories of the given directories are searched
     recursively.
 
-    The plugins are the files terminated by &#39;.so&#39; (the extension
+    The bindings are the files terminated by &#39;.so&#39; (the extension
     so denotes shared object) that contain the public entry symbol.
 
-  --plugin=xxxx
+  --binding=xxxx
 
-    Load the plugin of given path.
+    Load the binding of given path.
 
   --token=xxxx
 
@@ -294,7 +294,7 @@ Figure: binder afb-daemon for services
 
     Provides a binder afb-daemon service through dbus.
 
-    The name xxxx must be the name of an API defined by a plugin.
+    The name xxxx must be the name of an API defined by a binding.
     This API is exported through DBUS.
 
   --foreground