summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--server/red-channel.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/server/red-channel.h b/server/red-channel.h
index 8bec1f30..4cb18eb7 100644
--- a/server/red-channel.h
+++ b/server/red-channel.h
@@ -210,9 +210,13 @@ const RedChannelCapabilities* red_channel_get_local_capabilities(RedChannel *sel
*
* timeout is in nano sec. -1 for no timeout.
*
+ * This method tries for up to @timeout nanoseconds to send all the
+ * items which are currently queued. If the timeout elapses,
+ * the RedChannelClient which are too slow (those which still have pending
+ * items) will be disconnected.
+ *
* Return: TRUE if waiting succeeded. FALSE if timeout expired.
*/
-
bool red_channel_wait_all_sent(RedChannel *channel,
int64_t timeout);