X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=doc%2Fafb-daemon-vocabulary.md;h=c3b7c1ea5585de3ed82aca6437e597d5fd4e2452;hb=fb78efef43a9ffc8155649818cc7a907dc85cf4a;hp=83472d5114919053a21196bf3ca489c251f6ba6e;hpb=17b196f1326d6b6c249d44b8744d73d7bba12d7a;p=src%2Fapp-framework-binder.git diff --git a/doc/afb-daemon-vocabulary.md b/doc/afb-daemon-vocabulary.md index 83472d51..c3b7c1ea 100644 --- a/doc/afb-daemon-vocabulary.md +++ b/doc/afb-daemon-vocabulary.md @@ -1,10 +1,14 @@ + Vocabulary for AFB-DAEMON ========================= - version: 1 - Date: 27 mai 2016 - Author: José Bollo +## Binding + +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. ## Event @@ -18,18 +22,18 @@ The current implementation allows to widely broadcast events to all clients. This level that can be from 0 to 3 represent the level of assurance that the services can expect from the session. -The exact definition of the meaning of this levels and of -how to use it remains to be achived. +The exact definition of the meaning of these levels and how to use it remains to +be achieved. ## Plugin -A shared library object intended to be plug to an afb-daemon instance -to implement an API. +Old name for binding, see binding. ## Request -A request is an invocation by a client to a method of a plugin using a message -transfered through some protocol: HTTP, WebSocket, DBUS... served by afb-daemon +A request is an invocation by a client to a binding method using a message +transferred through some protocol: HTTP, WebSocket, DBUS... and served by +***afb-daemon*** ## Reply/Response @@ -37,18 +41,19 @@ This is a message sent to client as the result of the request. ## Service -Service are made of plugins runnning by their side on their binder. -It can serve many client. Each one being attached to one session. +Service are made of bindings running by their side on their binder. +It can serve many client. Each one attached to one session. -The framework establishes the connection between the services and -the clients. Using DBus currently. +The framework establishes connection between the services and +the clients. Using DBus currently but other protocols are considered. ## Session -A session is meant to be the unic context of an instance of client, -identifying that instance across requests. +A session is meant to be the unique instance context of a client, +which identify that instance across requests. -Each session has an identifier. Session identifier generated by afb-daemon are UUIDs. +Each session has an identifier. Session identifier generated by afb-daemon are +UUIDs. Internally, afb-daemon offers a mechanism to attach data to sessions. When the session is closed or disappears, the data attached to that session @@ -56,10 +61,10 @@ are freed. ## Token -The token is an identifier that the the client must give to be authentificated. +The token is an identifier that the client must give to be authenticated. At start, afb-daemon get an initial token. This initial token must be presented -incoming client to be authentificated. +by incoming client to be authenticated. A token is valid only for a period. @@ -70,24 +75,24 @@ Tokens generated by afb-daemon are UUIDs. ## UUID -It stand for Universal Unic IDentifier. +It stand for Universal Unique IDentifier. -Its is designed to create identifier in a way that avoid has much as possible conflicts. -It means that if two differents instance create a UUID, the probability that they create the same UUID is very low, near to zero. +It is designed to create identifier in a way that avoid has much as possible +conflicts. It means that if two different instances create an UUID, the +probability that they create the same UUID is very low, near to zero. ## x-afb-reqid -Argument name that can be used with HTTP request. -When this argument is given, it is automatically added to the "request" object of the -answer. +Argument name that can be used with HTTP request. When this argument is given, +it is automatically added to the "request" object of the answer. ## x-afb-token -Argument name for giving the token without ambiguity. -You can also use the name **token** but it may conflicts with other arguments. +Argument name meant to give the token without ambiguity. +You can also use the name **token** but it may conflicts with others arguments. ## x-afb-uuid -Argument name for giving explicitely the session identifier without ambiguity. -You can also use the name **uuid** but it may conflicts with other arguments. +Argument name for giving explicitly the session identifier without ambiguity. +You can also use the name **uuid** but it may conflicts with others arguments.