summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlice Ryhl <alice@ryhl.io>2020-11-06 17:01:22 +0100
committerGitHub <noreply@github.com>2020-11-06 17:01:22 +0100
commitf51ddc595804002c1bd5d6a4ff9059507d5c3eb1 (patch)
tree69d2de052c61fe98f9c6fbf73ec613e5fd886f94
parent47658a6da5a6cf2d7db4727e61915709727cd632 (diff)
net: add set_nonblocking to doc (#3100)
-rw-r--r--tokio/src/net/tcp/listener.rs1
-rw-r--r--tokio/src/net/tcp/stream.rs1
-rw-r--r--tokio/src/net/udp/socket.rs1
-rw-r--r--tokio/src/net/unix/datagram/socket.rs1
4 files changed, 4 insertions, 0 deletions
diff --git a/tokio/src/net/tcp/listener.rs b/tokio/src/net/tcp/listener.rs
index 118dca23..be528f2b 100644
--- a/tokio/src/net/tcp/listener.rs
+++ b/tokio/src/net/tcp/listener.rs
@@ -218,6 +218,7 @@ impl TcpListener {
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn Error>> {
/// let std_listener = std::net::TcpListener::bind("127.0.0.1:0")?;
+ /// std_listener.set_nonblocking(true)?;
/// let listener = TcpListener::from_std(std_listener)?;
/// Ok(())
/// }
diff --git a/tokio/src/net/tcp/stream.rs b/tokio/src/net/tcp/stream.rs
index 204a1940..045cb6c3 100644
--- a/tokio/src/net/tcp/stream.rs
+++ b/tokio/src/net/tcp/stream.rs
@@ -159,6 +159,7 @@ impl TcpStream {
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn Error>> {
/// let std_stream = std::net::TcpStream::connect("127.0.0.1:34254")?;
+ /// std_stream.set_nonblocking(true)?;
/// let stream = TcpStream::from_std(std_stream)?;
/// Ok(())
/// }
diff --git a/tokio/src/net/udp/socket.rs b/tokio/src/net/udp/socket.rs
index ce6f2ca8..c68e37f8 100644
--- a/tokio/src/net/udp/socket.rs
+++ b/tokio/src/net/udp/socket.rs
@@ -187,6 +187,7 @@ impl UdpSocket {
/// # async fn main() -> io::Result<()> {
/// let addr = "0.0.0.0:8080".parse::<SocketAddr>().unwrap();
/// let std_sock = std::net::UdpSocket::bind(addr)?;
+ /// std_sock.set_nonblocking(true)?;
/// let sock = UdpSocket::from_std(std_sock)?;
/// // use `sock`
/// # Ok(())
diff --git a/tokio/src/net/unix/datagram/socket.rs b/tokio/src/net/unix/datagram/socket.rs
index 051c0d1e..6215b579 100644
--- a/tokio/src/net/unix/datagram/socket.rs
+++ b/tokio/src/net/unix/datagram/socket.rs
@@ -179,6 +179,7 @@ impl UnixDatagram {
/// // Bind the socket to a filesystem path
/// let socket_path = tmp.path().join("socket");
/// let std_socket = StdUDS::bind(&socket_path)?;
+ /// std_socket.set_nonblocking(true)?;
/// let tokio_socket = UnixDatagram::from_std(std_socket)?;
///
/// # Ok(())