X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=doc%2Fafb-overview.md;h=eec3f91a1926eda6d3de291a72f9bd64069c573d;hb=ae6f684d830871e81b0b4168424f6a4873eabbff;hp=7071d3c6bd9c271e9de30164fa56189a29452e40;hpb=bd0fce461a2c0e316c29344137a872f02db51277;p=src%2Fapp-framework-binder.git
diff --git a/doc/afb-overview.md b/doc/afb-overview.md
index 7071d3c6..eec3f91a 100644
--- a/doc/afb-overview.md
+++ b/doc/afb-overview.md
@@ -15,7 +15,7 @@ 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
+
![binder-basis][binder-basis]
@@ -30,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
@@ -49,7 +49,7 @@ protocols.
So the [figure binder, basis](#binder-fig-basis) would become
when the application is run remotely:
-Figure: binder afb-daemon and remotely running application
+
### Adding native features to HTML5/QML applications
@@ -72,7 +72,7 @@ This will be used for:
In that case, the figure showing the whole aspects is
-Figure: binder afb-daemon for services
+
![afb-for-services][afb-for-services]
@@ -96,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
@@ -116,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
@@ -149,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]
@@ -164,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]
@@ -196,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.
@@ -224,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)
@@ -232,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
--------------------------------