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>

7 files changed, 189 insertions, 117 deletions

diff --git a/include/afb/afb-binding-v1.h b/include/afb/afb-binding-v1.h
index e6f322fb..b627d5c4 100644
--- a/include/afb/afb-binding-v1.h
+++ b/include/afb/afb-binding-v1.h
@@ -162,70 +162,5 @@ struct afb_binding_interface_v1
 #endif
 
 
-/***************************************************************************************************/
-
-#if AFB_BINDING_VERSION == 1
-
-# define afb_binding		afb_binding_v1
-# define afb_binding_interface	afb_binding_interface_v1
-
-# define AFB_SESSION_NONE	AFB_SESSION_NONE_V1
-# define AFB_SESSION_CREATE	AFB_SESSION_CREATE_V1
-# define AFB_SESSION_CLOSE	AFB_SESSION_CLOSE_V1
-# define AFB_SESSION_RENEW	AFB_SESSION_RENEW_V1
-# define AFB_SESSION_CHECK	AFB_SESSION_CHECK_V1
-
-# define AFB_SESSION_LOA_GE	AFB_SESSION_LOA_GE_V1
-# define AFB_SESSION_LOA_LE	AFB_SESSION_LOA_LE_V1
-# define AFB_SESSION_LOA_EQ	AFB_SESSION_LOA_EQ_V1
-
-# define AFB_SESSION_LOA_SHIFT	AFB_SESSION_LOA_SHIFT_V1
-# define AFB_SESSION_LOA_MASK	AFB_SESSION_LOA_MASK_V1
-
-# define AFB_SESSION_LOA_0	AFB_SESSION_LOA_0_V1
-# define AFB_SESSION_LOA_1	AFB_SESSION_LOA_1_V1
-# define AFB_SESSION_LOA_2	AFB_SESSION_LOA_2_V1
-# define AFB_SESSION_LOA_3	AFB_SESSION_LOA_3_V1
-# define AFB_SESSION_LOA_4	AFB_SESSION_LOA_4_V1
-
-# define AFB_SESSION_LOA_LE_0	AFB_SESSION_LOA_LE_0_V1
-# define AFB_SESSION_LOA_LE_1	AFB_SESSION_LOA_LE_1_V1
-# define AFB_SESSION_LOA_LE_2	AFB_SESSION_LOA_LE_2_V1
-# define AFB_SESSION_LOA_LE_3	AFB_SESSION_LOA_LE_3_V1
-
-# define AFB_SESSION_LOA_EQ_0	AFB_SESSION_LOA_EQ_0_V1
-# define AFB_SESSION_LOA_EQ_1	AFB_SESSION_LOA_EQ_1_V1
-# define AFB_SESSION_LOA_EQ_2	AFB_SESSION_LOA_EQ_2_V1
-# define AFB_SESSION_LOA_EQ_3	AFB_SESSION_LOA_EQ_3_V1
-
-# define AFB_SESSION_LOA_GE_0	AFB_SESSION_LOA_GE_0_V1
-# define AFB_SESSION_LOA_GE_1	AFB_SESSION_LOA_GE_1_V1
-# define AFB_SESSION_LOA_GE_2	AFB_SESSION_LOA_GE_2_V1
-# define AFB_SESSION_LOA_GE_3	AFB_SESSION_LOA_GE_3_V1
-
-# if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO)
-
-#  define ERROR			AFB_ERROR_V1
-#  define WARNING		AFB_WARNING_V1
-#  define NOTICE		AFB_NOTICE_V1
-#  define INFO			AFB_INFO_V1
-#  define DEBUG			AFB_DEBUG_V1
-
-# endif
-
-#define afb_daemon_get_event_loop	afb_daemon_get_event_loop_v1
-#define afb_daemon_get_user_bus		afb_daemon_get_user_bus_v1
-#define afb_daemon_get_system_bus	afb_daemon_get_system_bus_v1
-#define afb_daemon_broadcast_event	afb_daemon_broadcast_event_v1
-#define afb_daemon_make_event		afb_daemon_make_event_v1
-#define afb_daemon_verbose		afb_daemon_verbose_v1
-#define afb_daemon_rootdir_get_fd	afb_daemon_rootdir_get_fd_v1
-#define afb_daemon_rootdir_open_locale	afb_daemon_rootdir_open_locale_v1
-#define afb_daemon_queue_job		afb_daemon_queue_job_v1
-
-#define afb_service_call		afb_service_call_v1
-
-#endif
-
 
 
diff --git a/include/afb/afb-binding-v2.h b/include/afb/afb-binding-v2.h
index 6f8eb953..e763f1cf 100644
--- a/include/afb/afb-binding-v2.h
+++ b/include/afb/afb-binding-v2.h
@@ -77,11 +77,10 @@ extern const struct afb_binding_v2 afbBindingV2;
 #define AFB_BINDING_DATA_NAME_V2 afbBindingV2data
 #endif
 
