Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

Slightly improved documentation. #9976

Merged
gilescope merged 4 commits into from
Oct 19, 2021
Merged

Slightly improved documentation. #9976

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f4e7c8d
Slightly improved documentation.
eskimor Oct 8, 2021
58e05c1
Update client/network/src/service.rs
eskimor Oct 8, 2021
c283732
cargo fmt
gilescope Oct 19, 2021
ef88339
Merge branch 'master' into rk-better-docs
gilescope Oct 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions client/network/src/service.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1097,6 +1097,15 @@ impl<B: BlockT + 'static, H: ExHashT> NetworkService<B, H> {
/// Each `Multiaddr` must end with a `/p2p/` component containing the `PeerId`. It can also
/// consist of only `/p2p/<peerid>`.
///
/// The node will start establishing/accepting connections and substreams to/from peers in this
/// set, if it doesn't have any substream open with them yet.
///
/// Note however, if a call to this function results in less peers on the reserved set, they
/// will not necessarily get disconnected (depending on available free slots in the peer set).
/// If you want to also disconnect those removed peers, you will have to call
/// `remove_from_peers_set` on those in addition to updating the reserved set. You can omit
/// this step if the peer set is in reserved only mode.
///
/// Returns an `Err` if one of the given addresses is invalid or contains an
/// invalid peer ID (which includes the local peer ID).
pub fn set_reserved_peers(
Expand Down