diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/reference-v3/func-api.md | 2 | ||||
| -rw-r--r-- | docs/reference-v3/func-event.md | 7 |
2 files changed, 6 insertions, 3 deletions
diff --git a/docs/reference-v3/func-api.md b/docs/reference-v3/func-api.md index 454bc0f6..66dd4c9d 100644 --- a/docs/reference-v3/func-api.md +++ b/docs/reference-v3/func-api.md @@ -428,7 +428,7 @@ int afb_api_queue_job( * @param name the event name suffix * @param object the object that comes with the event * - * @return the count of clients that received the event. + * @return 0 in case of success or -1 in case of error */ int afb_api_broadcast_event( afb_api_t api, diff --git a/docs/reference-v3/func-event.md b/docs/reference-v3/func-event.md index 477cead6..7f0c3e72 100644 --- a/docs/reference-v3/func-event.md +++ b/docs/reference-v3/func-event.md @@ -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) * - * @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, @@ -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) * - * @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, |