Struct TcpSocket 

pub struct TcpSocket { /* private fields */ }

Low level synchronous TCP socket.

Implementations

impl TcpSocket

pub fn from_config(config: &TcpConfig) -> Result<Self>

Build a socket according to TcpSocketConfig.

pub fn new(domain: Domain, sock_type: SockType) -> Result<Self>

Create a socket of arbitrary type (STREAM or RAW).

pub fn v4_stream() -> Result<Self>

Convenience constructor for an IPv4 STREAM socket.

pub fn v6_stream() -> Result<Self>

Convenience constructor for an IPv6 STREAM socket.

pub fn raw_v4() -> Result<Self>

IPv4 RAW TCP. Requires administrator privileges.

pub fn raw_v6() -> Result<Self>

IPv6 RAW TCP. Requires administrator privileges.

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

Bind the socket to a specific address.

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

Connect to a remote address.

pub fn connect_timeout( &self, target: SocketAddr, timeout: Duration, ) -> Result<TcpStream>

Connect to the target address with a timeout and return the connected stream.

The returned TcpStream must be used for subsequent I/O.

pub fn listen(&self, backlog: i32) -> Result<()>

Start listening for incoming connections.

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

Accept an incoming connection.

pub fn to_tcp_stream(self) -> Result<TcpStream>

Convert the socket into a TcpStream.

pub fn to_tcp_listener(self) -> Result<TcpListener>

Convert the socket into a TcpListener.

pub fn send_to(&self, buf: &[u8], target: SocketAddr) -> Result<usize>

Send a raw packet (for RAW TCP use).

pub fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>

Receive a raw packet (for RAW TCP use).

pub fn shutdown(&self, how: Shutdown) -> Result<()>

Shutdown the socket.

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

Set the socket to reuse the address.

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

Get the socket address reuse option.

pub fn set_reuseport(&self, on: bool) -> Result<()>

Set the socket port reuse option where supported.

pub fn reuseport(&self) -> Result<bool>

Get the socket port reuse option where supported.

pub fn set_nodelay(&self, on: bool) -> Result<()>

Set the socket to not delay packets.

pub fn nodelay(&self) -> Result<bool>

Get the no delay option.

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

Set the linger option for the socket.

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

Set the time-to-live for IPv4 packets.

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

Get the time-to-live for IPv4 packets.

pub fn set_hoplimit(&self, hops: u32) -> Result<()>

Set the hop limit for IPv6 packets.

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

Get the hop limit for IPv6 packets.

pub fn set_keepalive(&self, on: bool) -> Result<()>

Set the keepalive option for the socket.

pub fn keepalive(&self) -> Result<bool>

Get the keepalive option.

pub fn set_recv_buffer_size(&self, size: usize) -> Result<()>

Set the receive buffer size.

pub fn recv_buffer_size(&self) -> Result<usize>

Get the receive buffer size.

pub fn set_send_buffer_size(&self, size: usize) -> Result<()>

Set the send buffer size.

pub fn send_buffer_size(&self) -> Result<usize>

Get the send buffer size.

pub fn set_tos(&self, tos: u32) -> Result<()>

Set IPv4 TOS / DSCP.

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

Get IPv4 TOS / DSCP.

pub fn set_tclass_v6(&self, tclass: u32) -> Result<()>

Set IPv6 traffic class where supported.

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

Get IPv6 traffic class where supported.

pub fn set_only_v6(&self, only_v6: bool) -> Result<()>

Set whether this socket is IPv6 only.

pub fn only_v6(&self) -> Result<bool>

Get whether this socket is IPv6 only.

pub fn set_bind_device(&self, iface: &str) -> Result<()>

Set the bind device for the socket (Linux specific).

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

Retrieve the local address of the socket.

pub fn as_raw_fd(&self) -> RawFd

Extract the RAW file descriptor for Unix.

pub fn from_socket(socket: Socket) -> Self

Construct from a raw socket2::Socket.

pub fn socket(&self) -> &Socket

Borrow the inner socket2::Socket.

pub fn into_socket(self) -> Socket

Consume and return the inner socket2::Socket.

Trait Implementations

impl Debug for TcpSocket

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

Formats the value using the given formatter.