Struct libp2prs_swarm::Swarm

pub struct Swarm { /* fields omitted */ }

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

Implementations

impl Swarm

pub fn new(key: PublicKey) -> Self

Builds a new Swarm.

pub fn with_transport(mut self: Self, transport: ITransportEx) -> Self

Adds transport to Swarm.

pub fn with_protocol(mut self: Self, p: IProtocolHandler) -> Self

Creates Swarm with protocol handler.

pub fn with_ping(mut self: Self, ping: PingConfig) -> Self

Creates Swarm with Ping service.

pub fn with_routing(mut self: Self, routing: IRouting) -> Self

Creates Swarm with routing service.

pub fn with_metric(mut self: Self, metric: Metric) -> Self

Creates Swarm with Metrics.

pub fn with_identify(mut self: Self, config: IdentifyConfig) -> Self

Creates Swarm with Identify service.

pub fn control(&self) -> Control

Get an API controller for Swarm.

pub fn start(self)

Starts Swarm background task handling the internal events and external controls

pub fn listen_on(&mut self, addrs: Vec<Multiaddr>) -> Result<(), SwarmError>

Starts listening on the given address.

Returns an error if the address is not supported.

pub fn local_pubkey(&self) -> &PublicKey

Returns the peer ID of the swarm passed as parameter.

pub fn local_peer_id(&self) -> &PeerId

Returns the peer ID of the swarm passed as parameter.

pub fn ban_peer_id(&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 is the peer is already banned.

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

Unbans a peer.