Struct ExpandedSwarm 

pub struct ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler>
where
    THandler: IntoProtocolsHandler,
{ /* private fields */ }

Contains the state of the network, plus the way it should behave.

Implementations

impl<TBehaviour, TInEvent, TOutEvent, THandler, THandleErr> ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler>

where TBehaviour: NetworkBehaviour<ProtocolsHandler = THandler>, TInEvent: Send + 'static, TOutEvent: Send + 'static, THandler: IntoProtocolsHandler + Send + 'static, THandler::Handler: ProtocolsHandler<InEvent = TInEvent, OutEvent = TOutEvent, Error = THandleErr>, THandleErr: Error + Send + 'static,

pub fn new( transport: Boxed<(PeerId, StreamMuxerBox)>, behaviour: TBehaviour, local_peer_id: PeerId, ) -> Self

Builds a new Swarm.

pub fn network_info(me: &Self) -> NetworkInfo

Returns information about the Network underlying the Swarm.

pub fn listen_on( me: &mut Self, addr: Multiaddr, ) -> Result<ListenerId, TransportError<Error>>

Starts listening on the given address.

Returns an error if the address is not supported.

pub fn remove_listener(me: &mut Self, id: ListenerId) -> Result<(), ()>

Remove some listener.

Returns Ok(()) if there was a listener with this ID.

pub fn dial_addr(me: &mut Self, addr: Multiaddr) -> Result<(), ConnectionLimit>

Initiates a new dialing attempt to the given address.

pub fn dial(me: &mut Self, peer_id: &PeerId) -> Result<(), DialError>

Initiates a new dialing attempt to the given peer.

pub fn listeners(me: &Self) -> impl Iterator<Item = &Multiaddr>

Returns an iterator that produces the list of addresses we’re listening on.

pub fn local_peer_id(me: &Self) -> &PeerId

Returns the peer ID of the swarm passed as parameter.

pub fn external_addresses(me: &Self) -> impl Iterator<Item = &AddressRecord>

Returns an iterator for AddressRecords of external addresses of the local node, in decreasing order of their current score.

pub fn add_external_address( me: &mut Self, a: Multiaddr, s: AddressScore, ) -> AddAddressResult

Adds an external address record for the local node.

An external address is an address of the local node known to be (likely) reachable for other nodes, possibly taking into account NAT. The external addresses of the local node may be shared with other nodes by the NetworkBehaviour.

The associated score determines both the position of the address in the list of external addresses (which can determine the order in which addresses are used to connect to) as well as how long the address is retained in the list, depending on how frequently it is reported by the NetworkBehaviour via NetworkBehaviourAction::ReportObservedAddr or explicitly through this method.

pub fn remove_external_address(me: &mut Self, addr: &Multiaddr) -> bool

Removes an external address of the local node, regardless of its current score. See ExpandedSwarm::add_external_address for details.

Returns true if the address existed and was removed, false otherwise.

pub fn ban_peer_id(me: &mut Self, peer_id: PeerId)

Bans a peer by its peer ID.

Any incoming connection and any dialing attempt will immediately be rejected. This function has no effect if the peer is already banned.

pub fn unban_peer_id(me: &mut Self, peer_id: PeerId)

Unbans a peer.

pub fn is_connected(me: &Self, peer_id: &PeerId) -> bool

Checks whether the Network has an established connection to a peer.

pub fn is_dialing(me: &Self, peer_id: &PeerId) -> bool

Checks whether the Network dealing to the peer.

pub async fn next_event( &mut self, ) -> SwarmEvent<TBehaviour::OutEvent, THandleErr>

Returns the next event that happens in the Swarm.

Includes events from the NetworkBehaviour but also events about the connections status.

pub async fn next(&mut self) -> TBehaviour::OutEvent

Returns the next event produced by the NetworkBehaviour.

pub fn disconnect_peer(&mut self, peer_id: &PeerId)

pub fn get_behaviour(&mut self) -> &mut TBehaviour

Trait Implementations

impl<TBehaviour, TInEvent, TOutEvent, THandler> Deref for ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler>

where THandler: IntoProtocolsHandler,

type Target = TBehaviour

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<TBehaviour, TInEvent, TOutEvent, THandler> DerefMut for ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler>

where THandler: IntoProtocolsHandler,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<TBehaviour, TInEvent, TOutEvent, THandler> FusedStream for ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler>

where TBehaviour: NetworkBehaviour<ProtocolsHandler = THandler>, THandler: IntoProtocolsHandler + Send + 'static, TInEvent: Send + 'static, TOutEvent: Send + 'static, THandler::Handler: ProtocolsHandler<InEvent = TInEvent, OutEvent = TOutEvent>,

the stream of behaviour events never terminates, so we can implement fused for it

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<TBehaviour, TInEvent, TOutEvent, THandler> Stream for ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler>

where TBehaviour: NetworkBehaviour<ProtocolsHandler = THandler>, THandler: IntoProtocolsHandler + Send + 'static, TInEvent: Send + 'static, TOutEvent: Send + 'static, THandler::Handler: ProtocolsHandler<InEvent = TInEvent, OutEvent = TOutEvent>,

type Item = <TBehaviour as NetworkBehaviour>::OutEvent

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<TBehaviour, TInEvent, TOutEvent, THandler> Unpin for ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler>

where THandler: IntoProtocolsHandler,