docs: GossipHandle::broadcast() blocking semantics
Document what happens when the gossip message queue is full.pull/24376/head
parent
6ea8c99c01
commit
117d70d807
|
@ -50,6 +50,9 @@ impl GossipHandle {
|
|||
///
|
||||
/// This is a best-effort operation - peers are not guaranteed to receive
|
||||
/// this broadcast.
|
||||
///
|
||||
/// If the outgoing message queue is full, this method blocks and waits for
|
||||
/// space to become available.
|
||||
pub async fn broadcast<T>(&self, payload: T) -> Result<(), PayloadSizeError>
|
||||
where
|
||||
T: Into<Bytes> + Send,
|
||||
|
|
Loading…
Reference in New Issue