From 741d4e0505c588f38a64350c1d3c53c74f7ac22c Mon Sep 17 00:00:00 2001 From: José Bollo Date: Thu, 9 Jun 2016 14:22:22 +0200 Subject: documentation: switch to pandoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I60fcea9d370f5b98efa1e08632f5f9682741b8c1 Signed-off-by: José Bollo --- doc/afb-daemon-vocabulary.html | 179 +++++++++++++++-------------------------- 1 file changed, 63 insertions(+), 116 deletions(-) (limited to 'doc/afb-daemon-vocabulary.html') diff --git a/doc/afb-daemon-vocabulary.html b/doc/afb-daemon-vocabulary.html index fadd1dee..d2d4f512 100644 --- a/doc/afb-daemon-vocabulary.html +++ b/doc/afb-daemon-vocabulary.html @@ -1,131 +1,78 @@ + - - + + + + + Vocabulary for AFB-DAEMON + + + - -

Vocabulary for AFB-DAEMON

- +
+

Vocabulary for AFB-DAEMON

+

José Bollo

+

27 mai 2016

+
+ +

Vocabulary for AFB-DAEMON

version: 1
 Date:    27 mai 2016
-Author:  José Bollo
-
- -

- - -

Event

- -

Message with data propagated from the services to the client and not expecting -any reply.

- +Author: José Bollo +

Event

+

Message with data propagated from the services to the client and not expecting any reply.

The current implementation allows to widely broadcast events to all clients.

- - -

Level of assurance (LOA)

- -

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.

- - -

Plugin

- -

A shared library object intended to be plug to an afb-daemon instance -to implement an API.

- - -

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

- - -

Reply/Response

- +

Level of assurance (LOA)

+

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.

+

Plugin

+

A shared library object intended to be plug to an afb-daemon instance to implement an API.

+

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

+

Reply/Response

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.

- -

The framework establishes the connection between the services and -the clients. Using DBus currently.

- - -

Session

- -

A session is meant to be the unic context of an instance of client, -identifying that instance across requests.

- +

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.

+

The framework establishes the connection between the services and the clients. Using DBus currently.

+

Session

+

A session is meant to be the unic context of an instance of client, identifying that instance across requests.

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 -are freed.

- - -

Token

- +

Internally, afb-daemon offers a mechanism to attach data to sessions. When the session is closed or disappears, the data attached to that session are freed.

+

Token

The token is an identifier that the the client must give to be authentificated.

- -

At start, afb-daemon get an initial token. This initial token must be presented -incoming client to be authentificated.

- +

At start, afb-daemon get an initial token. This initial token must be presented incoming client to be authentificated.

A token is valid only for a period.

- -

The token must be renewed periodically. When the token is renewed, afb-daemon -sends the new token to the client.

- +

The token must be renewed periodically. When the token is renewed, afb-daemon sends the new token to the client.

Tokens generated by afb-daemon are UUIDs.

- - -

UUID

- +

UUID

It stand for Universal Unic 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.

- - -

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.

- - -

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.

- - -

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.

+

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.

+

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.

+

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.

+

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.

-- cgit