fluencelabs/rust-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-06-21 13:51:33 +00:00
Code Issues Projects Releases Wiki Activity

swarm/src/behaviour: Document impact of blocking code (#2482)

Browse Source 
Co-authored-by: Max Inden <mail@max-inden.de>
This commit is contained in:
Frederik-Baetens
2022-02-09 20:26:59 +01:00
committed by GitHub
parent 44d63d8ed4
commit b39770b8e9
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
swarm/src/behaviour.rs
View File

@ -152,6 +152,13 @@ type THandlerInEvent<THandler> =
/// struct members are delegated to [`NetworkBehaviourEventProcess`] implementations. Those must be /// struct members are delegated to [`NetworkBehaviourEventProcess`] implementations. Those must be
/// provided by the user on the type that [`NetworkBehaviour`] is derived on. /// provided by the user on the type that [`NetworkBehaviour`] is derived on.
/// ///
/// Because these implementations are granted exclusive access to the [`NetworkBehaviour`],
/// [blocking code](https://ryhl.io/blog/async-what-is-blocking/) in these implementations will
/// block the entire [`Swarm`](crate::Swarm) from processing new events, since the swarm cannot progress
/// without also having exclusive access to the [`NetworkBehaviour`]. A better alternative is to execute
/// blocking or asynchronous logic on a separate task, perhaps with the help of a bounded channel to
/// maintain backpressure. The sender for the channel could be included in the NetworkBehaviours constructor.
///
/// Optionally one can provide a custom `poll` function through the `#[behaviour(poll_method = /// Optionally one can provide a custom `poll` function through the `#[behaviour(poll_method =
/// "poll")]` attribute. This function must have the same signature as the [`NetworkBehaviour#poll`] /// "poll")]` attribute. This function must have the same signature as the [`NetworkBehaviour#poll`]
/// function and will be called last within the generated [`NetworkBehaviour`] implementation. /// function and will be called last within the generated [`NetworkBehaviour`] implementation.