X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=doc%2Fafb-overview.md;h=eec3f91a1926eda6d3de291a72f9bd64069c573d;hb=ae6f684d830871e81b0b4168424f6a4873eabbff;hp=343a4f30f204a4c38630e0b10984a05938471462;hpb=836b3c0b74accc5494d7877a22b4a45b5450b6f3;p=src%2Fapp-framework-binder.git
diff --git a/doc/afb-overview.md b/doc/afb-overview.md
index 343a4f30..eec3f91a 100644
--- a/doc/afb-overview.md
+++ b/doc/afb-overview.md
@@ -15,29 +15,9 @@ an application to the AGL framework and AGL system.
On the following figure, you can use a typical use
of afb-daemon:
-Figure: binder afb-daemon, basis
-
- . . . . . . . . . . . . . . . . . . . . . . . . . .
- . Isolated security context .
- . .
- . +------------------------------+ .
- . | | .
- . | A P P L I C A T I O N | .
- . | | .
- . +--------------+---------------+ .
- . | .
- . | .
- . +-------------------+----------------------+ .
- . | : | .
- . | b i n d e r : | .
- . | A F B - D A E M O N : BINDINGS | .
- . | : | .
- . +-------------------+----------------------+ .
- . | .
- . . . . . . . . . . . . | . . . . . . . . . . . . .
- |
- v
- AGL SYSTEM
+
+
+![binder-basis][binder-basis]
The application and its companion binder run in secured and isolated
environment set for them. Applications are intended to access to AGL
@@ -50,7 +30,7 @@ The binder afb-daemon serves multiple purposes:
2. It acts as an HTTP server for serving files to HTML5 applications;
3. It allows HTML5 applications to have native extensions subject
-to security enforcement for accessing hardware ressources or
+to security enforcement for accessing hardware resources or
for speeding parts of algorithm.
Use cases of the binder afb-daemon
@@ -61,53 +41,23 @@ usage through several use cases.
### Remotely running application
-One of the most interresting aspect of using the binder afb-daemon
+One of the most interesting aspect of using the binder afb-daemon
is the ability to run applications remotely. This feature is
possible because the binder afb-daemon implements native web
protocols.
-So the [figure binder, basis](#binder-fig-1) would become
+So the [figure binder, basis](#binder-fig-basis) would become
when the application is run remotely:
-Figure: binder afb-daemon and remotely running application
-
- +------------------------------+
- | |
- | A P P L I C A T I O N |
- | |
- +--------------+---------------+
- |
- ~ ~ ~ ~ ~ ~
- : NETWORK :
- ~ ~ ~ ~ ~ ~
- |
- . . . . . . . . . . . . . . | . . . . . . . . . . . . . .
- . Isolated security | .
- . context | .
- . | .
- . . . . . . . . . . . . . . . . . . . . . . . . . .
- . . . .
- . . F I R E W A L L . .
- . . . .
- . . . . . . . . . . . . . . . . . . . . . . . . . .
- . | .
- . +-------------------+----------------------+ .
- . | : | .
- . | A F B - D A E M O N : BINDINGS | .
- . | : | .
- . +-------------------+----------------------+ .
- . | .
- . . . . . . . . . . . . . . | . . . . . . . . . . . . . .
- |
- v
- AGL SYSTEM
+
+
### Adding native features to HTML5/QML applications
Applications can provide with their packaged delivery a binding.
-That binding will be instanciated for each application instance.
+That binding will be instantiated for each application instance.
The methods of the binding will be accessible by applications and
-will be excuted within the security context.
+will be executed within the security context.
### Offering services to the system
@@ -122,45 +72,9 @@ This will be used for:
In that case, the figure showing the whole aspects is
-Figure: binder afb-daemon for services
-
- . . . . . . . . . . . . . . . . . . . . . .
- . Isolated security context application .
- . .
- . +------------------------------+ .
- . | | .
- . | A P P L I C A T I O N | .
- . | | .
- . +--------------+---------------+ . . . . . . . . . . . . . . . . . . . . . . .
- . | . . Isolated security context A .
- . | . . .
- . +-----------------+------------------+ . . +------------------------------------+ .
- . | : | . . | : | .
- . | b i n d e r : | . . | b i n d e r : service | .
- . | A F B - D A E M O N : BINDINGS | . . | A F B - D A E M O N : BINDINGS | .
- . | : | . . | : A | .
- . +-----------------+------------------+ . . +-----------------+------------------+ .
- . | . . | .
- . . . . . . . . . . | . . . . . . . . . . . . . . . . . . . . . | . . . . . . . . . . .
- | |
- v v
- ================================================================================
- D - B U S & C Y N A R A
- ================================================================================
- ^ ^
- | |
- . . . . . . . . . . | . . . . . . . . . . . . . . . . . . . . . | . . . . . . . . . . .
- . | . . | .
- . +-----------------+------------------+ . . +-----------------+------------------+ .
- . | : | . . | : | .
- . | b i n d e r : service | . . | b i n d e r : service | .
- . | 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 .
- . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
+
+![afb-for-services][afb-for-services]
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
@@ -169,7 +83,7 @@ associated to each of its client.
The bindings of the binder afb-daemon
------------------------------------
-The binder can instanciate bindings. The primary use of bindings
+The binder can instantiate 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.
@@ -182,7 +96,7 @@ This simple idea is declined to serves multiple purposes:
3. provide customers services
A specific document explains how to write an afb-daemon binder binding:
-[HOWTO WRITE a BINDING for AFB-DAEMON](afb-binding-writing.html)
+[HOWTO WRITE a BINDING for AFB-DAEMON](afb-bindings-writing.html)
Launching the binder afb-daemon
@@ -202,13 +116,31 @@ The launch options for binder **afb-daemon** are:
Increases the verbosity, can be repeated
+ --quiet
+
+ Decreases the verbosity, can be repeated
+
--port=xxxx
HTTP listening TCP port [default 1234]
+ --workdir=xxxx
+
+ Directory where the daemon must run [default: $PWD if defined
+ or the current working directory]
+
+ --uploaddir=xxxx
+
+ Directory where uploaded files are temporarily stored [default: workdir]
+
--rootdir=xxxx
- HTTP Root Directory [default $AFBDIR or else $HOME/.AFB]
+ Root directory of the application to serve [default: workdir]
+
+ --roothttp=xxxx
+
+ Directory of HTTP served files. If not set, files are not served
+ but apis are still accessibles.
--rootbase=xxxx
@@ -235,6 +167,10 @@ The launch options for binder **afb-daemon** are:
This option can be repeated.
+ --no-httpd
+
+ Tells to not start the HTTP server.
+
--apitimeout=xxxx
binding API timeout in seconds [default 20]
@@ -250,10 +186,6 @@ The launch options for binder **afb-daemon** are:
Client cache end of live [default 100000 that is 27,7 hours]
- --sessiondir=xxxx
-
- Sessions file path [default rootdir/sessions]
-
--session-max=xxxx
Maximum count of simultaneous sessions [default 10]
@@ -282,6 +214,10 @@ The launch options for binder **afb-daemon** are:
If set to the empty string, then any initial token is accepted.
+ --random-token
+
+ Generate a random starting token. See option --exec.
+
--mode=xxxx
Set the mode: either local, remote or global.
@@ -310,6 +246,20 @@ The launch options for binder **afb-daemon** are:
The name xxxx must be the name of an API defined by a binding.
This API is exported through DBUS.
+ --ws-client=xxxx
+
+ Transparent binding to a binder afb-daemon service through a WebSocket.
+
+ The value of xxxx is either a unix naming socket, of the form "unix:path/api",
+ or an internet socket, of the form "host:port/api".
+
+ --ws-server=xxxx
+
+ Provides a binder afb-daemon service through WebSocket.
+
+ The value of xxxx is either a unix naming socket, of the form "unix:path/api",
+ or an internet socket, of the form "host:port/api".
+
--foreground
Get all in foreground mode (default)
@@ -318,6 +268,26 @@ The launch options for binder **afb-daemon** are:
Get all in background mode
+ --no-httpd
+
+ Forbids HTTP serve
+
+ --exec
+
+ Must be the last option for afb-daemon. The remaining
+ arguments define a command that afb-daemon will launch.
+ The sequences @p, @t and @@ of the arguments are replaced
+ with the port, the token and @.
+
+ --tracereq=xxxx
+
+ Trace the processing of requests in the log file.
+
+ Valid values are 'no' (default), 'common', 'extra' or 'all'.
+
+
+
+
Future development of afb-daemon
--------------------------------
@@ -335,10 +305,11 @@ anymore.
- Make the service connection using WebSocket not DBUS.
-- Management of targetted events.
+- Management of targeted events.
-- Securisation of LOA.
+- Securing LOA.
- Integration of the protocol JSON-RPC for the websockets.
-
+[binder-basis]: pictures/AFB_overview.svg
+[afb-for-services]: pictures/AFB_for_services.svg