aboutsummaryrefslogtreecommitdiffstats
path: root/include/afb/afb-eventid.h
diff options
context:
space:
mode:
authorJosé Bollo <jose.bollo@iot.bzh>2017-09-21 13:11:02 +0200
committerJosé Bollo <jose.bollo@iot.bzh>2017-10-09 14:08:32 +0200
commitc12c74c208a30c5b18716b8faa464f0b4f643255 (patch)
treecdc3d6d44a7105aa43173601acbfbec7ed53e5fd /include/afb/afb-eventid.h
parent271bb6fc606fc5068a7b7a8f22b0052aca2fb900 (diff)
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>
Diffstat (limited to 'include/afb/afb-eventid.h')
-rw-r--r--include/afb/afb-eventid.h76
1 files changed, 76 insertions, 0 deletions
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);
+}
+