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
Move tokens from sessions to requests
[src/app-framework-binder.git]
/
docs
/
reference-v3
/
func-event.md
diff --git
a/docs/reference-v3/func-event.md
b/docs/reference-v3/func-event.md
index
d96095a
..
7f0c3e7
100644
(file)
--- a/
docs/reference-v3/func-event.md
+++ b/
docs/reference-v3/func-event.md
@@
-1,4
+1,4
@@
-Functions of class **afb_event
_t
**
+Functions of class **afb_event**
==============================
## General functions
==============================
## General functions
@@
-78,7
+78,7
@@
afb_event_t *afb_event_addref(
* @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
*/
int afb_event_broadcast(
afb_event_t event,
*/
int afb_event_broadcast(
afb_event_t event,
@@
-99,7
+99,10
@@
int afb_event_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)
*/
int afb_event_push(
afb_event_t event,
*/
int afb_event_push(
afb_event_t event,