Add comment for bindings v2
[src/app-framework-binder.git] / include / afb / afb-binding-v2.h
index 80e2385..68e6f78 100644 (file)
 
 #include <stdint.h>
 
-struct afb_service;
-struct afb_daemon;
-struct afb_binding_v2;
+#include "afb-auth.h"
+#include "afb-event-itf.h"
+#include "afb-req-common.h"
+#include "afb-service-common.h"
+#include "afb-daemon-common.h"
 
-struct json_object;
+#include "afb-req-v2.h"
+#include "afb-session-v2.h"
 
-/*
- * A binding V2 MUST have two exported symbols of name:
- *
- *            -  afbBindingV2
- *            -  afbBindingV2verbosity
- *
- */
-extern const struct afb_binding_v2 afbBindingV2;
-extern int afbBindingV2verbosity;
+struct json_object;
 
 /*
  * Description of one verb of the API provided by the binding
@@ -43,7 +38,7 @@ struct afb_verb_v2
 {
        const char *verb;                       /* name of the verb */
        void (*callback)(struct afb_req req);   /* callback function implementing the verb */
-       struct afb_auth *auth;                  /* required authorisation */
+       const struct afb_auth *auth;            /* required authorisation */
        uint32_t session;                       /* authorisation and session requirements of the verb */
 };
 
@@ -55,26 +50,82 @@ struct afb_binding_v2
        const char *api;                        /* api name for the binding */
        const char *specification;              /* textual specification of the binding */
        const struct afb_verb_v2 *verbs;        /* array of descriptions of verbs terminated by a NULL name */
-       int (*init)(struct afb_daemon daemon);
-       int (*start)(struct afb_service service);
-       void (*onevent)(struct afb_service service, const char *event, struct json_object *object);
+       int (*preinit)();                       /* callback at load of the binding */
+       int (*init)();                          /* callback for starting the service */
+       void (*onevent)(const char *event, struct json_object *object); /* callback for handling events */
+       unsigned noconcurrency: 1;              /* avoids concurrent requests to verbs */
 };
 
+struct afb_binding_data_v2
+{
+       int verbosity;                  /* level of verbosity */
+       struct afb_daemon daemon;       /* access to daemon APIs */
+       struct afb_service service;     /* access to service APIs */
+};
+
+/*
+ * A binding V2 MUST have two exported symbols of name:
+ *
+ *            -  afbBindingV2
+ *            -  afbBindingV2data
+ *
+ */
+#if !defined(AFB_BINDING_MAIN_NAME_V2)
+extern const struct afb_binding_v2 afbBindingV2;
+#endif
+
+#if !defined(AFB_BINDING_DATA_NAME_V2)
+#define AFB_BINDING_DATA_NAME_V2 afbBindingV2data
+#endif
+
+#if AFB_BINDING_VERSION != 2
+extern
+#endif
+struct afb_binding_data_v2 AFB_BINDING_DATA_NAME_V2  __attribute__ ((weak));
+
+#define afb_get_verbosity_v2() (AFB_BINDING_DATA_NAME_V2.verbosity)
+#define afb_get_daemon_v2()    (AFB_BINDING_DATA_NAME_V2.daemon)
+#define afb_get_service_v2()   (AFB_BINDING_DATA_NAME_V2.service)
+
 /*
  * Macros for logging messages
  */
 #if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO)
 # if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_DETAILS)
