Merge pull request #85 from quartiq/feature/tcp-updates

Adding new TCP socket APIs

Author: ryan-summers

CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Bump dependency version of `no-std-net` to `v0.6`.
 - Bump MSRV to 1.53.0 due to `no-std-net`'s use of or-patterns.
 - Added support for `core::net` with the `ip_in_core` feature.
+- [breaking] New TCP error enumerations added for identifying TCP-related connection errors
+- [breaking] Removed the `TcpClientStack::is_connected` API
 
 ## [0.6.0] - 2021-05-25
 

src/lib.rs

@@ -22,5 +22,6 @@ pub use no_std_net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, Socke
 
 pub use dns::{AddrType, Dns};
 pub use stack::{
-	SharableStack, SharedStack, TcpClientStack, TcpFullStack, UdpClientStack, UdpFullStack,
+	SharableStack, SharedStack, TcpClientStack, TcpError, TcpErrorKind, TcpFullStack,
+	UdpClientStack, UdpFullStack,
 };

src/stack/mod.rs

@@ -3,5 +3,5 @@ mod tcp;
 mod udp;
 
 pub use share::{SharableStack, SharedStack};
-pub use tcp::{TcpClientStack, TcpFullStack};
+pub use tcp::{TcpClientStack, TcpError, TcpErrorKind, TcpFullStack};
 pub use udp::{UdpClientStack, UdpFullStack};

src/stack/share.rs

@@ -128,7 +128,6 @@ where
 	forward! {connect(socket: &mut Self::TcpSocket, address: SocketAddr) -> Result<(), nb::Error<<T as TcpClientStack>::Error>>}
 	forward! {send(socket: &mut Self::TcpSocket, data: &[u8]) -> Result<usize, nb::Error<<T as TcpClientStack>::Error>>}
 	forward! {receive(socket: &mut Self::TcpSocket, data: &mut [u8]) -> Result<usize, nb::Error<<T as TcpClientStack>::Error>>}
-	forward! {is_connected(socket: &Self::TcpSocket) -> Result<bool, Self::Error>}
 	forward! {close(socket: Self::TcpSocket) -> Result<(), Self::Error>}
 }
 

src/stack/tcp.rs

@@ -1,5 +1,22 @@
 use crate::SocketAddr;
 
+/// Represents specific errors encountered during TCP operations.
+#[non_exhaustive]
+#[derive(Copy, Clone, PartialEq, Debug)]
+pub enum TcpErrorKind {
+	/// The socket has been closed in the direction in which the failing operation was attempted.
+	PipeClosed,
+
+	/// Some other error has occurred.
+	Other,
+}
+
+/// Methods to resolve errors into identifiable, actionable codes on the client side.
+pub trait TcpError: core::fmt::Debug {
+	/// Determines the kind of error that occurred.
+	fn kind(&self) -> TcpErrorKind;
+}
+
 /// This trait is implemented by TCP/IP stacks. You could, for example, have an implementation
 /// which knows how to send AT commands to an ESP8266 WiFi module. You could have another implementation
 /// which knows how to driver the Rust Standard Library's `std::net` module. Given this trait, you can
@@ -8,7 +25,7 @@ pub trait TcpClientStack {
 	/// The type returned when we create a new TCP socket
 	type TcpSocket;
 	/// The type returned when we have an error
-	type Error: core::fmt::Debug;
+	type Error: TcpError;
 
 	/// Open a socket for usage as a TCP client.
 	///
@@ -27,9 +44,6 @@ pub trait TcpClientStack {
 		remote: SocketAddr,
 	) -> nb::Result<(), Self::Error>;
 
-	/// Check if this socket is connected
-	fn is_connected(&mut self, socket: &Self::TcpSocket) -> Result<bool, Self::Error>;
-
 	/// Write to the stream.
 	///
 	/// Returns the number of bytes written (which may be less than `buffer.len()`) or an error.
@@ -98,10 +112,6 @@ impl<T: TcpClientStack> TcpClientStack for &mut T {
 		T::connect(self, socket, remote)
 	}
 
-	fn is_connected(&mut self, socket: &Self::TcpSocket) -> Result<bool, Self::Error> {
-		T::is_connected(self, socket)
-	}
-
 	fn send(
 		&mut self,
 		socket: &mut Self::TcpSocket,