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-session-v2.h"
  23
  24 struct afb_service;
  25 struct afb_daemon;
  26 struct afb_binding_v2;
  27
  28 struct json_object;
  29
  30 /*
  31  * A binding V2 MUST have two exported symbols of name:
  32  *
  33  *            -  afbBindingV2
  34  *            -  afbBindingV2verbosity
  35  *
  36  */
  37 extern const struct afb_binding_v2 afbBindingV2;
  38 extern int afbBindingV2verbosity;
  39
  40 /*
  41  * Description of one verb of the API provided by the binding
  42  * This enumeration is valid for bindings of type version 2
  43  */
  44 struct afb_verb_v2
  45 {
  46         const char *verb;                       /* name of the verb */
  47         void (*callback)(struct afb_req req);   /* callback function implementing the verb */
  48         const struct afb_auth *auth;            /* required authorisation */
  49         uint32_t session;                       /* authorisation and session requirements of the verb */
  50 };
  51
  52 /*
  53  * Description of the bindings of type version 2
  54  */
  55 struct afb_binding_v2
  56 {
  57         const char *api;                        /* api name for the binding */
  58         const char *specification;              /* textual specification of the binding */
  59         const struct afb_verb_v2 *verbs;        /* array of descriptions of verbs terminated by a NULL name */
  60         int (*init)(struct afb_daemon daemon);
  61         int (*start)(struct afb_service service);
  62         void (*onevent)(struct afb_service service, const char *event, struct json_object *object);
  63 };
  64
  65 /*
  66  * Macros for logging messages
  67  */
  68 #if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO)
  69 # if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_DETAILS)
  70 #  define AFB_ERROR_V2(daemon,...)   do{if(afbBindingV2verbosity>=0)afb_daemon_verbose(daemon,3,__FILE__,__LINE__,__VA_ARGS__);}while(0)
  71 #  define AFB_WARNING_V2(daemon,...) do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,4,__FILE__,__LINE__,__VA_ARGS__);}while(0)
  72 #  define AFB_NOTICE_V2(daemon,...)  do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,5,__FILE__,__LINE__,__VA_ARGS__);}while(0)
  73 #  define AFB_INFO_V2(daemon,...)    do{if(afbBindingV2verbosity>=2)afb_daemon_verbose(daemon,6,__FILE__,__LINE__,__VA_ARGS__);}while(0)
  74 #  define AFB_DEBUG_V2(daemon,...)   do{if(afbBindingV2verbosity>=3)afb_daemon_verbose(daemon,7,__FILE__,__LINE__,__VA_ARGS__);}while(0)
  75 # else
  76 #  define AFB_ERROR_V2(daemon,...)   do{if(afbBindingV2verbosity>=0)afb_daemon_verbose(daemon,3,NULL,0,__VA_ARGS__);}while(0)
  77 #  define AFB_WARNING_V2(daemon,...) do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,4,NULL,0,__VA_ARGS__);}while(0)
  78 #  define AFB_NOTICE_V2(daemon,...)  do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,5,NULL,0,__VA_ARGS__);}while(0)
  79 #  define AFB_INFO_V2(daemon,...)    do{if(afbBindingV2verbosity>=2)afb_daemon_verbose(daemon,6,NULL,0,__VA_ARGS__);}while(0)
  80 #  define AFB_DEBUG_V2(daemon,...)   do{if(afbBindingV2verbosity>=3)afb_daemon_verbose(daemon,7,NULL,0,__VA_ARGS__);}while(0)
  81 # endif
  82 #endif
  83
  84 #if AFB_BINDING_VERSION == 2
  85
  86 # define afb_binding            afb_binding_v2
  87 # define afb_binding_interface  afb_binding_interface_v2
  88
  89 # define AFB_SESSION_NONE       AFB_SESSION_NONE_V2
  90 # define AFB_SESSION_CLOSE      AFB_SESSION_CLOSE_V2
  91 # define AFB_SESSION_RENEW      AFB_SESSION_REFRESH_V2
  92 # define AFB_SESSION_REFRESH    AFB_SESSION_REFRESH_V2
  93 # define AFB_SESSION_CHECK      AFB_SESSION_CHECK_V2
  94
  95 # define AFB_SESSION_LOA_MASK   AFB_SESSION_LOA_MASK_V2
  96
  97 # define AFB_SESSION_LOA_0      AFB_SESSION_LOA_0_V2
  98 # define AFB_SESSION_LOA_1      AFB_SESSION_LOA_1_V2
  99 # define AFB_SESSION_LOA_2      AFB_SESSION_LOA_2_V2
 100 # define AFB_SESSION_LOA_3      AFB_SESSION_LOA_3_V2
 101
 102 # if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO)
 103
 104 #  define ERROR                 AFB_ERROR_V2
 105 #  define WARNING               AFB_WARNING_V2
 106 #  define NOTICE                AFB_NOTICE_V2
 107 #  define INFO                  AFB_INFO_V2
 108 #  define DEBUG                 AFB_DEBUG_V2
 109
 110 # endif
 111
 112 #endif