Struct TlsListener 

pub struct TlsListener<A: AsyncAccept, T: AsyncTls<A::Connection>> { /* private fields */ }

Wraps a Stream of connections (such as a TCP listener) so that each connection is itself encrypted using TLS.

It is similar to:

tcpListener.and_then(|s| tlsAcceptor.accept(s))

except that it has the ability to accept multiple transport-level connections simultaneously while the TLS handshake is pending for other connections.

By default, if a client fails the TLS handshake, that is treated as an error, and the TlsListener will return an Err. If the error is not handled, then an invalid handshake can cause the server to stop accepting connections. See http-stream.rs or http-low-level examples, for examples of how to avoid this.

Note that if the maximum number of pending connections is greater than 1, the resulting T::Stream connections may come in a different order than the connections produced by the underlying listener.

Implementations

impl<A: AsyncAccept, T> TlsListener<A, T>

where T: AsyncTls<A::Connection>,

pub fn new(tls: T, listener: A) -> Self

Create a TlsListener with default options.

impl<A, T> TlsListener<A, T>

where A: AsyncAccept, T: AsyncTls<A::Connection>,

pub fn poll_accept( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<<Self as Stream>::Item>

Poll accepting a connection.

This will return ready once the TLS handshake has completed on an incoming connection and return the connection and the source address.

pub fn accept(&mut self) -> impl Future<Output = <Self as Stream>::Item> + '_

where Self: Unpin,

Accept the next connection

This is similar to self.next(), but doesn’t return an Option because there isn’t an end condition on accepting connections, and has a more domain-appropriate name.

The future returned is “cancellation safe”.

pub fn replace_acceptor(&mut self, acceptor: T)

Replaces the Tls Acceptor configuration, which will be used for new connections.

This can be used to change the certificate used at runtime.

pub fn replace_acceptor_pin(self: Pin<&mut Self>, acceptor: T)

Replaces the Tls Acceptor configuration from a pinned reference to Self.

This is useful if your listener is !Unpin.

This can be used to change the certificate used at runtime.

pub fn connections( self, ) -> impl Stream<Item = Result<T::Stream, Error<<A as AsyncAccept>::Error, <T as AsyncTls<<A as AsyncAccept>::Connection>>::Error, <A as AsyncAccept>::Address>>>

Convert into a Stream of connections.

This drops the address of the connection, but provides a more convenient API if the address isn’t needed.

The address will still be included in errors.

Trait Implementations

impl<A, T> Stream for TlsListener<A, T>

where A: AsyncAccept, T: AsyncTls<A::Connection>,

type Item = Result<(<T as AsyncTls<<A as AsyncAccept>::Connection>>::Stream, <A as AsyncAccept>::Address), Error<<A as AsyncAccept>::Error, <T as AsyncTls<<A as AsyncAccept>::Connection>>::Error, <A as AsyncAccept>::Address>>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'__pin, A: AsyncAccept, T: AsyncTls<A::Connection>> Unpin for TlsListener<A, T>

where PinnedFieldsOf<__Origin<'__pin, A, T>>: Unpin,