diff options
author | 2017-07-03 13:57:19 +0200 | |
---|---|---|
committer | 2017-07-05 15:54:40 +0200 | |
commit | d52ab895eb35c2b13eef55b903b54797dff7d903 (patch) | |
tree | b4824f5848cf43f8a01dc776f5691631f7d6d084 /include | |
parent | b041cea81762dcfef0fd4b1c9a1fec16052d63b8 (diff) |
Make status common
Make all error status for bindings use
a common convention: a negative value
means an error.
Change-Id: Id09610051295810f04f00477d7ec1d9771bf7975
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'include')
-rw-r--r-- | include/afb/afb-req-common.h | 4 | ||||
-rw-r--r-- | include/afb/afb-service-v1.h | 6 | ||||
-rw-r--r-- | include/afb/afb-service-v2.h | 6 |
3 files changed, 8 insertions, 8 deletions
diff --git a/include/afb/afb-req-common.h b/include/afb/afb-req-common.h index df37739f..9fce668f 100644 --- a/include/afb/afb-req-common.h +++ b/include/afb/afb-req-common.h @@ -336,7 +336,7 @@ static inline int afb_req_unsubscribe(struct afb_req req, struct afb_event event * This call is made in the context of the request 'req'. * On completion, the function 'callback' is invoked with the * 'closure' given at call and two other parameters: 'iserror' and 'result'. - * 'iserror' is a boolean that indicates if the reply is an error reply. + * 'status' is 0 on success or negative when on an error reply. * 'result' is the json object of the reply, you must not call json_object_put * on the result. * @@ -353,7 +353,7 @@ static inline void afb_req_subcall(struct afb_req req, const char *api, const ch * Makes a call to the method of name 'api' / 'verb' with the object 'args'. * This call is made in the context of the request 'req'. * This call is synchronous, it waits untill completion of the request. - * It returns 0 on an error answer and returns 1 when no error was detected. + * It returns 0 on success or a negative value on error answer. * The object pointed by 'result' is filled and must be released by the caller * after its use by calling 'json_object_put'. * diff --git a/include/afb/afb-service-v1.h b/include/afb/afb-service-v1.h index ee207ab9..db798382 100644 --- a/include/afb/afb-service-v1.h +++ b/include/afb/afb-service-v1.h @@ -29,7 +29,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 service The service as received during initialisation @@ -46,7 +46,7 @@ static inline void afb_service_call_v1( 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); @@ -66,7 +66,7 @@ static inline void afb_service_call_v1( * @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' */ diff --git a/include/afb/afb-service-v2.h b/include/afb/afb-service-v2.h index 0e920365..08974c9d 100644 --- a/include/afb/afb-service-v2.h +++ b/include/afb/afb-service-v2.h @@ -29,7 +29,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 @@ -44,7 +44,7 @@ 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); @@ -63,7 +63,7 @@ static inline void afb_service_call_v2( * @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' */ |