openethereum/util/network/src/service.rs

194 lines
5.9 KiB
Rust
Raw Normal View History

// Copyright 2015-2017 Parity Technologies (UK) Ltd.
2016-02-05 13:40:41 +01:00
// This file is part of Parity.
// Parity is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Parity is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Parity. If not, see <http://www.gnu.org/licenses/>.
use {NetworkProtocolHandler, NetworkConfiguration, NonReservedPeerMode};
use error::NetworkError;
use host::{Host, NetworkContext, NetworkIoMessage, PeerId, ProtocolId};
use stats::NetworkStats;
use io::*;
use parking_lot::RwLock;
use std::sync::Arc;
use ansi_term::Colour;
2017-08-29 14:38:01 +02:00
use connection_filter::ConnectionFilter;
struct HostHandler {
public_url: RwLock<Option<String>>
}
impl IoHandler<NetworkIoMessage> for HostHandler {
fn message(&self, _io: &IoContext<NetworkIoMessage>, message: &NetworkIoMessage) {
if let NetworkIoMessage::NetworkStarted(ref public_url) = *message {
let mut url = self.public_url.write();
2016-07-19 09:25:51 +02:00
if url.as_ref().map_or(true, |uref| uref != public_url) {
info!(target: "network", "Public node URL: {}", Colour::White.bold().paint(public_url.as_ref()));
}
*url = Some(public_url.to_owned());
}
}
}
2015-12-30 12:23:36 +01:00
/// IO Service with networking
/// `Message` defines a notification data type.
pub struct NetworkService {
io_service: IoService<NetworkIoMessage>,
2016-01-14 19:04:13 +01:00
host_info: String,
host: RwLock<Option<Arc<Host>>>,
2016-02-10 16:35:52 +01:00
stats: Arc<NetworkStats>,
host_handler: Arc<HostHandler>,
2016-06-17 12:58:28 +02:00
config: NetworkConfiguration,
2017-08-29 14:38:01 +02:00
filter: Option<Arc<ConnectionFilter>>,
2015-12-17 11:42:30 +01:00
}
impl NetworkService {
2015-12-30 12:23:36 +01:00
/// Starts IO event loop
2017-08-29 14:38:01 +02:00
pub fn new(config: NetworkConfiguration, filter: Option<Arc<ConnectionFilter>>) -> Result<NetworkService, NetworkError> {
let host_handler = Arc::new(HostHandler { public_url: RwLock::new(None) });
let io_service = IoService::<NetworkIoMessage>::start()?;
2016-02-10 16:35:52 +01:00
2016-06-17 12:58:28 +02:00
let stats = Arc::new(NetworkStats::new());
let host_info = Host::client_version();
2015-12-17 11:42:30 +01:00
Ok(NetworkService {
2016-01-14 19:04:13 +01:00
io_service: io_service,
host_info: host_info,
2016-01-24 18:53:54 +01:00
stats: stats,
2016-06-17 12:58:28 +02:00
host: RwLock::new(None),
config: config,
host_handler: host_handler,
2017-08-29 14:38:01 +02:00
filter: filter,
2015-12-17 11:42:30 +01:00
})
}
2015-12-30 12:23:36 +01:00
/// Regiter a new protocol handler with the event loop.
pub fn register_protocol(&self, handler: Arc<NetworkProtocolHandler + Send + Sync>, protocol: ProtocolId, packet_count: u8, versions: &[u8]) -> Result<(), NetworkError> {
self.io_service.send_message(NetworkIoMessage::AddHandler {
2016-01-21 16:48:37 +01:00
handler: handler,
2015-12-17 11:42:30 +01:00
protocol: protocol,
versions: versions.to_vec(),
packet_count: packet_count,
})?;
2015-12-17 11:42:30 +01:00
Ok(())
}
2016-01-13 23:13:57 +01:00
2016-01-14 19:04:13 +01:00
/// Returns host identifier string as advertised to other peers
pub fn host_info(&self) -> String {
self.host_info.clone()
}
/// Returns underlying io service.
pub fn io(&self) -> &IoService<NetworkIoMessage> {
2016-06-17 12:58:28 +02:00
&self.io_service
2016-01-13 23:13:57 +01:00
}
2016-01-24 18:53:54 +01:00
2016-03-20 11:35:46 +01:00
/// Returns network statistics.
2016-01-24 18:53:54 +01:00
pub fn stats(&self) -> &NetworkStats {
&self.stats
}
2016-02-10 16:35:52 +01:00
/// Returns network configuration.
pub fn config(&self) -> &NetworkConfiguration {
&self.config
}
2016-03-20 11:35:46 +01:00
/// Returns external url if available.
pub fn external_url(&self) -> Option<String> {
let host = self.host.read();
2016-06-17 12:58:28 +02:00
host.as_ref().and_then(|h| h.external_url())
2016-03-20 11:35:46 +01:00
}
/// Returns external url if available.
2016-06-17 12:58:28 +02:00
pub fn local_url(&self) -> Option<String> {
let host = self.host.read();
2016-06-17 12:58:28 +02:00
host.as_ref().map(|h| h.local_url())
}
/// Start network IO
pub fn start(&self) -> Result<(), NetworkError> {
let mut host = self.host.write();
2016-06-17 12:58:28 +02:00
if host.is_none() {
2017-08-29 14:38:01 +02:00
let h = Arc::new(Host::new(self.config.clone(), self.stats.clone(), self.filter.clone())?);
self.io_service.register_handler(h.clone())?;
2016-06-17 12:58:28 +02:00
*host = Some(h);
}
if self.host_handler.public_url.read().is_none() {
self.io_service.register_handler(self.host_handler.clone())?;
}
2016-06-17 12:58:28 +02:00
Ok(())
}
/// Stop network IO
pub fn stop(&self) -> Result<(), NetworkError> {
let mut host = self.host.write();
2016-06-17 12:58:28 +02:00
if let Some(ref host) = *host {
let io = IoContext::new(self.io_service.channel(), 0); //TODO: take token id from host
host.stop(&io)?;
2016-06-17 12:58:28 +02:00
}
*host = None;
Ok(())
2016-03-20 11:35:46 +01:00
}
/// Get a list of all connected peers by id.
pub fn connected_peers(&self) -> Vec<PeerId> {
self.host.read().as_ref().map(|h| h.connected_peers()).unwrap_or_else(Vec::new)
}
/// Try to add a reserved peer.
pub fn add_reserved_peer(&self, peer: &str) -> Result<(), NetworkError> {
let host = self.host.read();
if let Some(ref host) = *host {
host.add_reserved_node(peer)
} else {
Ok(())
}
}
/// Try to remove a reserved peer.
pub fn remove_reserved_peer(&self, peer: &str) -> Result<(), NetworkError> {
let host = self.host.read();
if let Some(ref host) = *host {
host.remove_reserved_node(peer)
} else {
Ok(())
}
}
/// Set the non-reserved peer mode.
pub fn set_non_reserved_mode(&self, mode: NonReservedPeerMode) {
let host = self.host.read();
if let Some(ref host) = *host {
let io_ctxt = IoContext::new(self.io_service.channel(), 0);
host.set_non_reserved_mode(mode, &io_ctxt);
}
}
/// Executes action in the network context
2017-02-02 17:02:46 +01:00
pub fn with_context<F>(&self, protocol: ProtocolId, action: F) where F: FnOnce(&NetworkContext) {
let io = IoContext::new(self.io_service.channel(), 0);
let host = self.host.read();
if let Some(ref host) = host.as_ref() {
host.with_context(protocol, &io, action);
};
}
/// Evaluates function in the network context
2017-02-02 17:02:46 +01:00
pub fn with_context_eval<F, T>(&self, protocol: ProtocolId, action: F) -> Option<T> where F: FnOnce(&NetworkContext) -> T {
let io = IoContext::new(self.io_service.channel(), 0);
let host = self.host.read();
host.as_ref().map(|ref host| host.with_context_eval(protocol, &io, action))
}
2016-03-20 11:35:46 +01:00
}