-#  define AFB_ERROR_V2(daemon,...)   do{if(afbBindingV2verbosity>=0)afb_daemon_verbose(daemon,3,__FILE__,__LINE__,__VA_ARGS__);}while(0)
-#  define AFB_WARNING_V2(daemon,...) do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,4,__FILE__,__LINE__,__VA_ARGS__);}while(0)
-#  define AFB_NOTICE_V2(daemon,...)  do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,5,__FILE__,__LINE__,__VA_ARGS__);}while(0)
-#  define AFB_INFO_V2(daemon,...)    do{if(afbBindingV2verbosity>=2)afb_daemon_verbose(daemon,6,__FILE__,__LINE__,__VA_ARGS__);}while(0)
-#  define AFB_DEBUG_V2(daemon,...)   do{if(afbBindingV2verbosity>=3)afb_daemon_verbose(daemon,7,__FILE__,__LINE__,__VA_ARGS__);}while(0)
+#  define _AFB_LOGGING_V2_(vlevel,llevel,...) \
+       do{ \
+               if(AFB_BINDING_DATA_NAME_V2.verbosity>=vlevel) \
+                       afb_daemon_verbose_v2(llevel,__FILE__,__LINE__,__func__,__VA_ARGS__); \
+       }while(0)
+#  define _AFB_REQ_LOGGING_V2_(vlevel,llevel,req,...) \
+       do{ \
+               if(AFB_BINDING_DATA_NAME_V2.verbosity>=vlevel) \
+                       afb_req_verbose(req,llevel,__FILE__,__LINE__,__func__,__VA_ARGS__); \
+       }while(0)
 # else
-#  define AFB_ERROR_V2(daemon,...)   do{if(afbBindingV2verbosity>=0)afb_daemon_verbose(daemon,3,NULL,0,__VA_ARGS__);}while(0)
-#  define AFB_WARNING_V2(daemon,...) do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,4,NULL,0,__VA_ARGS__);}while(0)
-#  define AFB_NOTICE_V2(daemon,...)  do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,5,NULL,0,__VA_ARGS__);}while(0)
-#  define AFB_INFO_V2(daemon,...)    do{if(afbBindingV2verbosity>=2)afb_daemon_verbose(daemon,6,NULL,0,__VA_ARGS__);}while(0)
-#  define AFB_DEBUG_V2(daemon,...)   do{if(afbBindingV2verbosity>=3)afb_daemon_verbose(daemon,7,NULL,0,__VA_ARGS__);}while(0)
+#  define _AFB_LOGGING_V2_(vlevel,llevel,...) \
+       do{ \
+               if(afbBindingV2data.verbosity>=vlevel) \
+                       afb_daemon_verbose_v2(llevel,NULL,0,NULL,__VA_ARGS__); \
+       }while(0)
+#  define _AFB_REQ_LOGGING_V2_(vlevel,llevel,req,...) \
+       do{ \
+               if(AFB_BINDING_DATA_NAME_V2.verbosity>=vlevel) \
+                       afb_req_verbose(req,llevel,NULL,0,NULL,__VA_ARGS__); \
+       }while(0)
 # endif
+# define AFB_ERROR_V2(...)       _AFB_LOGGING_V2_(0,3,__VA_ARGS__)
+# define AFB_WARNING_V2(...)     _AFB_LOGGING_V2_(1,4,__VA_ARGS__)
+# define AFB_NOTICE_V2(...)      _AFB_LOGGING_V2_(1,5,__VA_ARGS__)
+# define AFB_INFO_V2(...)        _AFB_LOGGING_V2_(2,6,__VA_ARGS__)
+# define AFB_DEBUG_V2(...)       _AFB_LOGGING_V2_(3,7,__VA_ARGS__)
+# define AFB_REQ_ERROR_V2(...)   _AFB_REQ_LOGGING_V2_(0,3,__VA_ARGS__)
+# define AFB_REQ_WARNING_V2(...) _AFB_REQ_LOGGING_V2_(1,4,__VA_ARGS__)
+# define AFB_REQ_NOTICE_V2(...)  _AFB_REQ_LOGGING_V2_(1,5,__VA_ARGS__)
+# define AFB_REQ_INFO_V2(...)    _AFB_REQ_LOGGING_V2_(2,6,__VA_ARGS__)
+# define AFB_REQ_DEBUG_V2(...)   _AFB_REQ_LOGGING_V2_(3,7,__VA_ARGS__)
 #endif
+
+#include "afb-daemon-v2.h"
+#include "afb-service-v2.h"
+