diff options
author | Sebastien Douheret <sebastien.douheret@iot.bzh> | 2017-06-19 12:28:30 +0200 |
---|---|---|
committer | Sebastien Douheret <sebastien.douheret@iot.bzh> | 2017-06-19 16:19:52 +0200 |
commit | 98b3f3bfed183a89eec13386d5138ef73b13ea34 (patch) | |
tree | f25b5b8ea219816e43b50c9d6018ec896ebdfb08 | |
parent | c826c6662dc83633aac0ce1622e4a91b4c8100e3 (diff) |
Add page-break for pdf and fix spelling
Change-Id: I3225f27a4e45792aeeb418eac5430c93c9d70061
Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
-rw-r--r-- | docs/SUMMARY.md | 2 | ||||
-rw-r--r-- | docs/afb-binding-references.md | 20 | ||||
-rw-r--r-- | docs/afb-binding-writing.md | 70 | ||||
-rw-r--r-- | docs/afb-daemon-options.md | 2 | ||||
-rw-r--r-- | docs/afb-daemon-vocabulary.md | 2 | ||||
-rw-r--r-- | docs/afb-desktop-package.md | 10 | ||||
-rw-r--r-- | docs/afb-events-guide.md | 12 | ||||
-rw-r--r-- | docs/afb-migration-v1-to-v2.md | 60 | ||||
-rw-r--r-- | docs/afb-overview.md | 17 |
9 files changed, 94 insertions, 101 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 827e0031..5b4b9a64 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,6 +1,6 @@ # Summary -* [Overview](README.md) +* [Binder Overview](README.md) * [How to write a binding ?](afb-binding-writing.md) * [Binding references](afb-binding-references.md) * [Migration from v1 to v2](afb-migration-v1-to-v2.md) diff --git a/docs/afb-binding-references.md b/docs/afb-binding-references.md index 7d6cdd1d..e8b9629e 100644 --- a/docs/afb-binding-references.md +++ b/docs/afb-binding-references.md @@ -41,8 +41,8 @@ struct afb_verb_v2 { const char *verb; /* name of the verb */ void (*callback)(struct afb_req req); /* callback function implementing the verb */ - const struct afb_auth *auth; /* required authorisation */ - uint32_t session; /* authorisation and session requirements of the verb */ + const struct afb_auth *auth; /* required authorization */ + uint32_t session; /* authorization and session requirements of the verb */ }; ``` @@ -155,7 +155,7 @@ struct afb_event afb_daemon_make_event(const char *name); ``` The following function is used by logging macros and should normally -not be used. Instead, you should use the macros +not be used. Instead, you should use the macros **AFB\_ERROR**, **AFB\_WARNING**, **AFB\_NOTICE**, **AFB\_INFO**, **AFB\_DEBUG** @@ -208,7 +208,7 @@ The following function is used to queue jobs. * If 'timeout' is not 0, it represent the maximum execution time for the job in seconds. * At first, the job is called with 0 as signum and the given argument. * The job is executed with the monitoring of its time and some signals like SIGSEGV and - * SIGFPE. When a such signal is catched, the job is terminated and reexecuted but with + * SIGFPE. When a such signal is catched, the job is terminated and re-executed but with * signum being the signal number (SIGALRM when timeout expired). * * Returns 0 in case of success or -1 in case of error. @@ -217,7 +217,7 @@ int afb_daemon_queue_job(void (*callback)(int signum, void *arg), void *argument ``` The following function must be used when a binding depends on other -bindings at its initialisation. +bindings at its initialization. ```C /* @@ -449,7 +449,7 @@ void afb_req_success_v(struct afb_req req, struct json_object *obj, const char * * * Note that calling afb_req_fail("success", info) is equivalent * to call afb_req_success(NULL, info). Thus even if possible it - * is strongly recommanded to NEVER use "success" for status. + * is strongly recommended to NEVER use "success" for status. */ void afb_req_fail(struct afb_req req, const char *status, const char *info); @@ -533,7 +533,7 @@ void afb_req_addref(struct afb_req req); void afb_req_unref(struct afb_req req); /* - * Stores 'req' on heap for asynchrnous use. + * Stores 'req' on heap for asynchronous use. * Returns a handler to the stored 'req' or NULL on memory depletion. * The count of reference to 'req' is incremented on success * (see afb_req_addref). @@ -615,7 +615,7 @@ int afb_req_subcall_sync( ``` The following function is used by logging macros and should normally -not be used. Instead, you should use the macros +not be used. Instead, you should use the macros **AFB_REQ_ERROR**, **AFB_REQ_WARNING**, **AFB_REQ_NOTICE**, **AFB_REQ_INFO**, **AFB_REQ_DEBUG** @@ -666,7 +666,3 @@ AFB_REQ_DEBUG(req,fmt,...) By default, the logging macros add file, line and function indication. - -Some definitions can be used to - - diff --git a/docs/afb-binding-writing.md b/docs/afb-binding-writing.md index dd9a8b56..d7dccd1a 100644 --- a/docs/afb-binding-writing.md +++ b/docs/afb-binding-writing.md @@ -19,21 +19,19 @@ It is convenient to install the ***binder*** on the desktop used for writing the binding. It allows easy debug and test. -Nature of a binding -------------------- +## Nature of a binding A ***binding*** is an independent piece of software compiled as a shared library and dynamically loaded by a ***binder***. - It is intended to provide one **API** (**A**pplication **P**rogramming **I**nterface). The **API** is designated and accessed through its name. It contains several **verbs** that implement the ***binding*** -functionnalities. Each of these **verbs** is a **method** that +functionalities. Each of these **verbs** is a **method** that processes requests of applications and sends result. -The ***binding***'s methods is invoqued by HTTP or websocket +The ***binding***'s methods are invoked by HTTP or websocket requests. The **methods** of the ***bindings*** are noted **api/verb** @@ -50,21 +48,19 @@ The name of an **API** can be made of any characters except: The names if the **verbs** can be any character. -The binder mkes no distinctions between upper case and lower case +The binder makes no distinctions between upper case and lower case latin letters. So **API/VERB** matches **Api/Verb** or **api/verb**. Actually it exists 2 ways of writing ***bindings***. You can either write: - - a binding version 1 (not recommanded); - - a binding version 2 (RECOMMANDED). - -A ***binder*** loads and runs any of these version -in any combination. + - a binding version 1 (not recommended); + - a binding version 2 (RECOMMENDED). +A ***binder*** loads and runs any of these version in any combination. This document explain how to write bindings version 2. - +<!-- pagebreak --> Sample binding: tuto-1 ====================== @@ -73,18 +69,18 @@ This is the code of the binding **tuto-1.c**: ```C 1 #define AFB_BINDING_VERSION 2 2 #include <afb/afb-binding.h> - 3 + 3 4 void hello(afb_req req) 5 { 6 AFB_REQ_DEBUG(req, "hello world"); 7 afb_req_success(req, NULL, "hello world"); 8 } - 9 + 9 10 const afb_verb_v2 verbs[] = { 11 { .verb="hello", .callback=hello }, 12 { .verb=NULL } 13 }; - 14 + 14 15 const afb_binding_v2 afbBindingV2 = { 16 .api = "tuto-1", 17 .verbs = verbs @@ -151,8 +147,8 @@ temporarily and enables to continue to use previously written ***binding*** without change but it will change in some future when ***bindings*** V1 will become obsoletes. -To include **afb-binding.h** successfuly, the include search path -should be set correctly if needed (not needed only if installed in +To include **afb-binding.h** successfully, the include search path +should be set correctly if needed (not needed only if installed in /usr/include/afb directory that is the default). Setting the include path is easy using **pkg-config**: @@ -190,7 +186,7 @@ a structure of type **afb_binding_v2**. 11 { .verb="hello", .callback=hello }, 12 { .verb=NULL } 13 }; - 14 + 14 15 const afb_binding_v2 afbBindingV2 = { 16 .api = "tuto-1", 17 .verbs = verbs @@ -209,7 +205,7 @@ The only defined verb here (line 11) is named **hello** (field **.verb**) and the function that handle the related request is **hello** (field **.callback**). -Note that you can explicitely mark the fact that these are +Note that you can explicitly mark the fact that these are struct by typing the **struct** as below: ```C @@ -217,7 +213,7 @@ struct by typing the **struct** as below: 11 { .verb="hello", .callback=hello }, 12 { .verb=NULL } 13 }; - 14 + 14 15 const struct afb_binding_v2 afbBindingV2 = { 16 .api = "tuto-1", 17 .verbs = verbs @@ -238,30 +234,30 @@ the AGL stuff is installed. ``` When the ***binder*** receives a request for the verb **hello** of -of the api **tuto-1**, it invoque the callback **hello** of the **binding** +of the api **tuto-1**, it invoke the callback **hello** of the **binding** with the argument **req** that handles the client request. The callback has to treat synchronously or asynchronously the request and should at the end emit a reply for the request. Here, the callback for **tuto-1/hello** replies a successful answer -(ligne 7) to the request **req**. The second parameter (here NULL) +(line 7) to the request **req**. The second parameter (here NULL) is a json object that is sent to the client with the reply. The third parameter is also sent with the reply and is a string called info that can be used as some meta data. -Here again, you can explicitely mark the fact that +Here again, you can explicitly mark the fact that **afb_req** is a structure by declaring **hello** as below: ```C 4 void hello(struct afb_req req) ``` +<!-- pagebreak --> Sample binding: tuto-2 ====================== - The second tutorial shows many important feature that can -commonly be used when writting a ***binding***: initialisation, +commonly be used when writing a ***binding***: initialization, getting arguments, sending replies, pushing events. This is the code of the binding **tuto-2.c**: @@ -269,17 +265,17 @@ This is the code of the binding **tuto-2.c**: ```C 1 #include <string.h> 2 #include <json-c/json.h> - 3 + 3 4 #define AFB_BINDING_VERSION 2 5 #include <afb/afb-binding.h> - 6 + 6 7 afb_event event_login, event_logout; - 8 + 8 9 void login(afb_req req) 10 { 11 json_object *args, *user, *passwd; 12 char *usr; - 13 + 13 14 args = afb_req_json(req); 15 if (!json_object_object_get_ex(args, "user", &user) 16 || !json_object_object_get_ex(args, "password", &passwd)) { @@ -300,12 +296,12 @@ This is the code of the binding **tuto-2.c**: 31 afb_event_push(event_login, json_object_new_string(usr)); 32 } 33 } - 34 + 34 35 void action(afb_req req) 36 { 37 json_object *args, *val; 38 char *usr; - 39 + 39 40 args = afb_req_json(req); 41 usr = afb_req_context_get(req); 42 AFB_REQ_NOTICE(req, "action for user %s: %s", usr, json_object_get_string(args)); @@ -322,11 +318,11 @@ This is the code of the binding **tuto-2.c**: 53 } 54 afb_req_success(req, json_object_get(args), NULL); 55 } - 56 + 56 57 void logout(afb_req req) 58 { 59 char *usr; - 60 + 60 61 usr = afb_req_context_get(req); 62 AFB_REQ_NOTICE(req, "login user %s out", usr); 63 afb_event_push(event_logout, json_object_new_string(usr)); @@ -334,13 +330,13 @@ This is the code of the binding **tuto-2.c**: 65 afb_req_context_clear(req); 66 afb_req_success(req, NULL, NULL); 67 } - 68 + 68 69 int preinit() 70 { 71 AFB_NOTICE("preinit"); 72 return 0; 73 } - 74 + 74 75 int init() 76 { 77 AFB_NOTICE("init"); @@ -351,14 +347,14 @@ This is the code of the binding **tuto-2.c**: 82 AFB_ERROR("Can't create events"); 83 return -1; 84 } - 85 + 85 86 const afb_verb_v2 verbs[] = { 87 { .verb="login", .callback=login }, 88 { .verb="action", .callback=action, .session=AFB_SESSION_LOA_1 }, 89 { .verb="logout", .callback=logout, .session=AFB_SESSION_LOA_1 }, 90 { .verb=NULL } 91 }; - 92 + 92 93 const afb_binding_v2 afbBindingV2 = { 94 .api = "tuto-2", 95 .specification = NULL, diff --git a/docs/afb-daemon-options.md b/docs/afb-daemon-options.md index 39cf0bdb..84f7ce98 100644 --- a/docs/afb-daemon-options.md +++ b/docs/afb-daemon-options.md @@ -40,7 +40,7 @@ The launch options for binder **afb-daemon** are: --roothttp=xxxx Directory of HTTP served files. If not set, files are not served - but apis are still accessibles. + but apis are still accessible. --rootbase=xxxx diff --git a/docs/afb-daemon-vocabulary.md b/docs/afb-daemon-vocabulary.md index c3b7c1ea..c343abdc 100644 --- a/docs/afb-daemon-vocabulary.md +++ b/docs/afb-daemon-vocabulary.md @@ -8,7 +8,7 @@ A shared library object intended to add a functionality to an afb-daemon instance. It implements an API and may provide a service. Binding made for services can have specific entry point called after -initialisation and before serving. +initialization and before serving. ## Event diff --git a/docs/afb-desktop-package.md b/docs/afb-desktop-package.md index 775f4ee5..ad51c67d 100644 --- a/docs/afb-desktop-package.md +++ b/docs/afb-desktop-package.md @@ -1,5 +1,5 @@ -Desktop packages for binder developement +Desktop packages for binder development ======================================== It exists packages of the ***binder*** (afb-daemon) @@ -10,13 +10,13 @@ for common desktop linux distributions. - Debian - Suse -Installing the developement package of the ***binder*** -allows to write ***bindings*** that runs on the destop -computer of the developper. +Installing the development package of the ***binder*** +allows to write ***bindings*** that runs on the desktop +computer of the developer. It is very convenient to quickly write and debug a binding. -Retriving compiling option with pkg-config +Retrieving compiling option with pkg-config ========================================== The ***binder*** afb-daemon provides a configuration diff --git a/docs/afb-events-guide.md b/docs/afb-events-guide.md index b6e4557c..2718003e 100644 --- a/docs/afb-events-guide.md +++ b/docs/afb-events-guide.md @@ -107,7 +107,7 @@ event and/or an associated tag to its client in the reply of the subscription. This is part of the step 5 above. The framework only uses the event (not its name) for subscription, -unsubscription and pushing. +un-subscription and pushing. When the requested data is already generated and the event used for pushing it already exists, the signaling agent must not instantiate a @@ -243,8 +243,8 @@ The function ***afb\_daemon\_make\_event*** that is defined as below: struct afb_event afb_daemon_make_event(const char *name); ``` -The correct way to create the event at initialisation is to call the function -***afb\_daemon\_make\_event*** within the initialisation +The correct way to create the event at initialization is to call the function +***afb\_daemon\_make\_event*** within the initialization function referenced by the field ***init*** of the structure ***afbBindingV2***. ### Function afb\_event\_push @@ -307,12 +307,12 @@ below: /* * Revokes the subscription established to the 'event' for the client * link identified by 'req'. - * Returns 0 in case of successful unsubscription or -1 in case of error. + * Returns 0 in case of successful un-subscription or -1 in case of error. */ int afb_req_unsubscribe(struct afb_req req, struct afb_event event); ``` -The unsubscription removes the client of the request of the list of subscribers +The un-subscription removes the client of the request of the list of subscribers to the event. When the list of subscribers to the event becomes empty, the function ***afb\_event\_push*** will return zero. @@ -359,7 +359,7 @@ int afb_daemon_broadcast_event(const char *name, struct json_object *object); The name is given here explicitly. The name is automatically prefixed with the name of the binding. For example, a binding of prefix "xxx" -would broadcat the event "xxx/name". +would broadcast the event "xxx/name". ### Function onevent (field of afbBindingV2) diff --git a/docs/afb-migration-v1-to-v2.md b/docs/afb-migration-v1-to-v2.md index 487c259d..fd75ba56 100644 --- a/docs/afb-migration-v1-to-v2.md +++ b/docs/afb-migration-v1-to-v2.md @@ -6,7 +6,7 @@ for the following reasons: - integration of the security requirements within the bindings - simplification of the API (after developer feedbacks) - - removal of obscur features, cleanup + - removal of obscure features, cleanup The ***binder*** can run ***bindings*** v1 and/or v2 in any combination. Thus moving from v1 to v2 is not enforced. There is no real need. @@ -14,9 +14,9 @@ Thus moving from v1 to v2 is not enforced. There is no real need. More, it is possible to write a dual ***binding***: a ***binding*** that implements the version 1 AND the version 2. -However, IT IS HIGHLY RECOMMANDED TO SWITCH TO ONLY VERSION 2: +However, IT IS HIGHLY RECOMMENDED TO SWITCH TO ONLY VERSION 2: - - any new developement SHOULD start using ***binding*** V2 + - any new development SHOULD start using ***binding*** V2 - existing ***bindings*** SHOULD migrate to the version 2 This guide covers the migration of bindings from version 1 to version 2. @@ -67,7 +67,7 @@ As a programmer, you shouldn't care much about that hidden variable. It simplifies the job, that's all and that is the reason of the change. An other important difference is between the version 1 and the version 2 is -on how the ***binding***'s **API** is documented. The version 2 enphasis the +on how the ***binding***'s **API** is documented. The version 2 emphasis the **OpenAPI v3** description of the **API**. For this reason, to avoid duplication of descriptions, only one description is expected: the **OpenAPI** one. @@ -84,7 +84,7 @@ This task list is: 5. Consider where to emit logs for requests 6. Take care of store/unstore changes 7. Consider use of synchronous (sub)call requests - 8. Optionnaly, removes explicit struct + 8. Optionally, removes explicit struct The remaining chapters explain these task with more details. @@ -113,7 +113,7 @@ requirements. In version 1 it was: struct afb_verb_desc_v1 { const char *name; /* name of the verb */ - enum afb_session_flags_v1 session; /* authorisation and session requirements of the verb */ + enum afb_session_flags_v1 session; /* authorization and session requirements of the verb */ void (*callback)(struct afb_req req); /* callback function implementing the verb */ const char *info; /* textual description of the verb */ }; @@ -126,8 +126,8 @@ struct afb_verb_v2 { const char *verb; /* name of the verb */ void (*callback)(struct afb_req req); /* callback function implementing the verb */ - const struct afb_auth *auth; /* required authorisation */ - uint32_t session; /* authorisation and session requirements of the verb */ + const struct afb_auth *auth; /* required authorization */ + uint32_t session; /* authorization and session requirements of the verb */ }; ``` @@ -138,7 +138,7 @@ The migration of instances of that structure requires the following actions: - remove field **info** - adapt field **session** if needed - set field **auth** to NULL - + Example: ```C @@ -152,7 +152,7 @@ Becomes ``` The field **auth** can be set to a value describing the requested -authorisation. +authorization. The main describing structure also changed. In version 1 it was: @@ -182,10 +182,10 @@ struct afb_binding_v2 The migration of instances of that structure requires the following actions: - - declare, expore, name the structure as ```const struct afb_binding_v2 afbBindingV2``` + - declare, explore, name the structure as ```const struct afb_binding_v2 afbBindingV2``` - rename the field **prefix** to **api** - remove the field **info** - - setup the fields **preinit**, **init**, **onevent** accordling to the next section + - setup the fields **preinit**, **init**, **onevent** according to the next section - set the field **noconcurrency** to the right value: * to 1 if you want to avoid concurrent calls to verbs. * to 0 if you allow concurrent calls to verbs. @@ -237,7 +237,7 @@ be used to check features at load. When it returns a negative number, the The function **afbBindingV1ServiceInit** is replaced by the field **init** of the structure **afbBindingV2**. The init function should return 0 in case of success or a negative error code in case of problem. It is called during -initialisation of services. +initialization of services. The function **afbBindingV1ServiceEvent**is replaced by the field **onevent** of the structure **afbBindingV2**. @@ -319,7 +319,7 @@ These interfaces are now managed hiddenly for the **binding** by the **binder**. So the variable that ***bindings*** version used to store the ***binder*** interface and the service interface are no more needed and can be removed. -On the above example the folowing lines were removed: +On the above example the following lines were removed: ```C const struct afb_binding_interface *interface; struct afb_service service; @@ -364,7 +364,7 @@ Becomes: Also, to avoid possible conflicts, we introduced prefixed logging functions: the macros **ERROR**, **WARNING**, **NOTICE**, **INFO**, **DEBUG** have now a prefixed version: **AFB\_ERROR**, **AFB\_WARNING**, **AFB\_NOTICE**, -**AFB\_INFO**, **AFB\_DEBUG**. It is now recommanded to use the prefixed version. +**AFB\_INFO**, **AFB\_DEBUG**. It is now recommended to use the prefixed version. Example: @@ -384,7 +384,7 @@ or, better: AFB_NOTICE("hello plugin comes to live"); ``` -To remove definition of the unprefixed versions of logging macros **ERROR**, **WARNING**, +To remove definition of the un-prefixed versions of logging macros **ERROR**, **WARNING**, **NOTICE**, **INFO**, **DEBUG** and just define **AFB_BINDING_PRAGMA_NO_VERBOSE_UNPREFIX** before to include **afb/afb-binding.h**. @@ -399,7 +399,7 @@ Consider where to emit logs for requests The ***bindings*** v2 now allows to emit log messages associated to ***requests***. This feature is valuable when debugging because it allows to return -side informations associated to a ***request***. +side information associated to a ***request***. The defined macros for logging to requests are: **AFB_REQ_ERROR**, **AFB_REQ_WARNING**, **AFB_REQ_NOTICE**, **AFB_REQ_INFO**, **AFB_REQ_DEBUG**. @@ -421,7 +421,7 @@ Might become: Take care of store/unstore change --------------------------------- -For efficiency, the version 2 redefined how storing/unstoring of +For efficiency, the version 2 redefined how storing/un-storing of requests works. Storing request is needed for asynchronous handling of requests. @@ -454,13 +454,13 @@ Consider use of synchronous (sub)call requests their clients (subcalls). With ***bindings*** version 2 comes also synchronous requests for both cases. -So when migrating to bindings version 2, a developper can consider +So when migrating to bindings version 2, a developer can consider to replace the asynchronous requests (with asynchronous call back) by synchronous ones. See functions ***afb_service_call_sync*** and ***afb_req_subcall_sync***. -Optionnaly, removes explicit struct +Optionally, removes explicit struct ----------------------------------- The new definitions now includes **typedefs** for common @@ -497,7 +497,7 @@ static void verb(afb_req req) Example of migration -------------------- -The first ***binding*** that migrated from v1 to v2 was +The first ***binding*** that migrated from v1 to v2 was the sample **HelloWorld**. Here is shown the differences between the version 1 and the version 2. @@ -507,24 +507,24 @@ index c6fa779..505aee3 100644 --- a/bindings/samples/HelloWorld.c +++ b/bindings/samples/HelloWorld.c @@ -21,9 +21,9 @@ - + #include <json-c/json.h> - + +#define AFB_BINDING_VERSION 2 #include <afb/afb-binding.h> - + -const struct afb_binding_interface *interface; static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER; struct event @@ -79,7 +80,7 @@ static int event_add(const char *tag, const char *name) strcpy(e->tag, tag); - + /* make the event */ - e->event = afb_daemon_make_event(interface->daemon, name); + e->event = afb_daemon_make_event(name); if (!e->event.closure) { free(e); return -1; } - + /* link */ @@ -140,7 +141,7 @@ static void pingBug (struct afb_req request) static void pingEvent(struct afb_req request) @@ -534,11 +534,11 @@ index c6fa779..505aee3 100644 + afb_daemon_broadcast_event("event", json_object_get(query)); ping(request, json_object_get(query), "event"); } - + @@ -288,38 +289,43 @@ static void exitnow (struct afb_req request) exit(0); } - + +static int preinit() +{ + AFB_NOTICE("hello binding comes to live"); @@ -586,7 +586,7 @@ index c6fa779..505aee3 100644 + { "exit", exitnow , NULL, AFB_SESSION_NONE }, + { NULL} }; - + -static const struct afb_binding plugin_desc = { - .type = AFB_BINDING_VERSION_1, - .v1 = { @@ -601,7 +601,7 @@ index c6fa779..505aee3 100644 + .preinit = preinit, + .init = init }; - + -const struct afb_binding *afbBindingV1Register (const struct afb_binding_interface *itf) -{ - interface = itf; diff --git a/docs/afb-overview.md b/docs/afb-overview.md index 67e5b0d1..d0615ed5 100644 --- a/docs/afb-overview.md +++ b/docs/afb-overview.md @@ -1,13 +1,13 @@ -Overview of the binder -====================== +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 ***binder*** is developped for AGL. +The ***binder*** is developed for AGL. The ***binder*** is the usual name. The binary is named **afb-daemon**. @@ -21,7 +21,7 @@ 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 connexion between services and/or +Within AGL, the connection between services and/or applications is tuned by the AGL framework and the AGL system. @@ -58,7 +58,7 @@ The shown elements are: An **API** is a set of **verbs** that can be called using either REST over HTTP or a kind of JSON RPC. - + ***bindings*** are either: - dynamically loaded libraries in the ***binder*** process @@ -66,7 +66,7 @@ The shown elements are: - remote service running on other hosts When acting as an HTTP server, the binder treats the language - settings of the HTTP resquests to provide internationalized + settings of the HTTP requests to provide internationalized content as specified by [widget specifications](https://www.w3.org/TR/widgets/#internationalization-and-localization). @@ -76,6 +76,8 @@ The shown elements are: the **API** that it provides or to get its HTTP services to access resources. +<!-- pagebreak --> + Interconnection of binders ========================== @@ -91,8 +93,7 @@ The figure shows 4 several **application/service**: **A**, **B**, **C** and **D**. The application **A** might use an **API** that is shown as a -local ***binbing*** but that in reality runs within the context +local ***binding*** but that in reality runs within the context of **D**. The framework AGL takes care of making the plumbing working. - |