Struct TcpConfig 

pub struct TcpConfig {

    pub socket_family: SocketFamily,
    pub socket_type: TcpSocketType,
    pub bind_addr: Option<SocketAddr>,
    pub nonblocking: bool,
    pub reuseaddr: Option<bool>,
    pub reuseport: Option<bool>,
    pub nodelay: Option<bool>,
    pub linger: Option<Duration>,
    pub ttl: Option<u32>,
    pub hoplimit: Option<u32>,
    pub read_timeout: Option<Duration>,
    pub write_timeout: Option<Duration>,
    pub recv_buffer_size: Option<usize>,
    pub send_buffer_size: Option<usize>,
    pub tos: Option<u32>,
    pub tclass_v6: Option<u32>,
    pub only_v6: Option<bool>,
    pub bind_device: Option<String>,
    pub keepalive: Option<bool>,
}

Configuration options for a TCP socket.

Fields

socket_family: SocketFamily

The socket family, either IPv4 or IPv6.

socket_type: TcpSocketType

The type of TCP socket, either STREAM or RAW.

bind_addr: Option<SocketAddr>

Optional address to bind the socket to.

nonblocking: bool

Whether the socket should be non-blocking.

reuseaddr: Option<bool>

Whether to allow address reuse.

reuseport: Option<bool>

Whether to allow port reuse (SO_REUSEPORT) where supported.

nodelay: Option<bool>

Whether to disable Nagle’s algorithm (TCP_NODELAY).

linger: Option<Duration>

Optional linger duration for the socket.

ttl: Option<u32>

Optional Time-To-Live (TTL) for the socket.

hoplimit: Option<u32>

Optional Hop Limit for the socket (IPv6).

read_timeout: Option<Duration>

Optional read timeout for the socket.

write_timeout: Option<Duration>

Optional write timeout for the socket.

recv_buffer_size: Option<usize>

Optional receive buffer size in bytes.

send_buffer_size: Option<usize>

Optional send buffer size in bytes.

tos: Option<u32>

Optional IPv4 TOS / DSCP field value.

tclass_v6: Option<u32>

Optional IPv6 traffic class value (IPV6_TCLASS) where supported.

only_v6: Option<bool>

Whether to force IPv6-only behavior on dual-stack sockets.

bind_device: Option<String>

Optional device to bind the socket to.

keepalive: Option<bool>

Whether to enable TCP keepalive.

Implementations

impl TcpConfig

pub fn new(socket_family: SocketFamily) -> Self

Create a STREAM socket for the specified family.

pub fn v4_stream() -> Self

Create a STREAM socket for IPv4.

pub fn raw_v4() -> Self

Create a RAW socket. Requires administrator privileges.

pub fn v6_stream() -> Self

Create a STREAM socket for IPv6.

pub fn raw_v6() -> Self

Create a RAW socket for IPv6. Requires administrator privileges.

pub fn with_bind(self, addr: SocketAddr) -> Self

pub fn with_bind_addr(self, addr: SocketAddr) -> Self

pub fn with_nonblocking(self, flag: bool) -> Self

pub fn with_reuseaddr(self, flag: bool) -> Self

pub fn with_reuseport(self, flag: bool) -> Self

pub fn with_nodelay(self, flag: bool) -> Self

pub fn with_linger(self, dur: Duration) -> Self

pub fn with_ttl(self, ttl: u32) -> Self

pub fn with_hoplimit(self, hops: u32) -> Self

pub fn with_hop_limit(self, hops: u32) -> Self

pub fn with_keepalive(self, on: bool) -> Self

pub fn with_read_timeout(self, timeout: Duration) -> Self

pub fn with_write_timeout(self, timeout: Duration) -> Self

pub fn with_recv_buffer_size(self, size: usize) -> Self

pub fn with_send_buffer_size(self, size: usize) -> Self

pub fn with_tos(self, tos: u32) -> Self

pub fn with_tclass_v6(self, tclass: u32) -> Self

pub fn with_only_v6(self, only_v6: bool) -> Self

pub fn with_bind_device(self, iface: impl Into<String>) -> Self

pub fn validate(&self) -> Result<()>

Validate the configuration before socket creation.

Trait Implementations

impl Clone for TcpConfig

fn clone(&self) -> TcpConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TcpConfig

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

Formats the value using the given formatter.