From: Timo Sirainen Date: Wed, 12 Aug 2020 08:57:26 +0000 (+0300) Subject: lib: Clarify o_stream_set_flush_pending() comment related to corking X-Git-Tag: 2.3.13~415 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=1bbb54716a5ce4c957f9ada2c353c55b77c8ed3c;p=thirdparty%2Fdovecot%2Fcore.git lib: Clarify o_stream_set_flush_pending() comment related to corking --- diff --git a/src/lib/ostream.h b/src/lib/ostream.h index 99c1a8c9c2..59c7df77fc 100644 --- a/src/lib/ostream.h +++ b/src/lib/ostream.h @@ -152,7 +152,9 @@ static inline int o_stream_uncork_flush(struct ostream *stream) } /* Set "flush pending" state of stream. If set, the flush callback is called - when more data is allowed to be sent, even if the buffer itself is empty. */ + when more data is allowed to be sent, even if the buffer itself is empty. + Note that if the stream is corked, the flush callback won't be called until + the stream is first uncorked. */ void o_stream_set_flush_pending(struct ostream *stream, bool set); /* Returns the number of bytes currently in all the pending write buffers of this ostream, including its parent streams. This function is commonly used