X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Fafb%2Fafb-service-v2.h;h=7dfcc00c734dacfd905808c715c03112bec3658e;hb=65353dce81a629e042800bb7b86fcd869a76727e;hp=2d138350dc7d224f756744e98dd80be43bb81888;hpb=090379fdaf6ed1860dcff21424135ad71ead0cd2;p=src%2Fapp-framework-binder.git diff --git a/include/afb/afb-service-v2.h b/include/afb/afb-service-v2.h index 2d138350..7dfcc00c 100644 --- a/include/afb/afb-service-v2.h +++ b/include/afb/afb-service-v2.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,7 +17,14 @@ #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'. * @@ -27,7 +34,7 @@ * * 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 api The api name of the method to call @@ -42,13 +49,15 @@ static inline void afb_service_call_v2( 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) { afb_get_service_v2().itf->call(afb_get_service_v2().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. * @@ -56,13 +65,12 @@ static inline void afb_service_call_v2( * 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 1 in case of success or 0 in case of error. + * @returns 0 in case of success or a negative value in case of error. * * @see also 'afb_req_subcall' */ @@ -75,3 +83,4 @@ static inline int afb_service_call_sync_v2( return afb_get_service_v2().itf->call_sync(afb_get_service_v2().closure, api, verb, args, result); } +/** @} */