summaryrefslogtreecommitdiffstats
path: root/docs/afb-overview.md
diff options
context:
space:
mode:
authorRonan Le Martret <ronan.lemartret@iot.bzh>2017-07-27 16:28:22 +0200
committerJosé Bollo <jose.bollo@iot.bzh>2017-08-02 13:52:11 +0200
commitdf383333a53e62234b8999269834e08291326be7 (patch)
tree86b5407f13042dcfb47f1774a0facca0ec44d9fc /docs/afb-overview.md
parent5de0b9d895d196976b8a4d90f495b8cd34fe30c0 (diff)
update markdown documentation
Change-Id: I4f466ff4b965022998d2418a9c1310d4f5e0188e Signed-off-by: Ronan Le Martret <ronan.lemartret@iot.bzh>
Diffstat (limited to 'docs/afb-overview.md')
-rw-r--r--docs/afb-overview.md72
1 files changed, 32 insertions, 40 deletions
diff --git a/docs/afb-overview.md b/docs/afb-overview.md
index d0615ed5..0cff24cc 100644
--- a/docs/afb-overview.md
+++ b/docs/afb-overview.md
@@ -1,32 +1,26 @@
-
-Binder Overview
-===============
+# Binder Overview
The ***binder*** provides the way to connect applications to
-the services that it needs. It provides a fast way
-to securely offer APIs to applications written in
-any language and running almost anywhere.
+the services that it needs.
-The ***binder*** is developed for AGL.
+It provides a fast way to securely offer APIs to applications
+written in any language and running almost anywhere.
-The ***binder*** is the usual name.
-The binary is named **afb-daemon**.
+- The ***binder*** is developed for AGL.
+- The ***binder*** is the usual name.
+- The binary is named **afb-daemon**.
+- The name **afb-daemon** stands for ***Application Framework Binder Daemon***.
-The name **afb-daemon** stands for ***Application
-Framework Binder Daemon***. The word *daemon*, here,
-denote the fact that the ***binder*** makes witchcraft to
-connect applications to their expected services (note that usually
-the term of daemon denotes background process but not here).
+The word *daemon*, here, denote the fact that the ***binder*** makes witchcraft to
+connect applications to their expected services.
+(note: that usually the term of daemon denotes background process but not here).
-Each ***binder*** **afb-daemon** is in charge to bind
-one instance of an application or service to the rest
-of the system, applications and services.
-Within AGL, the connection between services and/or
-applications is tuned by the AGL framework and
-the AGL system.
+Each ***binder*** **afb-daemon** is in charge to bind one instance of
+an application or service to the rest of the system, applications and services.
+Within AGL, the connection between services and/or applications
+is tuned by the AGL framework and the AGL system.
-The basis of the binder
-=======================
+## The basis of the binder
The following figure shows main concepts linked to the ***binder***.
@@ -35,24 +29,24 @@ The following figure shows main concepts linked to the ***binder***.
The shown elements are:
-* The SECURITY CONTEXT
+- The SECURITY CONTEXT
The primary intend of any ***binder*** is to provide
- a secured environment for any application. On AGL, the
- **security context** is ensured by [Smack][Smack] a security context,
- the security context of the application or service.
+ a secured environment for any application.
+ On AGL, the **security context** is ensured by [Smack]
+ , the security context of the application or service.
-* The BINDER
+- The BINDER
- This is the central element. It makes possible to run HTML5
- applications and provides the unified access to APIs provided
- by the ***bindings***.
+ This is the central element.
+ It makes possible to run HTML5 applications and provides
+ the unified access to APIs provided by the ***bindings***.
- Running a pure HTML5 application doesn't require any ***binding***.
- in that case , the ***binder*** acts as a simple HTTP server for
+ Running a pure HTML5 application doesn't require any ***binding***.
+ In that case , the ***binder*** acts as a simple HTTP server for
the web runtime.
-* The BINDINGs
+- The BINDINGs
A ***binding*** adds one **API** to the ***binder***.
@@ -61,16 +55,15 @@ The shown elements are:
***bindings*** are either:
- - dynamically loaded libraries in the ***binder*** process
- - remote service running on the same host
- - remote service running on other hosts
+ - dynamically loaded libraries in the ***binder*** process
+ - remote service running on the same host
+ - remote service running on other hosts
When acting as an HTTP server, the binder treats the language
settings of the HTTP requests to provide internationalized
content as specified by
[widget specifications](https://www.w3.org/TR/widgets/#internationalization-and-localization).
-
-* The APPLICATION
+- The APPLICATION
An ***application*** connects to the binder to get access to
the **API** that it provides or to get its HTTP services to access
@@ -78,8 +71,7 @@ The shown elements are:
<!-- pagebreak -->
-Interconnection of binders
-==========================
+## Interconnection of binders
The AGL framework interprets the **widget/application** manifests
to setup the ***bindings*** configuration of the ***binders***.