Introduce afb_eventid

This new name is better suited because it is not an event
but the id of an event.

This also prepares the new api with pointers.

Change-Id: I7be88bb36cf72bf7df70793a77452e405130b951
Signed-off-by: José Bollo <jose.bollo@iot.bzh>

7 files changed, 230 insertions, 100 deletions

diff --git a/include/afb/afb-binding-v1.h b/include/afb/afb-binding-v1.h
index 6c9b5c19..4f881cd9 100644
--- a/include/afb/afb-binding-v1.h
+++ b/include/afb/afb-binding-v1.h
@@ -20,7 +20,7 @@
 struct json_object;
 
 #include "afb-req-common.h"
-#include "afb-event-itf.h"
+#include "afb-event.h"
 #include "afb-service-common.h"
 #include "afb-daemon-common.h"
 
diff --git a/include/afb/afb-binding-v2.h b/include/afb/afb-binding-v2.h
index 4780b4ef..8e88b4fd 100644
--- a/include/afb/afb-binding-v2.h
+++ b/include/afb/afb-binding-v2.h
@@ -20,7 +20,7 @@
 #include <stdint.h>
 
 #include "afb-auth.h"
-#include "afb-event-itf.h"
+#include "afb-event.h"
 #include "afb-req-common.h"
 #include "afb-service-common.h"
 #include "afb-daemon-common.h"
diff --git a/include/afb/afb-event-itf.h b/include/afb/afb-event-itf.h
index 6827d86a..8f2bfc78 100644
--- a/include/afb/afb-event-itf.h
+++ b/include/afb/afb-event-itf.h
@@ -17,102 +17,10 @@
 
 #pragma once
 
-/* avoid inclusion of <json-c/json.h> */
-struct json_object;
+#pragma GCC warning "\n\n\
+    This header file <afb/afb-event-itf.h> is OBSOLETE.\n\
+    It is provided for COMPATIBILITY ONLY.\n\n\
+    Please USE <afb/afb-binding.h> and ADAPT YOUR CODE to new names.\n"
 
