Struct network::service::NetworkService

pub struct NetworkService {
    pub io_service: Option<IoService<NetworkIoMessage>>,
    pub inner: Option<Arc<NetworkServiceInner>>,
    /* private fields */
}

NetworkService implements the P2P communication between different nodes. It manages connections between peers, including accepting new peers or dropping existing peers. Inside NetworkService, it has an IoService event loop with a thread pool.

Fields

io_service: Option<IoService<NetworkIoMessage>>

inner: Option<Arc<NetworkServiceInner>>

Implementations

impl NetworkService

pub fn new(config: NetworkConfiguration) -> NetworkService

pub fn is_consortium(&self) -> bool

pub fn get_network_type(&self) -> &Network

pub fn network_id(&self) -> u64

pub fn is_test_mode(&self) -> bool

pub fn start_network_poll(&self) -> Result<(), Error>

pub fn initialize( &mut self, pos_pub_keys: (ConsensusPublicKey, ConsensusVRFPublicKey) ) -> Result<(), Error>

Create and start the event loop inside the NetworkService

pub fn start(&self)

pub fn add_peer(&self, node: NodeEntry) -> Result<(), Error>

Add a P2P peer to the client as a trusted node

pub fn drop_peer(&self, node: NodeEntry) -> Result<(), Error>

Drop a P2P peer from the client

pub fn local_addr(&self) -> Option<SocketAddr>

Get the local address of the client

pub fn register_protocol( &self, handler: Arc<dyn NetworkProtocolHandler + Sync>, protocol: ProtocolId, version: ProtocolVersion ) -> Result<(), Error>

Register a new protocol handler

pub fn with_context<F, R>( &self, handler: Arc<dyn NetworkProtocolHandler + Sync>, protocol: ProtocolId, action: F ) -> Result<R, String>

where F: FnOnce(&NetworkContext<'_>) -> R,

Executes action in the network context

pub fn get_peer_info(&self) -> Option<Vec<PeerInfo>>

Return the current connected peers

pub fn sign_challenge(&self, challenge: Vec<u8>) -> Result<Vec<u8>, Error>

Sign a challenge to provide self NodeId

pub fn net_key_pair(&self) -> Result<KeyPair, Error>

pub fn pos_public_key(&self) -> Option<ConsensusPublicKey>

pub fn add_latency(&self, id: NodeId, latency_ms: f64) -> Result<(), Error>

pub fn get_node(&self, id: &NodeId) -> Option<(bool, Node)>

pub fn get_detailed_sessions( &self, node_id: Option<NodeId> ) -> Option<Vec<SessionDetails>>

pub fn disconnect_node( &self, id: &NodeId, op: Option<UpdateNodeOperation> ) -> bool

pub fn save_node_db(&self)