X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Fafb%2Fafb-binding-v2.h;h=c7d16a7bbdc81786bb17785143ecbdde29a8f5ae;hb=65353dce81a629e042800bb7b86fcd869a76727e;hp=e0ade91a62bcce6a04005266d079ad3b5b8158ef;hpb=7f4444176bd6efaa5e189a148351bab5a72c2853;p=src%2Fapp-framework-binder.git diff --git a/include/afb/afb-binding-v2.h b/include/afb/afb-binding-v2.h index e0ade91a..c7d16a7b 100644 --- a/include/afb/afb-binding-v2.h +++ b/include/afb/afb-binding-v2.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016, 2017 "IoT.bzh" + * Copyright (C) 2015-2020 "IoT.bzh" * Author: José Bollo * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -17,137 +17,156 @@ #pragma once -#include +/******************************************************************************/ +#include "afb-verbosity.h" #include "afb-auth.h" -#include "afb-event.h" -#include "afb-req.h" -#include "afb-service-itf.h" -#include "afb-daemon-itf.h" +#include "afb-event-x1.h" +#include "afb-req-x1.h" +#include "afb-service-itf-x1.h" +#include "afb-daemon-itf-x1.h" #include "afb-req-v2.h" -#include "afb-session-v2.h" +#include "afb-session-x2.h" -struct json_object; +/******************************************************************************/ -/* - * Description of one verb of the API provided by the binding - * This enumeration is valid for bindings of type version 2 +/** + * @deprecated use bindings version 3 + * + * Description of one verb as provided for binding API version 2 */ struct afb_verb_v2 { - const char *verb; /* name of the verb, NULL only at end of the array */ - void (*callback)(struct afb_req req); /* callback function implementing the verb */ - const struct afb_auth *auth; /* required authorisation, can be NULL */ - const char *info; /* some info about the verb, can be NULL */ - uint32_t session; /* authorisation and session requirements of the verb */ + const char *verb; /**< name of the verb, NULL only at end of the array */ + void (*callback)(struct afb_req_x1 req);/**< callback function implementing the verb */ + const struct afb_auth *auth; /**< required authorisation, can be NULL */ + const char *info; /**< some info about the verb, can be NULL */ + uint32_t session; /**< authorisation and session requirements of the verb */ }; -/* +/** + * @deprecated use bindings version 3 + * * Description of the bindings of type version 2 */ struct afb_binding_v2 { - const char *api; /* api name for the binding */ - const char *specification; /* textual specification of the binding, can be NULL */ - const char *info; /* some info about the api, can be NULL */ - const struct afb_verb_v2 *verbs; /* array of descriptions of verbs terminated by a NULL name */ - 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 */ + const char *api; /**< api name for the binding */ + const char *specification; /**< textual specification of the binding, can be NULL */ + const char *info; /**< some info about the api, can be NULL */ + const struct afb_verb_v2 *verbs; /**< array of descriptions of verbs terminated by a NULL name */ + 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 */ }; +/** + * @deprecated use bindings version 3 + * + * structure for the global data of the binding + */ 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 */ + int verbosity; /**< level of verbosity */ + struct afb_daemon_x1 daemon; /**< access to daemon APIs */ + struct afb_service_x1 service; /**< access to service APIs */ }; -/* +/** + * @page validity-v2 Validity of a binding v2 + * * A binding V2 MUST have two exported symbols of name: * - * - afbBindingV2 - * - afbBindingV2data + * - @ref afbBindingV2 + * - @ref afbBindingV2data + */ + +/** + * @deprecated use bindings version 3 * + * The global mandatory description of the binding */ #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 - +/** + * @deprecated use bindings version 3 + * + * The global auto declared internal data of the binding + */ #if AFB_BINDING_VERSION != 2 extern #endif -struct afb_binding_data_v2 AFB_BINDING_DATA_NAME_V2 __attribute__ ((weak)); +struct afb_binding_data_v2 afbBindingV2data __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) +#define afb_get_verbosity_v2() (afbBindingV2data.verbosity) +#define afb_get_daemon_v2() (afbBindingV2data.daemon) +#define afb_get_service_v2() (afbBindingV2data.service) +/******************************************************************************/ /* * Macros for logging messages */ #if defined(AFB_BINDING_PRAGMA_NO_VERBOSE_DATA) -# define _AFB_LOGGING_V2_(vlevel,llevel,...) \ - do{ \ - if(AFB_BINDING_DATA_NAME_V2.verbosity>=vlevel) {\ - if (llevel <= AFB_VERBOSITY_LEVEL_ERROR) \ - afb_daemon_verbose_v2(llevel,__FILE__,__LINE__,__func__,__VA_ARGS__); \ - else \ - afb_daemon_verbose_v2(llevel,__FILE__,__LINE__,NULL,NULL); \ - } \ - }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__,NULL,NULL); \ - }while(0) +#define AFB_VERBOSE_V2(level,...) \ + do { if(level <= AFB_VERBOSITY_LEVEL_ERROR) \ + afb_daemon_verbose_v2(level,__FILE__,__LINE__,NULL,__VA_ARGS__); \ + else afb_daemon_verbose_v2(level,__FILE__,__LINE__,NULL); } while(0) + +#define AFB_REQ_VERBOSE_V2(req,level,...) \ + do { if(level <= AFB_VERBOSITY_LEVEL_ERROR) \ + afb_req_x1_verbose(req,level,__FILE__,__LINE__,NULL,__VA_ARGS__); \ + else afb_req_x1_verbose(req,level,__FILE__,__LINE__,NULL); } while(0) #elif defined(AFB_BINDING_PRAGMA_NO_VERBOSE_DETAILS) -# define _AFB_LOGGING_V2_(vlevel,llevel,...) \ - do{ \ - if(AFB_BINDING_DATA_NAME_V2.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) +#define AFB_VERBOSE_V2(level,...) \ + afb_daemon_verbose_v2(level,NULL,0,NULL,__VA_ARGS__) + +#define AFB_REQ_VERBOSE_V2(req,level,...) \ + afb_req_x1_verbose(req,level,NULL,0,NULL,__VA_ARGS__) #else -# 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) +#define AFB_VERBOSE_V2(level,...) \ + afb_daemon_verbose_v2(level,__FILE__,__LINE__,__func__,__VA_ARGS__) + +#define AFB_REQ_VERBOSE_V2(req,level,...) \ + afb_req_x1_verbose(req,level,__FILE__,__LINE__,__func__,__VA_ARGS__) #endif -#include "afb-verbosity.h" -#define AFB_ERROR_V2(...) _AFB_LOGGING_V2_(AFB_VERBOSITY_LEVEL_ERROR,_AFB_SYSLOG_LEVEL_ERROR_,__VA_ARGS__) -#define AFB_WARNING_V2(...) _AFB_LOGGING_V2_(AFB_VERBOSITY_LEVEL_WARNING,_AFB_SYSLOG_LEVEL_WARNING_,__VA_ARGS__) -#define AFB_NOTICE_V2(...) _AFB_LOGGING_V2_(AFB_VERBOSITY_LEVEL_NOTICE,_AFB_SYSLOG_LEVEL_NOTICE_,__VA_ARGS__) -#define AFB_INFO_V2(...) _AFB_LOGGING_V2_(AFB_VERBOSITY_LEVEL_INFO,_AFB_SYSLOG_LEVEL_INFO_,__VA_ARGS__) -#define AFB_DEBUG_V2(...) _AFB_LOGGING_V2_(AFB_VERBOSITY_LEVEL_DEBUG,_AFB_SYSLOG_LEVEL_DEBUG_,__VA_ARGS__) -#define AFB_REQ_ERROR_V2(...) _AFB_REQ_LOGGING_V2_(AFB_VERBOSITY_LEVEL_ERROR,_AFB_SYSLOG_LEVEL_ERROR_,__VA_ARGS__) -#define AFB_REQ_WARNING_V2(...) _AFB_REQ_LOGGING_V2_(AFB_VERBOSITY_LEVEL_WARNING,_AFB_SYSLOG_LEVEL_WARNING_,__VA_ARGS__) -#define AFB_REQ_NOTICE_V2(...) _AFB_REQ_LOGGING_V2_(AFB_VERBOSITY_LEVEL_NOTICE,_AFB_SYSLOG_LEVEL_NOTICE_,__VA_ARGS__) -#define AFB_REQ_INFO_V2(...) _AFB_REQ_LOGGING_V2_(AFB_VERBOSITY_LEVEL_INFO,_AFB_SYSLOG_LEVEL_INFO_,__VA_ARGS__) -#define AFB_REQ_DEBUG_V2(...) _AFB_REQ_LOGGING_V2_(AFB_VERBOSITY_LEVEL_DEBUG,_AFB_SYSLOG_LEVEL_DEBUG_,__VA_ARGS__) +#define _AFB_LOGGING_V2_(vlevel,llevel,...) \ + do{ if(afb_get_verbosity_v2()>=vlevel) AFB_VERBOSE_V2(llevel,__VA_ARGS__); } while(0) +#define _AFB_REQ_LOGGING_V2_(vlevel,llevel,req,...) \ + do{ if(afb_get_verbosity_v2()>=vlevel) AFB_REQ_VERBOSE_V2(req,llevel,__VA_ARGS__); } while(0) + +#define AFB_ERROR_V2(...) _AFB_LOGGING_V2_(AFB_VERBOSITY_LEVEL_ERROR,AFB_SYSLOG_LEVEL_ERROR,__VA_ARGS__) +#define AFB_WARNING_V2(...) _AFB_LOGGING_V2_(AFB_VERBOSITY_LEVEL_WARNING,AFB_SYSLOG_LEVEL_WARNING,__VA_ARGS__) +#define AFB_NOTICE_V2(...) _AFB_LOGGING_V2_(AFB_VERBOSITY_LEVEL_NOTICE,AFB_SYSLOG_LEVEL_NOTICE,__VA_ARGS__) +#define AFB_INFO_V2(...) _AFB_LOGGING_V2_(AFB_VERBOSITY_LEVEL_INFO,AFB_SYSLOG_LEVEL_INFO,__VA_ARGS__) +#define AFB_DEBUG_V2(...) _AFB_LOGGING_V2_(AFB_VERBOSITY_LEVEL_DEBUG,AFB_SYSLOG_LEVEL_DEBUG,__VA_ARGS__) +#define AFB_REQ_ERROR_V2(...) _AFB_REQ_LOGGING_V2_(AFB_VERBOSITY_LEVEL_ERROR,AFB_SYSLOG_LEVEL_ERROR,__VA_ARGS__) +#define AFB_REQ_WARNING_V2(...) _AFB_REQ_LOGGING_V2_(AFB_VERBOSITY_LEVEL_WARNING,AFB_SYSLOG_LEVEL_WARNING,__VA_ARGS__) +#define AFB_REQ_NOTICE_V2(...) _AFB_REQ_LOGGING_V2_(AFB_VERBOSITY_LEVEL_NOTICE,AFB_SYSLOG_LEVEL_NOTICE,__VA_ARGS__) +#define AFB_REQ_INFO_V2(...) _AFB_REQ_LOGGING_V2_(AFB_VERBOSITY_LEVEL_INFO,AFB_SYSLOG_LEVEL_INFO,__VA_ARGS__) +#define AFB_REQ_DEBUG_V2(...) _AFB_REQ_LOGGING_V2_(AFB_VERBOSITY_LEVEL_DEBUG,AFB_SYSLOG_LEVEL_DEBUG,__VA_ARGS__) + +/******************************************************************************/ + +#if 0 && AFB_BINDING_VERSION >= 2 + +# define afb_verbose_error() (afb_get_verbosity() >= AFB_VERBOSITY_LEVEL_ERROR) +# define afb_verbose_warning() (afb_get_verbosity() >= AFB_VERBOSITY_LEVEL_WARNING) +# define afb_verbose_notice() (afb_get_verbosity() >= AFB_VERBOSITY_LEVEL_NOTICE) +# define afb_verbose_info() (afb_get_verbosity() >= AFB_VERBOSITY_LEVEL_INFO) +# define afb_verbose_debug() (afb_get_verbosity() >= AFB_VERBOSITY_LEVEL_DEBUG) + +#endif #include "afb-daemon-v2.h" #include "afb-service-v2.h"