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 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
use core::{
fmt,
future::Future,
pin::Pin,
task::{ready, Context, Poll},
};
use alloc::sync::{Arc, Weak};
use std::{error, io, sync::Mutex};
use bytes::{Bytes, BytesMut};
use futures_core::stream::Stream;
use pin_project_lite::pin_project;
use tokio::sync::mpsc::{channel, Receiver, Sender};
use super::{
codec::{Codec, Message},
error::ProtocolError,
};
pin_project! {
/// Decode `S` type into Stream of websocket [Message].
/// `S` type must impl `Stream` trait and output `Result<T, E>` as `Stream::Item`
/// where `T` type impl `AsRef<[u8]>` trait. (`&[u8]` is needed for parsing messages)
pub struct RequestStream<S, E> {
#[pin]
stream: S,
buf: BytesMut,
codec: Codec,
err: Option<WsError<E>>
}
}
impl<S, T, E> RequestStream<S, E>
where
S: Stream<Item = Result<T, E>>,
T: AsRef<[u8]>,
{
pub fn new(stream: S) -> Self {
Self::with_codec(stream, Codec::new())
}
pub fn with_codec(stream: S, codec: Codec) -> Self {
Self {
stream,
buf: BytesMut::new(),
codec,
err: None,
}
}
/// Make a [ResponseStream] from current DecodeStream.
///
/// This API is to share the same codec for both decode and encode stream.
pub fn response_stream(&self) -> (ResponseStream, ResponseSender) {
let codec = self.codec.duplicate();
let cap = codec.capacity();
let (tx, rx) = channel(cap);
(ResponseStream(rx), ResponseSender::new(tx, codec))
}
}
pub enum WsError<E> {
Protocol(ProtocolError),
Stream(E),
}
impl<E> fmt::Debug for WsError<E> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match *self {
Self::Protocol(ref e) => fmt::Debug::fmt(e, f),
Self::Stream(..) => f.write_str("Input Stream error"),
}
}
}
impl<E> fmt::Display for WsError<E> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match *self {
Self::Protocol(ref e) => fmt::Debug::fmt(e, f),
Self::Stream(..) => f.write_str("Input Stream error"),
}
}
}
impl<E> error::Error for WsError<E> {}
impl<E> From<ProtocolError> for WsError<E> {
fn from(e: ProtocolError) -> Self {
Self::Protocol(e)
}
}
impl<S, T, E> Stream for RequestStream<S, E>
where
S: Stream<Item = Result<T, E>>,
T: AsRef<[u8]>,
{
type Item = Result<Message, WsError<E>>;
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
let mut this = self.project();
loop {
if let Some(msg) = this.codec.decode(this.buf)? {
return Poll::Ready(Some(Ok(msg)));
}
match ready!(this.stream.as_mut().poll_next(cx)) {
Some(res) => {
let item = res.map_err(WsError::Stream)?;
this.buf.extend_from_slice(item.as_ref())
}
None => return Poll::Ready(None),
}
}
}
}
pub struct ResponseStream(Receiver<Item>);
type Item = io::Result<Bytes>;
impl Stream for ResponseStream {
type Item = Item;
#[inline]
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
self.get_mut().0.poll_recv(cx)
}
}
/// Encode [Message] into [Bytes] and send it to [ResponseStream].
#[derive(Debug)]
pub struct ResponseSender {
inner: Arc<_ResponseSender>,
}
impl ResponseSender {
fn new(tx: Sender<Item>, codec: Codec) -> Self {
Self {
inner: Arc::new(_ResponseSender {
encoder: Mutex::new(Encoder {
codec,
buf: BytesMut::with_capacity(codec.max_size()),
}),
tx,
}),
}
}
/// downgrade Self to a weak sender.
pub fn downgrade(&self) -> ResponseWeakSender {
ResponseWeakSender {
inner: Arc::downgrade(&self.inner),
}
}
/// encode [Message] and add to [ResponseStream].
#[inline]
pub fn send(&self, msg: Message) -> impl Future<Output = Result<(), ProtocolError>> + '_ {
self.inner.send(msg)
}
/// add [io::Error] to [ResponseStream].
///
/// the error should be used as a signal to the TCP connection associated with `ResponseStream`
/// to close immediately.
///
/// # Examples
/// ```rust
/// use std::{future::poll_fn, pin::Pin, time::Duration};
///
/// use futures_core::Stream;
/// use http_ws::{CloseCode, Message, RequestStream, ResponseSender, ResponseStream};
/// use tokio::{io::AsyncWriteExt, time::timeout, net::TcpStream};
///
/// // thread1:
/// // read and write websocket message.
/// async fn sender<S, T, E>(tx: ResponseSender, mut rx: Pin<&mut RequestStream<S, E>>)
/// where
/// S: Stream<Item = Result<T, E>>,
/// T: AsRef<[u8]>,
/// {
/// // send close message to client
/// tx.send(Message::Close(Some(CloseCode::Away.into()))).await.unwrap();
///
/// // the client failed to respond to close message in 5 seconds time window.
/// if let Err(_) = timeout(Duration::from_secs(5), poll_fn(|cx| rx.as_mut().poll_next(cx))).await {
/// // send io error to thread2
/// tx.send_error(std::io::ErrorKind::UnexpectedEof.into()).await.unwrap();
/// }
/// }
///
/// // thread2:
/// // receive websocket message from thread1 and transfer it on tcp connection.
/// async fn io_write(conn: &mut TcpStream, mut rx: Pin<&mut ResponseStream>) {
/// // the first message is the "go away" close message in Ok branch.
/// let msg = poll_fn(|cx| rx.as_mut().poll_next(cx)).await.unwrap().unwrap();
///
/// // send msg to client
/// conn.write_all(&msg).await.unwrap();
///
/// // the second message is the io::Error in Err branch.
/// let err = poll_fn(|cx| rx.as_mut().poll_next(cx)).await.unwrap().unwrap_err();
///
/// // at this point we should close the tcp connection by either graceful close or
/// // just return immediately and drop the TcpStream.
/// let _ = conn.shutdown().await;
/// }
///
/// // thread3:
/// // receive message from tcp connection and send it to thread1:
/// async fn io_read(conn: &mut TcpStream) {
/// // this part is ignored as it has no relation to the send_error api.
/// }
/// ```
#[inline]
pub fn send_error(&self, err: io::Error) -> impl Future<Output = Result<(), ProtocolError>> + '_ {
self.inner.send_error(err)
}
/// encode [Message::Text] variant and add to [ResponseStream].
#[inline]
pub fn text(&self, txt: impl Into<String>) -> impl Future<Output = Result<(), ProtocolError>> + '_ {
self.send(Message::Text(Bytes::from(txt.into())))
}
/// encode [Message::Binary] variant and add to [ResponseStream].
#[inline]
pub fn binary(&self, bin: impl Into<Bytes>) -> impl Future<Output = Result<(), ProtocolError>> + '_ {
self.send(Message::Binary(bin.into()))
}
}
/// [Weak] version of [ResponseSender].
#[derive(Debug)]
pub struct ResponseWeakSender {
inner: Weak<_ResponseSender>,
}
impl ResponseWeakSender {
/// upgrade self to strong response sender.
/// return None when [ResponseSender] is already dropped.
pub fn upgrade(&self) -> Option<ResponseSender> {
self.inner.upgrade().map(|inner| ResponseSender { inner })
}
}
#[derive(Debug)]
struct _ResponseSender {
encoder: Mutex<Encoder>,
tx: Sender<Item>,
}
#[derive(Debug)]
struct Encoder {
codec: Codec,
buf: BytesMut,
}
impl _ResponseSender {
// send message to response stream. it would produce Ok(bytes) when succeed where
// the bytes is encoded binary websocket message ready to be sent to client.
async fn send(&self, msg: Message) -> Result<(), ProtocolError> {
let permit = self.tx.reserve().await.map_err(|_| ProtocolError::Closed)?;
let buf = {
let mut encoder = self.encoder.lock().unwrap();
let Encoder { codec, buf } = &mut *encoder;
codec.encode(msg, buf)?;
buf.split().freeze()
};
permit.send(Ok(buf));
Ok(())
}
// send error to response stream. it would produce Err(io::Error) when succeed where
// the error is a representation of io error to the stream consumer. in most cases
// the consumer observing the error should close the stream and the tcp connection
// the stream belongs to.
async fn send_error(&self, err: io::Error) -> Result<(), ProtocolError> {
self.tx.send(Err(err)).await.map_err(|_| ProtocolError::Closed)
}
}