Move swarm and protocols handler into swarm crate. (#1188)

Move swarm and protocols handler into swarm crate.

core/src/lib.rs

@@ -18,46 +18,22 @@
 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 // DEALINGS IN THE SOFTWARE.
 
-//! Transport, protocol upgrade and swarm systems of *libp2p*.
+//! Transports, upgrades, multiplexing and node handling of *libp2p*.
 //!
-//! This crate contains all the core traits and mechanisms of the transport and swarm systems
-//! of *libp2p*.
+//! The main concepts of libp2p-core are:
 //!
-//! # Overview
-//!
-//! This documentation focuses on the concepts of *libp2p-core*, and is interesting mostly if you
-//! want to extend *libp2p* with new protocols. If you only want to use libp2p, you might find the
-//! documentation of the main *libp2p* crate more interesting.
-//!
-//! The main concepts of libp2p are:
-//!
-//! - A `PeerId` is a unique global identifier for a node on the network. Each node must have a
-//!   different `PeerId`. Normally, a `PeerId` is the hash of the public key used to negotiate
-//!   encryption on the communication channel, thereby guaranteeing that they cannot be spoofed.
-//! - The `Transport` trait defines how to reach a remote node or listen for incoming remote
-//!   connections. See the `transport` module.
-//! - The `Swarm` struct contains all active and pending connections to remotes and manages the
-//!   state of all the substreams that have been opened, and all the upgrades that were built upon
-//!   these substreams.
-//! - Use the `NetworkBehaviour` trait to customize the behaviour of a `Swarm`. It is the
-//!   `NetworkBehaviour` that controls what happens on the network. Multiple types that implement
-//!   `NetworkBehaviour` can be composed into a single behaviour.
-//! - The `StreamMuxer` trait is implemented on structs that hold a connection to a remote and can
-//!   subdivide this connection into multiple substreams. See the `muxing` module.
-//! - The `UpgradeInfo`, `InboundUpgrade` and `OutboundUpgrade` traits define how to upgrade each
-//!   individual substream to use a protocol. See the `upgrade` module.
-//! - The `ProtocolsHandler` trait defines how each active connection to a remote should behave:
-//!   how to handle incoming substreams, which protocols are supported, when to open a new
-//!   outbound substream, etc. See the `protocols_handler` trait.
-//!
-//! # High-level APIs vs low-level APIs
-//!
-//! This crate provides two sets of APIs:
-//!
-//! - The low-level APIs are contained within the `nodes` module. See the documentation for more
-//!   information.
-//! - The high-level APIs include the concepts of `Swarm`, `ProtocolsHandler` and `NetworkBehaviour`.
-
+//! - A [`PeerId`] is a unique global identifier for a node on the network.
+//!   Each node must have a different `PeerId`. Normally, a `PeerId` is the
+//!   hash of the public key used to negotiate encryption on the
+//!   communication channel, thereby guaranteeing that they cannot be spoofed.
+//! - The [`Transport`] trait defines how to reach a remote node or listen for
+//!   incoming remote connections. See the `transport` module.
+//! - The [`StreamMuxer`] trait is implemented on structs that hold a connection
+//!   to a remote and can subdivide this connection into multiple substreams.
+//!   See the `muxing` module.
+//! - The [`UpgradeInfo`], [`InboundUpgrade`] and [`OutboundUpgrade`] traits
+//!   define how to upgrade each individual substream to use a protocol.
+//!   See the `upgrade` module.
 
 /// Multi-address re-export.
 pub use multiaddr;
@@ -74,18 +50,13 @@ pub mod either;
 pub mod identity;
 pub mod muxing;
 pub mod nodes;
-pub mod protocols_handler;
-pub mod swarm;
 pub mod transport;
 pub mod upgrade;
 
 pub use multiaddr::Multiaddr;
 pub use muxing::StreamMuxer;
-pub use nodes::raw_swarm::ConnectedPoint;
 pub use peer_id::PeerId;
-pub use protocols_handler::{ProtocolsHandler, ProtocolsHandlerEvent};
 pub use identity::PublicKey;
-pub use swarm::Swarm;
 pub use transport::Transport;
 pub use translation::address_translation;
 pub use upgrade::{InboundUpgrade, OutboundUpgrade, UpgradeInfo, UpgradeError, ProtocolName};
@@ -129,3 +100,58 @@ impl Endpoint {
     }
 }
 
+/// How we connected to a node.
+#[derive(Debug, Clone)]
+pub enum ConnectedPoint {
+    /// We dialed the node.
+    Dialer {
+        /// Multiaddress that was successfully dialed.
+        address: Multiaddr,
+    },
+    /// We received the node.
+    Listener {
+        /// Address of the listener that received the connection.
+        listen_addr: Multiaddr,
+        /// Stack of protocols used to send back data to the remote.
+        send_back_addr: Multiaddr,
+    }
+}
+
+impl From<&'_ ConnectedPoint> for Endpoint {
+    fn from(endpoint: &'_ ConnectedPoint) -> Endpoint {
+        endpoint.to_endpoint()
+    }
+}
+
+impl From<ConnectedPoint> for Endpoint {
+    fn from(endpoint: ConnectedPoint) -> Endpoint {
+        endpoint.to_endpoint()
+    }
+}
+
+impl ConnectedPoint {
+    /// Turns the `ConnectedPoint` into the corresponding `Endpoint`.
+    pub fn to_endpoint(&self) -> Endpoint {
+        match self {
+            ConnectedPoint::Dialer { .. } => Endpoint::Dialer,
+            ConnectedPoint::Listener { .. } => Endpoint::Listener
+        }
+    }
+
+    /// Returns true if we are `Dialer`.
+    pub fn is_dialer(&self) -> bool {
+        match self {
+            ConnectedPoint::Dialer { .. } => true,
+            ConnectedPoint::Listener { .. } => false
+        }
+    }
+
+    /// Returns true if we are `Listener`.
+    pub fn is_listener(&self) -> bool {
+        match self {
+            ConnectedPoint::Dialer { .. } => false,
+            ConnectedPoint::Listener { .. } => true
+        }
+    }
+}
+