event: add ability to get the event name

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

diff --git a/include/afb/afb-event-itf.h b/include/afb/afb-event-itf.h
index b89b941..ad9206a 100644 (file)
--- a/include/afb/afb-event-itf.h
+++ b/include/afb/afb-event-itf.h
@@ -25,13 +25,14 @@ struct json_object;
  * It records the functions to be called for the request.
  * Don't use this structure directly.
  * Use the helper functions documented below.
- */ 
+ */
 struct afb_event_itf {
        /* CAUTION: respect the order, add at the end */
 
        int (*broadcast)(void *closure, struct json_object *obj);
        int (*push)(void *closure, struct json_object *obj);
        void (*drop)(void *closure);
+       const char *(*name)(void *closure);
 };
 
 /*
@@ -42,11 +43,21 @@ struct afb_event {
        void *closure;                          /* the closure argument for functions of 'itf' */
 };
 
+/*
+ * Checks wether the 'event' is valid or not.
+ *
+ * Returns 0 if not valid or 1 if valid.
+ */
+static inline int afb_event_is_valid(struct afb_event event)
+{
+       return event.itf != NULL;
+}
+
 /*
  * Broadcasts widely the 'event' with the data 'object'.
  * 'object' can be NULL.
  *
- * For conveniency, the function calls 'json_object_put' for 'object'.
+ * For convenience, the function calls 'json_object_put' for 'object'.
  * Thus, in the case where 'object' should remain available after
  * the function returns, the function 'json_object_get' shall be used.
  *
@@ -58,10 +69,10 @@ static inline int afb_event_broadcast(struct afb_event event, struct json_object
 }
 
 /*
- * Pushes the 'event' with the data 'object' to its obeservers.
+ * Pushes the 'event' with the data 'object' to its observers.
  * 'object' can be NULL.
  *
- * For conveniency, the function calls 'json_object_put' for 'object'.
+ * For convenience, the function calls 'json_object_put' for 'object'.
  * Thus, in the case where 'object' should remain available after
  * the function returns, the function 'json_object_get' shall be used.
  *
@@ -73,7 +84,7 @@ static inline int afb_event_push(struct afb_event event, struct json_object *obj
 }
 
 /*
- * Drops the data associated to the event
+ * Drops the data associated to the 'event'
  * After calling this function, the event
  * MUST NOT BE USED ANYMORE.
  */
@@ -82,3 +93,11 @@ static inline void afb_event_drop(struct afb_event event)
        event.itf->drop(event.closure);
 }
 
+/*
+ * Gets the name associated to the 'event'.
+ */
+static inline const char *afb_event_name(struct afb_event event)
+{
+       return event.itf->name(event.closure);
+}
+