X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Fafb%2Fafb-event-itf.h;h=3d66a893fe71b4ff7649bd888053c0762253dbe5;hb=8a30491d5e60239a338e485311a29c43398726e9;hp=b89b94153eb02d5c1ae3bd70f8dd44ced3036206;hpb=7059e59cddc1c81321639875636e88895bc14309;p=src%2Fapp-framework-binder.git

diff --git a/include/afb/afb-event-itf.h b/include/afb/afb-event-itf.h
index b89b9415..3d66a893 100644
--- a/include/afb/afb-event-itf.h
+++ b/include/afb/afb-event-itf.h
@@ -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");
@@ -25,28 +25,41 @@ 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 {
+ */
+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);
 };
 
 /*
  * 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' */
 };
 
+/*
+ * 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 +71,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 +86,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 +95,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);
+}
+