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  * The 'callback' receives 3 arguments:
  25  *  1. 'closure' the user defined closure pointer 'callback_closure',
  26  *  2. 'iserror' a boolean status being true (not null) when an error occured,
  27  *  2. 'result' the resulting data as a JSON object.
  28  *
  29  * @param api      The api name of the method to call
  30  * @param verb     The verb name of the method to call
  31  * @param args     The arguments to pass to the method
  32  * @param callback The to call on completion
  33  * @param callback_closure The closure to pass to the callback
  34  *
  35  * @returns 0 in case of success or -1 in case of error.
  36  *
  37  * @see also 'afb_req_subcall'
  38  */
  39 static inline void afb_service_call_v2(
  40         const char *api,
  41         const char *verb,
  42         struct json_object *args,
  43         void (*callback)(void*closure, int iserror, struct json_object *result),
  44         void *callback_closure)
  45 {
  46         afb_get_service_v2().itf->call(afb_get_service_v2().closure, api, verb, args, callback, callback_closure);
  47 }
  48