Code Review
/
src
/
app-framework-binder.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Update copyright dates
[src/app-framework-binder.git]
/
include
/
afb
/
afb-event-x2.h
diff --git
a/include/afb/afb-event-x2.h
b/include/afb/afb-event-x2.h
index
f0a2787
..
0caa706
100644
(file)
--- a/
include/afb/afb-event-x2.h
+++ b/
include/afb/afb-event-x2.h
@@
-1,5
+1,5
@@
/*
/*
- * Copyright (C) 201
6, 2017, 2018
"IoT.bzh"
+ * Copyright (C) 201
5-2020
"IoT.bzh"
* Author: José Bollo <jose.bollo@iot.bzh>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* Author: José Bollo <jose.bollo@iot.bzh>
*
* Licensed under the Apache License, Version 2.0 (the "License");
@@
-19,6
+19,9
@@
#include "afb-event-x2-itf.h"
#include "afb-event-x2-itf.h"
+/** @defgroup AFB_EVENT
+ * @{ */
+
/**
* Checks whether the 'event' is valid or not.
*
/**
* Checks whether the 'event' is valid or not.
*
@@
-42,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)
*
* @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,
*/
static inline int afb_event_x2_broadcast(
struct afb_event_x2 *event,
@@
-62,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)
*
* @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,
*/
static inline int afb_event_x2_push(
struct afb_event_x2 *event,
@@
-111,3
+117,4
@@
static inline struct afb_event_x2 *afb_event_x2_addref(
return event->itf->addref(event);
}
return event->itf->addref(event);
}
+/** @} */