include/afb/afb-binding-v2.h

   1 /*
   2  * Copyright (C) 2016, 2017 "IoT.bzh"
   3  * Author: José Bollo <jose.bollo@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #pragma once
  19
  20 #include <stdint.h>
  21
  22 #include "afb-auth.h"
  23 #include "afb-event-itf.h"
  24 #include "afb-req-common.h"
  25 #include "afb-service-common.h"
  26 #include "afb-daemon-common.h"
  27
  28 #include "afb-req-v2.h"
  29 #include "afb-session-v2.h"
  30
  31 struct json_object;
  32
  33 /*
  34  * Description of one verb of the API provided by the binding
  35  * This enumeration is valid for bindings of type version 2
  36  */
  37 struct afb_verb_v2
  38 {
  39         const char *verb;                       /* name of the verb */
  40         void (*callback)(struct afb_req req);   /* callback function implementing the verb */
  41         const struct afb_auth *auth;            /* required authorisation */
  42         uint32_t session;                       /* authorisation and session requirements of the verb */
  43 };
  44
  45 /*
  46  * Description of the bindings of type version 2
  47  */
  48 struct afb_binding_v2
  49 {
  50         const char *api;                        /* api name for the binding */
  51         const char *specification;              /* textual specification of the binding */
  52         const struct afb_verb_v2 *verbs;        /* array of descriptions of verbs terminated by a NULL name */
  53         int (*preinit)();                       /* callback at load of the binding */
  54         int (*init)();                          /* callback for starting the service */
  55         void (*onevent)(const char *event, struct json_object *object); /* callback for handling events */
  56         unsigned noconcurrency: 1;              /* avoids concurrent requests to verbs */
  57 };
  58
  59 struct afb_binding_data_v2
  60 {
  61         int verbosity;                  /* level of verbosity */
  62         struct afb_daemon daemon;       /* access to daemon APIs */
  63         struct afb_service service;     /* access to service APIs */
  64 };
  65
  66 /*
  67  * A binding V2 MUST have two exported symbols of name:
  68  *
  69  *            -  afbBindingV2
  70  *            -  afbBindingV2data
  71  *
  72  */
  73 #if !defined(AFB_BINDING_MAIN_NAME_V2)
  74 extern const struct afb_binding_v2 afbBindingV2;
  75 #endif
  76
  77 #if !defined(AFB_BINDING_DATA_NAME_V2)
  78 #define AFB_BINDING_DATA_NAME_V2 afbBindingV2data
  79 #endif
  80
  81 #if AFB_BINDING_VERSION != 2
  82 extern
  83 #endif
  84 struct afb_binding_data_v2 AFB_BINDING_DATA_NAME_V2  __attribute__ ((weak));
  85
  86 #define afb_get_verbosity_v2()  (AFB_BINDING_DATA_NAME_V2.verbosity)
  87 #define afb_get_daemon_v2()     (AFB_BINDING_DATA_NAME_V2.daemon)
  88 #define afb_get_service_v2()    (AFB_BINDING_DATA_NAME_V2.service)
  89
  90 /*
  91  * Macros for logging messages
  92  */
  93 #if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO)
  94 # if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_DETAILS)
  95 #  define _AFB_LOGGING_V2_(vlevel,llevel,...) \
  96         do{ \
  97                 if(AFB_BINDING_DATA_NAME_V2.verbosity>=vlevel) \
  98                         afb_daemon_verbose_v2(llevel,__FILE__,__LINE__,__func__,__VA_ARGS__); \
  99         }while(0)
 100 #  define _AFB_REQ_LOGGING_V2_(vlevel,llevel,req,...) \
 101         do{ \
 102                 if(AFB_BINDING_DATA_NAME_V2.verbosity>=vlevel) \
 103                         afb_req_verbose(req,llevel,__FILE__,__LINE__,__func__,__VA_ARGS__); \
 104         }while(0)
 105 # else
 106 #  define _AFB_LOGGING_V2_(vlevel,llevel,...) \
 107         do{ \
 108                 if(afbBindingV2data.verbosity>=vlevel) \
 109                         afb_daemon_verbose_v2(llevel,NULL,0,NULL,__VA_ARGS__); \
 110         }while(0)
 111 #  define _AFB_REQ_LOGGING_V2_(vlevel,llevel,req,...) \
 112         do{ \
 113                 if(AFB_BINDING_DATA_NAME_V2.verbosity>=vlevel) \
 114                         afb_req_verbose(req,llevel,NULL,0,NULL,__VA_ARGS__); \
 115         }while(0)
 116 # endif
 117 # include "afb-verbosity.h"
 118 # define AFB_ERROR_V2(...)       _AFB_LOGGING_V2_(AFB_VERBOSITY_LEVEL_ERROR,_AFB_SYSLOG_LEVEL_ERROR_,__VA_ARGS__)
 119 # define AFB_WARNING_V2(...)     _AFB_LOGGING_V2_(AFB_VERBOSITY_LEVEL_WARNING,_AFB_SYSLOG_LEVEL_WARNING_,__VA_ARGS__)
 120 # define AFB_NOTICE_V2(...)      _AFB_LOGGING_V2_(AFB_VERBOSITY_LEVEL_NOTICE,_AFB_SYSLOG_LEVEL_NOTICE_,__VA_ARGS__)
 121 # define AFB_INFO_V2(...)        _AFB_LOGGING_V2_(AFB_VERBOSITY_LEVEL_INFO,_AFB_SYSLOG_LEVEL_INFO_,__VA_ARGS__)
 122 # define AFB_DEBUG_V2(...)       _AFB_LOGGING_V2_(AFB_VERBOSITY_LEVEL_DEBUG,_AFB_SYSLOG_LEVEL_DEBUG_,__VA_ARGS__)
 123 # define AFB_REQ_ERROR_V2(...)   _AFB_REQ_LOGGING_V2_(AFB_VERBOSITY_LEVEL_ERROR,_AFB_SYSLOG_LEVEL_ERROR_,__VA_ARGS__)
 124 # define AFB_REQ_WARNING_V2(...) _AFB_REQ_LOGGING_V2_(AFB_VERBOSITY_LEVEL_WARNING,_AFB_SYSLOG_LEVEL_WARNING_,__VA_ARGS__)
 125 # define AFB_REQ_NOTICE_V2(...)  _AFB_REQ_LOGGING_V2_(AFB_VERBOSITY_LEVEL_NOTICE,_AFB_SYSLOG_LEVEL_NOTICE_,__VA_ARGS__)
 126 # define AFB_REQ_INFO_V2(...)    _AFB_REQ_LOGGING_V2_(AFB_VERBOSITY_LEVEL_INFO,_AFB_SYSLOG_LEVEL_INFO_,__VA_ARGS__)
 127 # define AFB_REQ_DEBUG_V2(...)   _AFB_REQ_LOGGING_V2_(AFB_VERBOSITY_LEVEL_DEBUG,_AFB_SYSLOG_LEVEL_DEBUG_,__VA_ARGS__)
 128 #endif
 129
 130 #include "afb-daemon-v2.h"
 131 #include "afb-service-v2.h"
 132