Add comment for bindings v2
[src/app-framework-binder.git] / include / afb / afb-binding-v2.h
index b949a2d..68e6f78 100644 (file)
 
 #include <stdint.h>
 
-#include "afb-session-v2.h"
+#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 afb_service;
-struct afb_daemon;
-struct afb_binding_v2;
+#include "afb-req-v2.h"
+#include "afb-session-v2.h"
 
 struct json_object;
 
-/*
- * A binding V2 MUST have two exported symbols of name:
- *
- *            -  afbBindingV2
- *            -  afbBindingV2verbosity
- *
- */
-extern const struct afb_binding_v2 afbBindingV2;
-extern int afbBindingV2verbosity;
-
 /*
  * Description of one verb of the API provided by the binding
  * This enumeration is valid for bindings of type version 2
@@ -57,57 +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);
-       unsigned concurrent: 1;                 /* allows concurrent requests to verbs */
+       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
 
-#if AFB_BINDING_VERSION == 2
+#include "afb-daemon-v2.h"
+#include "afb-service-v2.h"
 
-# define afb_binding           afb_binding_v2
-# define afb_binding_interface afb_binding_interface_v2
-
-# define AFB_SESSION_NONE      AFB_SESSION_NONE_V2
-# define AFB_SESSION_CLOSE     AFB_SESSION_CLOSE_V2
-# define AFB_SESSION_RENEW     AFB_SESSION_REFRESH_V2
-# define AFB_SESSION_REFRESH   AFB_SESSION_REFRESH_V2
-# define AFB_SESSION_CHECK     AFB_SESSION_CHECK_V2
-
-# define AFB_SESSION_LOA_MASK  AFB_SESSION_LOA_MASK_V2
-
-# define AFB_SESSION_LOA_0     AFB_SESSION_LOA_0_V2
-# define AFB_SESSION_LOA_1     AFB_SESSION_LOA_1_V2
-# define AFB_SESSION_LOA_2     AFB_SESSION_LOA_2_V2
-# define AFB_SESSION_LOA_3     AFB_SESSION_LOA_3_V2
-
-# if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO)
-
-#  define ERROR                        AFB_ERROR_V2
-#  define WARNING              AFB_WARNING_V2
-#  define NOTICE               AFB_NOTICE_V2
-#  define INFO                 AFB_INFO_V2
-#  define DEBUG                        AFB_DEBUG_V2
-
-# endif
-
-#endif