Struct mio::net::TcpListener

source · [−]

pub struct TcpListener { /* private fields */ }

Expand description

A structure representing a socket server

Examples

use mio::{Events, Interest, Poll, Token};
use mio::net::TcpListener;
use std::time::Duration;

let mut listener = TcpListener::bind("127.0.0.1:34255".parse()?)?;

let mut poll = Poll::new()?;
let mut events = Events::with_capacity(128);

// Register the socket with `Poll`
poll.registry().register(&mut listener, Token(0), Interest::READABLE)?;

poll.poll(&mut events, Some(Duration::from_millis(100)))?;

// There may be a socket ready to be accepted

Implementations

source

impl TcpListener

source

pub fn bind(addr: SocketAddr) -> Result<TcpListener>

Convenience method to bind a new TCP listener to the specified address to receive new connections.

This function will take the following steps:

Create a new TCP socket.
Set the SO_REUSEADDR option on the socket on Unix.
Bind the socket to the specified address.
Calls listen on the socket to prepare it to receive new connections.

source

pub fn from_std(listener: TcpListener) -> TcpListener

Creates a new TcpListener from a standard net::TcpListener.

This function is intended to be used to wrap a TCP listener from the standard library in the Mio equivalent. The conversion assumes nothing about the underlying listener; ; it is left up to the user to set it in non-blocking mode.

source

pub fn accept(&self) -> Result<(TcpStream, SocketAddr)>

Accepts a new TcpStream.

This may return an Err(e) where e.kind() is io::ErrorKind::WouldBlock. This means a stream may be ready at a later point and one should wait for an event before calling accept again.

If an accepted stream is returned, the remote address of the peer is returned along with it.

source

pub fn local_addr(&self) -> Result<SocketAddr>

Returns the local socket address of this listener.

source

pub fn set_ttl(&self, ttl: u32) -> Result<()>

Sets the value for the IP_TTL option on this socket.

This value sets the time-to-live field that is used in every packet sent from this socket.

source

pub fn ttl(&self) -> Result<u32>

Gets the value of the IP_TTL option for this socket.

For more information about this option, see set_ttl.

source

pub fn take_error(&self) -> Result<Option<Error>>

Get the value of the SO_ERROR option on this socket.

This will retrieve the stored error in the underlying socket, clearing the field in the process. This can be useful for checking errors between calls.