X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Fafb%2Fafb-service-v1.h;h=331f28a010f4dae34649c0b8838ba12d6ee6cddd;hb=65353dce81a629e042800bb7b86fcd869a76727e;hp=6e85a293d785bb540948b6abe7b66e1652eb2303;hpb=95c29ef579d6320a721f96d7146efd10f74a201b;p=src%2Fapp-framework-binder.git diff --git a/include/afb/afb-service-v1.h b/include/afb/afb-service-v1.h index 6e85a293..331f28a0 100644 --- a/include/afb/afb-service-v1.h +++ b/include/afb/afb-service-v1.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016, 2017 "IoT.bzh" + * Copyright (C) 2015-2020 "IoT.bzh" * Author: José Bollo * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -17,13 +17,24 @@ #pragma once +#include "afb-service-itf-x1.h" + +/** @addtogroup AFB_SERVICE + * @{ */ + /** + * @deprecated use bindings version 3 + * * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding. * The result of the call is delivered to the 'callback' function with the 'callback_closure'. * + * For convenience, the function calls 'json_object_put' for 'args'. + * Thus, in the case where 'args' should remain available after + * the function returns, the function 'json_object_get' shall be used. + * * The 'callback' receives 3 arguments: * 1. 'closure' the user defined closure pointer 'callback_closure', - * 2. 'iserror' a boolean status being true (not null) when an error occured, + * 2. 'status' a status being 0 on success or negative when an error occured, * 2. 'result' the resulting data as a JSON object. * * @param service The service as received during initialisation @@ -33,18 +44,47 @@ * @param callback The to call on completion * @param callback_closure The closure to pass to the callback * - * @returns 0 in case of success or -1 in case of error. - * * @see also 'afb_req_subcall' */ static inline void afb_service_call_v1( - struct afb_service service, + struct afb_service_x1 service, const char *api, const char *verb, struct json_object *args, - void (*callback)(void*closure, int iserror, struct json_object *result), + void (*callback)(void*closure, int status, struct json_object *result), void *callback_closure) { service.itf->call(service.closure, api, verb, args, callback, callback_closure); } +/** + * @deprecated use bindings version 3 + * + * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding. + * 'result' will receive the response. + * + * For convenience, the function calls 'json_object_put' for 'args'. + * Thus, in the case where 'args' should remain available after + * the function returns, the function 'json_object_get' shall be used. + * + * @param service The service as received during initialisation + * @param api The api name of the method to call + * @param verb The verb name of the method to call + * @param args The arguments to pass to the method + * @param result Where to store the result - should call json_object_put on it - + * + * @returns 0 in case of success or a negative value in case of error. + * + * @see also 'afb_req_subcall' + */ +static inline int afb_service_call_sync_v1( + struct afb_service_x1 service, + const char *api, + const char *verb, + struct json_object *args, + struct json_object **result) +{ + return service.itf->call_sync(service.closure, api, verb, args, result); +} + +/** @} */