[−][src]Struct smol::net::TcpListener
A TCP server, listening for connections.
After creating a TcpListener
by bind
ing it to an address, it
listens for incoming TCP connections. These can be accepted by calling
accept()
or by awaiting items from the stream of
incoming
connections.
Cloning a TcpListener
creates another handle to the same socket. The socket will be closed
when all handles to it are dropped.
The Transmission Control Protocol is specified in IETF RFC 793.
Examples
use async_net::TcpListener; use futures_lite::*; let listener = TcpListener::bind("127.0.0.1:8080").await?; let mut incoming = listener.incoming(); while let Some(stream) = incoming.next().await { let mut stream = stream?; stream.write_all(b"hello").await?; }
Implementations
impl TcpListener
[src]
pub async fn bind<A>(addr: A) -> Result<TcpListener, Error> where
A: AsyncToSocketAddrs,
[src]
A: AsyncToSocketAddrs,
Creates a new TcpListener
bound to the given address.
Binding with a port number of 0 will request that the operating system assigns an available
port to this listener. The assigned port can be queried via the
local_addr()
method.
If addr
yields multiple addresses, binding will be attempted with each of the addresses
until one succeeds and returns the listener. If none of the addresses succeed in creating a
listener, the error from the last attempt is returned.
Examples
Create a TCP listener bound to 127.0.0.1:80
:
use async_net::TcpListener; let listener = TcpListener::bind("127.0.0.1:80").await?;
Create a TCP listener bound to 127.0.0.1:80
. If that address is unavailable, then try
binding to 127.0.0.1:443
:
use async_net::{SocketAddr, TcpListener}; let addrs = [ SocketAddr::from(([127, 0, 0, 1], 80)), SocketAddr::from(([127, 0, 0, 1], 443)), ]; let listener = TcpListener::bind(&addrs[..]).await.unwrap();
pub fn local_addr(&self) -> Result<SocketAddr, Error>
[src]
Returns the local address this listener is bound to.
Examples
Bind to port 0 and then see which port was assigned by the operating system:
use async_net::{SocketAddr, TcpListener}; let listener = TcpListener::bind("127.0.0.1:0").await?; println!("Listening on {}", listener.local_addr()?);
pub async fn accept(&'_ self) -> Result<(TcpStream, SocketAddr), Error>
[src]
Accepts a new incoming connection.
Returns a TCP stream and the address it is connected to.
Examples
use async_net::TcpListener; let listener = TcpListener::bind("127.0.0.1:8080").await?; let (stream, addr) = listener.accept().await?;
pub fn incoming(&self) -> Incoming<'_>
[src]
Returns a stream of incoming connections.
Iterating over this stream is equivalent to calling accept()
in a loop. The stream of connections is infinite, i.e awaiting the next connection will
never result in None
.
Examples
use async_net::TcpListener; use futures_lite::*; let listener = TcpListener::bind("127.0.0.1:0").await?; let mut incoming = listener.incoming(); while let Some(stream) = incoming.next().await { let mut stream = stream?; stream.write_all(b"hello").await?; }
pub fn ttl(&self) -> Result<u32, Error>
[src]
Gets the value of the IP_TTL
option for this socket.
This option configures the time-to-live field that is used in every packet sent from this socket.
Examples
use async_net::TcpListener; let listener = TcpListener::bind("127.0.0.1:80").await?; listener.set_ttl(100)?; assert_eq!(listener.ttl()?, 100);
pub fn set_ttl(&self, ttl: u32) -> Result<(), Error>
[src]
Sets the value of the IP_TTL
option for this socket.
This option configures the time-to-live field that is used in every packet sent from this socket.
Examples
use async_net::TcpListener; let listener = TcpListener::bind("127.0.0.1:80").await?; listener.set_ttl(100)?;
Trait Implementations
impl AsRawFd for TcpListener
[src]
impl Clone for TcpListener
[src]
fn clone(&self) -> TcpListener
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for TcpListener
[src]
Auto Trait Implementations
impl RefUnwindSafe for TcpListener
impl Send for TcpListener
impl Sync for TcpListener
impl Unpin for TcpListener
impl UnwindSafe for TcpListener
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut Tⓘ
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,