update markdown documentation

[src/app-framework-binder.git] / docs / afb-daemon-vocabulary.md

diff --git a/docs/afb-daemon-vocabulary.md b/docs/afb-daemon-vocabulary.md
index c343abd..6c51f12 100644 (file)
--- a/docs/afb-daemon-vocabulary.md
+++ b/docs/afb-daemon-vocabulary.md
@@ -1,11 +1,10 @@
-
-Vocabulary for AFB-DAEMON
-=========================
+# Vocabulary for AFB-DAEMON

 
 ## Binding
 
 A shared library object intended to add a functionality to an 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.
+instance.  
+It implements an API and may provide a service.

 
 Binding made for services can have specific entry point called after
 initialization and before serving.
 
 Binding made for services can have specific entry point called after
 initialization and before serving.


@@ -32,8 +31,14 @@ Old name for binding, see binding.
 ## Request
 
 A request is an invocation by a client to a binding method using a message
 ## Request
 
 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***
+transferred through some protocol:
+
+- HTTP
+- WebSocket
+- DBUS
+- ...
+
+and served by ***afb-daemon***

 
 ## Reply/Response
 
 
 ## Reply/Response
 


@@ -41,21 +46,22 @@ This is a message sent to client as the result of the request.
 
 ## Service
 
 
 ## 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 by their side on their binder.  
+It can serve many client.  
+Each one attached to one session.

 
 

-The framework establishes connection between the services and
-the clients. Using DBus currently but other protocols are considered.
+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 unique instance context of a client,
 which identify that instance across requests.
 
 
 ## 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.
+Each session has an identifier.  
+Session identifier generated by afb-daemon are UUIDs.

 
 

-Internally, afb-daemon offers a mechanism to attach data to sessions.
+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.
 
 When the session is closed or disappears, the data attached to that session
 are freed.
 


@@ -63,13 +69,13 @@ are freed.
 
 The token is an identifier that the client must give to be authenticated.
 
 
 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.
+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.
 
 
 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.
 
 
 Tokens generated by afb-daemon are UUIDs.
 


@@ -78,21 +84,21 @@ Tokens generated by afb-daemon are UUIDs.
 It stand for Universal Unique IDentifier.
 
 It is designed to create identifier in a way that avoid has much as possible
 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
+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
 
 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
 
 
 ## x-afb-token
 

-Argument name meant to give the token without ambiguity.
+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
 
 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.
+Argument name for giving explicitly the session identifier without ambiguity.  

 You can also use the name **uuid** but it may conflicts with others arguments.
 You can also use the name **uuid** but it may conflicts with others arguments.

-