From cfa0067c4e1df2def1660e2da31efd62df6a3d30 Mon Sep 17 00:00:00 2001 From: Yannick Gicquel Date: Thu, 26 May 2016 14:13:11 +0200 Subject: css: minor update pre block: margin alignment h1,h2,h3: add outline Signed-off-by: Yannick Gicquel --- doc/doc.css | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/doc/doc.css b/doc/doc.css index c11082fd..a5c5be5c 100644 --- a/doc/doc.css +++ b/doc/doc.css @@ -4,12 +4,19 @@ body { color: #000; } -h1, h2, h3 { color: #306; } +h1, h2, h3 { + color: #306; + text-decoration: underline; +} pre { border: medium dashed #306; - background: #ccc; - margin-left: 4em; + border-width: 0.1em; + background-color: #eee; + margin-left: 2em; + margin-right: 2em; padding: 1em; + outline: #555; } + -- cgit 1.2.3-korg From ebb9bd69a97516763d5d9203245ded592b825a86 Mon Sep 17 00:00:00 2001 From: jobol Date: Thu, 26 May 2016 18:12:12 +0200 Subject: update documentation Signed-off-by: jobol --- doc/FAQ.html | 5 +- doc/FAQ.md | 2 +- doc/README.html | 9 +- doc/afb-daemon-vocabulary.html | 41 ++-- doc/afb-daemon-vocabulary.md | 2 +- doc/doc.css | 7 + doc/updt.sh | 40 ++-- doc/writing-afb-plugins.html | 459 ++++++++++++++++++++++++++++++++++------- doc/writing-afb-plugins.md | 288 ++++++++++++++++++++++---- 9 files changed, 687 insertions(+), 166 deletions(-) diff --git a/doc/FAQ.html b/doc/FAQ.html index 4ebefaa3..2bd963bb 100644 --- a/doc/FAQ.html +++ b/doc/FAQ.html @@ -4,11 +4,10 @@ - -

Frequently Asked Question about AFB-DAEMON

version: 1
-Date:    24 mai 2016
+Date:    25 May 2016
 Author:  José Bollo

diff --git a/doc/FAQ.md b/doc/FAQ.md index 32ef2789..76957c1f 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -1,7 +1,7 @@ Frequently Asked Question about AFB-DAEMON ========================================== version: 1 - Date: 24 mai 2016 + Date: 25 May 2016 Author: José Bollo TABLE-OF-CONTENT-HERE diff --git a/doc/README.html b/doc/README.html index 0a7dffa8..04d68bf1 100644 --- a/doc/README.html +++ b/doc/README.html @@ -4,18 +4,15 @@ - -

Inititial Build

mkdir build cd build cmake ..

- -

Netbeans

- -

Copy nbprojet at project base

cp -r doc/nbproject.template ./nbproject

diff --git a/doc/afb-daemon-vocabulary.html b/doc/afb-daemon-vocabulary.html index b398aa33..4416db81 100644 --- a/doc/afb-daemon-vocabulary.html +++ b/doc/afb-daemon-vocabulary.html @@ -4,11 +4,10 @@ - -

Vocabulary for AFB-DAEMON

version: 1
-Date:    24 mai 2016
+Date:    25 May 2016
 Author:  José Bollo

@@ -31,47 +30,35 @@ Author: José Bollo

- -

Authentification

- -

Context

- -

Level of authorisation (LOA)

- -

Plugin

- -

Request

- -

Reply/Response

- -

Service

- -

Session

A session records data as

- -

Token

- -

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-token

- -

x-afb-uuid

diff --git a/doc/afb-daemon-vocabulary.md b/doc/afb-daemon-vocabulary.md index 7a4b6537..2531c81a 100644 --- a/doc/afb-daemon-vocabulary.md +++ b/doc/afb-daemon-vocabulary.md @@ -1,7 +1,7 @@ Vocabulary for AFB-DAEMON ========================= version: 1 - Date: 24 mai 2016 + Date: 25 May 2016 Author: José Bollo TABLE-OF-CONTENT-HERE diff --git a/doc/doc.css b/doc/doc.css index a5c5be5c..d100bd1c 100644 --- a/doc/doc.css +++ b/doc/doc.css @@ -19,4 +19,11 @@ pre { outline: #555; } +pre:first-of-type { width: 20em; } +blockquote { + border-left: solid thick black; + background-color: #ff8; + font: bolder; + padding: 0.7em 1.5em; +} diff --git a/doc/updt.sh b/doc/updt.sh index cd978e22..af64e31e 100755 --- a/doc/updt.sh +++ b/doc/updt.sh @@ -1,9 +1,6 @@ -#!/bin/sh - -subst() { - awk -v pat="$1" -v rep="$(sed 's:\\:\\\\:g' $2)" '{gsub(pat,rep);gsub(pat,"\\&");print}' -} +#!/bin/bash +# the HTML template main=' @@ -14,18 +11,37 @@ GENERATED-MARKDOWN-HERE ' -for x in *.md; do - t=$(git log -n 1 --format=%ct $x) +# substitute the pattern $1 by the content of the file $2 +subst() { + awk -v pat="$1" -v rep="$(sed 's:\\:\\\\:g' $2)" '{gsub(pat,rep);gsub(pat,"\\&");print}' +} + +# update the date field of file $1 +updadate() { + local x=$1 + local t=$(git log -n 1 --format=%ct $x) [[ -n "$t" ]] || t=$(stat -c %Y $x) - d=$(LANG= date -d @$t +"%d %B %Y") + local d=$(LANG= date -d @$t +"%d %B %Y") sed -i "s/^$ Date: *$.*/\1$d/" $x - h=${x%%.md}.html - markdown -f toc,autolink $x > $h.toc.no - markdown -Tf toc,autolink $x > $h.toc.yes +} + +# make the html file for $1 +mkhtml() { + local x=$1 + local h=${x%%.md}.html + expand -i $x | sed 's: : :' > $h.pre + markdown -f toc,autolink $h.pre > $h.toc.no + markdown -Tf toc,autolink $h.pre > $h.toc.yes head --bytes=-$(stat -c %s $h.toc.no) $h.toc.yes > $h.toc echo "$main" | subst GENERATED-MARKDOWN-HERE $h.toc.no | subst TABLE-OF-CONTENT-HERE $h.toc > $h -# rm $h.toc* + rm $h.* +} + +# apply +for x in *.md; do + updadate $x + mkhtml $x done diff --git a/doc/writing-afb-plugins.html b/doc/writing-afb-plugins.html index 5aeca0a5..712d30ee 100644 --- a/doc/writing-afb-plugins.html +++ b/doc/writing-afb-plugins.html @@ -4,11 +4,10 @@ - -

HOWTO WRITE a PLUGIN for AFB-DAEMON

version: 1
-Date:    24 mai 2016
+Date:    25 May 2016
 Author:  José Bollo

@@ -18,6 +17,12 @@ Author: José Bollo

Summary

Nature of a plugin
Kinds of plugins +
- Application plugins
- Service plugins
+
Live cycle of a plugin within afb-daemon
Content of a plugin
- Writing a synchronous verb implementation
- Getting argument of invocation
- Getting argument of invocation +
  +
- Sending messages to the log system
- How to build a plugin

- -

Summary

The binder afb-daemon serves files through the HTTP protocol and offers access to API’s through @@ -69,8 +80,7 @@ by developpers.

Before going into details, through a tiny example, a short overview plugins basis is needed.

- -

Nature of a plugin

A plugin is a separate piece of code made of a shared library. The plugin is loaded and activated by afb-daemon when afb-daemon @@ -78,8 +88,33 @@ starts.

Technically, a plugin is not linked to any library of afb-daemon.

- -

Live cycle of a plugin within afb-daemon

Kinds of plugins

+ +

There is two kinds of plugins: application plugins and service +plugins.

+ +

Application plugins

+ +

Application plugins are intended to be instanciated for each +application: when an application using that plugin is started, +its binder starts a new instance of the plugin.

+ +

It means that the application plugins mainly have only one +context to manage for one client.

+ +

Service plugins

+ +

Service plugins are intended to be instanciated only one time +only and connected to many clients.

+ +

So either it does not manage context at all or otherwise, +if it manages context, it should be able to manage one context +per client.

+ +

In details, it may be useful to have service plugins at a user +level.

+ +

Live cycle of a plugin within afb-daemon

The plugins are loaded and activated when afb-daemon starts.

@@ -97,8 +132,7 @@ Consequently, developpers of plugins should use ‘atexit’ or ‘on_exit’ during initialisation if they need to perform specific actions when stopping.

- -

Content of a plugin

For afb-daemon, a plugin contains 2 different things: names and functions.

@@ -124,8 +158,7 @@ and upper case when searching for a method. Thus, The names TicTacToe/Board and tictactoe/borad are equals.

- -

The name of the plugin

The name of the plugin is also known as the name of the API that defines the plugin.

@@ -140,8 +173,7 @@ extracts the prefix foo and the suffix bar. foo is the API name and must match a plugin name, the plugin that implements the verb bar.

- -

Names of verbs

Each plugin exposes a set of verbs that can be called by client of afb-daemon.

@@ -154,8 +186,7 @@ when clients emit requests for that verb.

For example, when a client of afb-daemon calls a method named foo/bar.

- -

The initialisation function

The initialisation function serves several purposes.

@@ -171,8 +202,7 @@ requirements and implmentations of the verbs that it exposes.

- -

Functions implementing verbs

When a method is called, afb-daemon constructs a request object and pass it to the implementation function for verb @@ -198,8 +228,7 @@ returning are named asynchronous implementations.

asynchronous action and record to send the reply on completion of this action.

- -

The Tic-Tac-Toe example

This part explains how to write an afb-plugin. For the sake of being practical we will use many @@ -208,8 +237,7 @@ This plugin example is in plugins/samples/tic-tac-toe.c.

This plugin is named tictactoe.

- -

Choosing names

The designer of a plugin must defines names for its plugin (or its API) and for the verbs of its API. He also @@ -221,8 +249,7 @@ the names easy to use across plaforms.

The names and strings used ALL are UTF-8 encoded.

- -

Names for API (plugin)

The names of the API are checked. All characters are authorised except:

@@ -241,8 +268,7 @@ All characters are authorised except:

Afb-daemon make no distinction between lower case and upper case when searching for an API by its name.

- -

Names for verbs

The names of the verbs are not checked.

@@ -253,8 +279,7 @@ is forbidden.

Afb-daemon make no distinction between lower case and upper case when searching for an API by its name.

- -

Names for arguments

The names for arguments are not restricted and can be anything.

@@ -263,8 +288,7 @@ anything.

string comparison. Thus the names “index” and “Index” are not the same.

- -

Forging names widely available

The key names of javascript object can be almost anything using the arrayed notation:

@@ -287,8 +311,7 @@ valid javascript identifier.

rely on the case sensitivity and to avoid the use of names different only by the case.

- -

Options to set when compiling plugins

Afb-daemon provides a configuration file for pkg-config. Typing the command

@@ -313,8 +336,7 @@ This is done through the Requires keyword of pkg-config.

If this behaviour is a problem, let us know.

- -

Header files to include

The plugin tictactoe has the following lines for its includes:

@@ -341,8 +363,7 @@ if it needs it:

When including afb/afb-plugin.h, the macro _GNU_SOURCE must be defined.

- -

Writing a synchronous verb implementation

The verb tictactoe/board is a synchronous implementation. Here is its listing:

@@ -352,33 +373,61 @@ Here is its listing:

*/ static void board(struct afb_req req) { - struct board *board; - struct json_object *description; + struct board *board; + struct json_object *description; - /* retrieves the context for the session */ - board = board_of_req(req); - INFO(afbitf, "method 'board' called for boardid %d", board->id); + /* retrieves the context for the session */ + board = board_of_req(req); + INFO(afbitf, "method 'board' called for boardid %d", board->id); - /* describe the board */ - description = describe(board); + /* describe the board */ + description = describe(board); - /* send the board's description */ - afb_req_success(req, description, NULL); + /* send the board's description */ + afb_req_success(req, description, NULL); }

This examples show many aspects of writing a synchronous -verb implementation.

+verb implementation. Let summarize it:

- -

The incoming request

The function board_of_req retrieves the context stored +for the plugin: the board.
The macro INFO sends a message of kind INFO +to the logging system. The global variable named afbitf +used represents the interface to afb-daemon.
The function describe creates a json_object representing +the board.
The function afb_req_success sends the reply, attaching to +it the object description.

+ + +

The incoming request

For any implementation, the request is received by a structure of type +

For any implementation, the request is received by a structure of type struct afb_req.

Important: note that this is a PLAIN structure, not a pointer to a structure.

Note that this is a PLAIN structure, not a pointer to a structure.

+ +

The definition of struct afb_req is:

+ +

/*
+ * Describes the request by plugins from afb-daemon
+ */
+struct afb_req {
+        const struct afb_req_itf *itf;  /* the interfacing functions */
+        void *closure;          /* the closure for functions */
+};
+

+ +

It contains two pointers: one, itf, points to the functions needed +to handle the internal request represented by the second pointer, closure.

This structure, here named req, is used

The structure must never be used directly. +Insted, use the intended functions provided +by afb-daemon and described here.

req is used to get arguments of the request, to send answer, to store session data.

@@ -394,8 +443,7 @@ the session of the request.

The second time, it is used to send the reply: an object that describes the current board.

- -

Associating an object to the session for the plugin

Associating a context to the session

When the plugin tic-tac-toe receives a request, it musts regain the board that describes the game associated to the session.

@@ -430,14 +478,14 @@ its context: the board. This function is board_of_req:

*/ static inline struct board *board_of_req(struct afb_req req) { - return afb_req_context(req, (void*)get_new_board, (void*)release_board); + return afb_req_context(req, (void*)get_new_board, (void*)release_board); } -

This function is very simple because it merely wraps -a call to the function afb_req_context, providing -all needed arguments. -The casts are required to avoid a warning when compiling.

The function afb_req_context ensure an existing context +for the session of the request. +Its two last arguments are functions. Here, the casts are required +to avoid a warning when compiling.

Here is the definition of the function afb_req_context

@@ -450,33 +498,286 @@ The casts are required to avoid a warning when compiling.

*/ static inline void *afb_req_context(struct afb_req req, void *(*create_context)(), void (*free_context)(void*)) { - void *result = afb_req_context_get(req); - if (result == NULL) { - result = create_context(); - afb_req_context_set(req, result, free_context); - } - return result; + void *result = afb_req_context_get(req); + if (result == NULL) { + result = create_context(); + afb_req_context_set(req, result, free_context); + } + return result; } -

This powerful function ensures that the context exists and is -stored for the session.

- -

The function get_new_board creates a new board and set its +

The second argument if the function that creates the context. +For the plugin tic-tac-toe it is the function get_new_board. +The function get_new_board creates a new board and set its count of use to 1. The boards are counting their count of use to free there ressources when no more used.

The function release_board

The third argument if the function that frees the context. +For the plugin tic-tac-toe it is the function release_board. +The function release_board decrease the the count of use of +the board given as argument. If the use count decrease to zero, +the board data are freed.

+ +

The definition of the other functions for dealing with contexts are:

+ +

/*
+ * Gets the pointer stored by the plugin for the session of 'req'.
+ * When the plugin has not yet recorded a pointer, NULL is returned.
+ */
+void *afb_req_context_get(struct afb_req req);
+
+/*
+ * Stores for the plugin the pointer 'context' to the session of 'req'.
+ * The function 'free_context' will be called when the session is closed
+ * or if plugin stores an other pointer.
+ */
+void afb_req_context_set(struct afb_req req, void *context, void (*free_context)(void*));
+
+/*
+ * Frees the pointer stored by the plugin for the session of 'req'
+ * and sets it to NULL.
+ *
+ * Shortcut for: afb_req_context_set(req, NULL, NULL)
+ */
+static inline void afb_req_context_clear(struct afb_req req)
+{
+        afb_req_context_set(req, NULL, NULL);
+}
+

+ +

Sending the reply to a request

+ +

Two kinds of replies can be made: successful replies and +failure replies.

+ +

Sending a reply to a request must be done at most one time.

+ +

The two functions to send a reply of kind “success” are +afb_req_success and afb_req_success_f.

+ +

/*
+ * Sends a reply of kind success to the request 'req'.
+ * The status of the reply is automatically set to "success".
+ * Its send the object 'obj' (can be NULL) with an
+ * informationnal comment 'info (can also be NULL).
+ */
+void afb_req_success(struct afb_req req, struct json_object *obj, const char *info);
+
+/*
+ * Same as 'afb_req_success' but the 'info' is a formatting
+ * string followed by arguments.
+ */
+void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...);
+

+ +

The two functions to send a reply of kind “failure” are +afb_req_fail and afb_req_fail_f.

+ +

/*
+ * Sends a reply of kind failure to the request 'req'.
+ * The status of the reply is set to 'status' and an
+ * informationnal comment 'info' (can also be NULL) can be added.
+ *
+ * Note that calling afb_req_fail("success", info) is equivalent
+ * to call afb_req_success(NULL, info). Thus even if possible it
+ * is strongly recommanded to NEVER use "success" for status.
+ */
+void afb_req_fail(struct afb_req req, const char *status, const char *info);
+
+/*
+ * Same as 'afb_req_fail' but the 'info' is a formatting
+ * string followed by arguments.
+ */
+void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...);
+

+ +

Getting argument of invocation

+ +

Many verbs expect arguments. Afb-daemon let plugins +retrieve their arguments by name not by position.

+ +

Arguments are given by the requests either through HTTP +or through WebSockets.

+ +

For example, the verb join of the plugin tic-tac-toe +expects one argument: the boardid to join. Here is an extract:

+ +

