summaryrefslogtreecommitdiffstats
path: root/include/afb/afb-binding.h
diff options
context:
space:
mode:
authorJosé Bollo <jose.bollo@iot.bzh>2016-09-19 10:54:42 +0200
committerJosé Bollo <jose.bollo@iot.bzh>2016-09-20 14:39:50 +0200
commitc9bb1cec405741d5721dfcafb35b187c6f182a6f (patch)
tree134521beaae17dd2e63462a573bed59e83a3a142 /include/afb/afb-binding.h
parentda7789182cd0a7180bf7057d310cf9ad1cd75fe3 (diff)
Documentation: improvements
- improves formatting of the documentation on events - add documentations of functions in headers Change-Id: Ie39d34fca8bd563a099f6b575c72e314ca08a29d Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'include/afb/afb-binding.h')
-rw-r--r--include/afb/afb-binding.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/include/afb/afb-binding.h b/include/afb/afb-binding.h
index 7d5da112..43075df1 100644
--- a/include/afb/afb-binding.h
+++ b/include/afb/afb-binding.h
@@ -172,6 +172,23 @@ struct afb_binding_interface
/*
* Function for registering the binding
+ *
+ * A binding V1 MUST have a function of this name and signature.
+ * This function is called during loading of the binding. It
+ * receives an 'interface' that should be recorded for later access to
+ * functions provided by the framework.
+ *
+ * This function MUST return the address of a structure that describes
+ * the binding and its implemented verbs.
+ *
+ * In case of initialisation error, NULL must be returned.
+ *
+ * Be aware that the given 'interface' is not fully functionnal
+ * because no provision is given to the name and description
+ * of the binding. Check the function 'afbBindingV1ServiceInit'
+ * defined in the file <afb/afb-service-itf.h> because when
+ * the function 'afbBindingV1ServiceInit' is called, the 'interface'
+ * is fully functionnal.
*/
extern const struct afb_binding *afbBindingV1Register (const struct afb_binding_interface *interface);