Events: refactoring

[src/app-framework-binder.git] / include / afb / afb-req-itf.h

diff --git a/include/afb/afb-req-itf.h b/include/afb/afb-req-itf.h
index 5767c85..2b3bc46 100644 (file)
--- a/include/afb/afb-req-itf.h
+++ b/include/afb/afb-req-itf.h
@@ -25,6 +25,8 @@
 #include <stdarg.h>
 #include <stdio.h>
 
+#include <afb/afb-event-itf.h>
+
 /* avoid inclusion of <json-c/json.h> */
 struct json_object;
 
@@ -65,6 +67,9 @@ struct afb_req_itf {
 
        void (*session_close)(void *closure);
        int (*session_set_LOA)(void *closure, unsigned level);
+
+       int (*subscribe)(void *closure, struct afb_event event);
+       int (*unsubscribe)(void *closure, struct afb_event event);
 };
 
 /*
@@ -130,6 +135,10 @@ static inline struct json_object *afb_req_json(struct afb_req req)
  * The status of the reply is automatically set to "success".
  * Its send the object 'obj' (can be NULL) with an
  * informationnal comment 'info (can also be NULL).
+ *
+ * For conveniency, the function calls 'json_object_put' for 'obj'.
+ * Thus, in the case where 'obj' should remain available after
+ * the function returns, the function 'json_object_get' shall be used.
  */
 static inline void afb_req_success(struct afb_req req, struct json_object *obj, const char *info)
 {
@@ -139,6 +148,10 @@ static inline void afb_req_success(struct afb_req req, struct json_object *obj,
 /*
  * Same as 'afb_req_success' but the 'info' is a formatting
  * string followed by arguments.
+ *
+ * For conveniency, the function calls 'json_object_put' for 'obj'.
+ * Thus, in the case where 'obj' should remain available after
+ * the function returns, the function 'json_object_get' shall be used.
  */
 static inline void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...)
 {
@@ -160,6 +173,10 @@ static inline void afb_req_success_f(struct afb_req req, struct json_object *obj
  * Note that calling afb_req_fail("success", info) is equivalent
  * to call afb_req_success(NULL, info). Thus even if possible it
  * is strongly recommanded to NEVER use "success" for status.
+ *
+ * For conveniency, the function calls 'json_object_put' for 'obj'.
+ * Thus, in the case where 'obj' should remain available after
+ * the function returns, the function 'json_object_get' shall be used.
  */
 static inline void afb_req_fail(struct afb_req req, const char *status, const char *info)
 {
@@ -169,6 +186,10 @@ static inline void afb_req_fail(struct afb_req req, const char *status, const ch
 /*
  * Same as 'afb_req_fail' but the 'info' is a formatting
  * string followed by arguments.
+ *
+ * For conveniency, the function calls 'json_object_put' for 'obj'.
+ * Thus, in the case where 'obj' should remain available after
+ * the function returns, the function 'json_object_get' shall be used.
  */
 static inline void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...)
 {
@@ -299,6 +320,29 @@ static inline struct afb_req afb_req_unstore(struct afb_req *req)
        return result;
 }
 
+/*
+ * Establishes for the client link identified by 'req' a subscription
+ * to the 'event'.
+ * Returns 0 in case of successful subscription or -1 in case of error.
+ */
+static inline int afb_req_subscribe(struct afb_req req, struct afb_event event)
+{
+       return req.itf->subscribe(req.closure, event);
+}
+
+/*
+ * Revokes the subscription established to the 'event' for the client
+ * link identified by 'req'.
+ * Returns 0 in case of successful subscription or -1 in case of error.
+ */
+static inline int afb_req_unsubscribe(struct afb_req req, struct afb_event event)
+{
+       return req.itf->unsubscribe(req.closure, event);
+}
+
+
+
+
 /* internal use */
 static inline const char *afb_req_raw(struct afb_req req, size_t *size)
 {