1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
//! Wrapper around a stream to make it abortable. This allows in-flight requests to be cancelled
//! immediately instead of after the socket times out.
use futures::{FutureExt, channel::oneshot, future::Fuse};
use hyper_util::client::legacy::connect::{Connected, Connection};
use std::{
future::Future,
io,
pin::Pin,
sync::{Arc, Mutex},
task::{Context, Poll},
};
use tokio::io::{AsyncRead, AsyncWrite, ReadBuf};
#[derive(thiserror::Error, Debug)]
#[error("Stream is closed")]
pub struct Aborted(());
#[derive(Clone, Debug)]
pub struct AbortableStreamHandle {
tx: Arc<Mutex<Option<oneshot::Sender<()>>>>,
}
impl AbortableStreamHandle {
pub fn close(self) {
if let Some(tx) = self.tx.lock().unwrap().take() {
let _ = tx.send(());
}
}
/// Returns whether the stream has already stopped on its own.
pub fn is_closed(&self) -> bool {
self.tx
.lock()
.unwrap()
.as_ref()
.map(|tx| tx.is_canceled())
.unwrap_or(true)
}
}
pub struct AbortableStream<S: Unpin> {
stream: S,
shutdown_rx: Fuse<oneshot::Receiver<()>>,
}
impl<S> AbortableStream<S>
where
S: Unpin + Send + 'static,
{
pub fn new(stream: S) -> (Self, AbortableStreamHandle) {
let (tx, rx) = oneshot::channel();
let stream_handle = AbortableStreamHandle {
tx: Arc::new(Mutex::new(Some(tx))),
};
(
Self {
stream,
shutdown_rx: rx.fuse(),
},
stream_handle,
)
}
}
impl<S> AsyncWrite for AbortableStream<S>
where
S: AsyncWrite + Unpin + Send + 'static,
{
fn poll_write(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8],
) -> Poll<io::Result<usize>> {
if Pin::new(&mut self.shutdown_rx).poll(cx).is_ready() {
return Poll::Ready(Err(io::Error::new(
io::ErrorKind::ConnectionReset,
Aborted(()),
)));
}
Pin::new(&mut self.stream).poll_write(cx, buf)
}
fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
if Pin::new(&mut self.shutdown_rx).poll(cx).is_ready() {
return Poll::Ready(Err(io::Error::new(
io::ErrorKind::ConnectionReset,
Aborted(()),
)));
}
Pin::new(&mut self.stream).poll_flush(cx)
}
fn poll_shutdown(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
Pin::new(&mut self.stream).poll_shutdown(cx)
}
}
impl<S> AsyncRead for AbortableStream<S>
where
S: AsyncRead + Unpin + Send + 'static,
{
fn poll_read(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut ReadBuf<'_>,
) -> Poll<io::Result<()>> {
if Pin::new(&mut self.shutdown_rx).poll(cx).is_ready() {
return Poll::Ready(Err(io::Error::new(
io::ErrorKind::ConnectionReset,
Aborted(()),
)));
}
Pin::new(&mut self.stream).poll_read(cx, buf)
}
}
impl<S> Connection for AbortableStream<S>
where
S: Connection + Unpin,
{
fn connected(&self) -> Connected {
self.stream.connected()
}
}
#[cfg(test)]
mod test {
use super::*;
use std::time::Duration;
use tokio::io::AsyncReadExt;
/// Test whether the abort handle stops the stream.
#[test]
fn test_abort() {
let runtime = tokio::runtime::Runtime::new().expect("Failed to initialize runtime");
let (client, _server) = tokio::io::duplex(64);
runtime.block_on(async move {
let (mut stream, abort_handle) = AbortableStream::new(client);
let stream_task = tokio::spawn(async move {
let mut buf = vec![];
stream.read_to_end(&mut buf).await
});
abort_handle.close();
let result = tokio::time::timeout(Duration::from_secs(1), stream_task)
.await
.unwrap();
assert!(
matches!(result, Ok(Err(error)) if error.kind() == io::ErrorKind::ConnectionReset)
);
});
}
/// Test the `AbortableStreamHandle::is_closed` method when explicitly closed.
#[test]
fn test_shutdown_signal() {
let runtime = tokio::runtime::Runtime::new().expect("Failed to initialize runtime");
let (client, _server) = tokio::io::duplex(64);
runtime.block_on(async move {
let (_stream, abort_handle) = AbortableStream::new(client);
let abort_handle_2 = abort_handle.clone();
assert!(!abort_handle_2.is_closed());
abort_handle.close();
assert!(abort_handle_2.is_closed());
});
}
/// Test the `AbortableStreamHandle::is_closed` method when the stream stops on its own.
#[test]
fn test_shutdown_signal_normal() {
let runtime = tokio::runtime::Runtime::new().expect("Failed to initialize runtime");
let (client, server) = tokio::io::duplex(64);
runtime.block_on(async move {
let (mut stream, abort_handle) = AbortableStream::new(client);
assert!(!abort_handle.is_closed());
let stream_task = tokio::spawn(async move {
drop(server);
let mut buf = vec![];
stream.read_to_end(&mut buf).await
});
assert!(
tokio::time::timeout(Duration::from_secs(1), stream_task)
.await
.unwrap()
.is_ok()
);
assert!(abort_handle.is_closed());
});
}
}
|
