diff options
| author |   José Bollo <jose.bollo@iot.bzh> | 2016-05-29 22:15:41 +0200 |
|---|---|---|
| committer | José Bollo <jose.bollo@iot.bzh> | 2016-05-29 23:53:55 +0200 |
| commit | f5c013e32d1c8ee931bec45cee7bc04c5d536d50 (patch) | |
| tree | e2f33d0e9e6a7873154cfe4a20b6d9b0c413caaf /doc | |
| parent | a4487d8a46d3e4400bf73ce817fa1a34cde31a6f (diff) | |
Adds documentation
Also remove a old cmakefile
Change-Id: I2748514934790043a15bb48d1d06bd82967d4494
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/afb-application-writing.html | 40 | ||||
| -rw-r--r-- | doc/afb-application-writing.md | 27 | ||||
| -rw-r--r-- | doc/afb-overview.html | 72 | ||||
| -rw-r--r-- | doc/afb-overview.md | 58 | ||||
| -rw-r--r-- | doc/afb-plugin-writing.html | 18 |
5 files changed, 206 insertions, 9 deletions
diff --git a/doc/afb-application-writing.html b/doc/afb-application-writing.html new file mode 100644 index 00000000..adb5ca7b --- /dev/null +++ b/doc/afb-application-writing.html @@ -0,0 +1,40 @@ +<html> +<head> + <link rel="stylesheet" type="text/css" href="doc.css"> + <meta charset="UTF-8"> +</head> +<body> +<a name="HOWTO.WRITE.an.APPLICATION.above.AGL.FRAMEWORK"></a> +<h1>HOWTO WRITE an APPLICATION above AGL FRAMEWORK</h1> + +<pre><code>version: 1 +Date: 29 mai 2016 +Author: José Bollo +</code></pre> + +<p><ul> + <li><a href="#HOWTO.WRITE.an.APPLICATION.above.AGL.FRAMEWORK">HOWTO WRITE an APPLICATION above AGL FRAMEWORK</a> + <ul> + <li><a href="#Writing.a.C.application">Writing a C application</a></li> + </ul> + </li> +</ul></p> + +<a name="Writing.a.C.application"></a> +<h2>Writing a C application</h2> + +<p>C applications can use the binder afb-daemon through a websocket connection.</p> + +<p>The library <strong>libafbwsc</strong> is made for C clients that want +to connect to the afb-daemon binder.</p> + +<p>The program <strong>afb-client-demo</strong> is the C program that use +the provided library <strong>libafbwsc</strong>. +Its source code is here +<a href="https://github.com/iotbzh/afb-daemon/blob/master/src/afb-client-demo.c">src/afb-client-demo.c</a>.</p> + +<p>The current implementation use libsystemd and file descriptors. +This may be changed in the future to also support secure sockets +and being less dependant of libsystemd.</p> +</body> +</html> diff --git a/doc/afb-application-writing.md b/doc/afb-application-writing.md new file mode 100644 index 00000000..a7099a86 --- /dev/null +++ b/doc/afb-application-writing.md @@ -0,0 +1,27 @@ +HOWTO WRITE an APPLICATION above AGL FRAMEWORK +============================================== + version: 1 + Date: 29 mai 2016 + Author: José Bollo + +TABLE-OF-CONTENT-HERE + + +Writing a C application +----------------------- + +C applications can use the binder afb-daemon through a websocket connection. + +The library **libafbwsc** is made for C clients that want +to connect to the afb-daemon binder. + +The program **afb-client-demo** is the C program that use +the provided library **libafbwsc**. +Its source code is here +[src/afb-client-demo.c](https://github.com/iotbzh/afb-daemon/blob/master/src/afb-client-demo.c). + +The current implementation use libsystemd and file descriptors. +This may be changed in the future to also support secure sockets +and being less dependant of libsystemd. + + diff --git a/doc/afb-overview.html b/doc/afb-overview.html new file mode 100644 index 00000000..15331282 --- /dev/null +++ b/doc/afb-overview.html @@ -0,0 +1,72 @@ +<html> +<head> + <link rel="stylesheet" type="text/css" href="doc.css"> + <meta charset="UTF-8"> +</head> +<body> +<a name="Overview.of.AFB-DAEMON"></a> +<h1>Overview of AFB-DAEMON</h1> + +<pre><code>version: 1 +Date: 29 mai 2016 +Author: José Bollo +</code></pre> + +<p><ul> + <li><a href="#Overview.of.AFB-DAEMON">Overview of AFB-DAEMON</a> + <ul> + <li><a href="#Roles.of.afb-daemon">Roles of afb-daemon</a></li> + </ul> + </li> +</ul></p> + +<a name="Roles.of.afb-daemon"></a> +<h2>Roles of afb-daemon</h2> + +<p>The name <strong>afb-daemon</strong> stands for <em>Application +Framework Binder Daemon</em>. That is why afb-daemon +is also named <strong><em>the binder</em></strong>.</p> + +<p><strong>Afb-daemon</strong> is in charge to bind one instance of +an application to the AGL framework and AGL system.</p> + +<p>On the following figure, you can use a typical use +of afb-daemon:</p> + +<pre><code>. . . . . . . . . . . . . . . . . . . . . . . . . . +. Isolated security context . +. . +. +------------------------------+ . +. | | . +. | A P P L I C A T I O N | . +. | | . +. +--------------+---------------+ . +. | . +. | . +. +-------------------+----------------------+ . +. | : | . +. | A F B - D A E M O N : PLUGINS | . +. | : | . +. +-------------------+----------------------+ . +. | . +. . . . . . . . . . . . | . . . . . . . . . . . . . + | + v + AGL SYSTEM +</code></pre> + +<p>The application and its companion binder run in secured and isolated +environment set for them. Applications are intended to access to AGL +system through the binder.</p> + +<p>The binder afb-daemon serves multiple purposes:</p> + +<ol> +<li><p>It acts as a gateway for the application to access the system;</p></li> +<li><p>It acts as an HTTP server for serving files to HTML5 applications;</p></li> +<li><p>It allows HTML5 applications to have native extensions subject +to security enforcement for accessing hardware ressources or +for speeding parts of algorithm.</p></li> +</ol> +</body> +</html> diff --git a/doc/afb-overview.md b/doc/afb-overview.md new file mode 100644 index 00000000..a5b19231 --- /dev/null +++ b/doc/afb-overview.md @@ -0,0 +1,58 @@ +Overview of AFB-DAEMON +====================== + version: 1 + Date: 29 mai 2016 + Author: José Bollo + +TABLE-OF-CONTENT-HERE + +Roles of afb-daemon +------------------- + +The name **afb-daemon** stands for *Application +Framework Binder Daemon*. That is why afb-daemon +is also named ***the binder***. + +**Afb-daemon** is in charge to bind one instance of +an application to the AGL framework and AGL system. + +On the following figure, you can use a typical use +of afb-daemon: + + . . . . . . . . . . . . . . . . . . . . . . . . . . + . Isolated security context . + . . + . +------------------------------+ . + . | | . + . | A P P L I C A T I O N | . + . | | . + . +--------------+---------------+ . + . | . + . | . + . +-------------------+----------------------+ . + . | : | . + . | A F B - D A E M O N : PLUGINS | . + . | : | . + . +-------------------+----------------------+ . + . | . + . . . . . . . . . . . . | . . . . . . . . . . . . . + | + v + AGL SYSTEM + +The application and its companion binder run in secured and isolated +environment set for them. Applications are intended to access to AGL +system through the binder. + +The binder afb-daemon serves multiple purposes: + +1. It acts as a gateway for the application to access the system; + +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 +for speeding parts of algorithm. + + + diff --git a/doc/afb-plugin-writing.html b/doc/afb-plugin-writing.html index b80006f4..1864cfdf 100644 --- a/doc/afb-plugin-writing.html +++ b/doc/afb-plugin-writing.html @@ -967,7 +967,7 @@ enumeration but the wrapper of constant definitions that can be mixed using bitw <table> <thead> <tr> -<th>Constant name </th> +<th>Constant name </th> <th> Meaning</th> </tr> </thead> @@ -1070,7 +1070,7 @@ formatting messages if the message must not be output.</p> <tr> <th>Macro </th> <th style="text-align:center;"> Verbosity </th> -<th> Meaning </th> +<th> Meaning </th> <th style="text-align:center;"> syslog level</th> </tr> </thead> @@ -1078,13 +1078,13 @@ formatting messages if the message must not be output.</p> <tr> <td>ERROR </td> <td style="text-align:center;"> 0 </td> -<td> Error conditions </td> +<td> Error conditions </td> <td style="text-align:center;"> 3</td> </tr> <tr> <td>WARNING </td> <td style="text-align:center;"> 1 </td> -<td> Warning conditions </td> +<td> Warning conditions </td> <td style="text-align:center;"> 4</td> </tr> <tr> @@ -1096,13 +1096,13 @@ formatting messages if the message must not be output.</p> <tr> <td>INFO </td> <td style="text-align:center;"> 2 </td> -<td> Informational </td> +<td> Informational </td> <td style="text-align:center;"> 6</td> </tr> <tr> <td>DEBUG </td> <td style="text-align:center;"> 3 </td> -<td> Debug-level messages </td> +<td> Debug-level messages </td> <td style="text-align:center;"> 7</td> </tr> </tbody> @@ -1426,13 +1426,13 @@ endif() <table> <thead> <tr> -<th>Variable </th> +<th>Variable </th> <th> Meaning</th> </tr> </thead> <tbody> <tr> -<td>afb_FOUND </td> +<td>afb_FOUND </td> <td> Set to 1 if afb-daemon plugin development files exist</td> </tr> <tr> @@ -1452,7 +1452,7 @@ endif() <td> The ‘-I’ preprocessor flags (w/o the ‘-I’) for compiling afb-daemon plugins</td> </tr> <tr> -<td>afb_CFLAGS </td> +<td>afb_CFLAGS </td> <td> All required cflags for compiling afb-daemon plugins</td> </tr> </tbody> |