From 5214323d82cc09b15c25e348707f2639977ea763 Mon Sep 17 00:00:00 2001 From: Jose Bollo Date: Mon, 25 Feb 2019 11:27:48 +0100 Subject: doc: Improve comment on asynchronous calls Following the remarks of fellow developers, the status of the object received by the callback function needs to be explained better. Change-Id: I0e6bcd51849bbc5af92af08675949a901bfd683e Signed-off-by: Jose Bollo --- include/afb/afb-api-x3.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'include/afb/afb-api-x3.h') diff --git a/include/afb/afb-api-x3.h b/include/afb/afb-api-x3.h index fc72d070..ca92bb59 100644 --- a/include/afb/afb-api-x3.h +++ b/include/afb/afb-api-x3.h @@ -814,6 +814,9 @@ int afb_api_x3_event_handler_del( * 4. 'info' a string handling some info (can be NULL) * 5. 'api' the api * + * NOTE: For convenience, *json_object_put* is called on 'object' after the + * callback returns. So, it is wrong to call *json_object_put* in the callback. + * * @param api The api that makes the call * @param apiname The api name of the method to call * @param verb The verb name of the method to call @@ -821,7 +824,6 @@ int afb_api_x3_event_handler_del( * @param callback The to call on completion * @param closure The closure to pass to the callback * - * * @see afb_req_subcall * @see afb_req_subcall_sync * @see afb_api_x3_call_sync -- cgit 1.2.3-korg