Code Review
/
src
/
app-framework-binder.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Set defaultbranch to chinook in gitreview
[src/app-framework-binder.git]
/
doc
/
afb-overview.md
diff --git
a/doc/afb-overview.md
b/doc/afb-overview.md
index
37fdd0c
..
343a4f3
100644
(file)
--- a/
doc/afb-overview.md
+++ b/
doc/afb-overview.md
@@
-1,10
+1,6
@@
+
Overview of AFB-DAEMON
======================
Overview of AFB-DAEMON
======================
- version: 1
- Date: 30 mai 2016
- Author: José Bollo
-
-TABLE-OF-CONTENT-HERE
Roles of afb-daemon
-------------------
Roles of afb-daemon
-------------------
@@
-34,7
+30,7
@@
of afb-daemon:
. +-------------------+----------------------+ .
. | : | .
. | b i n d e r : | .
. +-------------------+----------------------+ .
. | : | .
. | b i n d e r : | .
- . | A F B - D A E M O N :
PLUGIN
S | .
+ . | A F B - D A E M O N :
BINDING
S | .
. | : | .
. +-------------------+----------------------+ .
. | .
. | : | .
. +-------------------+----------------------+ .
. | .
@@
-97,7
+93,7
@@
when the application is run remotely:
. | .
. +-------------------+----------------------+ .
. | : | .
. | .
. +-------------------+----------------------+ .
. | : | .
- . | A F B - D A E M O N :
PLUGINS
| .
+ . | A F B - D A E M O N :
BINDINGS
| .
. | : | .
. +-------------------+----------------------+ .
. | .
. | : | .
. +-------------------+----------------------+ .
. | .
@@
-108,15
+104,15
@@
when the application is run remotely:
### Adding native features to HTML5/QML applications
### Adding native features to HTML5/QML applications
-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
+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.
### Offering services to the system
It is possible to run the binder afb-daemon as a daemon that provides the
will be excuted within the security context.
### Offering services to the system
It is possible to run the binder afb-daemon as a daemon that provides the
-API of its
plugin
s.
+API of its
binding
s.
This will be used for:
This will be used for:
@@
-141,7
+137,7
@@
In that case, the figure showing the whole aspects is
. +-----------------+------------------+ . . +------------------------------------+ .
. | : | . . | : | .
. | b i n d e r : | . . | b i n d e r : service | .
. +-----------------+------------------+ . . +------------------------------------+ .
. | : | . . | : | .
. | 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 : PLUGIN
S | .
+ . | A F B - D A E M O N :
BINDINGS | . . | A F B - D A E M O N : BINDING
S | .
. | : | . . | : A | .
. +-----------------+------------------+ . . +-----------------+------------------+ .
. | . . | .
. | : | . . | : A | .
. +-----------------+------------------+ . . +-----------------+------------------+ .
. | . . | .
@@
-158,7
+154,7
@@
In that case, the figure showing the whole aspects is
. +-----------------+------------------+ . . +-----------------+------------------+ .
. | : | . . | : | .
. | b i n d e r : service | . . | b i n d e r : service | .
. +-----------------+------------------+ . . +-----------------+------------------+ .
. | : | . . | : | .
. | 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 : PLUGIN
S | .
+ . | A F B - D A E M O N :
BINDINGS | . . | A F B - D A E M O N : BINDING
S | .
. | : B | . . | : C | .
. +------------------------------------+ . . +------------------------------------+ .
. . . .
. | : B | . . | : C | .
. +------------------------------------+ . . +------------------------------------+ .
. . . .
@@
-166,10
+162,14
@@
In that case, the figure showing the whole aspects is
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
-The plugins of the binder afb-daemon
+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.
+
+The bindings of the binder afb-daemon
------------------------------------
------------------------------------
-The binder can instanciate
plugins. The primary use of plugin
s
+The binder can instanciate
bindings. The primary use of binding
s
is to add native methods that can be accessed by applications
written with any language through web technologies ala JSON RPC.
is to add native methods that can be accessed by applications
written with any language through web technologies ala JSON RPC.
@@
-181,7
+181,8
@@
This simple idea is declined to serves multiple purposes:
3. provide customers services
3. provide customers services
-A specific document shows
+A specific document explains how to write an afb-daemon binder binding:
+[HOWTO WRITE a BINDING for AFB-DAEMON](afb-binding-writing.html)
Launching the binder afb-daemon
Launching the binder afb-daemon
@@
-221,7
+222,7
@@
The launch options for binder **afb-daemon** are:
HTML Root API URL [default /api]
HTML Root API URL [default /api]
- The
plugin
s are available within that url.
+ The
binding
s are available within that url.
--alias=xxxx
--alias=xxxx
@@
-236,7
+237,7
@@
The launch options for binder **afb-daemon** are:
--apitimeout=xxxx
--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.
Defines how many seconds maximum a method is allowed to run.
0 means no limit.
@@
-259,19
+260,19
@@
The launch options for binder **afb-daemon** are:
--ldpaths=xxxx
--ldpaths=xxxx
- Load
Plugin
s from given paths separated by colons
- as for dir1:dir2:
plugin
1.so:... [default = $libdir/afb]
+ Load
binding
s from given paths separated by colons
+ as for dir1:dir2:
binding
1.so:... [default = $libdir/afb]
- You can mix path to directories and to
plugin
s.
+ You can mix path to directories and to
binding
s.
The sub-directories of the given directories are searched
recursively.
The sub-directories of the given directories are searched
recursively.
- The
plugin
s are the files terminated by '.so' (the extension
+ The
binding
s are the files terminated by '.so' (the extension
so denotes shared object) that contain the public entry symbol.
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
--token=xxxx
@@
-306,7
+307,7
@@
The launch options for binder **afb-daemon** are:
Provides a binder afb-daemon service through dbus.
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
This API is exported through DBUS.
--foreground