blob: d28699be467ddd3ad585dc1f39cda273c9436f7a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
# Vocabulary for AFB-DAEMON
## 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 points called after
initialization and before serving.
## Event
Messages 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 these levels and how to use it remains to
be achieved.
## Request
A request is an invocation by a client to a binding method using a message
transferred through some protocol:
- HTTP
- WebSocket
- ...
and served by ***afb-daemon***
## Reply/Response
This is a message sent to client as the result of the request.
## Service
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.
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.
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 a session is closed or disappears, data attached to that session
are freed.
## Token
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 by incoming client to be authenticated.
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.
Tokens generated by afb-daemon are UUIDs.
## UUID
It stand for Universal Unique IDentifier.
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.
## x-afb-token
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 explicitly the session identifier without ambiguity.
You can also use the name **uuid** but it may conflicts with others arguments.
|
