src/afb-api.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 struct afb_xreq;
  21 struct afb_apiset;
  22 struct json_object;
  23
  24 struct afb_api_itf
  25 {
  26         void (*call)(void *closure, struct afb_xreq *xreq);
  27         int (*service_start)(void *closure, int share_session, int onneed, struct afb_apiset *apiset);
  28         void (*update_hooks)(void *closure);
  29         int (*get_verbosity)(void *closure);
  30         void (*set_verbosity)(void *closure, int level);
  31         struct json_object *(*describe)(void *closure);
  32 };
  33
  34 struct afb_api
  35 {
  36         void *closure;
  37         struct afb_api_itf *itf;
  38         const void *group;
  39 };
  40
  41 extern int afb_api_is_valid_name(const char *name);
  42
  43 #define AFB_API_UNHOOKABLE_PREFIX_CHAR    '$'
  44 #define AFB_API_UNHOOKABLE_PREFIX_STRING  "$"
  45 #define afb_api_is_hookable(api)          ((api)[0] != AFB_API_UNHOOKABLE_PREFIX_CHAR)
  46