include/afb/afb-service-v1.h

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