hubcio commented on code in PR #4501:
URL: https://github.com/apache/iggy/pull/4501#discussion_r4255538939
##########
core/common/src/traits/client.rs:
##########
@@ -67,5 +67,10 @@ pub trait Client:
async fn shutdown(&self) -> Result<(), IggyError>;
/// Subscribe to diagnostic events.
+ ///
+ /// The event channel is bounded. When it is full, the client drops the
+ /// oldest event, so publishing never waits for a subscriber. A subscriber
+ /// that falls behind loses old events, not the newest ones. HTTP keeps no
Review Comment:
warning: these docs omit that `recv()` returns `RecvError::Overflowed`
before retained events. document that callers must retry `recv()` after
overflow or use `StreamExt::next()`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
