diff options
| author |   José Bollo <jose.bollo@iot.bzh> | 2017-08-02 19:14:09 +0200 |
|---|---|---|
| committer | José Bollo <jose.bollo@iot.bzh> | 2017-08-03 11:45:26 +0200 |
| commit | 04186fd953298be8b8c5673b5fcd01f0893986ff (patch) | |
| tree | 030e077e7dc7f84e7c3894111f451088255256eb /docs | |
| parent | 6d124e683d2511ac02a1cbe61fca3d230bda4f0c (diff) | |
subcall_req: introduce afb_req_subcall_req
The function 'afb_req_subcall_req' can be used to make asynchronous
subcalls. It improves the function 'afb_req_subcall' by automatically
keeping the request opened for the callback and by passing it, the
request, as an extra argument of the callback.
Change-Id: I2dc79c01fc25c7a65b9c8cc9e001a5b85fba99df
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/afb-binding-references.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/afb-binding-references.md b/docs/afb-binding-references.md index 97ed14a7..d0a9a6d0 100644 --- a/docs/afb-binding-references.md +++ b/docs/afb-binding-references.md @@ -586,6 +586,10 @@ client (with its permissions). * 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. + * + * See also: + * - 'afb_req_subcall_req' that is convenient to keep request alive automatically. + * - 'afb_req_subcall_sync' the synchronous version */ void afb_req_subcall( struct afb_req req, @@ -598,6 +602,29 @@ void afb_req_subcall( /* * 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'. + * On completion, the function 'callback' is invoked with the + * original request 'req', the 'closure' given at call and two + * other parameters: 'iserror' and 'result'. + * '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. + * + * 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. + * + * See also: + * - 'afb_req_subcall' that doesn't keep request alive automatically. + * - 'afb_req_subcall_sync' the synchronous version + */ +static inline void afb_req_subcall_req(struct afb_req req, const char *api, const char *verb, struct json_object *args, void (*callback)(void *closure, int iserror, struct json_object *result, struct afb_req req), void *closure) +{ + req.itf->subcall_req(req.closure, api, verb, args, callback, closure); +} + +/* + * 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 success or a negative value on error answer. * The object pointed by 'result' is filled and must be released by the caller @@ -606,6 +633,10 @@ void afb_req_subcall( * 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. + * + * See also: + * - 'afb_req_subcall_req' that is convenient to keep request alive automatically. + * - 'afb_req_subcall' that doesn't keep request alive automatically. */ int afb_req_subcall_sync( struct afb_req req, |