X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fafb-binding-references.md;h=d0a9a6d0d138ed14e87f180182b35fbdacb176df;hb=bdff72f45e1d02f596595f6229d5bccf7c0827c2;hp=97ed14a7fba0def988a91e741aba1ef72b403d07;hpb=d0c20134a2c9ecb53045b63cb1e0d6e2aa2b26d2;p=src%2Fapp-framework-binder.git

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,
@@ -595,6 +599,29 @@ void afb_req_subcall(
                 void (*callback)(void *closure, int status, struct json_object *result),
                 void *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'.
+ * 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'.
@@ -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,