Make afb_event_drop obsolete
[src/app-framework-binder.git] / include / afb / afb-event-itf.h
index 5f7b837..6827d86 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2016 "IoT.bzh"
+ * Copyright (C) 2016, 2017 "IoT.bzh"
  * Author: José Bollo <jose.bollo@iot.bzh>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,18 +26,22 @@ struct json_object;
  * Don't use this structure directly.
  * Use the helper functions documented below.
  */
-struct afb_event_itf {
+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);
+       void (*unref)(void *closure);
+       const char *(*name)(void *closure);
+       void (*addref)(void *closure);
 };
 
 /*
  * Describes the request of afb-daemon for bindings
  */
-struct afb_event {
+struct afb_event
+{
        const struct afb_event_itf *itf;        /* the interface to use */
        void *closure;                          /* the closure argument for functions of 'itf' */
 };
@@ -49,7 +53,7 @@ struct afb_event {
  */
 static inline int afb_event_is_valid(struct afb_event event)
 {
-       return event.itf != NULL;
+       return !!event.itf;
 }
 
 /*
@@ -82,13 +86,33 @@ static inline int afb_event_push(struct afb_event event, struct json_object *obj
        return event.itf->push(event.closure, object);
 }
 
+/* OBSOLETE */
+#define afb_event_drop afb_event_unref
+
+/*
+ * Gets the name associated to the 'event'.
+ */
+static inline const char *afb_event_name(struct afb_event event)
+{
+       return event.itf->name(event.closure);
+}
+
+/*
+ * Decrease the count of reference to 'event' and
+ * destroys the event when the reference count falls to zero.
+ */
+static inline void afb_event_unref(struct afb_event event)
+{
+       event.itf->unref(event.closure);
+}
+
 /*
- * Drops the data associated to the event
+ * remove one reference to the data associated to the 'event'
  * After calling this function, the event
  * MUST NOT BE USED ANYMORE.
  */
-static inline void afb_event_drop(struct afb_event event)
+static inline void afb_event_addref(struct afb_event event)
 {
-       event.itf->drop(event.closure);
+       event.itf->addref(event.closure);
 }