Add libp2p-request-response protocol.

Cargo.toml

@@ -107,6 +107,7 @@ members = [
     "protocols/noise",
     "protocols/ping",
     "protocols/plaintext",
+    "protocols/request-response",
     "protocols/secio",
     "swarm",
     "transports/dns",

core/src/upgrade.rs

@@ -87,12 +87,12 @@ pub use self::{
 ///
 /// # Context
 ///
-/// In situations where we provide a list of protocols that we support, the elements of that list are required to
-/// implement the [`ProtocolName`] trait.
+/// In situations where we provide a list of protocols that we support,
+/// the elements of that list are required to implement the [`ProtocolName`] trait.
 ///
-/// Libp2p will call the [`ProtocolName::protocol_name`] trait method on each element of that list, and transmit the
-/// returned value on the network. If the remote accepts a given protocol, the element serves as the return value of
-/// the function that performed the negotiation.
+/// Libp2p will call [`ProtocolName::protocol_name`] on each element of that list, and transmit the
+/// returned value on the network. If the remote accepts a given protocol, the element
+/// serves as the return value of the function that performed the negotiation.
 ///
 /// # Example
 ///
@@ -118,6 +118,9 @@ pub use self::{
 ///
 pub trait ProtocolName {
     /// The protocol name as bytes. Transmitted on the network.
+    ///
+    /// **Note:** Valid protocol names must start with `/` and
+    /// not exceed 140 bytes in length.
     fn protocol_name(&self) -> &[u8];
 }
 

protocols/floodsub/src/layer.rs

@@ -29,6 +29,7 @@ use libp2p_swarm::{
     NetworkBehaviourAction,
     PollParameters,
     ProtocolsHandler,
+    OneShotEvent,
     OneShotHandler,
     NotifyHandler,
     DialPeerCondition,
@@ -237,7 +238,7 @@ impl Floodsub {
 }
 
 impl NetworkBehaviour for Floodsub {
-    type ProtocolsHandler = OneShotHandler<FloodsubProtocol, FloodsubRpc, InnerMessage>;
+    type ProtocolsHandler = OneShotHandler<FloodsubProtocol, FloodsubRpc, InnerMessage, ()>;
     type OutEvent = FloodsubEvent;
 
     fn new_handler(&mut self) -> Self::ProtocolsHandler {
@@ -287,12 +288,12 @@ impl NetworkBehaviour for Floodsub {
         &mut self,
         propagation_source: PeerId,
         _connection: ConnectionId,
-        event: InnerMessage,
+        event: OneShotEvent<InnerMessage, ()>,
     ) {
-        // We ignore successful sends event.
+        // We ignore successful sends or timeouts.
         let event = match event {
-            InnerMessage::Rx(event) => event,
-            InnerMessage::Sent => return,
+            OneShotEvent::Success(InnerMessage::Rx(event)) => event,
+            OneShotEvent::Success(InnerMessage::Sent) | OneShotEvent::Timeout(()) => return,
         };
 
         // Update connected peers topics

protocols/request-response/Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+name = "libp2p-request-response"
+edition = "2018"
+description = "Generic Request/Response Protocols"
+version = "0.19.0"
+authors = ["Parity Technologies <[email protected]>"]
+license = "MIT"
+repository = "https://github.com/libp2p/rust-libp2p"
+keywords = ["peer-to-peer", "libp2p", "networking"]
+categories = ["network-programming", "asynchronous"]
+
+[dependencies]
+futures = "0.3.1"
+libp2p-core = { version = "0.19.0", path = "../../core" }
+libp2p-swarm = { version = "0.19.0", path = "../../swarm" }
+smallvec = "1.4"
+wasm-timer = "0.2"
+
+[dev-dependencies]
+async-std = "< 1.6"
+libp2p-noise = { version = "0.19.0", path = "../noise" }
+libp2p-tcp = { version = "0.19.0", path = "../../transports/tcp", features = ["async-std"] }
+libp2p-yamux = { version = "0.19.0", path = "../../muxers/yamux" }
+rand = "0.7"

protocols/request-response/src/codec.rs

@@ -0,0 +1,64 @@
+// Copyright 2020 Parity Technologies (UK) Ltd.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the "Software"),
+// to deal in the Software without restriction, including without limitation
+// the rights to use, copy, modify, merge, publish, distribute, sublicense,
+// and/or sell copies of the Software, and to permit persons to whom the
+// Software is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+
+pub use libp2p_core::ProtocolName;
+
+use futures::{prelude::*, future::BoxFuture};
+use std::io;
+
+/// A `RequestResponseCodec` defines the request and response types
+/// for a [`RequestResponse`](crate::RequestResponse) protocol or
+/// protocol family and how they are encoded / decoded on an I/O stream.
+pub trait RequestResponseCodec {
+    /// The type of protocol(s) or protocol versions being negotiated.
+    type Protocol: ProtocolName + Send + Sync + Clone;
+    /// The type of inbound and outbound requests.
+    type Request: Send + Clone;
+    /// The type of inbound and outbound responses.
+    type Response: Send;
+
+    /// Reads a request from the given I/O stream according to the
+    /// negotiated protocol.
+    fn read_request<'a, T>(&mut self, protocol: &Self::Protocol, io: &'a mut T)
+        -> BoxFuture<'a, Result<Self::Request, io::Error>>
+    where
+        T: AsyncRead + Unpin + Send;
+
+    /// Reads a response from the given I/O stream according to the
+    /// negotiated protocol.
+    fn read_response<'a, T>(&mut self, protocol: &Self::Protocol, io: &'a mut T)
+        -> BoxFuture<'a, Result<Self::Response, io::Error>>
+    where
+        T: AsyncRead + Unpin + Send;
+
+    /// Writes a request to the given I/O stream according to the
+    /// negotiated protocol.
+    fn write_request<'a, T>(&mut self, protocol: &Self::Protocol, io: &'a mut T, req: Self::Request)
+        -> BoxFuture<'a, Result<(), io::Error>>
+    where
+        T: AsyncWrite + Unpin + Send;
+
+    /// Writes a response to the given I/O stream according to the
+    /// negotiated protocol.
+    fn write_response<'a, T>(&mut self, protocol: &Self::Protocol, io: &'a mut T, res: Self::Response)
+        -> BoxFuture<'a, Result<(), io::Error>>
+    where
+        T: AsyncWrite + Unpin + Send;
+}