Struct ckb_network::network::NetworkController

pub struct NetworkController { /* private fields */ }

Network controller

Implementations

impl NetworkController

pub fn public_urls(&self, max_urls: usize) -> Vec<(String, u8)>

Node listen address list

pub fn version(&self) -> &String

ckb version

pub fn node_id(&self) -> String

Node peer id’s base58 format string

pub fn p2p_control(&self) -> &ServiceControl

p2p service control

pub fn add_node(&self, address: Multiaddr)

Dial remote node

pub fn remove_node(&self, peer_id: &PeerId)

Disconnect session with peer id

pub fn get_banned_addrs(&self) -> Vec<BannedAddr>

Get banned peer list

pub fn clear_banned_addrs(&self)

Clear banned list

pub fn addr_info(&self, addr: &Multiaddr) -> Option<AddrInfo>

Get address info from peer store

pub fn ban(&self, address: IpNetwork, ban_until: u64, ban_reason: String)

Ban an ip

pub fn unban(&self, address: &IpNetwork)

Unban an ip

pub fn connected_peers(&self) -> Vec<(PeerIndex, Peer)>

Return all connected peers’ information

pub fn ban_peer(&self, peer_index: PeerIndex, duration: Duration, reason: String)

Ban an peer through peer index

pub fn broadcast(
    &self,
    proto_id: ProtocolId,
    data: Bytes
) -> Result<(), SendErrorKind>

Broadcast a message to all connected peers

pub fn quick_broadcast(
    &self,
    proto_id: ProtocolId,
    data: Bytes
) -> Result<(), SendErrorKind>

Broadcast a message to all connected peers through quick queue

pub fn send_message_to(
    &self,
    session_id: SessionId,
    proto_id: ProtocolId,
    data: Bytes
) -> Result<(), SendErrorKind>

Send message to one connected peer

pub fn is_active(&self) -> bool

network message processing controller, always true, if false, discard any received messages

pub fn set_active(&self, active: bool)

Change active status, if set false discard any received messages

pub fn protocols(&self) -> Vec<(ProtocolId, String, Vec<String>)>

Return all connected peers’ protocols info

pub fn ping_peers(&self)

Try ping all connected peers

pub fn non_owning_clone(&self) -> Self

Since a non-owning reference does not count towards ownership, it will not prevent the value stored in the allocation from being dropped

Trait Implementations

impl Clone for NetworkController

fn clone(&self) -> NetworkController

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for NetworkController

fn drop(&mut self)

Executes the destructor for this type.