diff options
| author |   José Bollo <jose.bollo@iot.bzh> | 2018-06-19 20:16:28 +0200 |
|---|---|---|
| committer | José Bollo <jose.bollo@iot.bzh> | 2018-06-22 09:48:48 +0200 |
| commit | 525e9eaa644ca92fad23adfbb7c3119ae8b57a30 (patch) | |
| tree | 41de59627ccc937450daf4da6488efd4f4b2f3c2 /docs/afb-daemon-vocabulary.md | |
| parent | 9e15212d26916f59fae2be6d9e618ae9b75a4f40 (diff) | |
Improve documentation of api v3
The documentation is improved to reflect the new version.
Tune the options
Change-Id: I894c3db3bc0c10e89db66a9a51a9ad049bb8c0c4
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'docs/afb-daemon-vocabulary.md')
| -rw-r--r-- | docs/afb-daemon-vocabulary.md | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/docs/afb-daemon-vocabulary.md b/docs/afb-daemon-vocabulary.md index efe53d20..84725700 100644 --- a/docs/afb-daemon-vocabulary.md +++ b/docs/afb-daemon-vocabulary.md @@ -3,7 +3,7 @@ ## Binding A shared library object intended to add a functionality to an afb-daemon -instance. +instance. It implements an API and may provide a service. Binding made for services can have specific entry point called after @@ -31,7 +31,6 @@ transferred through some protocol: - HTTP - WebSocket -- DBUS - ... and served by ***afb-daemon*** @@ -42,23 +41,26 @@ This is a message sent to client as the result of the request. ## Service -Service are made of bindings running by their side on their binder. -It can serve many client. -Each one attached to one session. +Service are made of bindings running on a binder +The binder is in charge of connecting services and applications. +A service can serve many clients. -The framework establishes connection between the services and the clients. +The framework establishes connection between the services and the clients. Using sockets currently but other protocols are considered. +The term of service is tightly bound to the notion of API. + ## Session A session is meant to be the unique instance context of a client, which identify that instance across requests. -Each session has an identifier. +Each session has an identifier. Session identifier generated by afb-daemon are UUIDs. +A client can present its own session id. -Internally, afb-daemon offers a mechanism to attach data to sessions. -When the session is closed or disappears, the data attached to that session +Internally, afb-daemon offers a mechanism to attach data to sessions. +When a session is closed or disappears, data attached to that session are freed. ## Token |