include/afb/afb-service-itf.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 /* avoid inclusion of <json-c/json.h> */
  21 struct json_object;
  22
  23 /*
  24  * Interface for internal of services
  25  * It records the functions to be called for the request.
  26  * Don't use this structure directly.
  27  * Use the helper functions documented below.
  28  */
  29 struct afb_service_itf
  30 {
  31         /* CAUTION: respect the order, add at the end */
  32
  33         void (*call)(void *closure, const char *api, const char *verb, struct json_object *args,
  34                      void (*callback)(void*, int, struct json_object*), void *callback_closure);
  35 };
  36
  37 /*
  38  * Object that encapsulate accesses to service items
  39  */
  40 struct afb_service
  41 {
  42         const struct afb_service_itf *itf;
  43         void *closure;
  44 };
  45
  46 /**
  47  * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding.
  48  * The result of the call is delivered to the 'callback' function with the 'callback_closure'.
  49  *
  50  * The 'callback' receives 3 arguments:
  51  *  1. 'closure' the user defined closure pointer 'callback_closure',
  52  *  2. 'iserror' a boolean status being true (not null) when an error occured,
  53  *  2. 'result' the resulting data as a JSON object.
  54  *
  55  * @param service  The service as received during initialisation
  56  * @param api      The api name of the method to call
  57  * @param verb     The verb name of the method to call
  58  * @param args     The arguments to pass to the method
  59  * @param callback The to call on completion
  60  * @param callback_closure The closure to pass to the callback
  61  *
  62  * @returns 0 in case of success or -1 in case of error.
  63  *
  64  * @see also 'afb_req_subcall'
  65  */
  66 static inline void afb_service_call(
  67         struct afb_service service,
  68         const char *api,
  69         const char *verb,
  70         struct json_object *args,
  71         void (*callback)(void*closure, int iserror, struct json_object *result),
  72         void *callback_closure)
  73 {
  74         service.itf->call(service.closure, api, verb, args, callback, callback_closure);
  75 }
  76