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