Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

net: allow to set linger on TcpSocket #4324

Merged
merged 1 commit into from Dec 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 23 additions & 0 deletions tokio/src/net/tcp/socket.rs
Expand Up @@ -8,6 +8,7 @@ use std::net::SocketAddr;
use std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
#[cfg(windows)]
use std::os::windows::io::{AsRawSocket, FromRawSocket, IntoRawSocket, RawSocket};
use std::time::Duration;

cfg_net! {
/// A TCP socket that has not yet been converted to a `TcpStream` or
Expand Down Expand Up @@ -349,6 +350,28 @@ impl TcpSocket {
self.inner.get_recv_buffer_size()
}

/// Sets the linger duration of this socket by setting the SO_LINGER option.
///
/// This option controls the action taken when a stream has unsent messages and the stream is
/// closed. If SO_LINGER is set, the system shall block the process until it can transmit the
/// data or until the time expires.
///
/// If SO_LINGER is not specified, and the socket is closed, the system handles the call in a
/// way that allows the process to continue as quickly as possible.
pub fn set_linger(&self, dur: Option<Duration>) -> io::Result<()> {
self.inner.set_linger(dur)
}

/// Reads the linger duration for this socket by getting the `SO_LINGER`
/// option.
///
/// For more information about this option, see [`set_linger`].
///
/// [`set_linger`]: TcpSocket::set_linger
pub fn linger(&self) -> io::Result<Option<Duration>> {
self.inner.get_linger()
}

/// Gets the local address of this socket.
///
/// Will fail on windows if called before `bind`.
Expand Down
14 changes: 14 additions & 0 deletions tokio/tests/tcp_socket.rs
@@ -1,6 +1,7 @@
#![warn(rust_2018_idioms)]
#![cfg(feature = "full")]

use std::time::Duration;
use tokio::net::TcpSocket;
use tokio_test::assert_ok;

Expand Down Expand Up @@ -58,3 +59,16 @@ async fn bind_before_connect() {
// Accept
let _ = assert_ok!(srv.accept().await);
}

#[tokio::test]
async fn basic_linger() {
// Create server
let addr = assert_ok!("127.0.0.1:0".parse());
let srv = assert_ok!(TcpSocket::new_v4());
assert_ok!(srv.bind(addr));

assert!(srv.linger().unwrap().is_none());

srv.set_linger(Some(Duration::new(0, 0))).unwrap();
assert_eq!(srv.linger().unwrap(), Some(Duration::new(0, 0)));
}