mirror of
https://github.com/strophe/libstrophe.git
synced 2026-07-18 03:46:21 +00:00
Document handler return values.
This commit is contained in:
@@ -475,6 +475,9 @@ void xmpp_handler_delete(xmpp_conn_t * const conn,
|
||||
* to fire handlers as close to the period times as it can, but accuracy
|
||||
* will vary depending on the resolution of the event loop.
|
||||
*
|
||||
* If the handler function returns true, it will be kept, and if it
|
||||
* returns false, it will be deleted from the list of handlers.
|
||||
*
|
||||
* @param conn a Strophe connection object
|
||||
* @param handler a function pointer to a timed handler
|
||||
* @param period the time in milliseconds between firings
|
||||
@@ -513,6 +516,9 @@ void handler_add_timed(xmpp_conn_t * const conn,
|
||||
* type 'result' or 'error' with a specific id attribute. This can
|
||||
* be used to handle responses to specific <iq/>s.
|
||||
*
|
||||
* If the handler function returns true, it will be kept, and if it
|
||||
* returns false, it will be deleted from the list of handlers.
|
||||
*
|
||||
* @param conn a Strophe connection object
|
||||
* @param handler a function pointer to a stanza handler
|
||||
* @param id a string with the id
|
||||
@@ -555,6 +561,9 @@ void handler_add_id(xmpp_conn_t * const conn,
|
||||
* handle specific <iq/> stanzas based on the <query/>
|
||||
* child namespace.
|
||||
*
|
||||
* If the handler function returns true, it will be kept, and if it
|
||||
* returns false, it will be deleted from the list of handlers.
|
||||
*
|
||||
* @param conn a Strophe connection object
|
||||
* @param handler a function pointer to a stanza handler
|
||||
* @param ns a string with the namespace to match
|
||||
|
||||
Reference in New Issue
Block a user