-/*
- * Interface for handling requests.
- * 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 (*unref)(void *closure);
-	const char *(*name)(void *closure);
-	void (*addref)(void *closure);
-};
-
-/*
- * Describes the request of afb-daemon for bindings
- */
-struct afb_event
-{
-	const struct afb_event_itf *itf;	/* the interface to use */
-	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;
-}
-
-/*
- * Broadcasts widely the 'event' with the data 'object'.
- * 'object' can be NULL.
- *
- * 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.
- *
- * Returns the count of clients that received the event.
- */
-static inline int afb_event_broadcast(struct afb_event event, struct json_object *object)
-{
-	return event.itf->broadcast(event.closure, object);
-}
-
-/*
- * Pushes the 'event' with the data 'object' to its observers.
- * 'object' can be NULL.
- *
- * 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.
- *
- * Returns the count of clients that received the event.
- */
-static inline int afb_event_push(struct afb_event event, struct json_object *object)
-{
-	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);
-}
-
-/*
- * 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_addref(struct afb_event event)
-{
-	event.itf->addref(event.closure);
-}
+#include "afb-binding.h"
 
diff --git a/include/afb/afb-event.h b/include/afb/afb-event.h
new file mode 100644
index 00000000..c3686fdd
--- /dev/null
+++ b/include/afb/afb-event.h
@@ -0,0 +1,98 @@
+/*
+ * Copyright (C) 2016, 2017 "IoT.bzh"
+ * Author: José Bollo <jose.bollo@iot.bzh>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include "afb-eventid-itf.h"
+
+/*
+ * Describes the request of afb-daemon for bindings
+ */
+struct afb_event
+{
+	const struct afb_eventid_itf *itf;	/* the interface to use */
+	struct afb_eventid *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;
+}
+
+/*
+ * Broadcasts widely the 'event' with the data 'object'.
+ * 'object' can be NULL.
+ *
+ * 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.
+ *
+ * Returns the count of clients that received the event.
+ */
+static inline int afb_event_broadcast(struct afb_event event, struct json_object *object)
+{
+	return event.itf->broadcast(event.closure, object);
+}
+
+/*
+ * Pushes the 'event' with the data 'object' to its observers.
+ * 'object' can be NULL.
+ *
+ * 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.
+ *
+ * Returns the count of clients that received the event.
+ */
+static inline int afb_event_push(struct afb_event event, struct json_object *object)
+{
+	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);
+}
+
+/*
+ * Decreases 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);
+}
+
+/*
+ * Increases the count of reference to 'event'
+ */
+static inline void afb_event_addref(struct afb_event event)
+{
+	event.itf->addref(event.closure);
+}
+
diff --git a/include/afb/afb-eventid-itf.h b/include/afb/afb-eventid-itf.h
new file mode 100644
index 00000000..84ba2f97
--- /dev/null
+++ b/include/afb/afb-eventid-itf.h
@@ -0,0 +1,48 @@
+/*
+ * Copyright (C) 2016, 2017 "IoT.bzh"
+ * Author: José Bollo <jose.bollo@iot.bzh>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+struct json_object;
+struct afb_eventid;
+struct afb_eventid_itf;
+
+/*
+ * Interface for handling requests.
+ * It records the functions to be called for the request.
+ * Don't use this structure directly.
+ * Use the helper functions documented below.
+ */
+struct afb_eventid_itf
+{
+	/* CAUTION: respect the order, add at the end */
+
+	int (*broadcast)(struct afb_eventid *eventid, struct json_object *obj);
+	int (*push)(struct afb_eventid *eventid, struct json_object *obj);
+	void (*unref)(struct afb_eventid *eventid); /* aka drop */
+	const char *(*name)(struct afb_eventid *eventid);
+	struct afb_eventid *(*addref)(struct afb_eventid *eventid);
+};
+
+/*
+ * Describes the request of afb-daemon for bindings
+ */
+struct afb_eventid
+{
+	const struct afb_eventid_itf *itf;	/* the interface to use */
+};
+
diff --git a/include/afb/afb-eventid.h b/include/afb/afb-eventid.h
new file mode 100644
index 00000000..6f0ed329
--- /dev/null
+++ b/include/afb/afb-eventid.h
@@ -0,0 +1,76 @@
+/*
+ * Copyright (C) 2016, 2017 "IoT.bzh"
+ * Author: José Bollo <jose.bollo@iot.bzh>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include "afb-eventid-itf.h"
+
+/*
+ * Broadcasts widely an event of 'eventid' with the data 'object'.
+ * 'object' can be NULL.
+ *
+ * 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.
+ *
+ * Returns the count of clients that received the event.
+ */
+static inline int afb_eventid_broadcast(struct afb_eventid *eventid, struct json_object *object)
+{
+	return eventid->itf->broadcast(eventid, object);
+}
+
+/*
+ * Pushes an event of 'eventid' with the data 'object' to its observers.
+ * 'object' can be NULL.
+ *
+ * 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.
+ *
+ * Returns the count of clients that received the event.
+ */
+static inline int afb_eventid_push(struct afb_eventid *eventid, struct json_object *object)
+{
+	return eventid->itf->push(eventid, object);
+}
+
+/*
+ * Gets the name associated to 'eventid'.
+ */
+static inline const char *afb_eventid_name(struct afb_eventid *eventid)
+{
+	return eventid->itf->name(eventid);
+}
+
+/*
+ * Decrease the count of reference to 'eventid' and
+ * destroys the eventid when the reference count falls to zero.
+ */
+static inline void afb_eventid_unref(struct afb_eventid *eventid)
+{
+	eventid->itf->unref(eventid);
+}
+
+/*
+ * Increases the count of reference to 'eventid'
+ */
+static inline struct afb_eventid *afb_eventid_addref(struct afb_eventid *eventid)
+{
+	return eventid->itf->addref(eventid);
+}
+
diff --git a/include/afb/afb-req-common.h b/include/afb/afb-req-common.h
index adb0acf4..6784a3b1 100644
--- a/include/afb/afb-req-common.h
+++ b/include/afb/afb-req-common.h
@@ -19,7 +19,7 @@
 
 #include <stdarg.h>
 
-#include "afb-event-itf.h"
+#include "afb-event.h"
 
 struct json_object;
 struct afb_stored_req;