include/afb/afb-service-v1.h

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