// Copyright 2019 Parity Technologies (UK) Ltd. // // Permission is hereby granted, free of charge, to any person obtaining a // copy of this software and associated documentation files (the "Software"), // to deal in the Software without restriction, including without limitation // the rights to use, copy, modify, merge, publish, distribute, sublicense, // and/or sell copies of the Software, and to permit persons to whom the // Software is furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // DEALINGS IN THE SOFTWARE. use crate::{ connection::Endpoint, muxing::{StreamMuxer, StreamMuxerEvent}, }; use futures::prelude::*; use parking_lot::Mutex; use std::{ io, pin::Pin, sync::atomic::{AtomicBool, Ordering}, task::Context, task::Poll, }; /// Implementation of `StreamMuxer` that allows only one substream on top of a connection, /// yielding the connection itself. /// /// Applying this muxer on a connection doesn't read or write any data on the connection itself. /// Most notably, no protocol is negotiated. pub struct SingletonMuxer { /// The inner connection. inner: Mutex, /// If true, a substream has been produced and any further attempt should fail. substream_extracted: AtomicBool, /// Our local endpoint. Always the same value as was passed to `new`. endpoint: Endpoint, } impl SingletonMuxer { /// Creates a new `SingletonMuxer`. /// /// If `endpoint` is `Dialer`, then only one outbound substream will be permitted. /// If `endpoint` is `Listener`, then only one inbound substream will be permitted. pub fn new(inner: TSocket, endpoint: Endpoint) -> Self { SingletonMuxer { inner: Mutex::new(inner), substream_extracted: AtomicBool::new(false), endpoint, } } } /// Substream of the `SingletonMuxer`. pub struct Substream {} /// Outbound substream attempt of the `SingletonMuxer`. pub struct OutboundSubstream {} impl StreamMuxer for SingletonMuxer where TSocket: AsyncRead + AsyncWrite + Unpin, { type Substream = Substream; type OutboundSubstream = OutboundSubstream; type Error = io::Error; fn poll_event( &self, _: &mut Context<'_>, ) -> Poll, io::Error>> { match self.endpoint { Endpoint::Dialer => return Poll::Pending, Endpoint::Listener => {} } if !self.substream_extracted.swap(true, Ordering::Relaxed) { Poll::Ready(Ok(StreamMuxerEvent::InboundSubstream(Substream {}))) } else { Poll::Pending } } fn open_outbound(&self) -> Self::OutboundSubstream { OutboundSubstream {} } fn poll_outbound( &self, _: &mut Context<'_>, _: &mut Self::OutboundSubstream, ) -> Poll> { match self.endpoint { Endpoint::Listener => return Poll::Pending, Endpoint::Dialer => {} } if !self.substream_extracted.swap(true, Ordering::Relaxed) { Poll::Ready(Ok(Substream {})) } else { Poll::Pending } } fn destroy_outbound(&self, _: Self::OutboundSubstream) {} fn read_substream( &self, cx: &mut Context<'_>, _: &mut Self::Substream, buf: &mut [u8], ) -> Poll> { AsyncRead::poll_read(Pin::new(&mut *self.inner.lock()), cx, buf) } fn write_substream( &self, cx: &mut Context<'_>, _: &mut Self::Substream, buf: &[u8], ) -> Poll> { AsyncWrite::poll_write(Pin::new(&mut *self.inner.lock()), cx, buf) } fn flush_substream( &self, cx: &mut Context<'_>, _: &mut Self::Substream, ) -> Poll> { AsyncWrite::poll_flush(Pin::new(&mut *self.inner.lock()), cx) } fn shutdown_substream( &self, cx: &mut Context<'_>, _: &mut Self::Substream, ) -> Poll> { AsyncWrite::poll_close(Pin::new(&mut *self.inner.lock()), cx) } fn destroy_substream(&self, _: Self::Substream) {} fn poll_close(&self, cx: &mut Context<'_>) -> Poll> { // The `StreamMuxer` trait requires that `close()` implies `flush_all()`. self.flush_all(cx) } fn flush_all(&self, cx: &mut Context<'_>) -> Poll> { AsyncWrite::poll_flush(Pin::new(&mut *self.inner.lock()), cx) } }