aboutsummaryrefslogtreecommitdiffstats
path: root/include/afb/afb-service-v1.h
diff options
context:
space:
mode:
authorJosé Bollo <jose.bollo@iot.bzh>2017-05-29 14:16:13 +0200
committerJosé Bollo <jose.bollo@iot.bzh>2017-05-29 14:16:13 +0200
commit090379fdaf6ed1860dcff21424135ad71ead0cd2 (patch)
treeb7c9bde501e86a9fcf4a801444a670de3339208a /include/afb/afb-service-v1.h
parentce8d87d91aa710702b02a371278f4e1f39ea195c (diff)
Add 'afb_service_call_sync' function
This new function allows to call features for the services synchronously. Also refactoring how are handled arguments to calls. The call to 'json_object_put' is now always done by the binder. Change-Id: I910517da75b179aeafc824da4ce29bc299711990 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'include/afb/afb-service-v1.h')
-rw-r--r--include/afb/afb-service-v1.h34
1 files changed, 32 insertions, 2 deletions
diff --git a/include/afb/afb-service-v1.h b/include/afb/afb-service-v1.h
index 6e85a293..f3f55a56 100644
--- a/include/afb/afb-service-v1.h
+++ b/include/afb/afb-service-v1.h
@@ -21,6 +21,10 @@
* 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'.
*
+ * 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.
+ *
* 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,
@@ -33,8 +37,6 @@
* @param callback The to call on completion
* @param callback_closure The closure to pass to the callback
*
- * @returns 0 in case of success or -1 in case of error.
- *
* @see also 'afb_req_subcall'
*/
static inline void afb_service_call_v1(
@@ -48,3 +50,31 @@ static inline void afb_service_call_v1(
service.itf->call(service.closure, api, verb, args, callback, callback_closure);
}
+/**
+ * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding.
+ * 'result' will receive the response.
+ *
+ * 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.
+ *
+ * @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.
+ *
+ * @see also 'afb_req_subcall'
+ */
+static inline int afb_service_call_sync_v1(
+ struct afb_service service,
+ const char *api,
+ const char *verb,
+ struct json_object *args,
+ struct json_object **result)
+{
+ return service.itf->call_sync(service.closure, api, verb, args, result);
+}
+