summaryrefslogtreecommitdiffstats
path: root/include/afb
diff options
context:
space:
mode:
authorJosé Bollo <jose.bollo@iot.bzh>2016-05-27 22:18:26 +0200
committerJosé Bollo <jose.bollo@iot.bzh>2016-05-27 22:18:26 +0200
commitd96d0533b8326570db57d13b8f808bc62d1a7fa4 (patch)
treedeee50d324e9b8a44f832f4ac77370cee2e42e61 /include/afb
parentb81bab801d1a39cce7254b0c056d991412ec4331 (diff)
improves documentation
Change-Id: Idbd1b735571c2e35daed23d43f8d5d3990881533 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'include/afb')
-rw-r--r--include/afb/afb-plugin.h21
1 files changed, 16 insertions, 5 deletions
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 */
@@ -208,6 +209,16 @@ 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.
+ */
+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'.
* 'file' and 'line' are indicators of position of the code in source files.