summaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
Diffstat (limited to 'include')
-rw-r--r--include/afb/afb-daemon-v1.h2
-rw-r--r--include/afb/afb-daemon-v2.h2
-rw-r--r--include/afb/afb-event-x2.h7
3 files changed, 7 insertions, 4 deletions
diff --git a/include/afb/afb-daemon-v1.h b/include/afb/afb-daemon-v1.h
index c268bb83..0a821b72 100644
--- a/include/afb/afb-daemon-v1.h
+++ b/include/afb/afb-daemon-v1.h
@@ -68,7 +68,7 @@ static inline struct sd_bus *afb_daemon_get_system_bus_v1(struct afb_daemon_x1 d
*
* Calling this function is only forbidden during preinit.
*
- * Returns the count of clients that received the event.
+ * Returns 0 in case of success or -1 in case of error
*/
static inline int afb_daemon_broadcast_event_v1(struct afb_daemon_x1 daemon, const char *name, struct json_object *object)
{
diff --git a/include/afb/afb-daemon-v2.h b/include/afb/afb-daemon-v2.h
index 65e4afbc..220ce0b7 100644
--- a/include/afb/afb-daemon-v2.h
+++ b/include/afb/afb-daemon-v2.h
@@ -64,7 +64,7 @@ static inline struct sd_bus *afb_daemon_get_system_bus_v2()
*
* Calling this function is only forbidden during preinit.
*
- * Returns the count of clients that received the event.
+ * Returns 0 in case of success or -1 in case of error
*/
static inline int afb_daemon_broadcast_event_v2(const char *name, struct json_object *object)
{
diff --git a/include/afb/afb-event-x2.h b/include/afb/afb-event-x2.h
index 9732cad1..beb31f9d 100644
--- a/include/afb/afb-event-x2.h
+++ b/include/afb/afb-event-x2.h
@@ -45,7 +45,7 @@ static inline int afb_event_x2_is_valid(struct afb_event_x2 *event)
* @param event the event to broadcast
* @param object the companion object to associate to the broadcasted event (can be NULL)
*
- * @return the count of clients that received the event.
+ * @return 0 in case of success or -1 in case of error
*/
static inline int afb_event_x2_broadcast(
struct afb_event_x2 *event,
@@ -65,7 +65,10 @@ static inline int afb_event_x2_broadcast(
* @param event the event to push
* @param object the companion object to associate to the pushed event (can be NULL)
*
- * @return the count of clients that received the event.
+ * @Return
+ * * 1 if at least one client listen for the event
+ * * 0 if no more client listen for the event
+ * * -1 in case of error (the event can't be delivered)
*/
static inline int afb_event_x2_push(
struct afb_event_x2 *event,