-#if AFB_BINDING_VERSION == 2
-struct afb_binding_data_v2 AFB_BINDING_DATA_NAME_V2  __attribute__ ((weak));
-#else
-extern struct afb_binding_data_v2 AFB_BINDING_DATA_NAME_V2;
+#if AFB_BINDING_VERSION != 2
+extern
 #endif
+struct afb_binding_data_v2 AFB_BINDING_DATA_NAME_V2  __attribute__ ((weak));
 
 #define afb_get_verbosity_v2()	(AFB_BINDING_DATA_NAME_V2.verbosity)
 #define afb_get_daemon_v2()	(AFB_BINDING_DATA_NAME_V2.daemon)
@@ -114,46 +113,3 @@ extern struct afb_binding_data_v2 AFB_BINDING_DATA_NAME_V2;
 #include "afb-daemon-v2.h"
 #include "afb-service-v2.h"
 
-/***************************************************************************************************/
-
-#if AFB_BINDING_VERSION == 2
-
-# define afb_binding		afb_binding_v2
-# define afb_binding_interface	afb_binding_interface_v2
-
-# define AFB_SESSION_NONE	AFB_SESSION_NONE_V2
-# define AFB_SESSION_CLOSE	AFB_SESSION_CLOSE_V2
-# define AFB_SESSION_RENEW	AFB_SESSION_REFRESH_V2
-# define AFB_SESSION_REFRESH	AFB_SESSION_REFRESH_V2
-# define AFB_SESSION_CHECK	AFB_SESSION_CHECK_V2
-
-# define AFB_SESSION_LOA_MASK	AFB_SESSION_LOA_MASK_V2
-
-# define AFB_SESSION_LOA_0	AFB_SESSION_LOA_0_V2
-# define AFB_SESSION_LOA_1	AFB_SESSION_LOA_1_V2
-# define AFB_SESSION_LOA_2	AFB_SESSION_LOA_2_V2
-# define AFB_SESSION_LOA_3	AFB_SESSION_LOA_3_V2
-
-# if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO)
-
-#  define ERROR			AFB_ERROR_V2
-#  define WARNING		AFB_WARNING_V2
-#  define NOTICE		AFB_NOTICE_V2
-#  define INFO			AFB_INFO_V2
-#  define DEBUG			AFB_DEBUG_V2
-
-# endif
-
-#define afb_daemon_get_event_loop	afb_daemon_get_event_loop_v2
-#define afb_daemon_get_user_bus		afb_daemon_get_user_bus_v2
-#define afb_daemon_get_system_bus	afb_daemon_get_system_bus_v2
-#define afb_daemon_broadcast_event	afb_daemon_broadcast_event_v2
-#define afb_daemon_make_event		afb_daemon_make_event_v2
-#define afb_daemon_verbose		afb_daemon_verbose_v2
-#define afb_daemon_rootdir_get_fd	afb_daemon_rootdir_get_fd_v2
-#define afb_daemon_rootdir_open_locale	afb_daemon_rootdir_open_locale_v2
-#define afb_daemon_queue_job		afb_daemon_queue_job_v2
-
-#define afb_service_call		afb_service_call_v2
-
-#endif
diff --git a/include/afb/afb-binding.h b/include/afb/afb-binding.h
index ac750c7a..e2fd34d8 100644
--- a/include/afb/afb-binding.h
+++ b/include/afb/afb-binding.h
@@ -53,3 +53,113 @@
 #include "afb-binding-v1.h"
 #include "afb-binding-v2.h"
 
