Struct Router

pub struct Router<N: Network>(/* private fields */);

Implementations

impl<N: Network> Router<N>

pub async fn handshake<'a>( &'a self, peer_addr: SocketAddr, stream: &'a mut TcpStream, peer_side: ConnectionSide, genesis_header: Header<N>, restrictions_id: Field<N>, ) -> Result<(SocketAddr, Framed<&'a mut TcpStream, MessageCodec<N>>)>

Executes the handshake protocol.

impl<N: Network> Router<N>

pub async fn new( node_ip: SocketAddr, node_type: NodeType, account: Account<N>, trusted_peers: &[SocketAddr], max_peers: u16, rotate_external_peers: bool, allow_external_peers: bool, is_dev: bool, ) -> Result<Self>

Initializes a new Router instance.

impl<N: Network> Router<N>

pub fn connect(&self, peer_ip: SocketAddr) -> Option<JoinHandle<bool>>

Attempts to connect to the given peer IP.

pub fn disconnect(&self, peer_ip: SocketAddr) -> JoinHandle<bool>

Disconnects from the given peer IP, if the peer is connected.

pub fn local_ip(&self) -> SocketAddr

Returns the IP address of this node.

pub fn is_local_ip(&self, ip: &SocketAddr) -> bool

Returns true if the given IP is this node.

pub fn is_valid_peer_ip(&self, ip: &SocketAddr) -> bool

Returns true if the given IP is not this node, is not a bogon address, and is not unspecified.

pub fn node_type(&self) -> NodeType

Returns the node type.

pub fn private_key(&self) -> &PrivateKey<N>

Returns the account private key of the node.

pub fn view_key(&self) -> &ViewKey<N>

Returns the account view key of the node.

pub fn address(&self) -> Address<N>

Returns the account address of the node.

pub fn is_dev(&self) -> bool

Returns true if the node is in development mode.

pub fn rotate_external_peers(&self) -> bool

Returns true if the node is periodically evicting more external peers.

pub fn allow_external_peers(&self) -> bool

Returns true if the node is engaging in P2P gossip to request more peers.

pub fn resolve_to_listener(&self, peer_addr: &SocketAddr) -> Option<SocketAddr>

Returns the listener IP address from the (ambiguous) peer address.

pub fn resolve_to_ambiguous(&self, peer_ip: &SocketAddr) -> Option<SocketAddr>

Returns the (ambiguous) peer address from the listener IP address.

pub fn is_connected(&self, ip: &SocketAddr) -> bool

Returns true if the node is connected to the given peer IP.

pub fn is_connected_validator(&self, peer_ip: &SocketAddr) -> bool

Returns true if the given peer IP is a connected validator.

pub fn is_connected_prover(&self, peer_ip: &SocketAddr) -> bool

Returns true if the given peer IP is a connected prover.

pub fn is_connected_client(&self, peer_ip: &SocketAddr) -> bool

Returns true if the given peer IP is a connected client.

pub fn is_connecting(&self, ip: &SocketAddr) -> bool

Returns true if the node is currently connecting to the given peer IP.

pub fn is_restricted(&self, ip: &SocketAddr) -> bool

Returns true if the given IP is restricted.

pub fn is_trusted(&self, ip: &SocketAddr) -> bool

Returns true if the given IP is trusted.

pub fn max_connected_peers(&self) -> usize

Returns the maximum number of connected peers.

pub fn number_of_connected_peers(&self) -> usize

Returns the number of connected peers.

pub fn number_of_connected_validators(&self) -> usize

Returns the number of connected validators.

pub fn number_of_connected_provers(&self) -> usize

Returns the number of connected provers.

pub fn number_of_connected_clients(&self) -> usize

Returns the number of connected clients.

pub fn number_of_candidate_peers(&self) -> usize

Returns the number of candidate peers.

pub fn number_of_restricted_peers(&self) -> usize

Returns the number of restricted peers.

pub fn get_connected_peer(&self, ip: &SocketAddr) -> Option<Peer<N>>

Returns the connected peer given the peer IP, if it exists.

pub fn get_connected_peers(&self) -> Vec<Peer<N>>

Returns the connected peers.

pub fn connected_peers(&self) -> Vec<SocketAddr>

Returns the list of connected peers.

pub fn connected_validators(&self) -> Vec<SocketAddr>

Returns the list of connected validators.

pub fn connected_provers(&self) -> Vec<SocketAddr>

Returns the list of connected provers.

pub fn connected_clients(&self) -> Vec<SocketAddr>

Returns the list of connected clients.

pub fn candidate_peers(&self) -> HashSet<SocketAddr>

Returns the list of candidate peers.

pub fn restricted_peers(&self) -> Vec<SocketAddr>

Returns the list of restricted peers.

pub fn trusted_peers(&self) -> &HashSet<SocketAddr>

Returns the list of trusted peers.

pub fn bootstrap_peers(&self) -> Vec<SocketAddr>

Returns the list of bootstrap peers.

pub fn connected_metrics(&self) -> Vec<(SocketAddr, NodeType)>

Returns the list of metrics for the connected peers.

pub fn insert_connected_peer(&self, peer_ip: SocketAddr)

Inserts the given peer into the connected peers.

pub fn insert_candidate_peers(&self, peers: &[SocketAddr])

Inserts the given peer IPs to the set of candidate peers.

This method skips adding any given peers if the combined size exceeds the threshold, as the peer providing this list could be subverting the protocol.

pub fn insert_restricted_peer(&self, peer_ip: SocketAddr)

Inserts the given peer into the restricted peers.

pub fn update_connected_peer<Fn: FnMut(&mut Peer<N>)>( &self, peer_ip: SocketAddr, node_type: NodeType, write_fn: Fn, ) -> Result<()>

Updates the connected peer with the given function.

pub fn update_last_seen_for_connected_peer(&self, peer_ip: SocketAddr)

pub fn remove_connected_peer(&self, peer_ip: SocketAddr)

Removes the connected peer and adds them to the candidate peers.

pub fn remove_candidate_peer(&self, peer_ip: SocketAddr)

Removes the given address from the candidate peers, if it exists.

pub fn spawn<T: Future<Output = ()> + Send + 'static>(&self, future: T)

Spawns a task with the given future; it should only be used for long-running tasks.

pub async fn shut_down(&self)

Shuts down the router.

Trait Implementations

impl<N: Clone + Network> Clone for Router<N>

fn clone(&self) -> Router<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Network> Deref for Router<N>

type Target = Arc<InnerRouter<N>>

The resulting type after dereferencing.

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

Dereferences the value.

impl<N: Network> P2P for Router<N>

fn tcp(&self) -> &Tcp

Returns a reference to the TCP instance.