X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Fafb%2Fafb-plugin.h;h=85e8de7ebe8ac0060bf75f315f9956e6401a88e8;hb=b69290c369ba67ee804bc5a0a440210c0e5d37a3;hp=81df3a8f05bfef620cd4e9749e25cbea0ec0e16d;hpb=44eccb2c9d6f8dde8059cf75305d04992ae9feb7;p=src%2Fapp-framework-binder.git diff --git a/include/afb/afb-plugin.h b/include/afb/afb-plugin.h index 81df3a8f..85e8de7e 100644 --- a/include/afb/afb-plugin.h +++ b/include/afb/afb-plugin.h @@ -38,8 +38,8 @@ * Some function of the library are exported to afb-daemon. */ +#include #include -#include /* * Definition of the versions of the plugin. @@ -51,28 +51,29 @@ 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_CLOSE = 2, /* closes the session after authentification */ - AFB_SESSION_RENEW = 4, /* refreshes the token after authentification */ - AFB_SESSION_CHECK = 8, /* enforce 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 */ AFB_SESSION_LOA_LE = 32, /* check that the LOA is lesser or equal to the given value */ 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 */ @@ -140,11 +141,12 @@ struct sd_bus; * Definition of the facilities provided by the daemon. */ struct afb_daemon_itf { - struct afb_event_sender (*get_event_sender)(void *closure); /* get the event manager */ - struct sd_event *(*get_event_loop)(void *closure); /* get the common systemd's event loop */ - struct sd_bus *(*get_user_bus)(void *closure); /* get the common systemd's user d-bus */ - struct sd_bus *(*get_system_bus)(void *closure); /* get the common systemd's system d-bus */ + int (*event_broadcast)(void *closure, const char *name, struct json_object *object); /* broadcasts evant 'name' with 'object' */ + struct sd_event *(*get_event_loop)(void *closure); /* gets the common systemd's event loop */ + struct sd_bus *(*get_user_bus)(void *closure); /* gets the common systemd's user d-bus */ + struct sd_bus *(*get_system_bus)(void *closure); /* gets the common systemd's system d-bus */ void (*vverbose)(void*closure, int level, const char *file, int line, const char *fmt, va_list args); + struct afb_event (*event_make)(void *closure, const char *name); /* creates an event of 'name' */ }; /* @@ -171,15 +173,6 @@ struct AFB_interface */ extern const struct AFB_plugin *pluginAfbV1Register (const struct AFB_interface *interface); -/* - * Retrieves the event sender of AFB - * 'daemon' MUST be the daemon given in interface when activating the plugin. - */ -static inline struct afb_event_sender afb_daemon_get_event_sender(struct afb_daemon daemon) -{ - return daemon.itf->get_event_sender(daemon.closure); -} - /* * Retrieves the common systemd's event loop of AFB * 'daemon' MUST be the daemon given in interface when activating the plugin. @@ -207,6 +200,31 @@ 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. + * + * 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. + * + * Returns the count of clients that received the event. + */ +static inline int afb_daemon_broadcast_event(struct afb_daemon daemon, const char *name, struct json_object *object) +{ + return daemon.itf->event_broadcast(daemon.closure, name, object); +} + +/* + * Creates an event of 'name' and returns it. + * 'daemon' MUST be the daemon given in interface when activating the plugin. + */ +static inline struct afb_event afb_daemon_make_event(struct afb_daemon daemon, const char *name) +{ + return daemon.itf->event_make(daemon.closure, name); +} + /* * Send a message described by 'fmt' and following parameters * to the journal for the verbosity 'level'. @@ -222,10 +240,22 @@ static inline void afb_daemon_verbose(struct afb_daemon daemon, int level, const va_end(args); } +/* + * Macros for logging messages + */ #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 +