include/afb/afb-service-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 /**
  21  * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding.
  22  * The result of the call is delivered to the 'callback' function with the 'callback_closure'.
  23  *
  24  * For convenience, the function calls 'json_object_put' for 'args'.
  25  * Thus, in the case where 'args' should remain available after
  26  * the function returns, the function 'json_object_get' shall be used.
  27  *
  28  * The 'callback' receives 3 arguments:
  29  *  1. 'closure' the user defined closure pointer 'callback_closure',
  30  *  2. 'iserror' a boolean status being true (not null) when an error occured,
  31  *  2. 'result' the resulting data as a JSON object.
  32  *
  33  * @param api      The api name of the method to call
  34  * @param verb     The verb name of the method to call
  35  * @param args     The arguments to pass to the method
  36  * @param callback The to call on completion
  37  * @param callback_closure The closure to pass to the callback
  38  *
  39  * @see also 'afb_req_subcall'
  40  */
  41 static inline void afb_service_call_v2(
  42         const char *api,
  43         const char *verb,
  44         struct json_object *args,
  45         void (*callback)(void*closure, int iserror, struct json_object *result),
  46         void *callback_closure)
  47 {
  48         afb_get_service_v2().itf->call(afb_get_service_v2().closure, api, verb, args, callback, callback_closure);
  49 }
  50
  51 /**
  52  * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding.
  53  * 'result' will receive the response.
  54  *
  55  * For convenience, the function calls 'json_object_put' for 'args'.
  56  * Thus, in the case where 'args' should remain available after
  57  * the function returns, the function 'json_object_get' shall be used.
  58  *
  59  * @param api      The api name of the method to call
  60  * @param verb     The verb name of the method to call
  61  * @param args     The arguments to pass to the method
  62  * @param result   Where to store the result - should call json_object_put on it -
  63  *
  64  * @returns 1 in case of success or 0 in case of error.
  65  *
  66  * @see also 'afb_req_subcall'
  67  */
  68 static inline int afb_service_call_sync_v2(
  69         const char *api,
  70         const char *verb,
  71         struct json_object *args,
  72         struct json_object **result)
  73 {
  74         return afb_get_service_v2().itf->call_sync(afb_get_service_v2().closure, api, verb, args, result);
  75 }
  76