Struct mio::net::TcpListener

pub struct TcpListener { /* fields omitted */ }

This is supported on crate features tcp or udp or uds only.

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

impl TcpListener

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

This is supported on crate feature tcp only.

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

This function will take the following steps:

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

pub fn from_std(listener: TcpListener) -> TcpListener

This is supported on crate feature tcp only.

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.

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

This is supported on crate feature tcp only.

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.

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

This is supported on crate feature tcp only.

Returns the local socket address of this listener.

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

This is supported on crate feature tcp only.

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.

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

This is supported on crate feature tcp only.

Gets the value of the IP_TTL option for this socket.

For more information about this option, see set_ttl.

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

This is supported on crate feature tcp only.

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.

Trait Implementations

impl AsRawFd for TcpListener

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for TcpListener

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromRawFd for TcpListener

unsafe fn from_raw_fd(fd: RawFd) -> TcpListener

Converts a RawFd to a TcpListener.

Notes

The caller is responsible for ensuring that the socket is in non-blocking mode.

impl IntoRawFd for TcpListener

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl Source for TcpListener

fn register(
    &mut self,
    registry: &Registry,
    token: Token,
    interests: Interest
) -> Result<()>

Register self with the given Registry instance.

fn reregister(
    &mut self,
    registry: &Registry,
    token: Token,
    interests: Interest
) -> Result<()>

Re-register self with the given Registry instance.

fn deregister(&mut self, registry: &Registry) -> Result<()>

Deregister self from the given Registry instance.