/*
+ * Join a board
+ */
+static void join(struct afb_req req)
+{
+        struct board *board, *new_board;
+        const char *id;
+
+        /* retrieves the context for the session */
+        board = board_of_req(req);
+        INFO(afbitf, "method 'join' called for boardid %d", board->id);
+
+        /* retrieves the argument */
+        id = afb_req_value(req, "boardid");
+        if (id == NULL)
+                goto bad_request;
+        ...
+

+ +

The function afb_req_value search in the request req +for an argument whose name is given. When no argument of the +given name was passed, afb_req_value returns NULL.

+ +

The search is case sensitive. So the name boardid is not the +same name than BoardId. But this must not be assumed so two +expected names of argument should not differ only by case.

+ +

Basic functions for querying arguments

+ +

The function afb_req_value is defined as below:

+ +

/*
+ * Gets from the request 'req' the string value of the argument of 'name'.
+ * Returns NULL if when there is no argument of 'name'.
+ * Returns the value of the argument of 'name' otherwise.
+ *
+ * Shortcut for: afb_req_get(req, name).value
+ */
+static inline const char *afb_req_value(struct afb_req req, const char *name)
+{
+        return afb_req_get(req, name).value;
+}
+

+ +

It is defined as a shortcut to call the function afb_req_get. +That function is defined as below:

+ +

/*
+ * Gets from the request 'req' the argument of 'name'.
+ * Returns a PLAIN structure of type 'struct afb_arg'.
+ * When the argument of 'name' is not found, all fields of result are set to NULL.
+ * When the argument of 'name' is found, the fields are filled,
+ * in particular, the field 'result.name' is set to 'name'.
+ *
+ * There is a special name value: the empty string.
+ * The argument of name "" is defined only if the request was made using
+ * an HTTP POST of Content-Type "application/json". In that case, the
+ * argument of name "" receives the value of the body of the HTTP request.
+ */
+struct afb_arg afb_req_get(struct afb_req req, const char *name);
+

+ +

That function takes 2 parameters: the request and the name +of the argument to retrieve. It returns a PLAIN structure of +type struct afb_arg.

+ +

There is a special name that is defined when the request is +of type HTTP/POST with a Content-Type being application/json. +This name is “” (the empty string). In that case, the value +of this argument of empty name is the string received as a body +of the post and is supposed to be a JSON string.

+ +

The definition of struct afb_arg is:

+ +

/*
+ * Describes an argument (or parameter) of a request
+ */
+struct afb_arg {
+        const char *name;   /* name of the argument or NULL if invalid */
+        const char *value;  /* string representation of the value of the argument */
+                                /* original filename of the argument if path != NULL */
+        const char *path;   /* if not NULL, path of the received file for the argument */
+                                /* when the request is finalized this file is removed */
+};
+

+ +

The structure returns the data arguments that are known for the +request. This data include a field named path. This path +can be accessed using the function afb_req_path defined as +below:

+ +

/*
+ * Gets from the request 'req' the path for file attached to the argument of 'name'.
+ * Returns NULL if when there is no argument of 'name' or when there is no file.
+ * Returns the path of the argument of 'name' otherwise.
+ *
+ * Shortcut for: afb_req_get(req, name).path
+ */
+static inline const char *afb_req_path(struct afb_req req, const char *name)
+{
+        return afb_req_get(req, name).path;
+}
+

+ +

The path is only defined for HTTP/POST requests that send file.

+ +

Arguments for received files

+ +

As it is explained just above, clients can send files using +HTTP/POST requests.

+ +

Received files are attached to a arguments. For example, the +following HTTP fragment (from test/sample-post.html) +will send an HTTP/POST request to the method +post/upload-image with 2 arguments named file and +hidden.

+ +

<h2>Sample Post File</h2>
+<form enctype="multipart/form-data">
+    <input type="file" name="file" />
+    <input type="hidden" name="hidden" value="bollobollo" />
+    <br>
+    <button formmethod="POST" formaction="api/post/upload-image">Post File</button>
+</form>
+

+ +

In that case, the argument named file has its value and its +path defined and not NULL.

+ +

The value is the name of the file as it was +set by the HTTP client and is generally the filename on the +client side.

+ +

The path is the path of the file saved on the temporary local storage +area of the application. This is a randomly generated and unic filename +not linked in any way with the original filename on the client.

+ +

The plugin can use the file at the given path the way that it wants: +read, write, remove, copy, rename… +But when the reply is sent and the query is terminated, the file at +this path is destroyed if it still exist.

+ +

Arguments as a JSON object

+ +

Plugins can get all the arguments as one single object. +This feature is provided by the function afb_req_json +that is defined as below:

+ +

/*
+ * Gets from the request 'req' the json object hashing the arguments.
+ * The returned object must not be released using 'json_object_put'.
+ */
+struct json_object *afb_req_json(struct afb_req req);
+

+ +

It returns a json object. This object depends on how the request was +made:

+ +

For HTTP requests, this is an object whose keys are the names of the +arguments and whose values are either a string for common arguments or +an object like { “file”: “…”, “path”: “…” }
For WebSockets requests, the returned object is the object +given by the client transparently transported.

+ - -

Sending the reply to a request

In fact, for Websockets requests, the function afb_req_value +can be seen as a shortcut to +json_object_get_string(json_object_object_get(afb_req_json(req), name))

- -

Getting argument of invocation

Sending messages to the log system

- -

How to build a plugin

Afb-daemon provides a The packaging of afb-daemon

Afb-daemon provides a pkg-config configuration file.

diff --git a/doc/writing-afb-plugins.md b/doc/writing-afb-plugins.md index ba2e676a..7611600f 100644 --- a/doc/writing-afb-plugins.md +++ b/doc/writing-afb-plugins.md @@ -28,6 +28,32 @@ The plugin is loaded and activated by afb-daemon when afb-daemon starts. Technically, a plugin is not linked to any library of afb-daemon. + +### Kinds of plugins + +There is two kinds of plugins: application plugins and service +plugins. + +#### Application plugins + +Application plugins are intended to be instanciated for each +application: when an application using that plugin is started, +its binder starts a new instance of the plugin. + +It means that the application plugins mainly have only one +context to manage for one client. + +#### Service plugins + +Service plugins are intended to be instanciated only one time +only and connected to many clients. + +So either it does not manage context at all or otherwise, +if it manages context, it should be able to manage one context +per client. + +In details, it may be useful to have service plugins at a user +level. ### Live cycle of a plugin within afb-daemon @@ -312,12 +338,27 @@ it the object *description*. ### The incoming request -For any implementation, the request is received by a structure of type +For any implementation, the request is received by a structure of type **struct afb_req**. -***Important: note that this is a PLAIN structure, not a pointer to a structure.*** +> Note that this is a PLAIN structure, not a pointer to a structure. + +The definition of **struct afb_req** is: + + /* + * Describes the request by plugins from afb-daemon + */ + struct afb_req { + const struct afb_req_itf *itf; /* the interfacing functions */ + void *closure; /* the closure for functions */ + }; + +It contains two pointers: one, *itf*, points to the functions needed +to handle the internal request represented by the second pointer, *closure*. -This structure, here named *req*, is used +> The structure must never be used directly. +> Insted, use the intended functions provided +> by afb-daemon and described here. *req* is used to get arguments of the request, to send answer, to store session data. @@ -333,7 +374,7 @@ the session of the request. The second time, it is used to send the reply: an object that describes the current board. -### Associating an object to the session for the plugin +### Associating a context to the session When the plugin *tic-tac-toe* receives a request, it musts regain the board that describes the game associated to the session. @@ -407,14 +448,41 @@ The function **release_board** decrease the the count of use of the board given as argument. If the use count decrease to zero, the board data are freed. -### Sending the reply to a request +The definition of the other functions for dealing with contexts are: + + /* + * Gets the pointer stored by the plugin for the session of 'req'. + * When the plugin has not yet recorded a pointer, NULL is returned. + */ + void *afb_req_context_get(struct afb_req req); -Sending a reply to a request must be done at most one time. + /* + * Stores for the plugin the pointer 'context' to the session of 'req'. + * The function 'free_context' will be called when the session is closed + * or if plugin stores an other pointer. + */ + void afb_req_context_set(struct afb_req req, void *context, void (*free_context)(void*)); + + /* + * Frees the pointer stored by the plugin for the session of 'req' + * and sets it to NULL. + * + * Shortcut for: afb_req_context_set(req, NULL, NULL) + */ + static inline void afb_req_context_clear(struct afb_req req) + { + afb_req_context_set(req, NULL, NULL); + } + +### Sending the reply to a request Two kinds of replies can be made: successful replies and failure replies. -The functions to send replies are defined as below: +> Sending a reply to a request must be done at most one time. + +The two functions to send a reply of kind "success" are +**afb_req_success** and **afb_req_success_f**. /* * Sends a reply of kind success to the request 'req'. @@ -422,26 +490,16 @@ The functions to send replies are defined as below: * Its send the object 'obj' (can be NULL) with an * informationnal comment 'info (can also be NULL). */ - static inline void afb_req_success(struct afb_req req, struct json_object *obj, const char *info) - { - req.itf->success(req.closure, obj, info); - } + void afb_req_success(struct afb_req req, struct json_object *obj, const char *info); /* * Same as 'afb_req_success' but the 'info' is a formatting * string followed by arguments. */ - static inline void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...) - { - char *message; - va_list args; - va_start(args, info); - if (info == NULL || vasprintf(&message, info, args) < 0) - message = NULL; - va_end(args); - afb_req_success(req, obj, message); - free(message); - } + void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...); + +The two functions to send a reply of kind "failure" are +**afb_req_fail** and **afb_req_fail_f**. /* * Sends a reply of kind failure to the request 'req'. @@ -452,31 +510,187 @@ The functions to send replies are defined as below: * to call afb_req_success(NULL, info). Thus even if possible it * is strongly recommanded to NEVER use "success" for status. */ - static inline void afb_req_fail(struct afb_req req, const char *status, const char *info) - { - req.itf->fail(req.closure, status, info); - } + void afb_req_fail(struct afb_req req, const char *status, const char *info); /* * Same as 'afb_req_fail' but the 'info' is a formatting * string followed by arguments. */ - static inline void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...) + void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...); + +Getting argument of invocation +------------------------------ + +Many verbs expect arguments. Afb-daemon let plugins +retrieve their arguments by name not by position. + +Arguments are given by the requests either through HTTP +or through WebSockets. + +For example, the verb **join** of the plugin **tic-tac-toe** +expects one argument: the *boardid* to join. Here is an extract: + + /* + * Join a board + */ + static void join(struct afb_req req) { - char *message; - va_list args; - va_start(args, info); - if (info == NULL || vasprintf(&message, info, args) < 0) - message = NULL; - va_end(args); - afb_req_fail(req, status, message); - free(message); + struct board *board, *new_board; + const char *id; + + /* retrieves the context for the session */ + board = board_of_req(req); + INFO(afbitf, "method 'join' called for boardid %d", board->id); + + /* retrieves the argument */ + id = afb_req_value(req, "boardid"); + if (id == NULL) + goto bad_request; + ... + +The function **afb_req_value** search in the request *req* +for an argument whose name is given. When no argument of the +given name was passed, **afb_req_value** returns NULL. + +> The search is case sensitive. So the name *boardid* is not the +> same name than *BoardId*. But this must not be assumed so two +> expected names of argument should not differ only by case. + +### Basic functions for querying arguments + +The function **afb_req_value** is defined as below: + + /* + * Gets from the request 'req' the string value of the argument of 'name'. + * Returns NULL if when there is no argument of 'name'. + * Returns the value of the argument of 'name' otherwise. + * + * Shortcut for: afb_req_get(req, name).value + */ + static inline const char *afb_req_value(struct afb_req req, const char *name) + { + return afb_req_get(req, name).value; } +It is defined as a shortcut to call the function **afb_req_get**. +That function is defined as below: + /* + * Gets from the request 'req' the argument of 'name'. + * Returns a PLAIN structure of type 'struct afb_arg'. + * When the argument of 'name' is not found, all fields of result are set to NULL. + * When the argument of 'name' is found, the fields are filled, + * in particular, the field 'result.name' is set to 'name'. + * + * There is a special name value: the empty string. + * The argument of name "" is defined only if the request was made using + * an HTTP POST of Content-Type "application/json". In that case, the + * argument of name "" receives the value of the body of the HTTP request. + */ + struct afb_arg afb_req_get(struct afb_req req, const char *name); -Getting argument of invocation ------------------------------- +That function takes 2 parameters: the request and the name +of the argument to retrieve. It returns a PLAIN structure of +type **struct afb_arg**. + +There is a special name that is defined when the request is +of type HTTP/POST with a Content-Type being application/json. +This name is **""** (the empty string). In that case, the value +of this argument of empty name is the string received as a body +of the post and is supposed to be a JSON string. + +The definition of **struct afb_arg** is: + + /* + * Describes an argument (or parameter) of a request + */ + struct afb_arg { + const char *name; /* name of the argument or NULL if invalid */ + const char *value; /* string representation of the value of the argument */ + /* original filename of the argument if path != NULL */ + const char *path; /* if not NULL, path of the received file for the argument */ + /* when the request is finalized this file is removed */ + }; + +The structure returns the data arguments that are known for the +request. This data include a field named **path**. This **path** +can be accessed using the function **afb_req_path** defined as +below: + + /* + * Gets from the request 'req' the path for file attached to the argument of 'name'. + * Returns NULL if when there is no argument of 'name' or when there is no file. + * Returns the path of the argument of 'name' otherwise. + * + * Shortcut for: afb_req_get(req, name).path + */ + static inline const char *afb_req_path(struct afb_req req, const char *name) + { + return afb_req_get(req, name).path; + } + +The path is only defined for HTTP/POST requests that send file. + +### Arguments for received files + +As it is explained just above, clients can send files using +HTTP/POST requests. + +Received files are attached to a arguments. For example, the +following HTTP fragment (from test/sample-post.html) +will send an HTTP/POST request to the method +**post/upload-image** with 2 arguments named *file* and +*hidden*. + +

Sample Post File

+ + +In that case, the argument named **file** has its value and its +path defined and not NULL. + +The value is the name of the file as it was +set by the HTTP client and is generally the filename on the +client side. + +The path is the path of the file saved on the temporary local storage +area of the application. This is a randomly generated and unic filename +not linked in any way with the original filename on the client. + +The plugin can use the file at the given path the way that it wants: +read, write, remove, copy, rename... +But when the reply is sent and the query is terminated, the file at +this path is destroyed if it still exist. + +### Arguments as a JSON object + +Plugins can get all the arguments as one single object. +This feature is provided by the function **afb_req_json** +that is defined as below: + + /* + * Gets from the request 'req' the json object hashing the arguments. + * The returned object must not be released using 'json_object_put'. + */ + struct json_object *afb_req_json(struct afb_req req); + +It returns a json object. This object depends on how the request was +made: + +- For HTTP requests, this is an object whose keys are the names of the +arguments and whose values are either a string for common arguments or +an object like { "file": "...", "path": "..." } + +- For WebSockets requests, the returned object is the object +given by the client transparently transported. + +> In fact, for Websockets requests, the function **afb_req_value** +> can be seen as a shortcut to +> *json_object_get_string(json_object_object_get(afb_req_json(req), name))* Sending messages to the log system ---------------------------------- -- cgit 1.2.3-korg From f0f93f4d790343c4ae51ca55f165886c01358c89 Mon Sep 17 00:00:00 2001 From: jobol Date: Thu, 26 May 2016 18:12:54 +0200 Subject: rename parameter to argument Signed-off-by: jobol --- plugins/samples/tic-tac-toe.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/plugins/samples/tic-tac-toe.c b/plugins/samples/tic-tac-toe.c index a1630c50..67cddcb6 100644 --- a/plugins/samples/tic-tac-toe.c +++ b/plugins/samples/tic-tac-toe.c @@ -364,11 +364,11 @@ static void move(struct afb_req req) board = board_of_req(req); INFO(afbitf, "method 'move' called for boardid %d", board->id); - /* retrieves the parameters of the move */ + /* retrieves the arguments of the move */ index = afb_req_value(req, "index"); i = index == NULL ? -1 : atoi(index); - /* checks validity of parameters */ + /* checks validity of arguments */ if (i < 0 || i > 8) { WARNING(afbitf, "can't move to %s: %s", index?:"?", index?"wrong value":"not set"); afb_req_fail(req, "error", "bad request"); @@ -413,11 +413,11 @@ static void level(struct afb_req req) board = board_of_req(req); INFO(afbitf, "method 'level' called for boardid %d", board->id); - /* retrieves the parameters */ + /* retrieves the arguments */ level = afb_req_value(req, "level"); l = level == NULL ? -1 : atoi(level); - /* check validity of parameters */ + /* check validity of arguments */ if (l < 1 || l > 10) { WARNING(afbitf, "can't set level to %s: %s", level?:"?", level?"wrong value":"not set"); afb_req_fail(req, "error", "bad request"); @@ -447,7 +447,7 @@ static void join(struct afb_req req) board = board_of_req(req); INFO(afbitf, "method 'join' called for boardid %d", board->id); - /* retrieves the parameters */ + /* retrieves the arguments */ id = afb_req_value(req, "boardid"); if (id == NULL) goto bad_request; -- cgit 1.2.3-korg From 53d6a6e09c79383c086f8f4d6f41c6490c387e07 Mon Sep 17 00:00:00 2001 From: jobol Date: Thu, 26 May 2016 18:13:19 +0200 Subject: restore names Signed-off-by: jobol --- test/sample-post.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/sample-post.html b/test/sample-post.html index b1486c3b..d28c5bc0 100644 --- a/test/sample-post.html +++ b/test/sample-post.html @@ -6,7 +6,7 @@

Sample Post File

- +
@@ -58,4 +58,4 @@ - \ No newline at end of file + -- cgit 1.2.3-korg From ed6b81ea46629ae69176e77aec14844257dc36af Mon Sep 17 00:00:00 2001 From: Manuel Bachmann Date: Fri, 27 May 2016 11:04:56 +0200 Subject: Improve Audio plugin PulseAudio backend Remove obvious errors from the PulseAudio backend. It does not work yet (permissions issues ?), and some parts of the code are still hardly self-explaining. Signed-off-by: Manuel Bachmann --- plugins/audio/audio-pulse.c | 64 +++++++++++++++++++++++++++------------------ 1 file changed, 38 insertions(+), 26 deletions(-) diff --git a/plugins/audio/audio-pulse.c b/plugins/audio/audio-pulse.c index 7f511be1..50ddf40c 100644 --- a/plugins/audio/audio-pulse.c +++ b/plugins/audio/audio-pulse.c @@ -65,10 +65,10 @@ unsigned char _pulse_init (const char *name, audioCtxHandleT *ctx) { fprintf (stderr, "Stopping PulseAudio backend...\n"); return 0; } - if (ret >= 0) { + if (ret > 0) { /* found a matching sink from callback */ - fprintf (stderr, "Success : using sink n.%d\n", error); - ctx->audio_dev = (void*)dev_ctx_p[ret]; + fprintf (stderr, "Success : using sink n.%d\n", ret-1); + ctx->audio_dev = (void*)dev_ctx_p[ret-1]; break; } gettimeofday (&tv_now, NULL); @@ -78,11 +78,11 @@ unsigned char _pulse_init (const char *name, audioCtxHandleT *ctx) { return 0; /* make the client context aware of current card state */ - ctx->mute = (unsigned char)dev_ctx_p[ret]->mute; - ctx->channels = (unsigned int)dev_ctx_p[ret]->volume.channels; + ctx->mute = (unsigned char)dev_ctx_p[ret-1]->mute; + ctx->channels = (unsigned int)dev_ctx_p[ret-1]->volume.channels; for (i = 0; i < ctx->channels; i++) - ctx->volume[i] = dev_ctx_p[ret]->volume.values[i]; - ctx->idx = ret; + ctx->volume[i] = dev_ctx_p[ret-1]->volume.values[i]; + ctx->idx = ret-1; /* open matching sink for playback */ pa_spec = (pa_sample_spec*) malloc (sizeof(pa_sample_spec)); @@ -90,13 +90,13 @@ unsigned char _pulse_init (const char *name, audioCtxHandleT *ctx) { pa_spec->rate = 22050; pa_spec->channels = (uint8_t)ctx->channels; - if (!(pa = pa_simple_new (NULL, "afb-audio-plugin", PA_STREAM_PLAYBACK, dev_ctx_p[ret]->sink_name, + if (!(pa = pa_simple_new (NULL, "afb-audio-plugin", PA_STREAM_PLAYBACK, dev_ctx_p[ret-1]->sink_name, "afb-audio-output", pa_spec, NULL, NULL, &error))) { fprintf (stderr, "Error opening PulseAudio sink %s : %s\n", - dev_ctx_p[ret]->sink_name, pa_strerror(error)); + dev_ctx_p[ret-1]->sink_name, pa_strerror(error)); return 0; } - dev_ctx_p[ret]->pa = pa; + dev_ctx_p[ret-1]->pa = pa; free (pa_spec); client_count++; @@ -113,7 +113,7 @@ void _pulse_free (audioCtxHandleT *ctx) { client_count--; if (client_count > 0) return; - for (num = 0; num < (sizeof(dev_ctx_p)/sizeof(dev_ctx_pulse_T)); num++) { + for (num = 0; num < (sizeof(dev_ctx_p)/sizeof(dev_ctx_pulse_T*)); num++) { for (i = 0; num < (sizeof(dev_ctx_p[num]->card_name)/sizeof(char*)); i++) { free (dev_ctx_p[num]->card_name[i]); @@ -245,7 +245,7 @@ void _pulse_enumerate_cards () { int new_info, i, num = 0; /* allocate the global alsa array */ - alsa_info = (alsa_info_T**) malloc (sizeof(alsa_info_T)); + alsa_info = (alsa_info_T**) malloc (sizeof(alsa_info_T*)); alsa_info[0] = (alsa_info_T*) malloc (sizeof(alsa_info_T)); alsa_info[0]->device = NULL; alsa_info[0]->synonyms = NULL; @@ -276,7 +276,7 @@ void _pulse_enumerate_cards () { if (found) card_name[found-card_name] = '\0'; /* was the card name already listed in the global alsa array ? */ - for (i = 0; i < (sizeof(alsa_info)/sizeof(alsa_info_T)); i++) { + for (i = 0; i < (sizeof(alsa_info)/sizeof(alsa_info_T*)); i++) { if (alsa_info[i]->device && !strcmp (alsa_info[i]->device, card_name)) { @@ -288,7 +288,7 @@ void _pulse_enumerate_cards () { } /* it was not ; create it */ if (new_info) { - alsa_info = (alsa_info_T**) realloc (alsa_info, (num+1)*sizeof(alsa_info_T)); + alsa_info = (alsa_info_T**) realloc (alsa_info, (num+1)*sizeof(alsa_info_T*)); alsa_info[num]->device = strdup (card_name); asprintf (&alsa_info[num]->synonyms, ":%s", alsa_name); num++; @@ -309,12 +309,12 @@ char** _pulse_find_cards (const char *name) { asprintf (&needle, ":%s", name); - for (num = 0; num < (sizeof(alsa_info)/sizeof(alsa_info_T)); num++) { + for (num = 0; num < (sizeof(alsa_info)/sizeof(alsa_info_T*)); num++) { found = strstr (alsa_info[num]->synonyms, needle); while (found) { /* if next character is not ':' or '\0', we are wrong */ - if ((found[strlen(name)] != ':') && (found[strlen(name)] != '\0')) { + if ((found[strlen(name)+1] != ':') && (found[strlen(name)+1] != '\0')) { found = strstr (found+1, needle); continue; } @@ -322,11 +322,12 @@ char** _pulse_find_cards (const char *name) { found = strstr (alsa_info[num]->synonyms, ":"); while (found) { next = strstr (found+1, ":"); + if (!next) break; cards = (char**) realloc (cards, (i+1)*sizeof(char*)); cards[i] = (char*) malloc (next-found+1); strncpy (cards[i], found+1, next-found); - cards[i][next-found] = '\0'; - i++; + cards[i][next-found-1] = '\0'; + found = next; i++; } } } @@ -356,20 +357,20 @@ void _pulse_sink_list_cb (pa_context *context, const pa_sink_info *info, dev_ctx_pulse_T *dev_ctx_p_t = (dev_ctx_pulse_T *)data; const char *device_string; + char *device, *found; char **cards; int num, i; if (eol != 0) return; + device_string = pa_proplist_gets (info->proplist, "device.string"); /* ignore sinks with no cards */ - if (!pa_proplist_contains (info->proplist, "device.string")) + if (!device_string) return; - device_string = pa_proplist_gets (info->proplist, "device.string"); - /* was a sink with similar name already found ? */ - for (num = 0; num < (sizeof(dev_ctx_p)/sizeof(dev_ctx_pulse_T)); num++) { + for (num = 0; num < (sizeof(dev_ctx_p)/sizeof(dev_ctx_pulse_T*)); num++) { if (dev_ctx_p[num]->sink_name && !strcmp (dev_ctx_p[num]->sink_name, info->name)) { @@ -379,7 +380,8 @@ void _pulse_sink_list_cb (pa_context *context, const pa_sink_info *info, if (!strcmp (cards[i], dev_ctx_p_t->card_name[0])) { /* it did : stop there and succeed */ fprintf (stderr, "Found matching sink : %s\n", info->name); - pa_mainloop_quit (dev_ctx_p_t->pa_loop, num); + /* we return num+1 because '0' is already used */ + pa_mainloop_quit (dev_ctx_p_t->pa_loop, num+1); } } /* it did not, ignore and return */ @@ -388,11 +390,20 @@ void _pulse_sink_list_cb (pa_context *context, const pa_sink_info *info, } num++; + /* remove ending ":0",":1"... in device name */ + device = strdup (device_string); + found = strstr (device, ":"); + if (found) device[found-device] = '\0'; + +fprintf(stderr, "BEFORE PULSE_FIND_CARDS\n"); /* new sink, find all the cards it manages, fail if none */ - cards = _pulse_find_cards (device_string); - if (!cards) return; + cards = _pulse_find_cards (device); + free (device); + if (!cards) + return; /* everything is well, register it in global array */ +fprintf(stderr, "NEW SINK IN GLOBAL ARRAY\n"); dev_ctx_p_t->sink_name = strdup (info->name); dev_ctx_p_t->card_name = cards; dev_ctx_p_t->mute = info->mute; @@ -406,7 +417,8 @@ void _pulse_sink_list_cb (pa_context *context, const pa_sink_info *info, if (!strcmp (cards[i], dev_ctx_p_t->card_name[0])) { /* it did : stop there and succeed */ fprintf (stderr, "Found matching sink : %s\n", info->name); - pa_mainloop_quit (dev_ctx_p_t->pa_loop, num); + /* we return num+1 because '0' is already used */ + pa_mainloop_quit (dev_ctx_p_t->pa_loop, num+1); } } } -- cgit 1.2.3-korg From a1ed2c12ac2a305a54f35a3dad99b85cbe3113e6 Mon Sep 17 00:00:00 2001 From: Manuel Bachmann Date: Fri, 27 May 2016 14:16:54 +0200 Subject: Improve Audio plugin PulseAudio backend >100 return values are strangely returned by PulseAudio when doing an initial connection from afb-daemon. Just ignore them, because it breaks the logic. Allow 2 seconds of initial asynchronous connection (it should return earlier anyways). Signed-off-by: Manuel Bachmann --- plugins/audio/audio-pulse.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/plugins/audio/audio-pulse.c b/plugins/audio/audio-pulse.c index 50ddf40c..739b3774 100644 --- a/plugins/audio/audio-pulse.c +++ b/plugins/audio/audio-pulse.c @@ -58,14 +58,16 @@ unsigned char _pulse_init (const char *name, audioCtxHandleT *ctx) { /* 1 second should be sufficient to retrieve sink info */ gettimeofday (&tv_start, NULL); gettimeofday (&tv_now, NULL); - while (tv_now.tv_sec - tv_start.tv_sec <= 1) { + while (tv_now.tv_sec - tv_start.tv_sec <= 2) { pa_mainloop_iterate (pa_loop, 0, &ret); if (ret == -1) { fprintf (stderr, "Stopping PulseAudio backend...\n"); return 0; } - if (ret > 0) { + + /* 0 and >100 are returned by PulseAudio itself */ + if ((ret > 0)&&(ret < 100)) { /* found a matching sink from callback */ fprintf (stderr, "Success : using sink n.%d\n", ret-1); ctx->audio_dev = (void*)dev_ctx_p[ret-1]; @@ -395,7 +397,6 @@ void _pulse_sink_list_cb (pa_context *context, const pa_sink_info *info, found = strstr (device, ":"); if (found) device[found-device] = '\0'; -fprintf(stderr, "BEFORE PULSE_FIND_CARDS\n"); /* new sink, find all the cards it manages, fail if none */ cards = _pulse_find_cards (device); free (device); @@ -403,7 +404,6 @@ fprintf(stderr, "BEFORE PULSE_FIND_CARDS\n"); return; /* everything is well, register it in global array */ -fprintf(stderr, "NEW SINK IN GLOBAL ARRAY\n"); dev_ctx_p_t->sink_name = strdup (info->name); dev_ctx_p_t->card_name = cards; dev_ctx_p_t->mute = info->mute; -- cgit 1.2.3-korg From 645b2320fb04edda76e5761a439c865994f36b3a Mon Sep 17 00:00:00 2001 From: José Bollo Date: Fri, 27 May 2016 11:04:07 +0200 Subject: indicates the call to initialisation function MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: Ia2e27fa2661b539e67e388a7e9f3fc1555281bd7 Signed-off-by: José Bollo --- src/afb-api-so.c | 1 + 1 file changed, 1 insertion(+) diff --git a/src/afb-api-so.c b/src/afb-api-so.c index 3cf1feab..abe100b0 100644 --- a/src/afb-api-so.c +++ b/src/afb-api-so.c @@ -214,6 +214,7 @@ int afb_api_so_add_plugin(const char *path) desc->interface.daemon.closure = desc; /* init the plugin */ + NOTICE("plugin [%s] calling registering function %s", path, plugin_register_function_v1); desc->plugin = pluginAfbV1RegisterFct(&desc->interface); if (desc->plugin == NULL) { ERROR("plugin [%s] register function failed. continuing...", path); -- cgit 1.2.3-korg From 146bb49ca5acf4bbd5d9841398030c29b4333cc6 Mon Sep 17 00:00:00 2001 From: José Bollo Date: Fri, 27 May 2016 14:57:29 +0200 Subject: improves naming MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: If26d8b9af05c84bd24d0ac3ceb9a628a0039c2a6 Signed-off-by: José Bollo --- plugins/samples/tic-tac-toe.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/plugins/samples/tic-tac-toe.c b/plugins/samples/tic-tac-toe.c index 67cddcb6..4bae8d75 100644 --- a/plugins/samples/tic-tac-toe.c +++ b/plugins/samples/tic-tac-toe.c @@ -583,7 +583,7 @@ static void wait(struct afb_req req) /* * array of the verbs exported to afb-daemon */ -static const struct AFB_verb_desc_v1 verbs[] = { +static const struct AFB_verb_desc_v1 plugin_verbs[] = { /* VERB'S NAME SESSION MANAGEMENT FUNCTION TO CALL SHORT DESCRIPTION */ { .name= "new", .session= AFB_SESSION_NONE, .callback= new, .info= "Starts a new game" }, { .name= "play", .session= AFB_SESSION_NONE, .callback= play, .info= "Tells the server to play" }, @@ -593,8 +593,7 @@ static const struct AFB_verb_desc_v1 verbs[] = { { .name= "join", .session= AFB_SESSION_CHECK,.callback= join, .info= "Join a board" }, { .name= "undo", .session= AFB_SESSION_NONE, .callback= undo, .info= "Undo the last move" }, { .name= "wait", .session= AFB_SESSION_NONE, .callback= wait, .info= "Wait for a change" }, - /* marker for end of the array */ - { .name= NULL } + { .name= NULL } /* marker for end of the array */ }; /* @@ -607,7 +606,7 @@ static const struct AFB_plugin plugin_description = .v1= { /* fills the v1 field of the union when AFB_PLUGIN_VERSION_1 */ .prefix= "tictactoe", /* the API name (or plugin name or prefix) */ .info= "Sample tac-tac-toe game", /* short description of of the plugin */ - .verbs = verbs /* the array describing the verbs of the API */ + .verbs = plugin_verbs /* the array describing the verbs of the API */ } }; -- cgit 1.2.3-korg From 44eccb2c9d6f8dde8059cf75305d04992ae9feb7 Mon Sep 17 00:00:00 2001 From: José Bollo Date: Fri, 27 May 2016 14:58:15 +0200 Subject: improves detection of formatting error MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I426013cb841d6826c4904f68bf5fa1c653dd972c Signed-off-by: José Bollo --- include/afb/afb-plugin.h | 1 + src/verbose.h | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/include/afb/afb-plugin.h b/include/afb/afb-plugin.h index 6f5cd08c..81df3a8f 100644 --- a/include/afb/afb-plugin.h +++ b/include/afb/afb-plugin.h @@ -213,6 +213,7 @@ static inline struct sd_bus *afb_daemon_get_system_bus(struct afb_daemon daemon) * 'file' and 'line' are indicators of position of the code in source files. * 'daemon' MUST be the daemon given in interface when activating the plugin. */ +static inline void afb_daemon_verbose(struct afb_daemon daemon, int level, const char *file, int line, const char *fmt, ...) __attribute__((format(printf, 5, 6))); static inline void afb_daemon_verbose(struct afb_daemon daemon, int level, const char *file, int line, const char *fmt, ...) { va_list args; diff --git a/src/verbose.h b/src/verbose.h index 3382d39f..7e10d252 100644 --- a/src/verbose.h +++ b/src/verbose.h @@ -23,7 +23,7 @@ extern int verbosity; extern void verbose_set_name(const char *name, int authority); -extern void verbose(int level, const char *file, int line, const char *fmt, ...); +extern void verbose(int level, const char *file, int line, const char *fmt, ...) __attribute__((format(printf, 4, 5))); extern void vverbose(int level, const char *file, int line, const char *fmt, va_list args); # define ERROR(...) do{if(verbosity>=0)verbose(3,__FILE__,__LINE__,__VA_ARGS__);}while(0) -- cgit 1.2.3-korg From 2997fec69a89ceddefb2850d3eb47f5bd355aeed Mon Sep 17 00:00:00 2001 From: José Bollo Date: Fri, 27 May 2016 14:58:39 +0200 Subject: remove unuseful flags MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I1ae220cc7621647b0cbe1fa6ea4a21619b8fc52c Signed-off-by: José Bollo --- CMakeLists.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index d3b7a32d..6089f282 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -25,7 +25,6 @@ add_compile_options(-Wno-sign-compare -Wno-sign-conversion) add_compile_options(-Werror=maybe-uninitialized) add_compile_options(-Werror=implicit-function-declaration) add_compile_options(-ffunction-sections -fdata-sections) -add_compile_options(-Wl,--as-needed -Wl,--gc-sections) add_compile_options(-fPIC) add_compile_options(-g) -- cgit 1.2.3-korg From 478ec3693bae5dae8f3d0654e4f405160ce3291f Mon Sep 17 00:00:00 2001 From: José Bollo Date: Fri, 27 May 2016 15:23:58 +0200 Subject: allows to remove file/line indication MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I800dfdc68dc4538b2c46367a8594d7ac6a36824d Signed-off-by: José Bollo --- include/afb/afb-plugin.h | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/include/afb/afb-plugin.h b/include/afb/afb-plugin.h index 81df3a8f..9b99a437 100644 --- a/include/afb/afb-plugin.h +++ b/include/afb/afb-plugin.h @@ -223,9 +223,18 @@ static inline void afb_daemon_verbose(struct afb_daemon daemon, int level, const } #if !defined(NO_PLUGIN_VERBOSE_MACRO) -# define ERROR(itf,...) do{if(itf->verbosity>=0)afb_daemon_verbose(itf->daemon,3,__FILE__,__LINE__,__VA_ARGS__);}while(0) -# define WARNING(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,4,__FILE__,__LINE__,__VA_ARGS__);}while(0) -# define NOTICE(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,5,__FILE__,__LINE__,__VA_ARGS__);}while(0) -# define INFO(itf,...) do{if(itf->verbosity>=2)afb_daemon_verbose(itf->daemon,6,__FILE__,__LINE__,__VA_ARGS__);}while(0) -# define DEBUG(itf,...) do{if(itf->verbosity>=3)afb_daemon_verbose(itf->daemon,7,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# if !defined(NO_PLUGIN_FILE_LINE_INDICATION) +# define ERROR(itf,...) do{if(itf->verbosity>=0)afb_daemon_verbose(itf->daemon,3,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define WARNING(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,4,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define NOTICE(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,5,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define INFO(itf,...) do{if(itf->verbosity>=2)afb_daemon_verbose(itf->daemon,6,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define DEBUG(itf,...) do{if(itf->verbosity>=3)afb_daemon_verbose(itf->daemon,7,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# else +# define ERROR(itf,...) do{if(itf->verbosity>=0)afb_daemon_verbose(itf->daemon,3,NULL,0,__VA_ARGS__);}while(0) +# define WARNING(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,4,NULL,0,__VA_ARGS__);}while(0) +# define NOTICE(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,5,NULL,0,__VA_ARGS__);}while(0) +# define INFO(itf,...) do{if(itf->verbosity>=2)afb_daemon_verbose(itf->daemon,6,NULL,0,__VA_ARGS__);}while(0) +# define DEBUG(itf,...) do{if(itf->verbosity>=3)afb_daemon_verbose(itf->daemon,7,NULL,0,__VA_ARGS__);}while(0) +# endif #endif + -- cgit 1.2.3-korg From 69b098942bd6c5b54d4849564407f9d20e598c06 Mon Sep 17 00:00:00 2001 From: José Bollo Date: Fri, 27 May 2016 15:25:46 +0200 Subject: fix formatting error MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I1e5842a43a50c357d78f3318b4c0eed8ad1676e2 Signed-off-by: José Bollo --- plugins/samples/tic-tac-toe.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/samples/tic-tac-toe.c b/plugins/samples/tic-tac-toe.c index 4bae8d75..79aaaf58 100644 --- a/plugins/samples/tic-tac-toe.c +++ b/plugins/samples/tic-tac-toe.c @@ -390,7 +390,7 @@ static void move(struct afb_req req) } /* applies the move */ - INFO(afbitf, "method 'move' for boardid %d, index=%d", board->id, index); + INFO(afbitf, "method 'move' for boardid %d, index=%s", board->id, index); add_move(board, i); /* replies */ -- cgit 1.2.3-korg From 18439204034fca982b3b65c2d581f80a9ee62f56 Mon Sep 17 00:00:00 2001 From: José Bollo Date: Fri, 27 May 2016 16:41:59 +0200 Subject: terminology: Level Of Assurance MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I3c92aab34ba9414faf19d9a96d8f1de786f1e7b6 Signed-off-by: José Bollo --- include/afb/afb-plugin.h | 6 +++--- include/afb/afb-req-itf.h | 2 +- plugins/samples/ClientCtx.c | 32 ++++++++++++++++---------------- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/include/afb/afb-plugin.h b/include/afb/afb-plugin.h index 9b99a437..cad55fbe 100644 --- a/include/afb/afb-plugin.h +++ b/include/afb/afb-plugin.h @@ -51,16 +51,16 @@ enum AFB_plugin_version }; /* - * Enum for Session/Token/Authentication middleware. + * Enum for Session/Token/Assurance middleware. * This enumeration is valid for plugins of type 1 */ enum AFB_session_v1 { AFB_SESSION_NONE = 0, /* no session and no authentification required */ - AFB_SESSION_CREATE = 1, /* requires authentification and first call of the session */ + AFB_SESSION_CREATE = 1, /* obsolete */ AFB_SESSION_CLOSE = 2, /* closes the session after authentification */ AFB_SESSION_RENEW = 4, /* refreshes the token after authentification */ - AFB_SESSION_CHECK = 8, /* enforce authentification */ + AFB_SESSION_CHECK = 8, /* Requires token authentification */ AFB_SESSION_LOA_GE = 16, /* check that the LOA is greater or equal to the given value */ AFB_SESSION_LOA_LE = 32, /* check that the LOA is lesser or equal to the given value */ diff --git a/include/afb/afb-req-itf.h b/include/afb/afb-req-itf.h index 8530e05d..5767c853 100644 --- a/include/afb/afb-req-itf.h +++ b/include/afb/afb-req-itf.h @@ -259,7 +259,7 @@ static inline void afb_req_session_close(struct afb_req req) } /* - * Sets the level of authorisation of the session of 'req' + * Sets the level of assurance of the session of 'req' * to 'level'. The effect of this function is subject of * security policies. * Returns 1 on success or 0 if failed. diff --git a/plugins/samples/ClientCtx.c b/plugins/samples/ClientCtx.c index 353185c3..ef703759 100644 --- a/plugins/samples/ClientCtx.c +++ b/plugins/samples/ClientCtx.c @@ -125,22 +125,22 @@ static const struct AFB_verb_desc_v1 verbs[]= { {"create", AFB_SESSION_CREATE, myCreate , "Create a new session"}, {"action", AFB_SESSION_CHECK , myAction , "Use Session Context"}, {"close" , AFB_SESSION_CLOSE , myClose , "Free Context"}, - {"set_loa_0", AFB_SESSION_RENEW, clientSetLOA0 ,"Set level of authorisation to 0"}, - {"set_loa_1", AFB_SESSION_RENEW, clientSetLOA1 ,"Set level of authorisation to 1"}, - {"set_loa_2", AFB_SESSION_RENEW, clientSetLOA2 ,"Set level of authorisation to 2"}, - {"set_loa_3", AFB_SESSION_RENEW, clientSetLOA3 ,"Set level of authorisation to 3"}, - {"check_loa_ge_0", AFB_SESSION_LOA_GE_0, clientCheckLOA ,"Check whether level of authorisation is greater or equal to 0"}, - {"check_loa_ge_1", AFB_SESSION_LOA_GE_1, clientCheckLOA ,"Check whether level of authorisation is greater or equal to 1"}, - {"check_loa_ge_2", AFB_SESSION_LOA_GE_2, clientCheckLOA ,"Check whether level of authorisation is greater or equal to 2"}, - {"check_loa_ge_3", AFB_SESSION_LOA_GE_3, clientCheckLOA ,"Check whether level of authorisation is greater or equal to 3"}, - {"check_loa_le_0", AFB_SESSION_LOA_LE_0, clientCheckLOA ,"Check whether level of authorisation is lesser or equal to 0"}, - {"check_loa_le_1", AFB_SESSION_LOA_LE_1, clientCheckLOA ,"Check whether level of authorisation is lesser or equal to 1"}, - {"check_loa_le_2", AFB_SESSION_LOA_LE_2, clientCheckLOA ,"Check whether level of authorisation is lesser or equal to 2"}, - {"check_loa_le_3", AFB_SESSION_LOA_LE_3, clientCheckLOA ,"Check whether level of authorisation is lesser or equal to 3"}, - {"check_loa_eq_0", AFB_SESSION_LOA_EQ_0, clientCheckLOA ,"Check whether level of authorisation is equal to 0"}, - {"check_loa_eq_1", AFB_SESSION_LOA_EQ_1, clientCheckLOA ,"Check whether level of authorisation is equal to 1"}, - {"check_loa_eq_2", AFB_SESSION_LOA_EQ_2, clientCheckLOA ,"Check whether level of authorisation is equal to 2"}, - {"check_loa_eq_3", AFB_SESSION_LOA_EQ_3, clientCheckLOA ,"Check whether level of authorisation is equal to 3"}, + {"set_loa_0", AFB_SESSION_RENEW, clientSetLOA0 ,"Set level of assurance to 0"}, + {"set_loa_1", AFB_SESSION_RENEW, clientSetLOA1 ,"Set level of assurance to 1"}, + {"set_loa_2", AFB_SESSION_RENEW, clientSetLOA2 ,"Set level of assurance to 2"}, + {"set_loa_3", AFB_SESSION_RENEW, clientSetLOA3 ,"Set level of assurance to 3"}, + {"check_loa_ge_0", AFB_SESSION_LOA_GE_0, clientCheckLOA ,"Check whether level of assurance is greater or equal to 0"}, + {"check_loa_ge_1", AFB_SESSION_LOA_GE_1, clientCheckLOA ,"Check whether level of assurance is greater or equal to 1"}, + {"check_loa_ge_2", AFB_SESSION_LOA_GE_2, clientCheckLOA ,"Check whether level of assurance is greater or equal to 2"}, + {"check_loa_ge_3", AFB_SESSION_LOA_GE_3, clientCheckLOA ,"Check whether level of assurance is greater or equal to 3"}, + {"check_loa_le_0", AFB_SESSION_LOA_LE_0, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 0"}, + {"check_loa_le_1", AFB_SESSION_LOA_LE_1, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 1"}, + {"check_loa_le_2", AFB_SESSION_LOA_LE_2, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 2"}, + {"check_loa_le_3", AFB_SESSION_LOA_LE_3, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 3"}, + {"check_loa_eq_0", AFB_SESSION_LOA_EQ_0, clientCheckLOA ,"Check whether level of assurance is equal to 0"}, + {"check_loa_eq_1", AFB_SESSION_LOA_EQ_1, clientCheckLOA ,"Check whether level of assurance is equal to 1"}, + {"check_loa_eq_2", AFB_SESSION_LOA_EQ_2, clientCheckLOA ,"Check whether level of assurance is equal to 2"}, + {"check_loa_eq_3", AFB_SESSION_LOA_EQ_3, clientCheckLOA ,"Check whether level of assurance is equal to 3"}, {NULL} }; -- cgit 1.2.3-korg From 13a8c36f354376b622cebb3348f2500d87b980a9 Mon Sep 17 00:00:00 2001 From: José Bollo Date: Fri, 27 May 2016 17:15:21 +0200 Subject: Adds the library libafbwsc.so MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This library is intended to be used by C clients to connect to the binder and access to its fetures through the websocket. An example of integration is given by afb-client-demo.c It is known that it introduces an unwanted dependency to afb-common. This is a temporary issue. Change-Id: Ie0a395f116f6ee05679525a6399ef23ef245c944 Signed-off-by: José Bollo --- CMakeLists.txt | 4 +++- afb-wsc.pc.in | 31 +++++++++++++++++++++++++++++++ src/CMakeLists.txt | 23 ++++++++++++++++++++++- src/afb-client-demo.c | 2 +- src/export-afbwsc.map | 9 +++++++++ 5 files changed, 66 insertions(+), 3 deletions(-) create mode 100644 afb-wsc.pc.in create mode 100644 src/export-afbwsc.map diff --git a/CMakeLists.txt b/CMakeLists.txt index 6089f282..c5094bb8 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -67,11 +67,13 @@ ADD_SUBDIRECTORY(include) ADD_SUBDIRECTORY(plugins) ############################################################ -# installs the pkgconfig file +# installs the pkgconfig files CONFIGURE_FILE(afb-daemon.pc.in afb-daemon.pc @ONLY) +CONFIGURE_FILE(afb-wsc.pc.in afb-wsc.pc @ONLY) INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/afb-daemon.pc + ${CMAKE_CURRENT_BINARY_DIR}/afb-wsc.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig ) diff --git a/afb-wsc.pc.in b/afb-wsc.pc.in new file mode 100644 index 00000000..a8b29d71 --- /dev/null +++ b/afb-wsc.pc.in @@ -0,0 +1,31 @@ +## +## Copyright (C) 2016 "IoT.bzh" +## Author: José Bollo +## +## This file is part of afb-daemon project. +## +## Licensed under the Apache License, Version 2.0 (the "License"); +## you may not use this file except in compliance with the License. +## You may obtain a copy of the License at +## +## http://www.apache.org/licenses/LICENSE-2.0 +## +## Unless required by applicable law or agreed to in writing, software +## distributed under the License is distributed on an "AS IS" BASIS, +## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +## See the License for the specific language governing permissions and +## limitations under the License. +## + +includedir=@CMAKE_INSTALL_FULL_INCLUDEDIR@ +libdir=@CMAKE_INSTALL_FULL_LIBDIR@ + +Name: @PROJECT_PRETTY_NAME@ +Description: @PROJECT_DESCRIPTION@ +Version: @PROJECT_VERSION@ +URL: @PROJECT_URL@ + +Requires: json-c libsystemd +Cflags: -I${includedir} +Libs: -L${libdir} -lafbwsc + diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 3b3c6fd4..f41a3a88 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -51,6 +51,9 @@ ADD_LIBRARY(afb-lib STATIC websock.c ) +########################################### +# build and install afb-daemon +########################################### ADD_EXECUTABLE(afb-daemon main.c) TARGET_LINK_LIBRARIES(afb-daemon afb-lib @@ -66,11 +69,29 @@ TARGET_LINK_LIBRARIES(afb-daemon INSTALL(TARGETS afb-daemon RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) +########################################### +# build and install libafbwsc +########################################### +ADD_LIBRARY(afbwsc SHARED afb-ws.c afb-ws-client.c afb-wsj1.c websock.c afb-common.c) +TARGET_LINK_LIBRARIES(afbwsc + ${libsystemd_LIBRARIES} + -Wl,--version-script=${CMAKE_CURRENT_SOURCE_DIR}/export-afbwsc.map + -Wl,--as-needed + -Wl,--gc-sections +) +INSTALL(TARGETS afbwsc LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}) +INSTALL(FILES afb-wsj1.h afb-ws-client.h DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/afb) + +########################################### +# build and install afb-client-demo +########################################### ADD_EXECUTABLE(afb-client-demo afb-client-demo.c) TARGET_LINK_LIBRARIES(afb-client-demo - afb-lib + afbwsc ${link_libraries} ${libsystemd_LIBRARIES} ) INSTALL(TARGETS afb-client-demo RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) + + diff --git a/src/afb-client-demo.c b/src/afb-client-demo.c index 349a0274..6344d6a3 100644 --- a/src/afb-client-demo.c +++ b/src/afb-client-demo.c @@ -30,7 +30,7 @@ #include -#include "afb-common.h" +#include "afb-common.h" /* TODO: remove dependency to afb-common.h */ #include "afb-wsj1.h" #include "afb-ws-client.h" diff --git a/src/export-afbwsc.map b/src/export-afbwsc.map new file mode 100644 index 00000000..c775a16f --- /dev/null +++ b/src/export-afbwsc.map @@ -0,0 +1,9 @@ +{ +global: + afb_ws_client_connect_wsj1; + afb_wsj1_*; + afb_common_*; +local: + *; +}; + -- cgit 1.2.3-korg From b81bab801d1a39cce7254b0c056d991412ec4331 Mon Sep 17 00:00:00 2001 From: José Bollo Date: Fri, 27 May 2016 17:31:30 +0200 Subject: improves documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I5abae06cd5b5127fca97ba12aa8f18d037a95d79 Signed-off-by: José Bollo --- doc/FAQ.html | 5 +- doc/FAQ.md | 2 +- doc/README.html | 9 +- doc/afb-daemon-vocabulary.html | 103 ++- doc/afb-daemon-vocabulary.md | 64 +- doc/afb-plugin-writing.html | 1349 ++++++++++++++++++++++++++++++++++++++++ doc/afb-plugin-writing.md | 1034 ++++++++++++++++++++++++++++++ doc/doc.css | 12 +- doc/writing-afb-plugins.html | 783 ----------------------- doc/writing-afb-plugins.md | 703 --------------------- 10 files changed, 2548 insertions(+), 1516 deletions(-) create mode 100644 doc/afb-plugin-writing.html create mode 100644 doc/afb-plugin-writing.md delete mode 100644 doc/writing-afb-plugins.html delete mode 100644 doc/writing-afb-plugins.md diff --git a/doc/FAQ.html b/doc/FAQ.html index 2bd963bb..ffda81af 100644 --- a/doc/FAQ.html +++ b/doc/FAQ.html @@ -4,10 +4,11 @@ -

Frequently Asked Question about AFB-DAEMON

+ +

Frequently Asked Question about AFB-DAEMON

version: 1
-Date:    25 May 2016
+Date:    26 mai 2016
 Author:  José Bollo

diff --git a/doc/FAQ.md b/doc/FAQ.md index 76957c1f..93647311 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -1,7 +1,7 @@ Frequently Asked Question about AFB-DAEMON ========================================== version: 1 - Date: 25 May 2016 + Date: 26 mai 2016 Author: José Bollo TABLE-OF-CONTENT-HERE diff --git a/doc/README.html b/doc/README.html index 04d68bf1..0a7dffa8 100644 --- a/doc/README.html +++ b/doc/README.html @@ -4,15 +4,18 @@ -

Inititial Build

+ +

Inititial Build

mkdir build cd build cmake ..

Netbeans

+ +

Netbeans

Copy nbprojet at project base

+ +

Copy nbprojet at project base

cp -r doc/nbproject.template ./nbproject

diff --git a/doc/afb-daemon-vocabulary.html b/doc/afb-daemon-vocabulary.html index 4416db81..096f5076 100644 --- a/doc/afb-daemon-vocabulary.html +++ b/doc/afb-daemon-vocabulary.html @@ -4,19 +4,19 @@ -

Vocabulary for AFB-DAEMON

+ +

Vocabulary for AFB-DAEMON

version: 1
-Date:    25 May 2016
+Date:    26 mai 2016
 Author:  José Bollo

Vocabulary for AFB-DAEMON
- Authentification
- Context
- Level of authorisation (LOA)
- Event
- Level of assurance (LOA)
- Plugin
- Request
- Reply/Response
- Session
- Token
- UUID
- x-afb-reqid
- x-afb-token
- x-afb-uuid

Authentification

+ +

Event

Context

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

Level of authorisation (LOA)

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

Plugin

+ +

Level of assurance (LOA)

Request

This level that can be from 0 to 3 represent the level of +assurance that the services can expect from the session.

Reply/Response

The exact definition of the meaning of this levels and of +how to use it remains to be achived.

Service

+ +

Plugin

Session

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

A session records data as

+ +

Request

Token

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

UUID

+ +

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.

+ +

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

+ +

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.

+ +

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 Unic IDentifier.

x-afb-token

+ +

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.

diff --git a/doc/afb-daemon-vocabulary.md b/doc/afb-daemon-vocabulary.md index 2531c81a..71771947 100644 --- a/doc/afb-daemon-vocabulary.md +++ b/doc/afb-daemon-vocabulary.md @@ -1,31 +1,72 @@ Vocabulary for AFB-DAEMON ========================= version: 1 - Date: 25 May 2016 + Date: 26 mai 2016 Author: José Bollo TABLE-OF-CONTENT-HERE -## Authentification +## Event -## Context +Message with data propagated from the services to the client and not expecting +any reply. -## Level of authorisation (LOA) +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 +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 records data as +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 +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. + +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 @@ -34,6 +75,19 @@ 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. + diff --git a/doc/afb-plugin-writing.html b/doc/afb-plugin-writing.html new file mode 100644 index 00000000..9a98ffe9 --- /dev/null +++ b/doc/afb-plugin-writing.html @@ -0,0 +1,1349 @@ + + + + + + + +

HOWTO WRITE a PLUGIN for AFB-DAEMON

+ +

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

+ +

HOWTO WRITE a PLUGIN for AFB-DAEMON +
+

+ + +

Summary

+ +

The binder afb-daemon serves files through +the HTTP protocol and offers access to API’s through +HTTP or WebSocket protocol.

+ +

The plugins are used to add API’s to afb-daemon. +This part describes how to write a plugin for afb-daemon. +Excepting this summary, this part is intended to be read +by developpers.

+ +

Before going into details, through a tiny example, +a short overview plugins basis is needed.

+ + +

Nature of a plugin

+ +

A plugin is a separate piece of code made of a shared library. +The plugin is loaded and activated by afb-daemon when afb-daemon +starts.

+ +

Technically, a plugin is not linked to any library of afb-daemon.

+ + +

Kinds of plugins

+ +

There is two kinds of plugins: application plugins and service +plugins.

+ + +

Application plugins

+ +

Application plugins are intended to be instanciated for each +application: when an application using that plugin is started, +its binder starts a new instance of the plugin.

+ +

It means that the application plugins mainly have only one +context to manage for one client.

+ + +

Service plugins

+ +

Service plugins are intended to be instanciated only one time +only and connected to many clients.

+ +

So either it does not manage context at all or otherwise, +if it manages context, it should be able to manage one context +per client.

+ +

In details, it may be useful to have service plugins at a user +level.

+ + +

Live cycle of a plugin within afb-daemon

+ +

The plugins are loaded and activated when afb-daemon starts.

+ +

At start, the plugin initialise itself. +If it fails to initialise then afb-daemon stops.

+ +

Conversely, if it success to initialize, it must declare +a name, that must be unique, and a list of API’s verbs.

+ +

When initialized, the functions implementing the API’s verbs +of the plugin are activated on call.

+ +

At the end, nothing special is done by afb-daemon. +Consequently, developpers of plugins should use ‘atexit’ +or ‘on_exit’ during initialisation if they need to +perform specific actions when stopping.

+ + +

Content of a plugin

+ +

For afb-daemon, a plugin contains 2 different +things: names and functions.

+ +

There is two kind of names: + - the name of the plugin, + - the names of the verbs.

+ +

There is two kind of functions: + - the initialisation function + - functions implementing verbs

+ +

Afb-daemon translates the name of the method that is +invoked to a pair of API and verb names. For example, +the method named foo/bar translated to the API +name foo and the verb name bar. +To serve it, afb-daemon search the plugin that record +the name foo and if it also recorded the verb bar, +it calls the implementation function declared for this verb.

+ +

Afb-daemon make no distinction between lower case +and upper case when searching for a method. +Thus, The names TicTacToe/Board and tictactoe/borad +are equals.

+ + +

The name of the plugin

+ +

The name of the plugin is also known as the name +of the API that defines the plugin.

+ +

This name is also known as the prefix.

+ +

The name of a plugin MUST be unique within afb-daemon.

+ +

For example, when a client of afb-daemon +calls a method named foo/bar. Afb-daemon +extracts the prefix foo and the suffix bar. +foo is the API name and must match a plugin name, +the plugin that implements the verb bar.

+ + +

Names of verbs

+ +

Each plugin exposes a set of verbs that can be called +by client of afb-daemon.

+ +

The name of a verb MUST be unique within a plugin.

+ +

Plugins link verbs to functions that are called +when clients emit requests for that verb.

+ +

For example, when a client of afb-daemon +calls a method named foo/bar.

+ + +

The initialisation function

+ +

The initialisation function serves several purposes.

+ +

It allows afb-daemon to check the version +of the plugin using the name of the initialisation +functions that it found. Currently, the initialisation +function is named pluginAfbV1Register. It identifies +the first version of plugins.
It allows the plugin to initialise itself.
It serves to the plugin to declare names, descriptions, +requirements and implmentations of the verbs that it exposes.

+ + + +

Functions implementing verbs

+ +

When a method is called, afb-daemon constructs a request +object and pass it to the implementation function for verb +within the plugin of the API.

+ +

An implementation function receives a request object that +is used to get arguments of the request, to send +answer, to store session data.

+ +

A plugin MUST send an answer to the request.

+ +

But it is not mandatory to send the answer +before to return from the implementing function. +This behaviour is important for implementing +asynchronous actions.

+ +

Implementation functions that always reply to the request +before returning are named synchronous implementations. +Those that don’t always reply to the request before +returning are named asynchronous implementations.

+ +

Asynchronous implementations typically initiate an +asynchronous action and record to send the reply +on completion of this action.

+ + +

The Tic-Tac-Toe example

+ +

This part explains how to write an afb-plugin. +For the sake of being practical we will use many +examples from the tic-tac-toe example. +This plugin example is in plugins/samples/tic-tac-toe.c.

+ +

This plugin is named tictactoe.

+ + +

Choosing names

+ +

The designer of a plugin must defines names for its plugin +(or its API) and for the verbs of its API. He also +must defines names for arguments given by name.

+ +

While forging names, the designer should take into account +the rules for making valid names and some rules that make +the names easy to use across plaforms.

+ +

The names and strings used ALL are UTF-8 encoded.

+ + +

Names for API (plugin)

+ +

The names of the API are checked. +All characters are authorised except:

+ +

the control characters (\u0000 .. \u001f)
the characters of the set { ‘ ’, ‘“’, ‘#’, ‘%’, ‘&’, +‘’‘, ’/‘, ’?‘, ’`‘, ’\x7f' }

+ + +

In other words the set of forbidden characters is +{ \u0000..\u0020, \u0022, \u0023, \u0025..\u0027, + \u002f, \u003f, \u0060, \u007f }.

+ +

Afb-daemon make no distinction between lower case +and upper case when searching for an API by its name.

+ + +

Names for verbs

+ +

The names of the verbs are not checked.

+ +

However, the validity rules for verb’s names are the +same as for API’s names except that the dot (.) character +is forbidden.

+ +

Afb-daemon make no distinction between lower case +and upper case when searching for an API by its name.

+ + +

Names for arguments

+ +

The names for arguments are not restricted and can be +anything.

+ +

The arguments are searched with the case sensitive +string comparison. Thus the names “index” and “Index” +are not the same.

+ + +

Forging names widely available

+ +

The key names of javascript object can be almost +anything using the arrayed notation:

+ +

object[key] = value
+

+ +

That is not the case with the dot notation:

+ +

object.key = value
+

+ +

Using the dot notation, the key must be a valid javascript +identifier.

+ +

For this reason, the chosen names should better be +valid javascript identifier.

+ +

It is also a good practice, even for arguments, to not +rely on the case sensitivity and to avoid the use of +names different only by the case.

+ + +

Options to set when compiling plugins

+ +

Afb-daemon provides a configuration file for pkg-config. +Typing the command

+ +

pkg-config --cflags afb-daemon
+

+ +

will print the flags to use for compiling, like this:

+ +

$ pkg-config --cflags afb-daemon
+-I/opt/local/include -I/usr/include/json-c 
+

+ +

For linking, you should use

+ +

$ pkg-config --libs afb-daemon
+-ljson-c
+

+ +

As you see, afb-daemon automatically includes dependency to json-c. +This is done through the Requires keyword of pkg-config.

+ +

If this behaviour is a problem, let us know.

+ + +

Header files to include

+ +

The plugin tictactoe has the following lines for its includes:

+ +

#define _GNU_SOURCE
+#include <stdio.h>
+#include <string.h>
+#include <json-c/json.h>
+#include <afb/afb-plugin.h>
+

+ +

The header afb/afb-plugin.h includes all the features that a plugin +needs except two foreign header that must be included by the plugin +if it needs it:

+ +

json-c/json.h: this header must be include to handle json objects;
systemd/sd-event.h: this must be include to access the main loop;
systemd/sd-bus.h: this may be include to use dbus connections.

+ + +

The tictactoe plugin does not use systemd features so it is not included.

+ +

When including afb/afb-plugin.h, the macro _GNU_SOURCE must be +defined.

+ + +

Writing a synchronous verb implementation

+ +

The verb tictactoe/board is a synchronous implementation. +Here is its listing:

+ +

/*
+ * get the board
+ */
+static void board(struct afb_req req)
+{
+        struct board *board;
+        struct json_object *description;
+
+        /* retrieves the context for the session */
+        board = board_of_req(req);
+        INFO(afbitf, "method 'board' called for boardid %d", board->id);
+
+        /* describe the board */
+        description = describe(board);
+
+        /* send the board's description */
+        afb_req_success(req, description, NULL);
+}
+

+ +

This examples show many aspects of writing a synchronous +verb implementation. Let summarize it:

+ +

The function board_of_req retrieves the context stored +for the plugin: the board.
The macro INFO sends a message of kind INFO +to the logging system. The global variable named afbitf +used represents the interface to afb-daemon.
The function describe creates a json_object representing +the board.
The function afb_req_success sends the reply, attaching to +it the object description.

+ + + +

The incoming request

+ +

For any implementation, the request is received by a structure of type +struct afb_req.

+ +

Note that this is a PLAIN structure, not a pointer to a structure.

+ +

The definition of struct afb_req is:

+ +

/*
+ * Describes the request by plugins from afb-daemon
+ */
+struct afb_req {
+        const struct afb_req_itf *itf;  /* the interfacing functions */
+        void *closure;          /* the closure for functions */
+};
+

+ +

It contains two pointers: one, itf, points to the functions needed +to handle the internal request represented by the second pointer, closure.

+ +

The structure must never be used directly. +Insted, use the intended functions provided +by afb-daemon and described here.

+ +

req is used to get arguments of the request, to send +answer, to store session data.

+ +

This object and its interface is defined and documented +in the file names afb/afb-req-itf.h

+ +

The above example uses 2 times the request object req.

+ +

The first time, it is used for retrieving the board attached to +the session of the request.

+ +

The second time, it is used to send the reply: an object that +describes the current board.

+ + +

Associating a context to the session

+ +

When the plugin tic-tac-toe receives a request, it musts regain +the board that describes the game associated to the session.

+ +

For a plugin, having data associated to a session is a common case. +This data is called the context of the plugin for the session. +For the plugin tic-tac-toe, the context is the board.

+ +

The requests afb_req offer four functions for +storing and retrieving the context associated to the session.

+ +

These functions are:

+ +

afb_req_context_get: +retrieves the context data stored for the plugin.
afb_req_context_set: +store the context data of the plugin.
afb_req_context: +retrieves the context data of the plugin, +if needed, creates the context and store it.
afb_req_context_clear: +reset the stored data.

+ + +

The plugin tictactoe use a convenient function to retrieve +its context: the board. This function is board_of_req:

+ +

/*
+ * retrieves the board of the request
+ */
+static inline struct board *board_of_req(struct afb_req req)
+{
+        return afb_req_context(req, (void*)get_new_board, (void*)release_board);
+}
+

+ +

The function afb_req_context ensure an existing context +for the session of the request. +Its two last arguments are functions. Here, the casts are required +to avoid a warning when compiling.

+ +

Here is the definition of the function afb_req_context

+ +

/*
+ * Gets the pointer stored by the plugin for the session of 'req'.
+ * If the stored pointer is NULL, indicating that no pointer was
+ * already stored, afb_req_context creates a new context by calling
+ * the function 'create_context' and stores it with the freeing function
+ * 'free_context'.
+ */
+static inline void *afb_req_context(struct afb_req req, void *(*create_context)(), void (*free_context)(void*))
+{
+        void *result = afb_req_context_get(req);
+        if (result == NULL) {
+                result = create_context();
+                afb_req_context_set(req, result, free_context);
+        }
+        return result;
+}
+

+ +

The second argument if the function that creates the context. +For the plugin tic-tac-toe it is the function get_new_board. +The function get_new_board creates a new board and set its +count of use to 1. The boards are counting their count of use +to free there ressources when no more used.

+ +

The definition of the other functions for dealing with contexts are:

+ +

/*
+ * Gets the pointer stored by the plugin for the session of 'req'.
+ * When the plugin has not yet recorded a pointer, NULL is returned.
+ */
+void *afb_req_context_get(struct afb_req req);
+
+/*
+ * Stores for the plugin the pointer 'context' to the session of 'req'.
+ * The function 'free_context' will be called when the session is closed
+ * or if plugin stores an other pointer.
+ */
+void afb_req_context_set(struct afb_req req, void *context, void (*free_context)(void*));
+
+/*
+ * Frees the pointer stored by the plugin for the session of 'req'
+ * and sets it to NULL.
+ *
+ * Shortcut for: afb_req_context_set(req, NULL, NULL)
+ */
+static inline void afb_req_context_clear(struct afb_req req)
+{
+        afb_req_context_set(req, NULL, NULL);
+}
+

+ + +

Sending the reply to a request

+ +

Two kinds of replies can be made: successful replies and +failure replies.

+ +

Sending a reply to a request must be done at most one time.

+ +

The two functions to send a reply of kind “success” are +afb_req_success and afb_req_success_f.

+ +

/*
+ * Sends a reply of kind success to the request 'req'.
+ * The status of the reply is automatically set to "success".
+ * Its send the object 'obj' (can be NULL) with an
+ * informationnal comment 'info (can also be NULL).
+ */
+void afb_req_success(struct afb_req req, struct json_object *obj, const char *info);
+
+/*
+ * Same as 'afb_req_success' but the 'info' is a formatting
+ * string followed by arguments.
+ */
+void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...);
+

+ +

The two functions to send a reply of kind “failure” are +afb_req_fail and afb_req_fail_f.

+ +

/*
+ * Sends a reply of kind failure to the request 'req'.
+ * The status of the reply is set to 'status' and an
+ * informationnal comment 'info' (can also be NULL) can be added.
+ *
+ * Note that calling afb_req_fail("success", info) is equivalent
+ * to call afb_req_success(NULL, info). Thus even if possible it
+ * is strongly recommanded to NEVER use "success" for status.
+ */
+void afb_req_fail(struct afb_req req, const char *status, const char *info);
+
+/*
+ * Same as 'afb_req_fail' but the 'info' is a formatting
+ * string followed by arguments.
+ */
+void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...);
+

+ + +

Getting argument of invocation

+ +

Many verbs expect arguments. Afb-daemon let plugins +retrieve their arguments by name not by position.

+ +

Arguments are given by the requests either through HTTP +or through WebSockets.

+ +

For example, the verb join of the plugin tic-tac-toe +expects one argument: the boardid to join. Here is an extract:

+ +

/*
+ * Join a board
+ */
+static void join(struct afb_req req)
+{
+        struct board *board, *new_board;
+        const char *id;
+
+        /* retrieves the context for the session */
+        board = board_of_req(req);
+        INFO(afbitf, "method 'join' called for boardid %d", board->id);
+
+        /* retrieves the argument */
+        id = afb_req_value(req, "boardid");
+        if (id == NULL)
+                goto bad_request;
+        ...
+

+ +

The function afb_req_value search in the request req +for an argument whose name is given. When no argument of the +given name was passed, afb_req_value returns NULL.

+ +

The search is case sensitive. So the name boardid is not the +same name than BoardId. But this must not be assumed so two +expected names of argument should not differ only by case.

+ + +

Basic functions for querying arguments

+ +

The function afb_req_value is defined as below:

+ +

/*
+ * Gets from the request 'req' the string value of the argument of 'name'.
+ * Returns NULL if when there is no argument of 'name'.
+ * Returns the value of the argument of 'name' otherwise.
+ *
+ * Shortcut for: afb_req_get(req, name).value
+ */
+static inline const char *afb_req_value(struct afb_req req, const char *name)
+{
+        return afb_req_get(req, name).value;
+}
+

+ +

It is defined as a shortcut to call the function afb_req_get. +That function is defined as below:

+ +

/*
+ * Gets from the request 'req' the argument of 'name'.
+ * Returns a PLAIN structure of type 'struct afb_arg'.
+ * When the argument of 'name' is not found, all fields of result are set to NULL.
+ * When the argument of 'name' is found, the fields are filled,
+ * in particular, the field 'result.name' is set to 'name'.
+ *
+ * There is a special name value: the empty string.
+ * The argument of name "" is defined only if the request was made using
+ * an HTTP POST of Content-Type "application/json". In that case, the
+ * argument of name "" receives the value of the body of the HTTP request.
+ */
+struct afb_arg afb_req_get(struct afb_req req, const char *name);
+

+ +

That function takes 2 parameters: the request and the name +of the argument to retrieve. It returns a PLAIN structure of +type struct afb_arg.

+ +

The definition of struct afb_arg is:

+ +

/*
+ * Describes an argument (or parameter) of a request
+ */
+struct afb_arg {
+        const char *name;   /* name of the argument or NULL if invalid */
+        const char *value;  /* string representation of the value of the argument */
+                                /* original filename of the argument if path != NULL */
+        const char *path;   /* if not NULL, path of the received file for the argument */
+                                /* when the request is finalized this file is removed */
+};
+

+ +

/*
+ * Gets from the request 'req' the path for file attached to the argument of 'name'.
+ * Returns NULL if when there is no argument of 'name' or when there is no file.
+ * Returns the path of the argument of 'name' otherwise.
+ *
+ * Shortcut for: afb_req_get(req, name).path
+ */
+static inline const char *afb_req_path(struct afb_req req, const char *name)
+{
+        return afb_req_get(req, name).path;
+}
+

+ +

The path is only defined for HTTP/POST requests that send file.

+ + +

Arguments for received files

+ +

As it is explained just above, clients can send files using +HTTP/POST requests.

+ +

<h2>Sample Post File</h2>
+<form enctype="multipart/form-data">
+    <input type="file" name="file" />
+    <input type="hidden" name="hidden" value="bollobollo" />
+    <br>
+    <button formmethod="POST" formaction="api/post/upload-image">Post File</button>
+</form>
+

+ +

In that case, the argument named file has its value and its +path defined and not NULL.

+ +

The value is the name of the file as it was +set by the HTTP client and is generally the filename on the +client side.

+ +

+ + +

Arguments as a JSON object

+ +

Plugins can get all the arguments as one single object. +This feature is provided by the function afb_req_json +that is defined as below:

+ +

/*
+ * Gets from the request 'req' the json object hashing the arguments.
+ * The returned object must not be released using 'json_object_put'.
+ */
+struct json_object *afb_req_json(struct afb_req req);
+

+ +

It returns a json object. This object depends on how the request was +made:

+ +

For HTTP requests, this is an object whose keys are the names of the +arguments and whose values are either a string for common arguments or +an object like { “file”: “…”, “path”: “…” }
For WebSockets requests, the returned object is the object +given by the client transparently transported.

+ + +

In fact, for Websockets requests, the function afb_req_value +can be seen as a shortcut to +json_object_get_string(json_object_object_get(afb_req_json(req), name))

+ + +

Initialisation of the plugin and declaration of verbs

+ +

To be active, the verbs of the plugin should be declared to +afb-daemon. And even more, the plugin itself must be recorded.

+ +

The mechanism for doing this is very simple: when afb-need starts, +it loads the plugins that are listed in its argument or configuration.

+ +

Loading a plugin follows the following steps:

+ +

It loads the plugin using dlopen.
It searchs for the symbol named pluginAfbV1Register using dlsym. +This symbol is assumed to be the exported initialisation function of the plugin.
It build an interface object for the plugin.
It calls the found function pluginAfbV1Register and pass it the pointer +to its interface.
The function pluginAfbV1Register setup the plugin, initialize it.
The function pluginAfbV1Register returns the pointer to a structure +that describes the plugin: its version, its name (prefix or API name), and the +list of its verbs.
Afb-daemon checks that the returned version and name can be managed. +If it can manage it, the plugin and its verbs are recorded and can be used +when afb-daemon finishes it initialisation.

+ + +

Here is the listing of the function pluginAfbV1Register of the plugin +tic-tac-toe:

+ +

/*
+ * activation function for registering the plugin called by afb-daemon
+ */
+const struct AFB_plugin *pluginAfbV1Register(const struct AFB_interface *itf)
+{
+   afbitf = itf;         // records the interface for accessing afb-daemon
+   return &plugin_description;  // returns the description of the plugin
+}
+

+ +

This is a very small function because the tic-tac-toe plugin doesn’t have initialisation step. +It merely record the daemon’s interface and returns its descritption.

+ +

The variable afbitf is a variable global to the plugin. It records the +interface to afb-daemon and is used for logging and pushing events. +Here is its declaration:

+ +

/*
+ * the interface to afb-daemon
+ */
+const struct AFB_interface *afbitf;
+

+ +

The description of the plugin is defined as below.

+ +

/*
+ * array of the verbs exported to afb-daemon
+ */
+static const struct AFB_verb_desc_v1 plugin_verbs[] = {
+   /* VERB'S NAME     SESSION MANAGEMENT          FUNCTION TO CALL  SHORT DESCRIPTION */
+   { .name= "new",   .session= AFB_SESSION_NONE, .callback= new,   .info= "Starts a new game" },
+   { .name= "play",  .session= AFB_SESSION_NONE, .callback= play,  .info= "Tells the server to play" },
+   { .name= "move",  .session= AFB_SESSION_NONE, .callback= move,  .info= "Tells the client move" },
+   { .name= "board", .session= AFB_SESSION_NONE, .callback= board, .info= "Get the current board" },
+   { .name= "level", .session= AFB_SESSION_NONE, .callback= level, .info= "Set the server level" },
+   { .name= "join",  .session= AFB_SESSION_CHECK,.callback= join,  .info= "Join a board" },
+   { .name= "undo",  .session= AFB_SESSION_NONE, .callback= undo,  .info= "Undo the last move" },
+   { .name= "wait",  .session= AFB_SESSION_NONE, .callback= wait,  .info= "Wait for a change" },
+   { .name= NULL } /* marker for end of the array */
+};
+
+/*
+ * description of the plugin for afb-daemon
+ */
+static const struct AFB_plugin plugin_description =
+{
+   /* description conforms to VERSION 1 */
+   .type= AFB_PLUGIN_VERSION_1,
+   .v1= {               /* fills the v1 field of the union when AFB_PLUGIN_VERSION_1 */
+      .prefix= "tictactoe",     /* the API name (or plugin name or prefix) */
+      .info= "Sample tac-tac-toe game", /* short description of of the plugin */
+      .verbs = plugin_verbs     /* the array describing the verbs of the API */
+   }
+};
+

+ +

The structure plugin_description describes the plugin. +It declares the type and version of the plugin, its name, a description +and a list of its verbs.

+ +

The list of verbs is an array of structures describing the verbs and terminated by a marker: +a verb whose name is NULL.

+ +

The description of the verbs for this version is made of 4 fields:

+ +

the name of the verbs,
the session management flags,
the implementation function to be call for the verb,
a short description.

+ + +

The structure describing verbs is defined as follows:

+ +

/*
+ * Description of one verb of the API provided by the plugin
+ * This enumeration is valid for plugins of type 1
+ */
+struct AFB_verb_desc_v1
+{
+       const char *name;                       /* name of the verb */
+       enum AFB_session_v1 session;            /* authorisation and session requirements of the verb */
+       void (*callback)(struct afb_req req);   /* callback function implementing the verb */
+       const char *info;                       /* textual description of the verb */
+};
+

+ +

For technical reasons, the enumeration enum AFB_session_v1 is not exactly an +enumeration but the wrapper of constant definitions that can be mixed using bitwise or +(the C operator |).

+ +

The constants that can bit mixed are:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Constant name	Meaning
AFB_SESSION_CREATE	Equals to AFB_SESSION_LOA_EQ_0\|AFB_SESSION_RENEW
AFB_SESSION_CLOSE	Closes the session after the reply and set the LOA to 0
AFB_SESSION_RENEW	Refreshes the token of authentification
AFB_SESSION_CHECK	Just requires the token authentification
AFB_SESSION_LOA_LE_0	Requires the current LOA to be lesser then or equal to 0
AFB_SESSION_LOA_LE_1	Requires the current LOA to be lesser then or equal to 1
AFB_SESSION_LOA_LE_2	Requires the current LOA to be lesser then or equal to 2
AFB_SESSION_LOA_LE_3	Requires the current LOA to be lesser then or equal to 3
AFB_SESSION_LOA_GE_0	Requires the current LOA to be greater then or equal to 0
AFB_SESSION_LOA_GE_1	Requires the current LOA to be greater then or equal to 1
AFB_SESSION_LOA_GE_2	Requires the current LOA to be greater then or equal to 2
AFB_SESSION_LOA_GE_3	Requires the current LOA to be greater then or equal to 3
AFB_SESSION_LOA_EQ_0	Requires the current LOA to be equal to 0
AFB_SESSION_LOA_EQ_1	Requires the current LOA to be equal to 1
AFB_SESSION_LOA_EQ_2	Requires the current LOA to be equal to 2
AFB_SESSION_LOA_EQ_3	Requires the current LOA to be equal to 3

+ + +

If any of this flags is set, afb-daemon requires the token authentification +as if the flag AFB_SESSION_CHECK had been set.

+ +

The special value AFB_SESSION_NONE is zero and can be used to avoid any check.

+ +

Note that AFB_SESSION_CREATE and AFB_SESSION_CLOSE might be removed in later versions.

+ + +

Sending messages to the log system

+ +

Afb-daemon provides 4 levels of verbosity and 5 verbs for logging messages.

+ +

The verbosity is managed. Options allow the change the verbosity of afb-daemon +and the verbosity of the plugins can be set plugin by plugin.

+ +

The verbs for logging messages are defined as macros that test the +verbosity level and that call the real logging function only if the +message must be output. This avoid evaluation of arguments of the +formatting messages if the message must not be output.

+ + +

Verbs for logging messages

+ +

The 5 logging verbs are:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Macro	Verbosity	Meaning	syslog level
ERROR	0	Error conditions	3
WARNING	1	Warning conditions	4
NOTICE	1	Normal but significant condition	5
INFO	2	Informational	6
DEBUG	3	Debug-level messages	7

+ + +

You can note that the 2 verbs WARNING and INFO have the same level +of verbosity. But they don’t have the same syslog level. It means that +they are output with a different level on the logging system.

+ +

All of these verbs have the same signature:

+ +

void ERROR(const struct AFB_interface *afbitf, const char *message, ...);
+

+ +

The first argument afbitf is the interface to afb daemon that the +plugin received at its initialisation when pluginAfbV1Register was called.

+ +

The second argument message is a formatting string compatible with printf/sprintf.

+ +

The remaining arguments are arguments of the formating message like for printf.

+ + +

Managing verbosity

+ +

Depending on the level of verbosity, the messages are output or not. +The following table explains what messages will be output depending +ont the verbosity level.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Level of verbosity	Outputed macro
0	ERROR
1	ERROR + WARNING + NOTICE
2	ERROR + WARNING + NOTICE + INFO
3	ERROR + WARNING + NOTICE + INFO + DEBUG

+ + + +

Output format and destination

+ +

The syslog level is used for forging a prefix to the message. +The prefixes are:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

syslog level	prefix
0	<0> EMERGENCY
1	<1> ALERT
2	<2> CRITICAL
3	<3> ERROR
4	<4> WARNING
5	<5> NOTICE
6	<6> INFO
7	<7> DEBUG

+ + +

The message is issued to the standard error. +The final destination of the message depends on how the systemd service +was configured through the variable StandardError: It can be +journal, syslog or kmsg. (See man sd-daemon).

+ + +

Sending events

+ + +

Writing an asynchronous verb implementation

+ + +

How to build a plugin

+ +

Afb-daemon provides a pkg-config configuration file that can be +queried by the name afb-daemon. +This configuration file provides data that should be used +for compiling plugins. Examples:

+ +

$ pkg-config --cflags afb-daemon
+$ pkg-config --libs afb-daemon
+

+ + +

Example for cmake meta build system

+ +

This example is the extract for building the plugin afm-main using CMAKE.

+ +

pkg_check_modules(afb afb-daemon)
+if(afb_FOUND)
+        message(STATUS "Creation afm-main-plugin for AFB-DAEMON")
+        add_library(afm-main-plugin MODULE afm-main-plugin.c)
+        target_compile_options(afm-main-plugin PRIVATE ${afb_CFLAGS})
+        target_include_directories(afm-main-plugin PRIVATE ${afb_INCLUDE_DIRS})
+        target_link_libraries(afm-main-plugin utils ${afb_LIBRARIES})
+        set_target_properties(afm-main-plugin PROPERTIES
+                PREFIX ""
+                LINK_FLAGS "-Wl,--version-script=${CMAKE_CURRENT_SOURCE_DIR}/afm-main-plugin.export-map"
+        )
+        install(TARGETS afm-main-plugin LIBRARY DESTINATION ${plugin_dir})
+else()
+        message(STATUS "Not creating the plugin for AFB-DAEMON")
+endif()
+

+ +

Let now describe some of these lines.

+ +

pkg_check_modules(afb afb-daemon)
+

+ +

This first lines searches to the pkg-config configuration file for +afb-daemon. Resulting data are stored in the following variables:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable	Meaning
afb_FOUND	Set to 1 if afb-daemon plugin development files exist
afb_LIBRARIES	Only the libraries (w/o the ‘-l’) for compiling afb-daemon plugins
afb_LIBRARY_DIRS	The paths of the libraries (w/o the ‘-L’) for compiling afb-daemon plugins
afb_LDFLAGS	All required linker flags for compiling afb-daemon plugins
afb_INCLUDE_DIRS	The ‘-I’ preprocessor flags (w/o the ‘-I’) for compiling afb-daemon plugins
afb_CFLAGS	All required cflags for compiling afb-daemon plugins

+ + +

If development files are found, the plugin can be added to the set of +target to build.

+ +

add_library(afm-main-plugin MODULE afm-main-plugin.c)
+

+ +

This line asks to create a shared library having only the +source file afm-main-plugin.c (that is compiled). +The default name of the created shared object is +libafm-main-plugin.so.

+ +

set_target_properties(afm-main-plugin PROPERTIES
+        PREFIX ""
+        LINK_FLAGS "-Wl,--version-script=${CMAKE_CURRENT_SOURCE_DIR}/afm-main-plugin.export-map"
+)
+

+ +

This lines are doing two things:

+ +

It renames the built library from libafm-main-plugin.so to afm-main-plugin.so +by removing the implicitely added prefix lib. This step is not mandatory +at all because afb-daemon doesn’t check names of files when loading it. +The only convention that use afb-daemon is that extension is .so +but this convention is used only when afb-daemon discovers plugin +from a directory hierarchy.
It applies a version script at link to only export the conventional name +of the entry point: pluginAfbV1Register. See below. By default, the linker +that creates the shared object exports all the public symbols (C functions that +are not static).

+ + +

Next line are:

+ +

target_include_directories(afm-main-plugin PRIVATE ${afb_INCLUDE_DIRS})
+target_link_libraries(afm-main-plugin utils ${afb_LIBRARIES})
+

+ +

As you can see it uses the variables computed by pkg_check_modules(afb afb-daemon) +to configure the compiler and the linker.

+ + +

Exporting the function pluginAfbV1Register

+ +

The function pluginAfbV1Register must be exported. This can be achieved +using a version script when linking. Here is the version script that is +used for tic-tac-toe (plugins/samples/export.map).

+ +

{ global: pluginAfbV1Register; local: *; };
+

+ +

This sample version script +exports as global the symbol pluginAfbV1Register and hides any +other symbols.

+ +

This version script is added to the link options using the +option –version-script=export.map is given directly to the +linker or using th option -Wl,–version-script=export.map +when the option is given to the C compiler.

+ + +

Building within yocto

+ +

Adding a dependency to afb-daemon is enough. See below:

+ +

DEPENDS += " afb-daemon "
+

+ + diff --git a/doc/afb-plugin-writing.md b/doc/afb-plugin-writing.md new file mode 100644 index 00000000..734b15a5 --- /dev/null +++ b/doc/afb-plugin-writing.md @@ -0,0 +1,1034 @@ +HOWTO WRITE a PLUGIN for AFB-DAEMON +=================================== + version: 1 + Date: 27 mai 2016 + Author: José Bollo + +TABLE-OF-CONTENT-HERE + +Summary +------- + +The binder afb-daemon serves files through +the HTTP protocol and offers access to API's through +HTTP or WebSocket protocol. + +The plugins are used to add API's to afb-daemon. +This part describes how to write a plugin for afb-daemon. +Excepting this summary, this part is intended to be read +by developpers. + +Before going into details, through a tiny example, +a short overview plugins basis is needed. + +### Nature of a plugin + +A plugin is a separate piece of code made of a shared library. +The plugin is loaded and activated by afb-daemon when afb-daemon +starts. + +Technically, a plugin is not linked to any library of afb-daemon. + +### Kinds of plugins + +There is two kinds of plugins: application plugins and service +plugins. + +#### Application plugins + +Application plugins are intended to be instanciated for each +application: when an application using that plugin is started, +its binder starts a new instance of the plugin. + +It means that the application plugins mainly have only one +context to manage for one client. + +#### Service plugins + +Service plugins are intended to be instanciated only one time +only and connected to many clients. + +So either it does not manage context at all or otherwise, +if it manages context, it should be able to manage one context +per client. + +In details, it may be useful to have service plugins at a user +level. + +### Live cycle of a plugin within afb-daemon + +The plugins are loaded and activated when afb-daemon starts. + +At start, the plugin initialise itself. +If it fails to initialise then afb-daemon stops. + +Conversely, if it success to initialize, it must declare +a name, that must be unique, and a list of API's verbs. + +When initialized, the functions implementing the API's verbs +of the plugin are activated on call. + +At the end, nothing special is done by afb-daemon. +Consequently, developpers of plugins should use 'atexit' +or 'on_exit' during initialisation if they need to +perform specific actions when stopping. + +### Content of a plugin + +For afb-daemon, a plugin contains 2 different +things: names and functions. + +There is two kind of names: + - the name of the plugin, + - the names of the verbs. + +There is two kind of functions: + - the initialisation function + - functions implementing verbs + +Afb-daemon translates the name of the method that is +invoked to a pair of API and verb names. For example, +the method named **foo/bar** translated to the API +name **foo** and the verb name **bar**. +To serve it, afb-daemon search the plugin that record +the name **foo** and if it also recorded the verb **bar**, +it calls the implementation function declared for this verb. + +Afb-daemon make no distinction between lower case +and upper case when searching for a method. +Thus, The names **TicTacToe/Board** and **tictactoe/borad** +are equals. + +#### The name of the plugin + +The name of the plugin is also known as the name +of the API that defines the plugin. + +This name is also known as the prefix. + +The name of a plugin MUST be unique within afb-daemon. + +For example, when a client of afb-daemon +calls a method named **foo/bar**. Afb-daemon +extracts the prefix **foo** and the suffix **bar**. +**foo** is the API name and must match a plugin name, +the plugin that implements the verb **bar**. + +#### Names of verbs + +Each plugin exposes a set of verbs that can be called +by client of afb-daemon. + +The name of a verb MUST be unique within a plugin. + +Plugins link verbs to functions that are called +when clients emit requests for that verb. + +For example, when a client of afb-daemon +calls a method named **foo/bar**. + +#### The initialisation function + +The initialisation function serves several purposes. + +1. It allows afb-daemon to check the version +of the plugin using the name of the initialisation +functions that it found. Currently, the initialisation +function is named **pluginAfbV1Register**. It identifies +the first version of plugins. + +2. It allows the plugin to initialise itself. + +3. It serves to the plugin to declare names, descriptions, +requirements and implmentations of the verbs that it exposes. + +#### Functions implementing verbs + +When a method is called, afb-daemon constructs a request +object and pass it to the implementation function for verb +within the plugin of the API. + +An implementation function receives a request object that +is used to get arguments of the request, to send +answer, to store session data. + +A plugin MUST send an answer to the request. + +But it is not mandatory to send the answer +before to return from the implementing function. +This behaviour is important for implementing +asynchronous actions. + +Implementation functions that always reply to the request +before returning are named *synchronous implementations*. +Those that don't always reply to the request before +returning are named *asynchronous implementations*. + +Asynchronous implementations typically initiate an +asynchronous action and record to send the reply +on completion of this action. + +The Tic-Tac-Toe example +----------------------- + +This part explains how to write an afb-plugin. +For the sake of being practical we will use many +examples from the tic-tac-toe example. +This plugin example is in *plugins/samples/tic-tac-toe.c*. + +This plugin is named ***tictactoe***. + +Choosing names +-------------- + +The designer of a plugin must defines names for its plugin +(or its API) and for the verbs of its API. He also +must defines names for arguments given by name. + +While forging names, the designer should take into account +the rules for making valid names and some rules that make +the names easy to use across plaforms. + +The names and strings used ALL are UTF-8 encoded. + +### Names for API (plugin) + +The names of the API are checked. +All characters are authorised except: + +- the control characters (\u0000 .. \u001f) +- the characters of the set { ' ', '"', '#', '%', '&', + '\'', '/', '?', '`', '\x7f' } + +In other words the set of forbidden characters is +{ \u0000..\u0020, \u0022, \u0023, \u0025..\u0027, + \u002f, \u003f, \u0060, \u007f }. + +Afb-daemon make no distinction between lower case +and upper case when searching for an API by its name. + +### Names for verbs + +The names of the verbs are not checked. + +However, the validity rules for verb's names are the +same as for API's names except that the dot (.) character +is forbidden. + +Afb-daemon make no distinction between lower case +and upper case when searching for an API by its name. + +### Names for arguments + +The names for arguments are not restricted and can be +anything. + +The arguments are searched with the case sensitive +string comparison. Thus the names "index" and "Index" +are not the same. + +### Forging names widely available + +The key names of javascript object can be almost +anything using the arrayed notation: + + object[key] = value + +That is not the case with the dot notation: + + object.key = value + +Using the dot notation, the key must be a valid javascript +identifier. + +For this reason, the chosen names should better be +valid javascript identifier. + +It is also a good practice, even for arguments, to not +rely on the case sensitivity and to avoid the use of +names different only by the case. + +Options to set when compiling plugins +------------------------------------- + +Afb-daemon provides a configuration file for *pkg-config*. +Typing the command + + pkg-config --cflags afb-daemon + +will print the flags to use for compiling, like this: + + $ pkg-config --cflags afb-daemon + -I/opt/local/include -I/usr/include/json-c + +For linking, you should use + + $ pkg-config --libs afb-daemon + -ljson-c + +As you see, afb-daemon automatically includes dependency to json-c. +This is done through the **Requires** keyword of pkg-config. + +If this behaviour is a problem, let us know. + +Header files to include +----------------------- + +The plugin *tictactoe* has the following lines for its includes: + + #define _GNU_SOURCE + #include + #include + #include + #include + +The header *afb/afb-plugin.h* includes all the features that a plugin +needs except two foreign header that must be included by the plugin +if it needs it: + +- *json-c/json.h*: this header must be include to handle json objects; +- *systemd/sd-event.h*: this must be include to access the main loop; +- *systemd/sd-bus.h*: this may be include to use dbus connections. + +The *tictactoe* plugin does not use systemd features so it is not included. + +When including *afb/afb-plugin.h*, the macro **_GNU_SOURCE** must be +defined. + +Writing a synchronous verb implementation +----------------------------------------- + +The verb **tictactoe/board** is a synchronous implementation. +Here is its listing: + + /* + * get the board + */ + static void board(struct afb_req req) + { + struct board *board; + struct json_object *description; + + /* retrieves the context for the session */ + board = board_of_req(req); + INFO(afbitf, "method 'board' called for boardid %d", board->id); + + /* describe the board */ + description = describe(board); + + /* send the board's description */ + afb_req_success(req, description, NULL); + } + +This examples show many aspects of writing a synchronous +verb implementation. Let summarize it: + +1. The function **board_of_req** retrieves the context stored +for the plugin: the board. + +2. The macro **INFO** sends a message of kind *INFO* +to the logging system. The global variable named **afbitf** +used represents the interface to afb-daemon. + +3. The function **describe** creates a json_object representing +the board. + +4. The function **afb_req_success** sends the reply, attaching to +it the object *description*. + +### The incoming request + +For any implementation, the request is received by a structure of type +**struct afb_req**. + +> Note that this is a PLAIN structure, not a pointer to a structure. + +The definition of **struct afb_req** is: + + /* + * Describes the request by plugins from afb-daemon + */ + struct afb_req { + const struct afb_req_itf *itf; /* the interfacing functions */ + void *closure; /* the closure for functions */ + }; + +It contains two pointers: one, *itf*, points to the functions needed +to handle the internal request represented by the second pointer, *closure*. + +> The structure must never be used directly. +> Insted, use the intended functions provided +> by afb-daemon and described here. + +*req* is used to get arguments of the request, to send +answer, to store session data. + +This object and its interface is defined and documented +in the file names *afb/afb-req-itf.h* + +The above example uses 2 times the request object *req*. + +The first time, it is used for retrieving the board attached to +the session of the request. + +The second time, it is used to send the reply: an object that +describes the current board. + +### Associating a context to the session + +When the plugin *tic-tac-toe* receives a request, it musts regain +the board that describes the game associated to the session. + +For a plugin, having data associated to a session is a common case. +This data is called the context of the plugin for the session. +For the plugin *tic-tac-toe*, the context is the board. + +The requests *afb_req* offer four functions for +storing and retrieving the context associated to the session. + +These functions are: + +- **afb_req_context_get**: + retrieves the context data stored for the plugin. + +- **afb_req_context_set**: + store the context data of the plugin. + +- **afb_req_context**: + retrieves the context data of the plugin, + if needed, creates the context and store it. + +- **afb_req_context_clear**: + reset the stored data. + +The plugin *tictactoe* use a convenient function to retrieve +its context: the board. This function is *board_of_req*: + + /* + * retrieves the board of the request + */ + static inline struct board *board_of_req(struct afb_req req) + { + return afb_req_context(req, (void*)get_new_board, (void*)release_board); + } + +The function **afb_req_context** ensure an existing context +for the session of the request. +Its two last arguments are functions. Here, the casts are required +to avoid a warning when compiling. + +Here is the definition of the function **afb_req_context** + + /* + * Gets the pointer stored by the plugin for the session of 'req'. + * If the stored pointer is NULL, indicating that no pointer was + * already stored, afb_req_context creates a new context by calling + * the function 'create_context' and stores it with the freeing function + * 'free_context'. + */ + static inline void *afb_req_context(struct afb_req req, void *(*create_context)(), void (*free_context)(void*)) + { + void *result = afb_req_context_get(req); + if (result == NULL) { + result = create_context(); + afb_req_context_set(req, result, free_context); + } + return result; + } + +The second argument if the function that creates the context. +For the plugin *tic-tac-toe* it is the function **get_new_board**. +The function **get_new_board** creates a new board and set its +count of use to 1. The boards are counting their count of use +to free there ressources when no more used. + +The third argument if the function that frees the context. +For the plugin *tic-tac-toe* it is the function **release_board**. +The function **release_board** decrease the the count of use of +the board given as argument. If the use count decrease to zero, +the board data are freed. + +The definition of the other functions for dealing with contexts are: + + /* + * Gets the pointer stored by the plugin for the session of 'req'. + * When the plugin has not yet recorded a pointer, NULL is returned. + */ + void *afb_req_context_get(struct afb_req req); + + /* + * Stores for the plugin the pointer 'context' to the session of 'req'. + * The function 'free_context' will be called when the session is closed + * or if plugin stores an other pointer. + */ + void afb_req_context_set(struct afb_req req, void *context, void (*free_context)(void*)); + + /* + * Frees the pointer stored by the plugin for the session of 'req' + * and sets it to NULL. + * + * Shortcut for: afb_req_context_set(req, NULL, NULL) + */ + static inline void afb_req_context_clear(struct afb_req req) + { + afb_req_context_set(req, NULL, NULL); + } + +### Sending the reply to a request + +Two kinds of replies can be made: successful replies and +failure replies. + +> Sending a reply to a request must be done at most one time. + +The two functions to send a reply of kind "success" are +**afb_req_success** and **afb_req_success_f**. + + /* + * Sends a reply of kind success to the request 'req'. + * The status of the reply is automatically set to "success". + * Its send the object 'obj' (can be NULL) with an + * informationnal comment 'info (can also be NULL). + */ + void afb_req_success(struct afb_req req, struct json_object *obj, const char *info); + + /* + * Same as 'afb_req_success' but the 'info' is a formatting + * string followed by arguments. + */ + void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...); + +The two functions to send a reply of kind "failure" are +**afb_req_fail** and **afb_req_fail_f**. + + /* + * Sends a reply of kind failure to the request 'req'. + * The status of the reply is set to 'status' and an + * informationnal comment 'info' (can also be NULL) can be added. + * + * Note that calling afb_req_fail("success", info) is equivalent + * to call afb_req_success(NULL, info). Thus even if possible it + * is strongly recommanded to NEVER use "success" for status. + */ + void afb_req_fail(struct afb_req req, const char *status, const char *info); + + /* + * Same as 'afb_req_fail' but the 'info' is a formatting + * string followed by arguments. + */ + void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...); + +Getting argument of invocation +------------------------------ + +Many verbs expect arguments. Afb-daemon let plugins +retrieve their arguments by name not by position. + +Arguments are given by the requests either through HTTP +or through WebSockets. + +For example, the verb **join** of the plugin **tic-tac-toe** +expects one argument: the *boardid* to join. Here is an extract: + + /* + * Join a board + */ + static void join(struct afb_req req) + { + struct board *board, *new_board; + const char *id; + + /* retrieves the context for the session */ + board = board_of_req(req); + INFO(afbitf, "method 'join' called for boardid %d", board->id); + + /* retrieves the argument */ + id = afb_req_value(req, "boardid"); + if (id == NULL) + goto bad_request; + ... + +The function **afb_req_value** search in the request *req* +for an argument whose name is given. When no argument of the +given name was passed, **afb_req_value** returns NULL. + +> The search is case sensitive. So the name *boardid* is not the +> same name than *BoardId*. But this must not be assumed so two +> expected names of argument should not differ only by case. + +### Basic functions for querying arguments + +The function **afb_req_value** is defined as below: + + /* + * Gets from the request 'req' the string value of the argument of 'name'. + * Returns NULL if when there is no argument of 'name'. + * Returns the value of the argument of 'name' otherwise. + * + * Shortcut for: afb_req_get(req, name).value + */ + static inline const char *afb_req_value(struct afb_req req, const char *name) + { + return afb_req_get(req, name).value; + } + +It is defined as a shortcut to call the function **afb_req_get**. +That function is defined as below: + + /* + * Gets from the request 'req' the argument of 'name'. + * Returns a PLAIN structure of type 'struct afb_arg'. + * When the argument of 'name' is not found, all fields of result are set to NULL. + * When the argument of 'name' is found, the fields are filled, + * in particular, the field 'result.name' is set to 'name'. + * + * There is a special name value: the empty string. + * The argument of name "" is defined only if the request was made using + * an HTTP POST of Content-Type "application/json". In that case, the + * argument of name "" receives the value of the body of the HTTP request. + */ + struct afb_arg afb_req_get(struct afb_req req, const char *name); + +That function takes 2 parameters: the request and the name +of the argument to retrieve. It returns a PLAIN structure of +type **struct afb_arg**. + +There is a special name that is defined when the request is +of type HTTP/POST with a Content-Type being application/json. +This name is **""** (the empty string). In that case, the value +of this argument of empty name is the string received as a body +of the post and is supposed to be a JSON string. + +The definition of **struct afb_arg** is: + + /* + * Describes an argument (or parameter) of a request + */ + struct afb_arg { + const char *name; /* name of the argument or NULL if invalid */ + const char *value; /* string representation of the value of the argument */ + /* original filename of the argument if path != NULL */ + const char *path; /* if not NULL, path of the received file for the argument */ + /* when the request is finalized this file is removed */ + }; + +The structure returns the data arguments that are known for the +request. This data include a field named **path**. This **path** +can be accessed using the function **afb_req_path** defined as +below: + + /* + * Gets from the request 'req' the path for file attached to the argument of 'name'. + * Returns NULL if when there is no argument of 'name' or when there is no file. + * Returns the path of the argument of 'name' otherwise. + * + * Shortcut for: afb_req_get(req, name).path + */ + static inline const char *afb_req_path(struct afb_req req, const char *name) + { + return afb_req_get(req, name).path; + } + +The path is only defined for HTTP/POST requests that send file. + +### Arguments for received files + +As it is explained just above, clients can send files using +HTTP/POST requests. + +Received files are attached to a arguments. For example, the +following HTTP fragment (from test/sample-post.html) +will send an HTTP/POST request to the method +**post/upload-image** with 2 arguments named *file* and +*hidden*. + +

Sample Post File

+ + + +
+ + + +In that case, the argument named **file** has its value and its +path defined and not NULL. + +The value is the name of the file as it was +set by the HTTP client and is generally the filename on the +client side. + +The path is the path of the file saved on the temporary local storage +area of the application. This is a randomly generated and unic filename +not linked in any way with the original filename on the client. + +The plugin can use the file at the given path the way that it wants: +read, write, remove, copy, rename... +But when the reply is sent and the query is terminated, the file at +this path is destroyed if it still exist. + +### Arguments as a JSON object + +Plugins can get all the arguments as one single object. +This feature is provided by the function **afb_req_json** +that is defined as below: + + /* + * Gets from the request 'req' the json object hashing the arguments. + * The returned object must not be released using 'json_object_put'. + */ + struct json_object *afb_req_json(struct afb_req req); + +It returns a json object. This object depends on how the request was +made: + +- For HTTP requests, this is an object whose keys are the names of the +arguments and whose values are either a string for common arguments or +an object like { "file": "...", "path": "..." } + +- For WebSockets requests, the returned object is the object +given by the client transparently transported. + +> In fact, for Websockets requests, the function **afb_req_value** +> can be seen as a shortcut to +> ***json_object_get_string(json_object_object_get(afb_req_json(req), name))*** + +Initialisation of the plugin and declaration of verbs +----------------------------------------------------- + +To be active, the verbs of the plugin should be declared to +afb-daemon. And even more, the plugin itself must be recorded. + +The mechanism for doing this is very simple: when afb-need starts, +it loads the plugins that are listed in its argument or configuration. + +Loading a plugin follows the following steps: + +1. It loads the plugin using *dlopen*. + +2. It searchs for the symbol named **pluginAfbV1Register** using *dlsym*. +This symbol is assumed to be the exported initialisation function of the plugin. + +3. It build an interface object for the plugin. + +4. It calls the found function **pluginAfbV1Register** and pass it the pointer +to its interface. + +5. The function **pluginAfbV1Register** setup the plugin, initialize it. + +6. The function **pluginAfbV1Register** returns the pointer to a structure +that describes the plugin: its version, its name (prefix or API name), and the +list of its verbs. + +7. Afb-daemon checks that the returned version and name can be managed. +If it can manage it, the plugin and its verbs are recorded and can be used +when afb-daemon finishes it initialisation. + +Here is the listing of the function **pluginAfbV1Register** of the plugin +*tic-tac-toe*: + + /* + * activation function for registering the plugin called by afb-daemon + */ + const struct AFB_plugin *pluginAfbV1Register(const struct AFB_interface *itf) + { + afbitf = itf; // records the interface for accessing afb-daemon + return &plugin_description; // returns the description of the plugin + } + +This is a very small function because the *tic-tac-toe* plugin doesn't have initialisation step. +It merely record the daemon's interface and returns its descritption. + +The variable **afbitf** is a variable global to the plugin. It records the +interface to afb-daemon and is used for logging and pushing events. +Here is its declaration: + + /* + * the interface to afb-daemon + */ + const struct AFB_interface *afbitf; + +The description of the plugin is defined as below. + + /* + * array of the verbs exported to afb-daemon + */ + static const struct AFB_verb_desc_v1 plugin_verbs[] = { + /* VERB'S NAME SESSION MANAGEMENT FUNCTION TO CALL SHORT DESCRIPTION */ + { .name= "new", .session= AFB_SESSION_NONE, .callback= new, .info= "Starts a new game" }, + { .name= "play", .session= AFB_SESSION_NONE, .callback= play, .info= "Tells the server to play" }, + { .name= "move", .session= AFB_SESSION_NONE, .callback= move, .info= "Tells the client move" }, + { .name= "board", .session= AFB_SESSION_NONE, .callback= board, .info= "Get the current board" }, + { .name= "level", .session= AFB_SESSION_NONE, .callback= level, .info= "Set the server level" }, + { .name= "join", .session= AFB_SESSION_CHECK,.callback= join, .info= "Join a board" }, + { .name= "undo", .session= AFB_SESSION_NONE, .callback= undo, .info= "Undo the last move" }, + { .name= "wait", .session= AFB_SESSION_NONE, .callback= wait, .info= "Wait for a change" }, + { .name= NULL } /* marker for end of the array */ + }; + + /* + * description of the plugin for afb-daemon + */ + static const struct AFB_plugin plugin_description = + { + /* description conforms to VERSION 1 */ + .type= AFB_PLUGIN_VERSION_1, + .v1= { /* fills the v1 field of the union when AFB_PLUGIN_VERSION_1 */ + .prefix= "tictactoe", /* the API name (or plugin name or prefix) */ + .info= "Sample tac-tac-toe game", /* short description of of the plugin */ + .verbs = plugin_verbs /* the array describing the verbs of the API */ + } + }; + +The structure **plugin_description** describes the plugin. +It declares the type and version of the plugin, its name, a description +and a list of its verbs. + +The list of verbs is an array of structures describing the verbs and terminated by a marker: +a verb whose name is NULL. + +The description of the verbs for this version is made of 4 fields: + +- the name of the verbs, + +- the session management flags, + +- the implementation function to be call for the verb, + +- a short description. + +The structure describing verbs is defined as follows: + + /* + * Description of one verb of the API provided by the plugin + * This enumeration is valid for plugins of type 1 + */ + struct AFB_verb_desc_v1 + { + const char *name; /* name of the verb */ + enum AFB_session_v1 session; /* authorisation and session requirements of the verb */ + void (*callback)(struct afb_req req); /* callback function implementing the verb */ + const char *info; /* textual description of the verb */ + }; + +For technical reasons, the enumeration **enum AFB_session_v1** is not exactly an +enumeration but the wrapper of constant definitions that can be mixed using bitwise or +(the C operator |). + +The constants that can bit mixed are: + +Constant name | Meaning +-------------------------|------------------------------------------------------------- +**AFB_SESSION_CREATE** | Equals to AFB_SESSION_LOA_EQ_0|AFB_SESSION_RENEW +**AFB_SESSION_CLOSE** | Closes the session after the reply and set the LOA to 0 +**AFB_SESSION_RENEW** | Refreshes the token of authentification +**AFB_SESSION_CHECK** | Just requires the token authentification +**AFB_SESSION_LOA_LE_0** | Requires the current LOA to be lesser then or equal to 0 +**AFB_SESSION_LOA_LE_1** | Requires the current LOA to be lesser then or equal to 1 +**AFB_SESSION_LOA_LE_2** | Requires the current LOA to be lesser then or equal to 2 +**AFB_SESSION_LOA_LE_3** | Requires the current LOA to be lesser then or equal to 3 +**AFB_SESSION_LOA_GE_0** | Requires the current LOA to be greater then or equal to 0 +**AFB_SESSION_LOA_GE_1** | Requires the current LOA to be greater then or equal to 1 +**AFB_SESSION_LOA_GE_2** | Requires the current LOA to be greater then or equal to 2 +**AFB_SESSION_LOA_GE_3** | Requires the current LOA to be greater then or equal to 3 +**AFB_SESSION_LOA_EQ_0** | Requires the current LOA to be equal to 0 +**AFB_SESSION_LOA_EQ_1** | Requires the current LOA to be equal to 1 +**AFB_SESSION_LOA_EQ_2** | Requires the current LOA to be equal to 2 +**AFB_SESSION_LOA_EQ_3** | Requires the current LOA to be equal to 3 + +If any of this flags is set, afb-daemon requires the token authentification +as if the flag **AFB_SESSION_CHECK** had been set. + +The special value **AFB_SESSION_NONE** is zero and can be used to avoid any check. + +> Note that **AFB_SESSION_CREATE** and **AFB_SESSION_CLOSE** might be removed in later versions. + +Sending messages to the log system +---------------------------------- + +Afb-daemon provides 4 levels of verbosity and 5 verbs for logging messages. + +The verbosity is managed. Options allow the change the verbosity of afb-daemon +and the verbosity of the plugins can be set plugin by plugin. + +The verbs for logging messages are defined as macros that test the +verbosity level and that call the real logging function only if the +message must be output. This avoid evaluation of arguments of the +formatting messages if the message must not be output. + +### Verbs for logging messages + +The 5 logging verbs are: + +Macro | Verbosity | Meaning | syslog level +--------|:---------:|-----------------------------------|:-----------: +ERROR | 0 | Error conditions | 3 +WARNING | 1 | Warning conditions | 4 +NOTICE | 1 | Normal but significant condition | 5 +INFO | 2 | Informational | 6 +DEBUG | 3 | Debug-level messages | 7 + +You can note that the 2 verbs **WARNING** and **INFO** have the same level +of verbosity. But they don't have the same *syslog level*. It means that +they are output with a different level on the logging system. + +All of these verbs have the same signature: + + void ERROR(const struct AFB_interface *afbitf, const char *message, ...); + +The first argument **afbitf** is the interface to afb daemon that the +plugin received at its initialisation when **pluginAfbV1Register** was called. + +The second argument **message** is a formatting string compatible with printf/sprintf. + +The remaining arguments are arguments of the formating message like for printf. + +### Managing verbosity + +Depending on the level of verbosity, the messages are output or not. +The following table explains what messages will be output depending +ont the verbosity level. + +Level of verbosity | Outputed macro +:-----------------:|-------------------------- + 0 | ERROR + 1 | ERROR + WARNING + NOTICE + 2 | ERROR + WARNING + NOTICE + INFO + 3 | ERROR + WARNING + NOTICE + INFO + DEBUG + +### Output format and destination + +The syslog level is used for forging a prefix to the message. +The prefixes are: + +syslog level | prefix +:-----------:|--------------- + 0 | <0> EMERGENCY + 1 | <1> ALERT + 2 | <2> CRITICAL + 3 | <3> ERROR + 4 | <4> WARNING + 5 | <5> NOTICE + 6 | <6> INFO + 7 | <7> DEBUG + + +The message is issued to the standard error. +The final destination of the message depends on how the systemd service +was configured through the variable **StandardError**: It can be +journal, syslog or kmsg. (See man sd-daemon). + +Sending events +-------------- + + +Writing an asynchronous verb implementation +------------------------------------------- + + +How to build a plugin +--------------------- + +Afb-daemon provides a *pkg-config* configuration file that can be +queried by the name **afb-daemon**. +This configuration file provides data that should be used +for compiling plugins. Examples: + + $ pkg-config --cflags afb-daemon + $ pkg-config --libs afb-daemon + +### Example for cmake meta build system + +This example is the extract for building the plugin *afm-main* using *CMAKE*. + + pkg_check_modules(afb afb-daemon) + if(afb_FOUND) + message(STATUS "Creation afm-main-plugin for AFB-DAEMON") + add_library(afm-main-plugin MODULE afm-main-plugin.c) + target_compile_options(afm-main-plugin PRIVATE ${afb_CFLAGS}) + target_include_directories(afm-main-plugin PRIVATE ${afb_INCLUDE_DIRS}) + target_link_libraries(afm-main-plugin utils ${afb_LIBRARIES}) + set_target_properties(afm-main-plugin PROPERTIES + PREFIX "" + LINK_FLAGS "-Wl,--version-script=${CMAKE_CURRENT_SOURCE_DIR}/afm-main-plugin.export-map" + ) + install(TARGETS afm-main-plugin LIBRARY DESTINATION ${plugin_dir}) + else() + message(STATUS "Not creating the plugin for AFB-DAEMON") + endif() + +Let now describe some of these lines. + + pkg_check_modules(afb afb-daemon) + +This first lines searches to the *pkg-config* configuration file for +**afb-daemon**. Resulting data are stored in the following variables: + +Variable | Meaning +------------------|------------------------------------------------ +afb_FOUND | Set to 1 if afb-daemon plugin development files exist +afb_LIBRARIES | Only the libraries (w/o the '-l') for compiling afb-daemon plugins +afb_LIBRARY_DIRS | The paths of the libraries (w/o the '-L') for compiling afb-daemon plugins +afb_LDFLAGS | All required linker flags for compiling afb-daemon plugins +afb_INCLUDE_DIRS | The '-I' preprocessor flags (w/o the '-I') for compiling afb-daemon plugins +afb_CFLAGS | All required cflags for compiling afb-daemon plugins + +If development files are found, the plugin can be added to the set of +target to build. + + add_library(afm-main-plugin MODULE afm-main-plugin.c) + +This line asks to create a shared library having only the +source file afm-main-plugin.c (that is compiled). +The default name of the created shared object is +**libafm-main-plugin.so**. + + set_target_properties(afm-main-plugin PROPERTIES + PREFIX "" + LINK_FLAGS "-Wl,--version-script=${CMAKE_CURRENT_SOURCE_DIR}/afm-main-plugin.export-map" + ) + +This lines are doing two things: + +1. It renames the built library from **libafm-main-plugin.so** to **afm-main-plugin.so** +by removing the implicitely added prefix *lib*. This step is not mandatory +at all because afb-daemon doesn't check names of files when loading it. +The only convention that use afb-daemon is that extension is **.so** +but this convention is used only when afb-daemon discovers plugin +from a directory hierarchy. + +2. It applies a version script at link to only export the conventional name +of the entry point: **pluginAfbV1Register**. See below. By default, the linker +that creates the shared object exports all the public symbols (C functions that +are not **static**). + +Next line are: + + target_include_directories(afm-main-plugin PRIVATE ${afb_INCLUDE_DIRS}) + target_link_libraries(afm-main-plugin utils ${afb_LIBRARIES}) + +As you can see it uses the variables computed by ***pkg_check_modules(afb afb-daemon)*** +to configure the compiler and the linker. + +### Exporting the function pluginAfbV1Register + +The function **pluginAfbV1Register** must be exported. This can be achieved +using a version script when linking. Here is the version script that is +used for *tic-tac-toe* (plugins/samples/export.map). + + { global: pluginAfbV1Register; local: *; }; + +This sample [version script](https://sourceware.org/binutils/docs-2.26/ld/VERSION.html#VERSION) +exports as global the symbol *pluginAfbV1Register* and hides any +other symbols. + +This version script is added to the link options using the +option **--version-script=export.map** is given directly to the +linker or using th option **-Wl,--version-script=export.map** +when the option is given to the C compiler. + +### Building within yocto + +Adding a dependency to afb-daemon is enough. See below: + + DEPENDS += " afb-daemon " + diff --git a/doc/doc.css b/doc/doc.css index d100bd1c..27be9dc7 100644 --- a/doc/doc.css +++ b/doc/doc.css @@ -4,7 +4,7 @@ body { color: #000; } -h1, h2, h3 { +h1, h2, h3, h4 { color: #306; text-decoration: underline; } @@ -27,3 +27,13 @@ blockquote { font: bolder; padding: 0.7em 1.5em; } + +table { + margin-left: 2em; + background-color: #dff; + outline: 0.25em solid #a6f; +/* padding: 0.25em;*/ +} +thead {background-color: #a6f;} +tr:nth-child(even) {background-color: #aee;} +td { padding: 0.1em 0.5em; } diff --git a/doc/writing-afb-plugins.html b/doc/writing-afb-plugins.html deleted file mode 100644 index 712d30ee..00000000 --- a/doc/writing-afb-plugins.html +++ /dev/null @@ -1,783 +0,0 @@ - - - - - - -

HOWTO WRITE a PLUGIN for AFB-DAEMON

- -

version: 1
-Date:    25 May 2016
-Author:  José Bollo
-

- -

HOWTO WRITE a PLUGIN for AFB-DAEMON -
- Summary -
  - Nature of a plugin
  - Kinds of plugins -
    - Application plugins
    - Service plugins
    -
  - Live cycle of a plugin within afb-daemon
  - Content of a plugin -
    -
  -
- The Tic-Tac-Toe example
- Choosing names -
  -
- Options to set when compiling plugins
- Header files to include
- Writing a synchronous verb implementation -
  -
- Getting argument of invocation -
  -
- Sending messages to the log system
- How to build a plugin
-

- -

Summary

- -

The binder afb-daemon serves files through -the HTTP protocol and offers access to API’s through -HTTP or WebSocket protocol.

- -

The plugins are used to add API’s to afb-daemon. -This part describes how to write a plugin for afb-daemon. -Excepting this summary, this part is intended to be read -by developpers.

- -

Before going into details, through a tiny example, -a short overview plugins basis is needed.

- -

Nature of a plugin

- -

A plugin is a separate piece of code made of a shared library. -The plugin is loaded and activated by afb-daemon when afb-daemon -starts.

- -

Technically, a plugin is not linked to any library of afb-daemon.

- -

Kinds of plugins

- -

There is two kinds of plugins: application plugins and service -plugins.

- -

Application plugins

- -

Application plugins are intended to be instanciated for each -application: when an application using that plugin is started, -its binder starts a new instance of the plugin.

- -

It means that the application plugins mainly have only one -context to manage for one client.

- -

Service plugins

- -

Service plugins are intended to be instanciated only one time -only and connected to many clients.

- -

So either it does not manage context at all or otherwise, -if it manages context, it should be able to manage one context -per client.

- -

In details, it may be useful to have service plugins at a user -level.

- -

Live cycle of a plugin within afb-daemon

- -

The plugins are loaded and activated when afb-daemon starts.

- -

At start, the plugin initialise itself. -If it fails to initialise then afb-daemon stops.

- -

Conversely, if it success to initialize, it must declare -a name, that must be unique, and a list of API’s verbs.

- -

When initialized, the functions implementing the API’s verbs -of the plugin are activated on call.

- -

At the end, nothing special is done by afb-daemon. -Consequently, developpers of plugins should use ‘atexit’ -or ‘on_exit’ during initialisation if they need to -perform specific actions when stopping.

- -

Content of a plugin

- -

For afb-daemon, a plugin contains 2 different -things: names and functions.

- -

There is two kind of names: - - the name of the plugin, - - the names of the verbs.

- -

There is two kind of functions: - - the initialisation function - - functions implementing verbs

- -

Afb-daemon translates the name of the method that is -invoked to a pair of API and verb names. For example, -the method named foo/bar translated to the API -name foo and the verb name bar. -To serve it, afb-daemon search the plugin that record -the name foo and if it also recorded the verb bar, -it calls the implementation function declared for this verb.

- -

Afb-daemon make no distinction between lower case -and upper case when searching for a method. -Thus, The names TicTacToe/Board and tictactoe/borad -are equals.

- -

The name of the plugin

- -

The name of the plugin is also known as the name -of the API that defines the plugin.

- -

This name is also known as the prefix.

- -

The name of a plugin MUST be unique within afb-daemon.

- -

For example, when a client of afb-daemon -calls a method named foo/bar. Afb-daemon -extracts the prefix foo and the suffix bar. -foo is the API name and must match a plugin name, -the plugin that implements the verb bar.

- -

Names of verbs

- -

Each plugin exposes a set of verbs that can be called -by client of afb-daemon.

- -

The name of a verb MUST be unique within a plugin.

- -

Plugins link verbs to functions that are called -when clients emit requests for that verb.

- -

For example, when a client of afb-daemon -calls a method named foo/bar.

- -

The initialisation function

- -

The initialisation function serves several purposes.

- -

It allows afb-daemon to check the version -of the plugin using the name of the initialisation -functions that it found. Currently, the initialisation -function is named pluginAfbV1Register. It identifies -the first version of plugins.
It allows the plugin to initialise itself.
It serves to the plugin to declare names, descriptions, -requirements and implmentations of the verbs that it exposes.

- - -

Functions implementing verbs

- -

When a method is called, afb-daemon constructs a request -object and pass it to the implementation function for verb -within the plugin of the API.

- -

An implementation function receives a request object that -is used to get arguments of the request, to send -answer, to store session data.

- -

A plugin MUST send an answer to the request.

- -

But it is not mandatory to send the answer -before to return from the implementing function. -This behaviour is important for implementing -asynchronous actions.

- -

Implementation functions that always reply to the request -before returning are named synchronous implementations. -Those that don’t always reply to the request before -returning are named asynchronous implementations.

- -

Asynchronous implementations typically initiate an -asynchronous action and record to send the reply -on completion of this action.

- -

The Tic-Tac-Toe example

- -

This part explains how to write an afb-plugin. -For the sake of being practical we will use many -examples from the tic-tac-toe example. -This plugin example is in plugins/samples/tic-tac-toe.c.

- -

This plugin is named tictactoe.

- -

Choosing names

- -

The designer of a plugin must defines names for its plugin -(or its API) and for the verbs of its API. He also -must defines names for arguments given by name.

- -

While forging names, the designer should take into account -the rules for making valid names and some rules that make -the names easy to use across plaforms.

- -

The names and strings used ALL are UTF-8 encoded.

- -

Names for API (plugin)

- -

The names of the API are checked. -All characters are authorised except:

- -

the control characters (\u0000 .. \u001f)
the characters of the set { ‘ ’, ‘“’, ‘#’, ‘%’, ‘&’, -‘’‘, ’/‘, ’?‘, ’`‘, ’\x7f' }

- - -

In other words the set of forbidden characters is -{ \u0000..\u0020, \u0022, \u0023, \u0025..\u0027, - \u002f, \u003f, \u0060, \u007f }.

- -

Afb-daemon make no distinction between lower case -and upper case when searching for an API by its name.

- -

Names for verbs

- -

The names of the verbs are not checked.

- -

However, the validity rules for verb’s names are the -same as for API’s names except that the dot (.) character -is forbidden.

- -

Afb-daemon make no distinction between lower case -and upper case when searching for an API by its name.

- -

Names for arguments

- -

The names for arguments are not restricted and can be -anything.

- -

The arguments are searched with the case sensitive -string comparison. Thus the names “index” and “Index” -are not the same.

- -

Forging names widely available

- -

The key names of javascript object can be almost -anything using the arrayed notation:

- -

object[key] = value
-

- -

That is not the case with the dot notation:

- -

object.key = value
-

- -

Using the dot notation, the key must be a valid javascript -identifier.

- -

For this reason, the chosen names should better be -valid javascript identifier.

- -

It is also a good practice, even for arguments, to not -rely on the case sensitivity and to avoid the use of -names different only by the case.

- -

Options to set when compiling plugins

- -

Afb-daemon provides a configuration file for pkg-config. -Typing the command

- -

pkg-config --cflags afb-daemon
-

- -

will print the flags to use for compiling, like this:

- -

$ pkg-config --cflags afb-daemon
--I/opt/local/include -I/usr/include/json-c 
-

- -

For linking, you should use

- -

$ pkg-config --libs afb-daemon
--ljson-c
-

- -

As you see, afb-daemon automatically includes dependency to json-c. -This is done through the Requires keyword of pkg-config.

- -

If this behaviour is a problem, let us know.

- - - -

The plugin tictactoe has the following lines for its includes:

- -

#define _GNU_SOURCE
-#include <stdio.h>
-#include <string.h>
-#include <json-c/json.h>
-#include <afb/afb-plugin.h>
-

- -

The header afb/afb-plugin.h includes all the features that a plugin -needs except two foreign header that must be included by the plugin -if it needs it:

- -

json-c/json.h: this header must be include to handle json objects;
systemd/sd-event.h: this must be include to access the main loop;
systemd/sd-bus.h: this may be include to use dbus connections.

- - -

The tictactoe plugin does not use systemd features so it is not included.

- -

When including afb/afb-plugin.h, the macro _GNU_SOURCE must be -defined.

- -

Writing a synchronous verb implementation

- -

The verb tictactoe/board is a synchronous implementation. -Here is its listing:

- -

/*
- * get the board
- */
-static void board(struct afb_req req)
-{
-        struct board *board;
-        struct json_object *description;
-
-        /* retrieves the context for the session */
-        board = board_of_req(req);
-        INFO(afbitf, "method 'board' called for boardid %d", board->id);
-
-        /* describe the board */
-        description = describe(board);
-
-        /* send the board's description */
-        afb_req_success(req, description, NULL);
-}
-

- -

This examples show many aspects of writing a synchronous -verb implementation. Let summarize it:

- -

The function board_of_req retrieves the context stored -for the plugin: the board.
The macro INFO sends a message of kind INFO -to the logging system. The global variable named afbitf -used represents the interface to afb-daemon.
The function describe creates a json_object representing -the board.
The function afb_req_success sends the reply, attaching to -it the object description.

- - -

The incoming request

- -

For any implementation, the request is received by a structure of type -struct afb_req.

- -

Note that this is a PLAIN structure, not a pointer to a structure.

- -

The definition of struct afb_req is:

- -

/*
- * Describes the request by plugins from afb-daemon
- */
-struct afb_req {
-        const struct afb_req_itf *itf;  /* the interfacing functions */
-        void *closure;          /* the closure for functions */
-};
-

- -

It contains two pointers: one, itf, points to the functions needed -to handle the internal request represented by the second pointer, closure.

- -

The structure must never be used directly. -Insted, use the intended functions provided -by afb-daemon and described here.

- -

req is used to get arguments of the request, to send -answer, to store session data.

- -

This object and its interface is defined and documented -in the file names afb/afb-req-itf.h

- -

The above example uses 2 times the request object req.

- -

The first time, it is used for retrieving the board attached to -the session of the request.

- -

The second time, it is used to send the reply: an object that -describes the current board.

- -

Associating a context to the session

- -

When the plugin tic-tac-toe receives a request, it musts regain -the board that describes the game associated to the session.

- -

For a plugin, having data associated to a session is a common case. -This data is called the context of the plugin for the session. -For the plugin tic-tac-toe, the context is the board.

- -

The requests afb_req offer four functions for -storing and retrieving the context associated to the session.

- -

These functions are:

- -

afb_req_context_get: -retrieves the context data stored for the plugin.
afb_req_context_set: -store the context data of the plugin.
afb_req_context: -retrieves the context data of the plugin, -if needed, creates the context and store it.
afb_req_context_clear: -reset the stored data.

- - -

The plugin tictactoe use a convenient function to retrieve -its context: the board. This function is board_of_req:

- -

/*
- * retrieves the board of the request
- */
-static inline struct board *board_of_req(struct afb_req req)
-{
-        return afb_req_context(req, (void*)get_new_board, (void*)release_board);
-}
-

- -

The function afb_req_context ensure an existing context -for the session of the request. -Its two last arguments are functions. Here, the casts are required -to avoid a warning when compiling.

- -

Here is the definition of the function afb_req_context

- -

/*
- * Gets the pointer stored by the plugin for the session of 'req'.
- * If the stored pointer is NULL, indicating that no pointer was
- * already stored, afb_req_context creates a new context by calling
- * the function 'create_context' and stores it with the freeing function
- * 'free_context'.
- */
-static inline void *afb_req_context(struct afb_req req, void *(*create_context)(), void (*free_context)(void*))
-{
-        void *result = afb_req_context_get(req);
-        if (result == NULL) {
-                result = create_context();
-                afb_req_context_set(req, result, free_context);
-        }
-        return result;
-}
-

- -

The second argument if the function that creates the context. -For the plugin tic-tac-toe it is the function get_new_board. -The function get_new_board creates a new board and set its -count of use to 1. The boards are counting their count of use -to free there ressources when no more used.

- -

The third argument if the function that frees the context. -For the plugin tic-tac-toe it is the function release_board. -The function release_board decrease the the count of use of -the board given as argument. If the use count decrease to zero, -the board data are freed.

- -

The definition of the other functions for dealing with contexts are:

- -

/*
- * Gets the pointer stored by the plugin for the session of 'req'.
- * When the plugin has not yet recorded a pointer, NULL is returned.
- */
-void *afb_req_context_get(struct afb_req req);
-
-/*
- * Stores for the plugin the pointer 'context' to the session of 'req'.
- * The function 'free_context' will be called when the session is closed
- * or if plugin stores an other pointer.
- */
-void afb_req_context_set(struct afb_req req, void *context, void (*free_context)(void*));
-
-/*
- * Frees the pointer stored by the plugin for the session of 'req'
- * and sets it to NULL.
- *
- * Shortcut for: afb_req_context_set(req, NULL, NULL)
- */
-static inline void afb_req_context_clear(struct afb_req req)
-{
-        afb_req_context_set(req, NULL, NULL);
-}
-

- -

Sending the reply to a request

- -

Two kinds of replies can be made: successful replies and -failure replies.

- -

Sending a reply to a request must be done at most one time.

- -

The two functions to send a reply of kind “success” are -afb_req_success and afb_req_success_f.

- -

/*
- * Sends a reply of kind success to the request 'req'.
- * The status of the reply is automatically set to "success".
- * Its send the object 'obj' (can be NULL) with an
- * informationnal comment 'info (can also be NULL).
- */
-void afb_req_success(struct afb_req req, struct json_object *obj, const char *info);
-
-/*
- * Same as 'afb_req_success' but the 'info' is a formatting
- * string followed by arguments.
- */
-void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...);
-

- -

The two functions to send a reply of kind “failure” are -afb_req_fail and afb_req_fail_f.

- -

/*
- * Sends a reply of kind failure to the request 'req'.
- * The status of the reply is set to 'status' and an
- * informationnal comment 'info' (can also be NULL) can be added.
- *
- * Note that calling afb_req_fail("success", info) is equivalent
- * to call afb_req_success(NULL, info). Thus even if possible it
- * is strongly recommanded to NEVER use "success" for status.
- */
-void afb_req_fail(struct afb_req req, const char *status, const char *info);
-
-/*
- * Same as 'afb_req_fail' but the 'info' is a formatting
- * string followed by arguments.
- */
-void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...);
-

- -

Getting argument of invocation

- -

Many verbs expect arguments. Afb-daemon let plugins -retrieve their arguments by name not by position.

- -

Arguments are given by the requests either through HTTP -or through WebSockets.

- -

For example, the verb join of the plugin tic-tac-toe -expects one argument: the boardid to join. Here is an extract:

- -

/*
- * Join a board
- */
-static void join(struct afb_req req)
-{
-        struct board *board, *new_board;
-        const char *id;
-
-        /* retrieves the context for the session */
-        board = board_of_req(req);
-        INFO(afbitf, "method 'join' called for boardid %d", board->id);
-
-        /* retrieves the argument */
-        id = afb_req_value(req, "boardid");
-        if (id == NULL)
-                goto bad_request;
-        ...
-

- -

The function afb_req_value search in the request req -for an argument whose name is given. When no argument of the -given name was passed, afb_req_value returns NULL.

- -

The search is case sensitive. So the name boardid is not the -same name than BoardId. But this must not be assumed so two -expected names of argument should not differ only by case.

- -

Basic functions for querying arguments

- -

The function afb_req_value is defined as below:

- -

/*
- * Gets from the request 'req' the string value of the argument of 'name'.
- * Returns NULL if when there is no argument of 'name'.
- * Returns the value of the argument of 'name' otherwise.
- *
- * Shortcut for: afb_req_get(req, name).value
- */
-static inline const char *afb_req_value(struct afb_req req, const char *name)
-{
-        return afb_req_get(req, name).value;
-}
-

- -

It is defined as a shortcut to call the function afb_req_get. -That function is defined as below:

- -

/*
- * Gets from the request 'req' the argument of 'name'.
- * Returns a PLAIN structure of type 'struct afb_arg'.
- * When the argument of 'name' is not found, all fields of result are set to NULL.
- * When the argument of 'name' is found, the fields are filled,
- * in particular, the field 'result.name' is set to 'name'.
- *
- * There is a special name value: the empty string.
- * The argument of name "" is defined only if the request was made using
- * an HTTP POST of Content-Type "application/json". In that case, the
- * argument of name "" receives the value of the body of the HTTP request.
- */
-struct afb_arg afb_req_get(struct afb_req req, const char *name);
-

- -

That function takes 2 parameters: the request and the name -of the argument to retrieve. It returns a PLAIN structure of -type struct afb_arg.

- -

There is a special name that is defined when the request is -of type HTTP/POST with a Content-Type being application/json. -This name is “” (the empty string). In that case, the value -of this argument of empty name is the string received as a body -of the post and is supposed to be a JSON string.

- -

The definition of struct afb_arg is:

- -

/*
- * Describes an argument (or parameter) of a request
- */
-struct afb_arg {
-        const char *name;   /* name of the argument or NULL if invalid */
-        const char *value;  /* string representation of the value of the argument */
-                                /* original filename of the argument if path != NULL */
-        const char *path;   /* if not NULL, path of the received file for the argument */
-                                /* when the request is finalized this file is removed */
-};
-

- -

The structure returns the data arguments that are known for the -request. This data include a field named path. This path -can be accessed using the function afb_req_path defined as -below:

- -

/*
- * Gets from the request 'req' the path for file attached to the argument of 'name'.
- * Returns NULL if when there is no argument of 'name' or when there is no file.
- * Returns the path of the argument of 'name' otherwise.
- *
- * Shortcut for: afb_req_get(req, name).path
- */
-static inline const char *afb_req_path(struct afb_req req, const char *name)
-{
-        return afb_req_get(req, name).path;
-}
-

- -

The path is only defined for HTTP/POST requests that send file.

- -

Arguments for received files

- -

As it is explained just above, clients can send files using -HTTP/POST requests.

- -

Received files are attached to a arguments. For example, the -following HTTP fragment (from test/sample-post.html) -will send an HTTP/POST request to the method -post/upload-image with 2 arguments named file and -hidden.

- -

<h2>Sample Post File</h2>
-<form enctype="multipart/form-data">
-    <input type="file" name="file" />
-    <input type="hidden" name="hidden" value="bollobollo" />
-    <br>
-    <button formmethod="POST" formaction="api/post/upload-image">Post File</button>
-</form>
-

- -

In that case, the argument named file has its value and its -path defined and not NULL.

- -

The value is the name of the file as it was -set by the HTTP client and is generally the filename on the -client side.

- -

The path is the path of the file saved on the temporary local storage -area of the application. This is a randomly generated and unic filename -not linked in any way with the original filename on the client.

- -

The plugin can use the file at the given path the way that it wants: -read, write, remove, copy, rename… -But when the reply is sent and the query is terminated, the file at -this path is destroyed if it still exist.

- -

Arguments as a JSON object

- -

Plugins can get all the arguments as one single object. -This feature is provided by the function afb_req_json -that is defined as below:

- -

/*
- * Gets from the request 'req' the json object hashing the arguments.
- * The returned object must not be released using 'json_object_put'.
- */
-struct json_object *afb_req_json(struct afb_req req);
-

- -

It returns a json object. This object depends on how the request was -made:

- -

For HTTP requests, this is an object whose keys are the names of the -arguments and whose values are either a string for common arguments or -an object like { “file”: “…”, “path”: “…” }
For WebSockets requests, the returned object is the object -given by the client transparently transported.

- - -

In fact, for Websockets requests, the function afb_req_value -can be seen as a shortcut to -json_object_get_string(json_object_object_get(afb_req_json(req), name))

- -

Sending messages to the log system

- -

How to build a plugin

- -

Afb-daemon provides a pkg-config configuration file.

- - diff --git a/doc/writing-afb-plugins.md b/doc/writing-afb-plugins.md deleted file mode 100644 index 7611600f..00000000 --- a/doc/writing-afb-plugins.md +++ /dev/null @@ -1,703 +0,0 @@ -HOWTO WRITE a PLUGIN for AFB-DAEMON -=================================== - version: 1 - Date: 25 May 2016 - Author: José Bollo - -TABLE-OF-CONTENT-HERE - -Summary -------- - -The binder afb-daemon serves files through -the HTTP protocol and offers access to API's through -HTTP or WebSocket protocol. - -The plugins are used to add API's to afb-daemon. -This part describes how to write a plugin for afb-daemon. -Excepting this summary, this part is intended to be read -by developpers. - -Before going into details, through a tiny example, -a short overview plugins basis is needed. - -### Nature of a plugin - -A plugin is a separate piece of code made of a shared library. -The plugin is loaded and activated by afb-daemon when afb-daemon -starts. - -Technically, a plugin is not linked to any library of afb-daemon. - -### Kinds of plugins - -There is two kinds of plugins: application plugins and service -plugins. - -#### Application plugins - -Application plugins are intended to be instanciated for each -application: when an application using that plugin is started, -its binder starts a new instance of the plugin. - -It means that the application plugins mainly have only one -context to manage for one client. - -#### Service plugins - -Service plugins are intended to be instanciated only one time -only and connected to many clients. - -So either it does not manage context at all or otherwise, -if it manages context, it should be able to manage one context -per client. - -In details, it may be useful to have service plugins at a user -level. - -### Live cycle of a plugin within afb-daemon - -The plugins are loaded and activated when afb-daemon starts. - -At start, the plugin initialise itself. -If it fails to initialise then afb-daemon stops. - -Conversely, if it success to initialize, it must declare -a name, that must be unique, and a list of API's verbs. - -When initialized, the functions implementing the API's verbs -of the plugin are activated on call. - -At the end, nothing special is done by afb-daemon. -Consequently, developpers of plugins should use 'atexit' -or 'on_exit' during initialisation if they need to -perform specific actions when stopping. - -### Content of a plugin - -For afb-daemon, a plugin contains 2 different -things: names and functions. - -There is two kind of names: - - the name of the plugin, - - the names of the verbs. - -There is two kind of functions: - - the initialisation function - - functions implementing verbs - -Afb-daemon translates the name of the method that is -invoked to a pair of API and verb names. For example, -the method named **foo/bar** translated to the API -name **foo** and the verb name **bar**. -To serve it, afb-daemon search the plugin that record -the name **foo** and if it also recorded the verb **bar**, -it calls the implementation function declared for this verb. - -Afb-daemon make no distinction between lower case -and upper case when searching for a method. -Thus, The names **TicTacToe/Board** and **tictactoe/borad** -are equals. - -#### The name of the plugin - -The name of the plugin is also known as the name -of the API that defines the plugin. - -This name is also known as the prefix. - -The name of a plugin MUST be unique within afb-daemon. - -For example, when a client of afb-daemon -calls a method named **foo/bar**. Afb-daemon -extracts the prefix **foo** and the suffix **bar**. -**foo** is the API name and must match a plugin name, -the plugin that implements the verb **bar**. - -#### Names of verbs - -Each plugin exposes a set of verbs that can be called -by client of afb-daemon. - -The name of a verb MUST be unique within a plugin. - -Plugins link verbs to functions that are called -when clients emit requests for that verb. - -For example, when a client of afb-daemon -calls a method named **foo/bar**. - -#### The initialisation function - -The initialisation function serves several purposes. - -1. It allows afb-daemon to check the version -of the plugin using the name of the initialisation -functions that it found. Currently, the initialisation -function is named **pluginAfbV1Register**. It identifies -the first version of plugins. - -2. It allows the plugin to initialise itself. - -3. It serves to the plugin to declare names, descriptions, -requirements and implmentations of the verbs that it exposes. - -#### Functions implementing verbs - -When a method is called, afb-daemon constructs a request -object and pass it to the implementation function for verb -within the plugin of the API. - -An implementation function receives a request object that -is used to get arguments of the request, to send -answer, to store session data. - -A plugin MUST send an answer to the request. - -But it is not mandatory to send the answer -before to return from the implementing function. -This behaviour is important for implementing -asynchronous actions. - -Implementation functions that always reply to the request -before returning are named *synchronous implementations*. -Those that don't always reply to the request before -returning are named *asynchronous implementations*. - -Asynchronous implementations typically initiate an -asynchronous action and record to send the reply -on completion of this action. - -The Tic-Tac-Toe example ------------------------ - -This part explains how to write an afb-plugin. -For the sake of being practical we will use many -examples from the tic-tac-toe example. -This plugin example is in *plugins/samples/tic-tac-toe.c*. - -This plugin is named ***tictactoe***. - -Choosing names --------------- - -The designer of a plugin must defines names for its plugin -(or its API) and for the verbs of its API. He also -must defines names for arguments given by name. - -While forging names, the designer should take into account -the rules for making valid names and some rules that make -the names easy to use across plaforms. - -The names and strings used ALL are UTF-8 encoded. - -### Names for API (plugin) - -The names of the API are checked. -All characters are authorised except: - -- the control characters (\u0000 .. \u001f) -- the characters of the set { ' ', '"', '#', '%', '&', - '\'', '/', '?', '`', '\x7f' } - -In other words the set of forbidden characters is -{ \u0000..\u0020, \u0022, \u0023, \u0025..\u0027, - \u002f, \u003f, \u0060, \u007f }. - -Afb-daemon make no distinction between lower case -and upper case when searching for an API by its name. - -### Names for verbs - -The names of the verbs are not checked. - -However, the validity rules for verb's names are the -same as for API's names except that the dot (.) character -is forbidden. - -Afb-daemon make no distinction between lower case -and upper case when searching for an API by its name. - -### Names for arguments - -The names for arguments are not restricted and can be -anything. - -The arguments are searched with the case sensitive -string comparison. Thus the names "index" and "Index" -are not the same. - -### Forging names widely available - -The key names of javascript object can be almost -anything using the arrayed notation: - - object[key] = value - -That is not the case with the dot notation: - - object.key = value - -Using the dot notation, the key must be a valid javascript -identifier. - -For this reason, the chosen names should better be -valid javascript identifier. - -It is also a good practice, even for arguments, to not -rely on the case sensitivity and to avoid the use of -names different only by the case. - -Options to set when compiling plugins -------------------------------------- - -Afb-daemon provides a configuration file for *pkg-config*. -Typing the command - - pkg-config --cflags afb-daemon - -will print the flags to use for compiling, like this: - - $ pkg-config --cflags afb-daemon - -I/opt/local/include -I/usr/include/json-c - -For linking, you should use - - $ pkg-config --libs afb-daemon - -ljson-c - -As you see, afb-daemon automatically includes dependency to json-c. -This is done through the **Requires** keyword of pkg-config. - -If this behaviour is a problem, let us know. - -Header files to include ------------------------ - -The plugin *tictactoe* has the following lines for its includes: - - #define _GNU_SOURCE - #include - #include - #include - #include - -The header *afb/afb-plugin.h* includes all the features that a plugin -needs except two foreign header that must be included by the plugin -if it needs it: - -- *json-c/json.h*: this header must be include to handle json objects; -- *systemd/sd-event.h*: this must be include to access the main loop; -- *systemd/sd-bus.h*: this may be include to use dbus connections. - -The *tictactoe* plugin does not use systemd features so it is not included. - -When including *afb/afb-plugin.h*, the macro **_GNU_SOURCE** must be -defined. - -Writing a synchronous verb implementation ------------------------------------------ - -The verb **tictactoe/board** is a synchronous implementation. -Here is its listing: - - /* - * get the board - */ - static void board(struct afb_req req) - { - struct board *board; - struct json_object *description; - - /* retrieves the context for the session */ - board = board_of_req(req); - INFO(afbitf, "method 'board' called for boardid %d", board->id); - - /* describe the board */ - description = describe(board); - - /* send the board's description */ - afb_req_success(req, description, NULL); - } - -This examples show many aspects of writing a synchronous -verb implementation. Let summarize it: - -1. The function **board_of_req** retrieves the context stored -for the plugin: the board. - -2. The macro **INFO** sends a message of kind *INFO* -to the logging system. The global variable named **afbitf** -used represents the interface to afb-daemon. - -3. The function **describe** creates a json_object representing -the board. - -4. The function **afb_req_success** sends the reply, attaching to -it the object *description*. - -### The incoming request - -For any implementation, the request is received by a structure of type -**struct afb_req**. - -> Note that this is a PLAIN structure, not a pointer to a structure. - -The definition of **struct afb_req** is: - - /* - * Describes the request by plugins from afb-daemon - */ - struct afb_req { - const struct afb_req_itf *itf; /* the interfacing functions */ - void *closure; /* the closure for functions */ - }; - -It contains two pointers: one, *itf*, points to the functions needed -to handle the internal request represented by the second pointer, *closure*. - -> The structure must never be used directly. -> Insted, use the intended functions provided -> by afb-daemon and described here. - -*req* is used to get arguments of the request, to send -answer, to store session data. - -This object and its interface is defined and documented -in the file names *afb/afb-req-itf.h* - -The above example uses 2 times the request object *req*. - -The first time, it is used for retrieving the board attached to -the session of the request. - -The second time, it is used to send the reply: an object that -describes the current board. - -### Associating a context to the session - -When the plugin *tic-tac-toe* receives a request, it musts regain -the board that describes the game associated to the session. - -For a plugin, having data associated to a session is a common case. -This data is called the context of the plugin for the session. -For the plugin *tic-tac-toe*, the context is the board. - -The requests *afb_req* offer four functions for -storing and retrieving the context associated to the session. - -These functions are: - -- **afb_req_context_get**: - retrieves the context data stored for the plugin. - -- **afb_req_context_set**: - store the context data of the plugin. - -- **afb_req_context**: - retrieves the context data of the plugin, - if needed, creates the context and store it. - -- **afb_req_context_clear**: - reset the stored data. - -The plugin *tictactoe* use a convenient function to retrieve -its context: the board. This function is *board_of_req*: - - /* - * retrieves the board of the request - */ - static inline struct board *board_of_req(struct afb_req req) - { - return afb_req_context(req, (void*)get_new_board, (void*)release_board); - } - -The function **afb_req_context** ensure an existing context -for the session of the request. -Its two last arguments are functions. Here, the casts are required -to avoid a warning when compiling. - -Here is the definition of the function **afb_req_context** - - /* - * Gets the pointer stored by the plugin for the session of 'req'. - * If the stored pointer is NULL, indicating that no pointer was - * already stored, afb_req_context creates a new context by calling - * the function 'create_context' and stores it with the freeing function - * 'free_context'. - */ - static inline void *afb_req_context(struct afb_req req, void *(*create_context)(), void (*free_context)(void*)) - { - void *result = afb_req_context_get(req); - if (result == NULL) { - result = create_context(); - afb_req_context_set(req, result, free_context); - } - return result; - } - -The second argument if the function that creates the context. -For the plugin *tic-tac-toe* it is the function **get_new_board**. -The function **get_new_board** creates a new board and set its -count of use to 1. The boards are counting their count of use -to free there ressources when no more used. - -The third argument if the function that frees the context. -For the plugin *tic-tac-toe* it is the function **release_board**. -The function **release_board** decrease the the count of use of -the board given as argument. If the use count decrease to zero, -the board data are freed. - -The definition of the other functions for dealing with contexts are: - - /* - * Gets the pointer stored by the plugin for the session of 'req'. - * When the plugin has not yet recorded a pointer, NULL is returned. - */ - void *afb_req_context_get(struct afb_req req); - - /* - * Stores for the plugin the pointer 'context' to the session of 'req'. - * The function 'free_context' will be called when the session is closed - * or if plugin stores an other pointer. - */ - void afb_req_context_set(struct afb_req req, void *context, void (*free_context)(void*)); - - /* - * Frees the pointer stored by the plugin for the session of 'req' - * and sets it to NULL. - * - * Shortcut for: afb_req_context_set(req, NULL, NULL) - */ - static inline void afb_req_context_clear(struct afb_req req) - { - afb_req_context_set(req, NULL, NULL); - } - -### Sending the reply to a request - -Two kinds of replies can be made: successful replies and -failure replies. - -> Sending a reply to a request must be done at most one time. - -The two functions to send a reply of kind "success" are -**afb_req_success** and **afb_req_success_f**. - - /* - * Sends a reply of kind success to the request 'req'. - * The status of the reply is automatically set to "success". - * Its send the object 'obj' (can be NULL) with an - * informationnal comment 'info (can also be NULL). - */ - void afb_req_success(struct afb_req req, struct json_object *obj, const char *info); - - /* - * Same as 'afb_req_success' but the 'info' is a formatting - * string followed by arguments. - */ - void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...); - -The two functions to send a reply of kind "failure" are -**afb_req_fail** and **afb_req_fail_f**. - - /* - * Sends a reply of kind failure to the request 'req'. - * The status of the reply is set to 'status' and an - * informationnal comment 'info' (can also be NULL) can be added. - * - * Note that calling afb_req_fail("success", info) is equivalent - * to call afb_req_success(NULL, info). Thus even if possible it - * is strongly recommanded to NEVER use "success" for status. - */ - void afb_req_fail(struct afb_req req, const char *status, const char *info); - - /* - * Same as 'afb_req_fail' but the 'info' is a formatting - * string followed by arguments. - */ - void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...); - -Getting argument of invocation ------------------------------- - -Many verbs expect arguments. Afb-daemon let plugins -retrieve their arguments by name not by position. - -Arguments are given by the requests either through HTTP -or through WebSockets. - -For example, the verb **join** of the plugin **tic-tac-toe** -expects one argument: the *boardid* to join. Here is an extract: - - /* - * Join a board - */ - static void join(struct afb_req req) - { - struct board *board, *new_board; - const char *id; - - /* retrieves the context for the session */ - board = board_of_req(req); - INFO(afbitf, "method 'join' called for boardid %d", board->id); - - /* retrieves the argument */ - id = afb_req_value(req, "boardid"); - if (id == NULL) - goto bad_request; - ... - -The function **afb_req_value** search in the request *req* -for an argument whose name is given. When no argument of the -given name was passed, **afb_req_value** returns NULL. - -> The search is case sensitive. So the name *boardid* is not the -> same name than *BoardId*. But this must not be assumed so two -> expected names of argument should not differ only by case. - -### Basic functions for querying arguments - -The function **afb_req_value** is defined as below: - - /* - * Gets from the request 'req' the string value of the argument of 'name'. - * Returns NULL if when there is no argument of 'name'. - * Returns the value of the argument of 'name' otherwise. - * - * Shortcut for: afb_req_get(req, name).value - */ - static inline const char *afb_req_value(struct afb_req req, const char *name) - { - return afb_req_get(req, name).value; - } - -It is defined as a shortcut to call the function **afb_req_get**. -That function is defined as below: - - /* - * Gets from the request 'req' the argument of 'name'. - * Returns a PLAIN structure of type 'struct afb_arg'. - * When the argument of 'name' is not found, all fields of result are set to NULL. - * When the argument of 'name' is found, the fields are filled, - * in particular, the field 'result.name' is set to 'name'. - * - * There is a special name value: the empty string. - * The argument of name "" is defined only if the request was made using - * an HTTP POST of Content-Type "application/json". In that case, the - * argument of name "" receives the value of the body of the HTTP request. - */ - struct afb_arg afb_req_get(struct afb_req req, const char *name); - -That function takes 2 parameters: the request and the name -of the argument to retrieve. It returns a PLAIN structure of -type **struct afb_arg**. - -There is a special name that is defined when the request is -of type HTTP/POST with a Content-Type being application/json. -This name is **""** (the empty string). In that case, the value -of this argument of empty name is the string received as a body -of the post and is supposed to be a JSON string. - -The definition of **struct afb_arg** is: - - /* - * Describes an argument (or parameter) of a request - */ - struct afb_arg { - const char *name; /* name of the argument or NULL if invalid */ - const char *value; /* string representation of the value of the argument */ - /* original filename of the argument if path != NULL */ - const char *path; /* if not NULL, path of the received file for the argument */ - /* when the request is finalized this file is removed */ - }; - -The structure returns the data arguments that are known for the -request. This data include a field named **path**. This **path** -can be accessed using the function **afb_req_path** defined as -below: - - /* - * Gets from the request 'req' the path for file attached to the argument of 'name'. - * Returns NULL if when there is no argument of 'name' or when there is no file. - * Returns the path of the argument of 'name' otherwise. - * - * Shortcut for: afb_req_get(req, name).path - */ - static inline const char *afb_req_path(struct afb_req req, const char *name) - { - return afb_req_get(req, name).path; - } - -The path is only defined for HTTP/POST requests that send file. - -### Arguments for received files - -As it is explained just above, clients can send files using -HTTP/POST requests. - -Received files are attached to a arguments. For example, the -following HTTP fragment (from test/sample-post.html) -will send an HTTP/POST request to the method -**post/upload-image** with 2 arguments named *file* and -*hidden*. - -

Sample Post File

- - -In that case, the argument named **file** has its value and its -path defined and not NULL. - -The value is the name of the file as it was -set by the HTTP client and is generally the filename on the -client side. - -The path is the path of the file saved on the temporary local storage -area of the application. This is a randomly generated and unic filename -not linked in any way with the original filename on the client. - -The plugin can use the file at the given path the way that it wants: -read, write, remove, copy, rename... -But when the reply is sent and the query is terminated, the file at -this path is destroyed if it still exist. - -### Arguments as a JSON object - -Plugins can get all the arguments as one single object. -This feature is provided by the function **afb_req_json** -that is defined as below: - - /* - * Gets from the request 'req' the json object hashing the arguments. - * The returned object must not be released using 'json_object_put'. - */ - struct json_object *afb_req_json(struct afb_req req); - -It returns a json object. This object depends on how the request was -made: - -- For HTTP requests, this is an object whose keys are the names of the -arguments and whose values are either a string for common arguments or -an object like { "file": "...", "path": "..." } - -- For WebSockets requests, the returned object is the object -given by the client transparently transported. - -> In fact, for Websockets requests, the function **afb_req_value** -> can be seen as a shortcut to -> *json_object_get_string(json_object_object_get(afb_req_json(req), name))* - -Sending messages to the log system ----------------------------------- - -How to build a plugin ---------------------- - -Afb-daemon provides a *pkg-config* configuration file. - - -- cgit 1.2.3-korg From d96d0533b8326570db57d13b8f808bc62d1a7fa4 Mon Sep 17 00:00:00 2001 From: José Bollo Date: Fri, 27 May 2016 22:18:26 +0200 Subject: improves documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: Idbd1b735571c2e35daed23d43f8d5d3990881533 Signed-off-by: José Bollo --- doc/FAQ.html | 2 +- doc/FAQ.md | 2 +- doc/afb-daemon-vocabulary.html | 2 +- doc/afb-daemon-vocabulary.md | 2 +- doc/afb-plugin-writing.html | 202 +++++++++++++++++++++++++++++------------ doc/afb-plugin-writing.md | 179 ++++++++++++++++++++++++++---------- include/afb/afb-plugin.h | 21 ++++- plugins/samples/HelloWorld.c | 4 +- plugins/samples/tic-tac-toe.c | 4 +- 9 files changed, 300 insertions(+), 118 deletions(-) diff --git a/doc/FAQ.html b/doc/FAQ.html index ffda81af..98337815 100644 --- a/doc/FAQ.html +++ b/doc/FAQ.html @@ -8,7 +8,7 @@

Frequently Asked Question about AFB-DAEMON

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

diff --git a/doc/FAQ.md b/doc/FAQ.md index 93647311..61105823 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -1,7 +1,7 @@ Frequently Asked Question about AFB-DAEMON ========================================== version: 1 - Date: 26 mai 2016 + Date: 27 mai 2016 Author: José Bollo TABLE-OF-CONTENT-HERE diff --git a/doc/afb-daemon-vocabulary.html b/doc/afb-daemon-vocabulary.html index 096f5076..fadd1dee 100644 --- a/doc/afb-daemon-vocabulary.html +++ b/doc/afb-daemon-vocabulary.html @@ -8,7 +8,7 @@

Vocabulary for AFB-DAEMON

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

diff --git a/doc/afb-daemon-vocabulary.md b/doc/afb-daemon-vocabulary.md index 71771947..8427b736 100644 --- a/doc/afb-daemon-vocabulary.md +++ b/doc/afb-daemon-vocabulary.md @@ -1,7 +1,7 @@ Vocabulary for AFB-DAEMON ========================= version: 1 - Date: 26 mai 2016 + Date: 27 mai 2016 Author: José Bollo TABLE-OF-CONTENT-HERE diff --git a/doc/afb-plugin-writing.html b/doc/afb-plugin-writing.html index 9a98ffe9..9873b626 100644 --- a/doc/afb-plugin-writing.html +++ b/doc/afb-plugin-writing.html @@ -37,6 +37,8 @@ Author: José Bollo

The Tic-Tac-Toe example

Dependencies when compiling

Header files to include

Choosing names

Names for API (plugin)
Forging names widely available

Options to set when compiling plugins

Header files to include

Writing a synchronous verb implementation

The incoming request

plugins/samples/tic-tac-toe.c

This plugin is named tictactoe.

Dependencies when compiling

Afb-daemon provides a configuration file for pkg-config. +Typing the command

pkg-config --cflags afb-daemon
+

will print the flags to use for compiling, like this:

$ pkg-config --cflags afb-daemon
+-I/opt/local/include -I/usr/include/json-c 
+

For linking, you should use

$ pkg-config --libs afb-daemon
+-ljson-c
+

As you see, afb-daemon automatically includes dependency to json-c. +This is done through the Requires keyword of pkg-config +because almost all plugin will use json-c.

If this behaviour is a problem, let us know.

Internally, afb-daemon uses libsystemd for its event loop +and for its binding to D-Bus. +Plugins developpers are encouraged to also use this library. +But it is a matter of choice. +Thus there is no dependency to libsystemd.

Afb-daemon provides no library for plugins. +The functions that the plugin need to have are given +to the plugin at runtime through pointer using read-only +memory.

Header files to include

The plugin tictactoe has the following lines for its includes:

#define _GNU_SOURCE
+#include <stdio.h>
+#include <string.h>
+#include <json-c/json.h>
+#include <afb/afb-plugin.h>
+

The header afb/afb-plugin.h includes all the features that a plugin +needs except two foreign header that must be included by the plugin +if it needs it:

json-c/json.h: this header must be include to handle json objects;
systemd/sd-event.h: this must be include to access the main loop;
systemd/sd-bus.h: this may be include to use dbus connections.

The tictactoe plugin does not use systemd features so it is not included.

When including afb/afb-plugin.h, the macro _GNU_SOURCE must be +defined.

Choosing names

Options to set when compiling plugins

Afb-daemon provides a configuration file for pkg-config. -Typing the command

pkg-config --cflags afb-daemon
-

will print the flags to use for compiling, like this:

$ pkg-config --cflags afb-daemon
--I/opt/local/include -I/usr/include/json-c 
-

For linking, you should use

$ pkg-config --libs afb-daemon
--ljson-c
-

As you see, afb-daemon automatically includes dependency to json-c. -This is done through the Requires keyword of pkg-config.

If this behaviour is a problem, let us know.

Header files to include

The plugin tictactoe has the following lines for its includes:

#define _GNU_SOURCE
-#include <stdio.h>
-#include <string.h>
-#include <json-c/json.h>
-#include <afb/afb-plugin.h>
-

The header afb/afb-plugin.h includes all the features that a plugin -needs except two foreign header that must be included by the plugin -if it needs it:

json-c/json.h: this header must be include to handle json objects;
systemd/sd-event.h: this must be include to access the main loop;
systemd/sd-bus.h: this may be include to use dbus connections.

The tictactoe plugin does not use systemd features so it is not included.

When including afb/afb-plugin.h, the macro _GNU_SOURCE must be -defined.

Writing a synchronous verb implementation

Sending events

Since version 0.5, plugins can broadcast events to any potential listener. +This kind of bradcast is not targeted. Event targeted will come in a future +version of afb-daemon.

The plugin tic-tac-toe broadcasts events when the board changes. +This is done in the function changed:

/*
+ * signals a change of the board
+ */
+static void changed(struct board *board, const char *reason)
+{
+        ...
+        struct json_object *description;
+
+        /* get the description */
+        description = describe(board);
+
+        ...
+
+        afb_daemon_broadcast_event(afbitf->daemon, reason, description);
+}
+

The description of the changed board is pushed via the daemon interface.

Within the plugin tic-tac-toe, the reason indicates the origin of +the change. For the function afb_daemon_broadcast_event, the second +parameter is the name of the broadcasted event. The third argument is the +object that is transmitted with the event.

The function afb_daemon_broadcast_event is defined as below:

/*
+ * Broadcasts widely the event of 'name' with the data 'object'.
+ * 'object' can be NULL.
+ * 'daemon' MUST be the daemon given in interface when activating the plugin.
+ */
+void afb_daemon_broadcast_event(struct afb_daemon daemon, const char *name, struct json_object *object);
+

In fact the event name received by the listener is prefixed with +the name of the plugin. So when the change occurs after a move, the +reason is move and then the clients receive the event tictactoe/move.

Note that nothing is said about the case sensitivity of event names. +However, the event is always prefixed with the name that the plugin +declared, with the same case, followed with a slash /. +Thus it is safe to compare event using a case sensitive comparison.

Writing an asynchronous verb implementation

/ + * signals a change of the board + / +static void changed(struct board board, const char reason) +{ + struct waiter waiter, next; + struct json_object *description;

/* get the description */
+description = describe(board);
+
+waiter = board->waiters;
+board->waiters = NULL;
+while (waiter != NULL) {
+        next = waiter->next;
+        afb_req_success(waiter->req, json_object_get(description), reason);
+        afb_req_unref(waiter->req);
+        free(waiter);
+        waiter = next;
+}
+
+afb_event_sender_push(afb_daemon_get_event_sender(afbitf->daemon), reason, description);
+

}

How to build a plugin

+ #include + #include + #include + +The header *afb/afb-plugin.h* includes all the features that a plugin +needs except two foreign header that must be included by the plugin +if it needs it: + +- *json-c/json.h*: this header must be include to handle json objects; +- *systemd/sd-event.h*: this must be include to access the main loop; +- *systemd/sd-bus.h*: this may be include to use dbus connections. + +The *tictactoe* plugin does not use systemd features so it is not included. + +When including *afb/afb-plugin.h*, the macro **_GNU_SOURCE** must be +defined. + Choosing names -------------- @@ -248,53 +307,6 @@ It is also a good practice, even for arguments, to not rely on the case sensitivity and to avoid the use of names different only by the case. -Options to set when compiling plugins -------------------------------------- - -Afb-daemon provides a configuration file for *pkg-config*. -Typing the command - - pkg-config --cflags afb-daemon - -will print the flags to use for compiling, like this: - - $ pkg-config --cflags afb-daemon - -I/opt/local/include -I/usr/include/json-c - -For linking, you should use - - $ pkg-config --libs afb-daemon - -ljson-c - -As you see, afb-daemon automatically includes dependency to json-c. -This is done through the **Requires** keyword of pkg-config. - -If this behaviour is a problem, let us know. - -Header files to include ------------------------ - -The plugin *tictactoe* has the following lines for its includes: - - #define _GNU_SOURCE - #include - #include - #include - #include - -The header *afb/afb-plugin.h* includes all the features that a plugin -needs except two foreign header that must be included by the plugin -if it needs it: - -- *json-c/json.h*: this header must be include to handle json objects; -- *systemd/sd-event.h*: this must be include to access the main loop; -- *systemd/sd-bus.h*: this may be include to use dbus connections. - -The *tictactoe* plugin does not use systemd features so it is not included. - -When including *afb/afb-plugin.h*, the macro **_GNU_SOURCE** must be -defined. - Writing a synchronous verb implementation ----------------------------------------- @@ -755,7 +767,7 @@ The description of the plugin is defined as below. static const struct AFB_verb_desc_v1 plugin_verbs[] = { /* VERB'S NAME SESSION MANAGEMENT FUNCTION TO CALL SHORT DESCRIPTION */ { .name= "new", .session= AFB_SESSION_NONE, .callback= new, .info= "Starts a new game" }, - { .name= "play", .session= AFB_SESSION_NONE, .callback= play, .info= "Tells the server to play" }, + { .name= "play", .session= AFB_SESSION_NONE, .callback= play, .info= "Asks the server to play" }, { .name= "move", .session= AFB_SESSION_NONE, .callback= move, .info= "Tells the client move" }, { .name= "board", .session= AFB_SESSION_NONE, .callback= board, .info= "Get the current board" }, { .name= "level", .session= AFB_SESSION_NONE, .callback= level, .info= "Set the server level" }, @@ -920,10 +932,81 @@ journal, syslog or kmsg. (See man sd-daemon). Sending events -------------- +Since version 0.5, plugins can broadcast events to any potential listener. +This kind of bradcast is not targeted. Event targeted will come in a future +version of afb-daemon. + +The plugin *tic-tac-toe* broadcasts events when the board changes. +This is done in the function **changed**: + + /* + * signals a change of the board + */ + static void changed(struct board *board, const char *reason) + { + ... + struct json_object *description; + + /* get the description */ + description = describe(board); + + ... + + afb_daemon_broadcast_event(afbitf->daemon, reason, description); + } + +The description of the changed board is pushed via the daemon interface. + +Within the plugin *tic-tac-toe*, the *reason* indicates the origin of +the change. For the function **afb_daemon_broadcast_event**, the second +parameter is the name of the broadcasted event. The third argument is the +object that is transmitted with the event. + +The function **afb_daemon_broadcast_event** is defined as below: + + /* + * Broadcasts widely the event of 'name' with the data 'object'. + * 'object' can be NULL. + * 'daemon' MUST be the daemon given in interface when activating the plugin. + */ + void afb_daemon_broadcast_event(struct afb_daemon daemon, const char *name, struct json_object *object); + +In fact the event name received by the listener is prefixed with +the name of the plugin. So when the change occurs after a move, the +reason is **move** and then the clients receive the event **tictactoe/move**. + +> Note that nothing is said about the case sensitivity of event names. +> However, the event is always prefixed with the name that the plugin +> declared, with the same case, followed with a slash /. +> Thus it is safe to compare event using a case sensitive comparison. + Writing an asynchronous verb implementation ------------------------------------------- +/* + * signals a change of the board + */ +static void changed(struct board *board, const char *reason) +{ + struct waiter *waiter, *next; + struct json_object *description; + + /* get the description */ + description = describe(board); + + waiter = board->waiters; + board->waiters = NULL; + while (waiter != NULL) { + next = waiter->next; + afb_req_success(waiter->req, json_object_get(description), reason); + afb_req_unref(waiter->req); + free(waiter); + waiter = next; + } + + afb_event_sender_push(afb_daemon_get_event_sender(afbitf->daemon), reason, description); +} How to build a plugin --------------------- diff --git a/include/afb/afb-plugin.h b/include/afb/afb-plugin.h index cad55fbe..3d16c7ad 100644 --- a/include/afb/afb-plugin.h +++ b/include/afb/afb-plugin.h @@ -56,10 +56,10 @@ enum AFB_plugin_version */ enum AFB_session_v1 { - AFB_SESSION_NONE = 0, /* no session and no authentification required */ - AFB_SESSION_CREATE = 1, /* obsolete */ - AFB_SESSION_CLOSE = 2, /* closes the session after authentification */ - AFB_SESSION_RENEW = 4, /* refreshes the token after authentification */ + AFB_SESSION_NONE = 0, /* nothing required */ + AFB_SESSION_CREATE = 1, /* Obsolete */ + AFB_SESSION_CLOSE = 2, /* After token authentification, closes the session at end */ + AFB_SESSION_RENEW = 4, /* After token authentification, refreshes the token at end */ AFB_SESSION_CHECK = 8, /* Requires token authentification */ AFB_SESSION_LOA_GE = 16, /* check that the LOA is greater or equal to the given value */ @@ -67,12 +67,13 @@ enum AFB_session_v1 AFB_SESSION_LOA_EQ = 48, /* check that the LOA is equal to the given value */ AFB_SESSION_LOA_SHIFT = 6, /* shift for LOA */ - AFB_SESSION_LOA_MASK = 3, /* mask for LOA */ + AFB_SESSION_LOA_MASK = 7, /* mask for LOA */ AFB_SESSION_LOA_0 = 0, /* value for LOA of 0 */ AFB_SESSION_LOA_1 = 64, /* value for LOA of 1 */ AFB_SESSION_LOA_2 = 128, /* value for LOA of 2 */ AFB_SESSION_LOA_3 = 192, /* value for LOA of 3 */ + AFB_SESSION_LOA_4 = 256, /* value for LOA of 4 */ AFB_SESSION_LOA_LE_0 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_0, /* check LOA <= 0 */ AFB_SESSION_LOA_LE_1 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_1, /* check LOA <= 1 */ @@ -207,6 +208,16 @@ static inline struct sd_bus *afb_daemon_get_system_bus(struct afb_daemon daemon) return daemon.itf->get_system_bus(daemon.closure); } +/* + * Broadcasts widely the event of 'name' with the data 'object'. + * 'object' can be NULL. + * 'daemon' MUST be the daemon given in interface when activating the plugin. + */ +static inline void afb_daemon_broadcast_event(struct afb_daemon daemon, const char *name, struct json_object *object) +{ + return afb_event_sender_push(afb_daemon_get_event_sender(daemon), name, object); +} + /* * Send a message described by 'fmt' and following parameters * to the journal for the verbosity 'level'. diff --git a/plugins/samples/HelloWorld.c b/plugins/samples/HelloWorld.c index 78a1eafd..fe117846 100644 --- a/plugins/samples/HelloWorld.c +++ b/plugins/samples/HelloWorld.c @@ -54,8 +54,8 @@ static void pingBug (struct afb_req request) static void pingEvent(struct afb_req request) { json_object *query = afb_req_json(request); - afb_event_sender_push(afb_daemon_get_event_sender(interface->daemon), "event", query); - ping(request, json_object_get(query), "event"); + afb_daemon_broadcast_event(interface->daemon, "event", json_object_get(query)); + ping(request, query, "event"); } diff --git a/plugins/samples/tic-tac-toe.c b/plugins/samples/tic-tac-toe.c index 79aaaf58..c372e99f 100644 --- a/plugins/samples/tic-tac-toe.c +++ b/plugins/samples/tic-tac-toe.c @@ -299,7 +299,7 @@ static void changed(struct board *board, const char *reason) waiter = next; } - afb_event_sender_push(afb_daemon_get_event_sender(afbitf->daemon), reason, description); + afb_daemon_broadcast_event(afbitf->daemon, reason, description); } /* @@ -586,7 +586,7 @@ static void wait(struct afb_req req) static const struct AFB_verb_desc_v1 plugin_verbs[] = { /* VERB'S NAME SESSION MANAGEMENT FUNCTION TO CALL SHORT DESCRIPTION */ { .name= "new", .session= AFB_SESSION_NONE, .callback= new, .info= "Starts a new game" }, - { .name= "play", .session= AFB_SESSION_NONE, .callback= play, .info= "Tells the server to play" }, + { .name= "play", .session= AFB_SESSION_NONE, .callback= play, .info= "Asks the server to play" }, { .name= "move", .session= AFB_SESSION_NONE, .callback= move, .info= "Tells the client move" }, { .name= "board", .session= AFB_SESSION_NONE, .callback= board, .info= "Get the current board" }, { .name= "level", .session= AFB_SESSION_NONE, .callback= level, .info= "Set the server level" }, -- cgit 1.2.3-korg From 13b6d9bb553e996f76bc5f9bb1d9f7094e0e104b Mon Sep 17 00:00:00 2001 From: José Bollo Date: Fri, 27 May 2016 23:07:19 +0200 Subject: removes restriction on the count of waiters MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit in fact, using more than on web socket, the same client (same session) can lock itself using wait and unlock itself using move... Change-Id: I4ebd8fa93d3373589e9bb7fac7c250e29f94c460 Signed-off-by: José Bollo --- plugins/samples/tic-tac-toe.c | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/plugins/samples/tic-tac-toe.c b/plugins/samples/tic-tac-toe.c index c372e99f..31682d94 100644 --- a/plugins/samples/tic-tac-toe.c +++ b/plugins/samples/tic-tac-toe.c @@ -549,7 +549,6 @@ static void play(struct afb_req req) static void wait(struct afb_req req) { - int count; struct board *board; struct waiter *waiter; @@ -557,21 +556,6 @@ static void wait(struct afb_req req) board = board_of_req(req); INFO(afbitf, "method 'wait' called for boardid %d", board->id); - /* counts the waiters */ - count = 0; - waiter = board->waiters; - while (waiter != NULL) { - count++; - waiter = waiter->next; - } - - /* checks ability to wait */ - if (count + 1 >= board->use_count) { - WARNING(afbitf, "can't wait: count=%d and use_count=%d", count, board->use_count); - afb_req_fail(req, "error", "can't wait"); - return; - } - /* creates the waiter and enqueues it */ waiter = calloc(1, sizeof *waiter); waiter->req = req; -- cgit 1.2.3-korg From eaab2fbbed4601415b5be052b39a0c0df11fdc38 Mon Sep 17 00:00:00 2001 From: José Bollo Date: Fri, 27 May 2016 23:43:24 +0200 Subject: improves documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: Ia86f95ee852ca0cc419b2fe6e796621e358c8b29 Signed-off-by: José Bollo --- doc/afb-plugin-writing.html | 145 +++++++++++++++++++++++++++++++++++++------ doc/afb-plugin-writing.md | 147 +++++++++++++++++++++++++++++++++++++------- include/afb/afb-plugin.h | 4 ++ include/afb/afb-req-itf.h | 16 +++++ 4 files changed, 271 insertions(+), 41 deletions(-) diff --git a/doc/afb-plugin-writing.html b/doc/afb-plugin-writing.html index 9873b626..20e25972 100644 --- a/doc/afb-plugin-writing.html +++ b/doc/afb-plugin-writing.html @@ -612,12 +612,20 @@ failure replies.

* The status of the reply is automatically set to "success". * Its send the object 'obj' (can be NULL) with an * informationnal comment 'info (can also be NULL). + * + * For conveniency, the function calls 'json_object_put' for 'obj'. + * Thus, in the case where 'obj' should remain available after + * the function returns, the function 'json_object_get' shall be used. */ void afb_req_success(struct afb_req req, struct json_object *obj, const char *info); /* * Same as 'afb_req_success' but the 'info' is a formatting * string followed by arguments. + * + * For conveniency, the function calls 'json_object_put' for 'obj'. + * Thus, in the case where 'obj' should remain available after + * the function returns, the function 'json_object_get' shall be used. */ void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...); @@ -633,16 +641,29 @@ void afb_req_success_f(struct afb_req req, struct json_object *obj, const char * * Note that calling afb_req_fail("success", info) is equivalent * to call afb_req_success(NULL, info). Thus even if possible it * is strongly recommanded to NEVER use "success" for status. + * + * For conveniency, the function calls 'json_object_put' for 'obj'. + * Thus, in the case where 'obj' should remain available after + * the function returns, the function 'json_object_get' shall be used. */ void afb_req_fail(struct afb_req req, const char *status, const char *info); /* * Same as 'afb_req_fail' but the 'info' is a formatting * string followed by arguments. + * + * For conveniency, the function calls 'json_object_put' for 'obj'. + * Thus, in the case where 'obj' should remain available after + * the function returns, the function 'json_object_get' shall be used. */ void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...); +

For conveniency, these functions call json_object_put to release the object obj +that they send. Then obj can not be used after calling one of these reply functions. +When it is not the expected behaviour, calling the function json_object_get on the object obj +before cancels the effect of json_object_put.

Getting argument of invocation

@@ -1245,10 +1266,19 @@ object that is transmitted with the event.

* Broadcasts widely the event of 'name' with the data 'object'. * 'object' can be NULL. * 'daemon' MUST be the daemon given in interface when activating the plugin. + * + * For conveniency, the function calls 'json_object_put' for 'object'. + * Thus, in the case where 'object' should remain available after + * the function returns, the function 'json_object_get' shall be used. */ void afb_daemon_broadcast_event(struct afb_daemon daemon, const char *name, struct json_object *object); +

Be aware, as for reply functions, the object is automatically released using +json_object_put by the function. Then call json_object_get before +calling afb_daemon_broadcast_event to keep object available +after the returning of the function.

In fact the event name received by the listener is prefixed with the name of the plugin. So when the change occurs after a move, the reason is move and then the clients receive the event tictactoe/move.

@@ -1261,31 +1291,106 @@ Thus it is safe to compare event using a case sensitive comparison.

Writing an asynchronous verb implementation

/ - * signals a change of the board - / -static void changed(struct board board, const char reason) +

The tic-tac-toe example allows two clients or more to share the same board. +This is implemented by the verb join that illustrated partly the how to +retrieve arguments.

+ +

When two or more clients are sharing a same board, one of them can wait +until the state of the board changes. (This coulded also be implemented using +events because an even is generated each time the board changes).

+ +

In this case, the reply to the wait is sent only when the board changes. +See the diagram below:

+ +

CLIENT A       CLIENT B         TIC-TAC-TOE
+   |              |                  |
+   +--------------|----------------->| wait . . . . . . . .
+   |              |                  |                     .
+   :              :                  :                      .
+   :              :                  :                      .
+   |              |                  |                      .
+   |              +----------------->| move . . .           .
+   |              |                  |          V           .
+   |              |<-----------------+ success of move      .
+   |              |                  |                    .
+   |<-------------|------------------+ success of wait  <
+

+ +

Here, this is an invocation of the plugin by an other client that +unblock the suspended wait call. +But in general, this will be a timer, a hardware event, the sync with +a concurrent process or thread, …

+ +

So the case is common, this is an asynchronous implementation.

+ +

Here is the listing of the function wait:

+ +

static void wait(struct afb_req req)
 {
-    struct waiter waiter, next;
-    struct json_object *description;
-
-/* get the description */
-description = describe(board);
-
-waiter = board->waiters;
-board->waiters = NULL;
-while (waiter != NULL) {
-        next = waiter->next;
-        afb_req_success(waiter->req, json_object_get(description), reason);
-        afb_req_unref(waiter->req);
-        free(waiter);
-        waiter = next;
+        struct board *board;
+        struct waiter *waiter;
+
+        /* retrieves the context for the session */
+        board = board_of_req(req);
+        INFO(afbitf, "method 'wait' called for boardid %d", board->id);
+
+        /* creates the waiter and enqueues it */
+        waiter = calloc(1, sizeof *waiter);
+        waiter->req = req;
+        waiter->next = board->waiters;
+        afb_req_addref(req);
+        board->waiters = waiter;
 }
+
+
+After retrieving the board, the function adds a new waiter to the
+current list of waiters and returns without sending a reply.
 
-afb_event_sender_push(afb_daemon_get_event_sender(afbitf->daemon), reason, description);
+Before returning, it increases the reference count of the
+request req using the function afb_req_addref.
+
+When the implentation of a verb returns without sending a reply,
+it MUST increment the reference count of the request
+using afb_req_addref. If it doesn’t bad things can happen.
+
+Later, when the board changes, it calls the function changed
+of tic-tac-toe with the reason of the change.
+
+Here is the full listing of the function changed:
+
+/*
+ * signals a change of the board
+ */
+static void changed(struct board *board, const char *reason)
+{
+        struct waiter *waiter, *next;
+        struct json_object *description;
+
+        /* get the description */
+        description = describe(board);
+
+        waiter = board->waiters;
+        board->waiters = NULL;
+        while (waiter != NULL) {
+                next = waiter->next;
+                afb_req_success(waiter->req, json_object_get(description), reason);
+                afb_req_unref(waiter->req);
+                free(waiter);
+                waiter = next;
+        }
+
+        afb_event_sender_push(afb_daemon_get_event_sender(afbitf->daemon), reason, description);
+}
 
 
-}
+The list of waiters is walked and a reply is sent to each waiter.
+After the sending the reply, the reference count of the request
+is decremented using afb_req_unref to allow its resources to be freed.
+
+The reference count MUST be decremented using afb_req_unref because,
+otherwise, there is a leak of resources.
+It must be decremented AFTER the sending of the reply, because, otherwise,
+bad things may happen.
 
 
 How to build a plugin
diff --git a/doc/afb-plugin-writing.md b/doc/afb-plugin-writing.md
index 7861021b..486b141d 100644
--- a/doc/afb-plugin-writing.md
+++ b/doc/afb-plugin-writing.md
@@ -501,12 +501,20 @@ The two functions to send a reply of kind "success" are
 	 * The status of the reply is automatically set to "success".
 	 * Its send the object 'obj' (can be NULL) with an
 	 * informationnal comment 'info (can also be NULL).
+	 *
+	 * For conveniency, the function calls 'json_object_put' for 'obj'.
+	 * Thus, in the case where 'obj' should remain available after
+	 * the function returns, the function 'json_object_get' shall be used.
 	 */
 	void afb_req_success(struct afb_req req, struct json_object *obj, const char *info);
 
 	/*
 	 * Same as 'afb_req_success' but the 'info' is a formatting
 	 * string followed by arguments.
+	 *
+	 * For conveniency, the function calls 'json_object_put' for 'obj'.
+	 * Thus, in the case where 'obj' should remain available after
+	 * the function returns, the function 'json_object_get' shall be used.
 	 */
 	void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...);
 
@@ -521,15 +529,28 @@ The two functions to send a reply of kind "failure" are
 	 * Note that calling afb_req_fail("success", info) is equivalent
 	 * to call afb_req_success(NULL, info). Thus even if possible it
 	 * is strongly recommanded to NEVER use "success" for status.
+	 *
+	 * For conveniency, the function calls 'json_object_put' for 'obj'.
+	 * Thus, in the case where 'obj' should remain available after
+	 * the function returns, the function 'json_object_get' shall be used.
 	 */
 	void afb_req_fail(struct afb_req req, const char *status, const char *info);
 
 	/*
 	 * Same as 'afb_req_fail' but the 'info' is a formatting
 	 * string followed by arguments.
+	 *
+	 * For conveniency, the function calls 'json_object_put' for 'obj'.
+	 * Thus, in the case where 'obj' should remain available after
+	 * the function returns, the function 'json_object_get' shall be used.
 	 */
 	void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...);
 
+> For conveniency, these functions call **json_object_put** to release the object **obj**
+> that they send. Then **obj** can not be used after calling one of these reply functions.
+> When it is not the expected behaviour, calling the function **json_object_get** on the object **obj**
+> before cancels the effect of **json_object_put**.
+
 Getting argument of invocation
 ------------------------------
 
@@ -968,9 +989,18 @@ The function **afb_daemon_broadcast_event** is defined as below:
 	 * Broadcasts widely the event of 'name' with the data 'object'.
 	 * 'object' can be NULL.
 	 * 'daemon' MUST be the daemon given in interface when activating the plugin.
+	 *
+	 * For conveniency, the function calls 'json_object_put' for 'object'.
+	 * Thus, in the case where 'object' should remain available after
+	 * the function returns, the function 'json_object_get' shall be used.
 	 */
 	void afb_daemon_broadcast_event(struct afb_daemon daemon, const char *name, struct json_object *object);
 
+> Be aware, as for reply functions, the **object** is automatically released using
+> **json_object_put** by the function. Then call **json_object_get** before
+> calling **afb_daemon_broadcast_event** to keep **object** available
+> after the returning of the function.
+
 In fact the event name received by the listener is prefixed with
 the name of the plugin. So when the change occurs after a move, the
 reason is **move** and then the clients receive the event **tictactoe/move**.
@@ -981,32 +1011,107 @@ reason is **move** and then the clients receive the event **tictactoe/move**.
 > Thus it is safe to compare event using a case sensitive comparison.
 
 
+
 Writing an asynchronous verb implementation
 -------------------------------------------
 
-/*
- * signals a change of the board
- */
-static void changed(struct board *board, const char *reason)
-{
-	struct waiter *waiter, *next;
-	struct json_object *description;
-
-	/* get the description */
-	description = describe(board);
-
-	waiter = board->waiters;
-	board->waiters = NULL;
-	while (waiter != NULL) {
-		next = waiter->next;
-		afb_req_success(waiter->req, json_object_get(description), reason);
-		afb_req_unref(waiter->req);
-		free(waiter);
-		waiter = next;
+The *tic-tac-toe* example allows two clients or more to share the same board.
+This is implemented by the verb **join** that illustrated partly the how to
+retrieve arguments.
+
+When two or more clients are sharing a same board, one of them can wait
+until the state of the board changes. (This coulded also be implemented using
+events because an even is generated each time the board changes).
+
+In this case, the reply to the wait is sent only when the board changes.
+See the diagram below:
+
+	CLIENT A       CLIENT B         TIC-TAC-TOE
+	   |              |                  |
+	   +--------------|----------------->| wait . . . . . . . .
+	   |              |                  |                     .
+	   :              :                  :                      .
+	   :              :                  :                      .
+	   |              |                  |                      .
+	   |              +----------------->| move . . .           .
+	   |              |                  |          V           .
+	   |              |<-----------------+ success of move      .
+	   |              |                  |                    .
+	   |<-------------|------------------+ success of wait  <
+
+Here, this is an invocation of the plugin by an other client that
+unblock the suspended *wait* call.
+But in general, this will be a timer, a hardware event, the sync with
+a concurrent process or thread, ...
+
+So the case is common, this is an asynchronous implementation.
+
+Here is the listing of the function **wait**:
+
+	static void wait(struct afb_req req)
+	{
+		struct board *board;
+		struct waiter *waiter;
+
+		/* retrieves the context for the session */
+		board = board_of_req(req);
+		INFO(afbitf, "method 'wait' called for boardid %d", board->id);
+
+		/* creates the waiter and enqueues it */
+		waiter = calloc(1, sizeof *waiter);
+		waiter->req = req;
+		waiter->next = board->waiters;
+		afb_req_addref(req);
+		board->waiters = waiter;
+	}
+
+After retrieving the board, the function adds a new waiter to the
+current list of waiters and returns without sending a reply.
+
+Before returning, it increases the reference count of the
+request **req** using the function **afb_req_addref**.
+
+> When the implentation of a verb returns without sending a reply,
+> it **MUST** increment the reference count of the request
+> using **afb_req_addref**. If it doesn't bad things can happen.
+
+Later, when the board changes, it calls the function **changed**
+of *tic-tac-toe* with the reason of the change.
+
+Here is the full listing of the function **changed**:
+
+	/*
+	 * signals a change of the board
+	 */
+	static void changed(struct board *board, const char *reason)
+	{
+		struct waiter *waiter, *next;
+		struct json_object *description;
+
+		/* get the description */
+		description = describe(board);
+
+		waiter = board->waiters;
+		board->waiters = NULL;
+		while (waiter != NULL) {
+			next = waiter->next;
+			afb_req_success(waiter->req, json_object_get(description), reason);
+			afb_req_unref(waiter->req);
+			free(waiter);
+			waiter = next;
+		}
+
+		afb_event_sender_push(afb_daemon_get_event_sender(afbitf->daemon), reason, description);
 	}
 
-	afb_event_sender_push(afb_daemon_get_event_sender(afbitf->daemon), reason, description);
-}
+The list of waiters is walked and a reply is sent to each waiter.
+After the sending the reply, the reference count of the request
+is decremented using **afb_req_unref** to allow its resources to be freed.
+
+> The reference count **MUST** be decremented using **afb_req_unref** because,
+> otherwise, there is a leak of resources.
+> It must be decremented **AFTER** the sending of the reply, because, otherwise,
+> bad things may happen.
 
 How to build a plugin
 ---------------------
diff --git a/include/afb/afb-plugin.h b/include/afb/afb-plugin.h
index 3d16c7ad..2b065b08 100644
--- a/include/afb/afb-plugin.h
+++ b/include/afb/afb-plugin.h
@@ -212,6 +212,10 @@ static inline struct sd_bus *afb_daemon_get_system_bus(struct afb_daemon daemon)
  * Broadcasts widely the event of 'name' with the data 'object'.
  * 'object' can be NULL.
  * 'daemon' MUST be the daemon given in interface when activating the plugin.
+ *
+ * For conveniency, the function calls 'json_object_put' for 'object'.
+ * Thus, in the case where 'object' should remain available after
+ * the function returns, the function 'json_object_get' shall be used.
  */
 static inline void afb_daemon_broadcast_event(struct afb_daemon daemon, const char *name, struct json_object *object)
 {
diff --git a/include/afb/afb-req-itf.h b/include/afb/afb-req-itf.h
index 5767c853..f4fab551 100644
--- a/include/afb/afb-req-itf.h
+++ b/include/afb/afb-req-itf.h
@@ -130,6 +130,10 @@ static inline struct json_object *afb_req_json(struct afb_req req)
  * The status of the reply is automatically set to "success".
  * Its send the object 'obj' (can be NULL) with an
  * informationnal comment 'info (can also be NULL).
+ *
+ * For conveniency, the function calls 'json_object_put' for 'obj'.
+ * Thus, in the case where 'obj' should remain available after
+ * the function returns, the function 'json_object_get' shall be used.
  */
 static inline void afb_req_success(struct afb_req req, struct json_object *obj, const char *info)
 {
@@ -139,6 +143,10 @@ static inline void afb_req_success(struct afb_req req, struct json_object *obj,
 /*
  * Same as 'afb_req_success' but the 'info' is a formatting
  * string followed by arguments.
+ *
+ * For conveniency, the function calls 'json_object_put' for 'obj'.
+ * Thus, in the case where 'obj' should remain available after
+ * the function returns, the function 'json_object_get' shall be used.
  */
 static inline void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...)
 {
@@ -160,6 +168,10 @@ static inline void afb_req_success_f(struct afb_req req, struct json_object *obj
  * Note that calling afb_req_fail("success", info) is equivalent
  * to call afb_req_success(NULL, info). Thus even if possible it
  * is strongly recommanded to NEVER use "success" for status.
+ *
+ * For conveniency, the function calls 'json_object_put' for 'obj'.
+ * Thus, in the case where 'obj' should remain available after
+ * the function returns, the function 'json_object_get' shall be used.
  */
 static inline void afb_req_fail(struct afb_req req, const char *status, const char *info)
 {
@@ -169,6 +181,10 @@ static inline void afb_req_fail(struct afb_req req, const char *status, const ch
 /*
  * Same as 'afb_req_fail' but the 'info' is a formatting
  * string followed by arguments.
+ *
+ * For conveniency, the function calls 'json_object_put' for 'obj'.
+ * Thus, in the case where 'obj' should remain available after
+ * the function returns, the function 'json_object_get' shall be used.
  */
 static inline void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...)
 {
-- 
cgit 1.2.3-korg