doc/afb-daemon-vocabulary.md

   1
   2 Vocabulary for AFB-DAEMON
   3 =========================
   4
   5 ## Binding
   6
   7 A shared library object intended to be add a functionnality to an afb-daemon
   8 instance. It implements an API. It may provide a service.
   9
  10 Binding made for services can have specific entry point called after
  11 initialisation and before serving.
  12
  13 ## Event
  14
  15 Message with data propagated from the services to the client and not expecting
  16 any reply.
  17
  18 The current implementation allows to widely broadcast events to all clients.
  19
  20 ## Level of assurance (LOA)
  21
  22 This level that can be from 0 to 3 represent the level of
  23 assurance that the services can expect from the session.
  24
  25 The exact definition of the meaning of this levels and of
  26 how to use it remains to be achived.
  27
  28 ## Plugin
  29
  30 Old name for binding, see binding.
  31
  32 ## Request
  33
  34 A request is an invocation by a client to a method of a binding using a message
  35 transfered through some protocol: HTTP, WebSocket, DBUS... served by afb-daemon
  36
  37 ## Reply/Response
  38
  39 This is a message sent to client as the result of the request.
  40
  41 ## Service
  42
  43 Service are made of binding runnning by their side on their binder.
  44 It can serve many client. Each one being attached to one session.
  45
  46 The framework establishes the connection between the services and
  47 the clients. Using DBus currently but other protocols are considered.
  48
  49 ## Session
  50
  51 A session is meant to be the unic context of an instance of client,
  52 identifying that instance across requests.
  53
  54 Each session has an identifier. Session identifier generated by afb-daemon are UUIDs.
  55
  56 Internally, afb-daemon offers a mechanism to attach data to sessions.
  57 When the session is closed or disappears, the data attached to that session
  58 are freed.
  59
  60 ## Token
  61
  62 The token is an identifier that the the client must give to be authentificated.
  63
  64 At start, afb-daemon get an initial token. This initial token must be presented
  65 incoming client to be authentificated.
  66
  67 A token is valid only for a period.
  68
  69 The token must be renewed periodically. When the token is renewed, afb-daemon
  70 sends the new token to the client.
  71
  72 Tokens generated by afb-daemon are UUIDs.
  73
  74 ## UUID
  75
  76 It stand for Universal Unic IDentifier.
  77
  78 Its is designed to create identifier in a way that avoid has much as possible conflicts.
  79 It means that if two differents instance create a UUID, the probability that they create the same UUID is very low, near to zero.
  80
  81 ## x-afb-reqid
  82
  83 Argument name that can be used with HTTP request.
  84 When this argument is given, it is automatically added to the "request" object of the
  85 answer.
  86
  87 ## x-afb-token
  88
  89 Argument name for giving the token without ambiguity.
  90 You can also use the name **token** but it may conflicts with other arguments.
  91
  92 ## x-afb-uuid
  93
  94 Argument name for giving explicitely the session identifier without ambiguity.
  95 You can also use the name **uuid** but it may conflicts with other arguments.
  96