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 struct afb_service;
  23 struct afb_daemon;
  24 struct afb_binding_v2;
  25
  26 struct json_object;
  27
  28 /*
  29  * A binding V2 MUST have two exported symbols of name:
  30  *
  31  *            -  afbBindingV2
  32  *            -  afbBindingV2verbosity
  33  *
  34  */
  35 extern const struct afb_binding_v2 afbBindingV2;
  36 extern int afbBindingV2verbosity;
  37
  38 /*
  39  * Description of one verb of the API provided by the binding
  40  * This enumeration is valid for bindings of type version 2
  41  */
  42 struct afb_verb_v2
  43 {
  44         const char *verb;                       /* name of the verb */
  45         void (*callback)(struct afb_req req);   /* callback function implementing the verb */
  46         const char * permissions;               /* required permissions */
  47         uint32_t session;                       /* authorisation and session requirements of the verb */
  48 };
  49
  50 /*
  51  * Description of the bindings of type version 2
  52  */
  53 struct afb_binding_v2
  54 {
  55         const char *api;                        /* api name for the binding */
  56         const char *specification;              /* textual specification of the binding */
  57         const struct afb_verb_v2 *verbs;        /* array of descriptions of verbs terminated by a NULL name */
  58         int (*init)(struct afb_daemon daemon);
  59         int (*start)(struct afb_service service);
  60         void (*onevent)(struct afb_service service, const char *event, struct json_object *object);
  61 };
  62
  63 /*
  64  * Macros for logging messages
  65  */
  66 #if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO)
  67 # if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_DETAILS)
  68 #  define AFB_ERROR_V2(daemon,...)   do{if(afbBindingV2verbosity>=0)afb_daemon_verbose(daemon,3,__FILE__,__LINE__,__VA_ARGS__);}while(0)
  69 #  define AFB_WARNING_V2(daemon,...) do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,4,__FILE__,__LINE__,__VA_ARGS__);}while(0)
  70 #  define AFB_NOTICE_V2(daemon,...)  do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,5,__FILE__,__LINE__,__VA_ARGS__);}while(0)
  71 #  define AFB_INFO_V2(daemon,...)    do{if(afbBindingV2verbosity>=2)afb_daemon_verbose(daemon,6,__FILE__,__LINE__,__VA_ARGS__);}while(0)
  72 #  define AFB_DEBUG_V2(daemon,...)   do{if(afbBindingV2verbosity>=3)afb_daemon_verbose(daemon,7,__FILE__,__LINE__,__VA_ARGS__);}while(0)
  73 # else
  74 #  define AFB_ERROR_V2(daemon,...)   do{if(afbBindingV2verbosity>=0)afb_daemon_verbose(daemon,3,NULL,0,__VA_ARGS__);}while(0)
  75 #  define AFB_WARNING_V2(daemon,...) do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,4,NULL,0,__VA_ARGS__);}while(0)
  76 #  define AFB_NOTICE_V2(daemon,...)  do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,5,NULL,0,__VA_ARGS__);}while(0)
  77 #  define AFB_INFO_V2(daemon,...)    do{if(afbBindingV2verbosity>=2)afb_daemon_verbose(daemon,6,NULL,0,__VA_ARGS__);}while(0)
  78 #  define AFB_DEBUG_V2(daemon,...)   do{if(afbBindingV2verbosity>=3)afb_daemon_verbose(daemon,7,NULL,0,__VA_ARGS__);}while(0)
  79 # endif
  80 #endif