Struct TcpListener

pub struct TcpListener { /* private fields */ }

A structure representing a socket server

Examples

# use std::error::Error;
# fn main() -> Result<(), Box<dyn Error>> {
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
#     Ok(())
# }

Implementations

impl TcpListener

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:

  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.
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 into non-blocking mode.

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.

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

Returns the local socket address of this listener.

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.

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.

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.

Trait Implementations

impl AsFd for TcpListener

fn as_fd(&self) -> BorrowedFd<'_>

impl AsRawFd for TcpListener

fn as_raw_fd(&self) -> RawFd

impl Debug for TcpListener

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

impl From<OwnedFd> for TcpListener

fn from(fd: OwnedFd) -> Self

Converts a RawFd to a TcpListener.

Notes

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

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

impl Source for TcpListener

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

Auto Trait Implementations

impl !Freeze for TcpListener

impl RefUnwindSafe for TcpListener

impl Send for TcpListener

impl Sync for TcpListener

impl Unpin for TcpListener

impl UnsafeUnpin for TcpListener

impl UnwindSafe for TcpListener

Blanket Implementations

impl<T> Any for TcpListener where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for TcpListener where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for TcpListener where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for TcpListener

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for TcpListener where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for TcpListener where U: Into<T>,

type Error = Infallible;
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for TcpListener where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>