+/***************************************************************************************************/
+
+#if AFB_BINDING_VERSION == 1
+
+# define afb_binding		afb_binding_v1
+# define afb_binding_interface	afb_binding_interface_v1
+
+# define AFB_SESSION_NONE	AFB_SESSION_NONE_V1
+# define AFB_SESSION_CREATE	AFB_SESSION_CREATE_V1
+# define AFB_SESSION_CLOSE	AFB_SESSION_CLOSE_V1
+# define AFB_SESSION_RENEW	AFB_SESSION_RENEW_V1
+# define AFB_SESSION_CHECK	AFB_SESSION_CHECK_V1
+
+# define AFB_SESSION_LOA_GE	AFB_SESSION_LOA_GE_V1
+# define AFB_SESSION_LOA_LE	AFB_SESSION_LOA_LE_V1
+# define AFB_SESSION_LOA_EQ	AFB_SESSION_LOA_EQ_V1
+
+# define AFB_SESSION_LOA_SHIFT	AFB_SESSION_LOA_SHIFT_V1
+# define AFB_SESSION_LOA_MASK	AFB_SESSION_LOA_MASK_V1
+
+# define AFB_SESSION_LOA_0	AFB_SESSION_LOA_0_V1
+# define AFB_SESSION_LOA_1	AFB_SESSION_LOA_1_V1
+# define AFB_SESSION_LOA_2	AFB_SESSION_LOA_2_V1
+# define AFB_SESSION_LOA_3	AFB_SESSION_LOA_3_V1
+# define AFB_SESSION_LOA_4	AFB_SESSION_LOA_4_V1
+
+# define AFB_SESSION_LOA_LE_0	AFB_SESSION_LOA_LE_0_V1
+# define AFB_SESSION_LOA_LE_1	AFB_SESSION_LOA_LE_1_V1
+# define AFB_SESSION_LOA_LE_2	AFB_SESSION_LOA_LE_2_V1
+# define AFB_SESSION_LOA_LE_3	AFB_SESSION_LOA_LE_3_V1
+
+# define AFB_SESSION_LOA_EQ_0	AFB_SESSION_LOA_EQ_0_V1
+# define AFB_SESSION_LOA_EQ_1	AFB_SESSION_LOA_EQ_1_V1
+# define AFB_SESSION_LOA_EQ_2	AFB_SESSION_LOA_EQ_2_V1
+# define AFB_SESSION_LOA_EQ_3	AFB_SESSION_LOA_EQ_3_V1
+
+# define AFB_SESSION_LOA_GE_0	AFB_SESSION_LOA_GE_0_V1
+# define AFB_SESSION_LOA_GE_1	AFB_SESSION_LOA_GE_1_V1
+# define AFB_SESSION_LOA_GE_2	AFB_SESSION_LOA_GE_2_V1
+# define AFB_SESSION_LOA_GE_3	AFB_SESSION_LOA_GE_3_V1
+
+# if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO)
+
+#  define ERROR			AFB_ERROR_V1
+#  define WARNING		AFB_WARNING_V1
+#  define NOTICE		AFB_NOTICE_V1
+#  define INFO			AFB_INFO_V1
+#  define DEBUG			AFB_DEBUG_V1
+
+# endif
+
+#define afb_daemon_get_event_loop	afb_daemon_get_event_loop_v1
+#define afb_daemon_get_user_bus		afb_daemon_get_user_bus_v1
+#define afb_daemon_get_system_bus	afb_daemon_get_system_bus_v1
+#define afb_daemon_broadcast_event	afb_daemon_broadcast_event_v1
+#define afb_daemon_make_event		afb_daemon_make_event_v1
+#define afb_daemon_verbose		afb_daemon_verbose_v1
+#define afb_daemon_rootdir_get_fd	afb_daemon_rootdir_get_fd_v1
+#define afb_daemon_rootdir_open_locale	afb_daemon_rootdir_open_locale_v1
+#define afb_daemon_queue_job		afb_daemon_queue_job_v1
+
+#define afb_service_call		afb_service_call_v1
+#define afb_service_call_sync		afb_service_call_sync_v1
+
+#endif
+
+/***************************************************************************************************/
+
+#if AFB_BINDING_VERSION == 2
+
+# define afb_binding		afb_binding_v2
+# define afb_binding_interface	afb_binding_interface_v2
+
+# define AFB_SESSION_NONE	AFB_SESSION_NONE_V2
+# define AFB_SESSION_CLOSE	AFB_SESSION_CLOSE_V2
+# define AFB_SESSION_RENEW	AFB_SESSION_REFRESH_V2
+# define AFB_SESSION_REFRESH	AFB_SESSION_REFRESH_V2
+# define AFB_SESSION_CHECK	AFB_SESSION_CHECK_V2
+
+# define AFB_SESSION_LOA_MASK	AFB_SESSION_LOA_MASK_V2
+
+# define AFB_SESSION_LOA_0	AFB_SESSION_LOA_0_V2
+# define AFB_SESSION_LOA_1	AFB_SESSION_LOA_1_V2
+# define AFB_SESSION_LOA_2	AFB_SESSION_LOA_2_V2
+# define AFB_SESSION_LOA_3	AFB_SESSION_LOA_3_V2
+
+# if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO)
+
+#  define ERROR			AFB_ERROR_V2
+#  define WARNING		AFB_WARNING_V2
+#  define NOTICE		AFB_NOTICE_V2
+#  define INFO			AFB_INFO_V2
+#  define DEBUG			AFB_DEBUG_V2
+
+# endif
+
+#define afb_daemon_get_event_loop	afb_daemon_get_event_loop_v2
+#define afb_daemon_get_user_bus		afb_daemon_get_user_bus_v2
+#define afb_daemon_get_system_bus	afb_daemon_get_system_bus_v2
+#define afb_daemon_broadcast_event	afb_daemon_broadcast_event_v2
+#define afb_daemon_make_event		afb_daemon_make_event_v2
+#define afb_daemon_verbose		afb_daemon_verbose_v2
+#define afb_daemon_rootdir_get_fd	afb_daemon_rootdir_get_fd_v2
+#define afb_daemon_rootdir_open_locale	afb_daemon_rootdir_open_locale_v2
+#define afb_daemon_queue_job		afb_daemon_queue_job_v2
+
+#define afb_service_call		afb_service_call_v2
+#define afb_service_call_sync		afb_service_call_sync_v2
+
+#endif
diff --git a/include/afb/afb-req-itf.h b/include/afb/afb-req-itf.h
index 8f8dc8a9..1d60daee 100644
--- a/include/afb/afb-req-itf.h
+++ b/include/afb/afb-req-itf.h
@@ -359,7 +359,12 @@ static inline int afb_req_unsubscribe(struct afb_req req, struct afb_event event
  * 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.
- * 'result' is the json object of the 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.
  */
 static inline void afb_req_subcall(struct afb_req req, const char *api, const char *verb, struct json_object *args, void (*callback)(void *closure, int iserror, struct json_object *result), void *closure)
 {
@@ -373,6 +378,10 @@ static inline void afb_req_subcall(struct afb_req req, const char *api, const ch
  * It returns 0 on an error answer and returns 1 when no error was detected.
  * The object pointed by 'result' is filled and must be released by the caller
  * after its use by calling 'json_object_put'.
+ *
+ * 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.
  */
 static inline int afb_req_subcall_sync(struct afb_req req, const char *api, const char *verb, struct json_object *args, struct json_object **result)
 {
diff --git a/include/afb/afb-service-common.h b/include/afb/afb-service-common.h
index 76f8e4e4..081b1db6 100644
--- a/include/afb/afb-service-common.h
+++ b/include/afb/afb-service-common.h
@@ -32,6 +32,9 @@ struct afb_service_itf
 
 	void (*call)(void *closure, const char *api, const char *verb, struct json_object *args,
 	             void (*callback)(void*, int, struct json_object*), void *callback_closure);
+
+	int (*call_sync)(void *closure, const char *api, const char *verb, struct json_object *args,
+	                 struct json_object **result);
 };
 
 /*
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);
+}
+
diff --git a/include/afb/afb-service-v2.h b/include/afb/afb-service-v2.h
index 84da1209..2d138350 100644
--- a/include/afb/afb-service-v2.h
+++ b/include/afb/afb-service-v2.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,
@@ -32,8 +36,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_v2(
@@ -46,3 +48,30 @@ static inline void afb_service_call_v2(
 	afb_get_service_v2().itf->call(afb_get_service_v2().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_v2(
+	const char *api,
+	const char *verb,
+	struct json_object *args,
+	struct json_object **result)
+{
+	return afb_get_service_v2().itf->call_sync(afb_get_service_v2().closure, api, verb, args, result);
+}
+