Struct ckb_network::network::NetworkController

source · [−]

pub struct NetworkController { /* private fields */ }

Expand description

Network controller

Implementations

source

impl NetworkController

source

pub fn public_urls(&self, max_urls: usize) -> Vec<(String, u8)>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Node listen address list

source

pub fn version(&self) -> &String

ckb version

source

pub fn node_id(&self) -> String

Node peer id’s base58 format string

source

pub fn add_node(&self, address: Multiaddr)

Dial remote node

source

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

Disconnect session with peer id

source

pub fn get_banned_addrs(&self) -> Vec<BannedAddr>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get banned peer list

source

pub fn clear_banned_addrs(&self)

Clear banned list

source

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

Get address info from peer store

source

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

Ban an ip

source

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

Unban an ip

source

pub fn connected_peers(&self) -> Vec<(PeerIndex, Peer)>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Return all connected peers’ information

source

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

Ban an peer through peer index

source

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

Broadcast a message to all connected peers

source

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

Broadcast a message to all connected peers through quick queue

source

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

Send message to one connected peer

source

pub fn is_active(&self) -> bool

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

source

pub fn set_active(&self, active: bool)

Change active status, if set false discard any received messages

source

pub fn protocols(&self) -> Vec<(ProtocolId, String, Vec<String>)>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Return all connected peers’ protocols info

source

pub fn ping_peers(&self)

Try ping all connected peers

source

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

source

impl Clone for NetworkController

source

fn clone(&self) -> NetworkController

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Drop for NetworkController

source

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations

impl !RefUnwindSafe for NetworkController

impl Send for NetworkController

impl Sync for NetworkController

impl Unpin for NetworkController

impl !UnwindSafe for NetworkController

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AsAny for T where
T: Any,

fn as_any(&self) -> &(dyn Any + 'static)

TODO(doc): @quake

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct ckb_network::network::NetworkController

Implementations

impl NetworkController

pub fn public_urls(&self, max_urls: usize) -> Vec<(String, u8)>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn version(&self) -> &String

pub fn node_id(&self) -> String

pub fn add_node(&self, address: Multiaddr)

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

pub fn get_banned_addrs(&self) -> Vec<BannedAddr>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn clear_banned_addrs(&self)

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

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

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

pub fn connected_peers(&self) -> Vec<(PeerIndex, Peer)>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

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

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

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

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

pub fn is_active(&self) -> bool

pub fn set_active(&self, active: bool)

pub fn protocols(&self) -> Vec<(ProtocolId, String, Vec<String>)>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn ping_peers(&self)

pub fn non_owning_clone(&self) -> Self

Trait Implementations

impl Clone for NetworkController

fn clone(&self) -> NetworkController

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

impl Drop for NetworkController

fn drop(&mut self)

Auto Trait Implementations

impl !RefUnwindSafe for NetworkController

impl Send for NetworkController

impl Sync for NetworkController

impl Unpin for NetworkController

impl !UnwindSafe for NetworkController

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> AsAny for T where T: Any,

fn as_any(&self) -> &(dyn Any + 'static)

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn public_urls(&self, max_urls: usize) -> Vec<(String, u8)>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn get_banned_addrs(&self) -> Vec<BannedAddr>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn connected_peers(&self) -> Vec<(PeerIndex, Peer)>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

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

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

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

pub fn protocols(&self) -> Vec<(ProtocolId, String, Vec<String>)>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> AsAny for T where
T: Any,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,