Struct mio::net::TcpSocket

pub struct TcpSocket { /* fields omitted */ }

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

A non-blocking TCP socket used to configure a stream or listener.

The TcpSocket type wraps the operating-system's socket handle. This type is used to configure the socket before establishing a connection or start listening for inbound connections.

The socket will be closed when the value is dropped.

Implementations

impl TcpSocket

pub fn new_v4() -> Result<TcpSocket>

This is supported on crate feature tcp only.

Create a new IPv4 TCP socket.

This calls socket(2).

pub fn new_v6() -> Result<TcpSocket>

This is supported on crate feature tcp only.

Create a new IPv6 TCP socket.

This calls socket(2).

pub fn bind(&self, addr: SocketAddr) -> Result<()>

This is supported on crate feature tcp only.

Bind addr to the TCP socket.

pub fn connect(self, addr: SocketAddr) -> Result<TcpStream>

This is supported on crate feature tcp only.

Connect the socket to addr.

This consumes the socket and performs the connect operation. Once the connection completes, the socket is now a non-blocking TcpStream and can be used as such.

pub fn listen(self, backlog: u32) -> Result<TcpListener>

This is supported on crate feature tcp only.

Listen for inbound connections, converting the socket to a TcpListener.

pub fn set_reuseaddr(&self, reuseaddr: bool) -> Result<()>

This is supported on crate feature tcp only.

Sets the value of SO_REUSEADDR on this socket.

pub fn set_linger(&self, dur: Option<Duration>) -> Result<()>

This is supported on crate feature tcp only.

Sets the value of SO_LINGER on this socket.

Trait Implementations

impl AsRawFd for TcpSocket

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for TcpSocket

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

Formats the value using the given formatter.

impl Drop for TcpSocket

fn drop(&mut self)

Executes the destructor for this type.

impl FromRawFd for TcpSocket

unsafe fn from_raw_fd(fd: RawFd) -> TcpSocket

Converts a RawFd to a TcpSocket.

Notes

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