Module sockopt

rustix::net

Module sockopt 

Source
Expand description

getsockopt and setsockopt functions.

In the rustix API, there is a separate function for each option, so that it can be given an option-specific type signature.

§References for all getter functions:

§References for all set_* functions:

§References for get_socket_* and set_socket_* functions:

§References for get_ip_* and set_ip_* functions:

§References for get_ipv6_* and set_ipv6_* functions:

§References for get_tcp_* and set_tcp_* functions:

Structs§

Ipv4PathMtuDiscovery
IPv4 Path MTU Discovery option values (IP_PMTUDISC_*) for use with set_ip_mtu_discover and ip_mtu_discover.
Ipv6PathMtuDiscovery
IPv6 Path MTU Discovery option values (IPV6_PMTUDISC_*) for use with set_ipv6_mtu_discover and ipv6_mtu_discover.

Enums§

Timeout
Timeout identifier for use with set_socket_timeout and socket_timeout.

Functions§

get_txtime
getsockopt(fd, SOL_SOCKET, SO_TXTIME) — Get transmission timing configuration.
ip_freebind
getsockopt(fd, IPPROTO_IP, IP_FREEBIND)
ip_mtu
getsockopt(fd, IPPROTO_IP, IP_MTU)
ip_mtu_discover
getsockopt(fd, IPPROTO_IP, IP_MTU_DISCOVER)
ip_multicast_if
getsockopt(fd, IPPROTO_IP, IP_MULTICAST_IF)
ip_multicast_loop
getsockopt(fd, IPPROTO_IP, IP_MULTICAST_LOOP)
ip_multicast_ttl
getsockopt(fd, IPPROTO_IP, IP_MULTICAST_TTL)
ip_original_dst
getsockopt(fd, IPPROTO_IP, SO_ORIGINAL_DST)
ip_recvtos
getsockopt(fd, IPPROTO_IP, IP_RECVTOS)
ip_tos
getsockopt(fd, IPPROTO_IP, IP_TOS)
ip_ttl
getsockopt(fd, IPPROTO_IP, IP_TTL)
ipv6_freebind
getsockopt(fd, IPPROTO_IPV6, IPV6_FREEBIND)
ipv6_mtu
getsockopt(fd, IPPROTO_IPV6, IPV6_MTU)
ipv6_mtu_discover
getsockopt(fd, IPPROTO_IPV6, IPV6_MTU_DISCOVER)
ipv6_multicast_hops
getsockopt(fd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS)
ipv6_multicast_if
getsockopt(fd, IPPROTO_IPV6, IPV6_MULTICAST_IF)
ipv6_multicast_loop
getsockopt(fd, IPPROTO_IPV6, IPV6_MULTICAST_LOOP)
ipv6_original_dst
getsockopt(fd, IPPROTO_IPV6, IP6T_SO_ORIGINAL_DST)
ipv6_recvtclass
getsockopt(fd, IPPROTO_IPV6, IPV6_RECVTCLASS)
ipv6_tclass
getsockopt(fd, IPPROTO_IPV6, IPV6_TCLASS)
ipv6_unicast_hops
getsockopt(fd, IPPROTO_IPV6, IPV6_UNICAST_HOPS)
ipv6_v6only
getsockopt(fd, IPPROTO_IPV6, IPV6_V6ONLY)
set_ip_add_membership
setsockopt(fd, IPPROTO_IP, IP_ADD_MEMBERSHIP, multiaddr, interface)
set_ip_add_membership_with_ifindex
setsockopt(fd, IPPROTO_IP, IP_ADD_MEMBERSHIP, multiaddr, address, ifindex)
set_ip_add_source_membership
setsockopt(fd, IPPROTO_IP, IP_ADD_SOURCE_MEMBERSHIP, value)
set_ip_drop_membership
setsockopt(fd, IPPROTO_IP, IP_DROP_MEMBERSHIP, multiaddr, interface)
set_ip_drop_membership_with_ifindex
setsockopt(fd, IPPROTO_IP, IP_DROP_MEMBERSHIP, multiaddr, interface)
set_ip_drop_source_membership
setsockopt(fd, IPPROTO_IP, IP_DROP_SOURCE_MEMBERSHIP, value)
set_ip_freebind
setsockopt(fd, IPPROTO_IP, IP_FREEBIND, value)
set_ip_mtu_discover
setsockopt(fd, IPPROTO_IP, IP_MTU_DISCOVER, value)
set_ip_multicast_if
setsockopt(fd, IPPROTO_IP, IP_MULTICAST_IF, value)
set_ip_multicast_if_with_ifindex
setsockopt(fd, IPPROTO_IP, IP_MULTICAST_IF, multiaddr, address, ifindex)
set_ip_multicast_loop
setsockopt(fd, IPPROTO_IP, IP_MULTICAST_LOOP, value)
set_ip_multicast_ttl
setsockopt(fd, IPPROTO_IP, IP_MULTICAST_TTL, value)
set_ip_recvtos
setsockopt(fd, IPPROTO_IP, IP_RECVTOS, value)
set_ip_tos
setsockopt(fd, IPPROTO_IP, IP_TOS, value)
set_ip_ttl
setsockopt(fd, IPPROTO_IP, IP_TTL, value)
set_ipv6_add_membership
setsockopt(fd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, multiaddr, interface)
set_ipv6_drop_membership
setsockopt(fd, IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, multiaddr, interface)
set_ipv6_freebind
setsockopt(fd, IPPROTO_IPV6, IPV6_FREEBIND, value)
set_ipv6_mtu_discover
setsockopt(fd, IPPROTO_IPV6, IPV6_MTU_DISCOVER, value)
set_ipv6_multicast_hops
setsockopt(fd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, value)
set_ipv6_multicast_if
setsockopt(fd, IPPROTO_IPV6, IPV6_MULTICAST_IF, value)
set_ipv6_multicast_loop
setsockopt(fd, IPPROTO_IPV6, IPV6_MULTICAST_LOOP, value)
set_ipv6_recvtclass
setsockopt(fd, IPPROTO_IPV6, IPV6_RECVTCLASS, value)
set_ipv6_tclass
setsockopt(fd, IPPROTO_IPV6, IPV6_TCLASS, value)
set_ipv6_unicast_hops
setsockopt(fd, IPPROTO_IPV6, IPV6_UNICAST_HOPS, value)
set_ipv6_v6only
setsockopt(fd, IPPROTO_IPV6, IPV6_V6ONLY, value)
set_socket_broadcast
setsockopt(fd, SOL_SOCKET, SO_BROADCAST, value)
set_socket_incoming_cpu
setsockopt(fd, SOL_SOCKET, SO_INCOMING_CPU, value)
set_socket_keepalive
setsockopt(fd, SOL_SOCKET, SO_KEEPALIVE, value)
set_socket_linger
setsockopt(fd, SOL_SOCKET, SO_LINGER, value)
set_socket_oobinline
setsockopt(fd, SOL_SOCKET, SO_OOBINLINE, value)
set_socket_passcred
setsockopt(fd, SOL_SOCKET, SO_PASSCRED, value)
set_socket_recv_buffer_size
setsockopt(fd, SOL_SOCKET, SO_RCVBUF, value)
set_socket_recv_buffer_size_force
setsockopt(fd, SOL_SOCKET, SO_RCVBUFFORCE, value)
set_socket_reuseaddr
setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, value)—Set whether local addresses may be reused in bind.
set_socket_reuseport
setsockopt(fd, SOL_SOCKET, SO_REUSEPORT, value)
set_socket_send_buffer_size
setsockopt(fd, SOL_SOCKET, SO_SNDBUF, value)
set_socket_send_buffer_size_force
setsockopt(fd, SOL_SOCKET, SO_SNDBUFFORCE, value)
set_socket_timeout
setsockopt(fd, SOL_SOCKET, id, value)—Set the sending or receiving timeout.
set_tcp_congestion
setsockopt(fd, IPPROTO_TCP, TCP_CONGESTION, value)
set_tcp_cork
setsockopt(fd, IPPROTO_TCP, TCP_CORK, value)
set_tcp_keepcnt
setsockopt(fd, IPPROTO_TCP, TCP_KEEPCNT, value)
set_tcp_keepidle
setsockopt(fd, IPPROTO_TCP, TCP_KEEPIDLE, value)
set_tcp_keepintvl
setsockopt(fd, IPPROTO_TCP, TCP_KEEPINTVL, value)
set_tcp_nodelay
setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, value)
set_tcp_quickack
setsockopt(fd, IPPROTO_TCP, TCP_QUICKACK, value)
set_tcp_thin_linear_timeouts
setsockopt(fd, IPPROTO_TCP, TCP_THIN_LINEAR_TIMEOUTS, value)
set_tcp_user_timeout
setsockopt(fd, IPPROTO_TCP, TCP_USER_TIMEOUT, value)
set_txtime
setsockopt(fd, SOL_SOCKET, SO_TXTIME) — Configure transmission timing.
set_xdp_rx_ring_size
setsockopt(fd, SOL_XDP, XDP_RX_RING, value)
set_xdp_tx_ring_size
setsockopt(fd, SOL_XDP, XDP_TX_RING, value)
set_xdp_umem_completion_ring_size
setsockopt(fd, SOL_XDP, XDP_UMEM_COMPLETION_RING, value)
set_xdp_umem_fill_ring_size
setsockopt(fd, SOL_XDP, XDP_UMEM_FILL_RING, value)
set_xdp_umem_reg
setsockopt(fd, SOL_XDP, XDP_UMEM_REG, value)
socket_acceptconn
getsockopt(fd, SOL_SOCKET, SO_ACCEPTCONN)
socket_broadcast
getsockopt(fd, SOL_SOCKET, SO_BROADCAST)
socket_cookie
getsockopt(fd, SOL_SOCKET, SO_COOKIE)
socket_domain
getsockopt(fd, SOL_SOCKET, SO_DOMAIN)
socket_error
getsockopt(fd, SOL_SOCKET, SO_ERROR)
socket_incoming_cpu
getsockopt(fd, SOL_SOCKET, SO_INCOMING_CPU)
socket_keepalive
getsockopt(fd, SOL_SOCKET, SO_KEEPALIVE)
socket_linger
getsockopt(fd, SOL_SOCKET, SO_LINGER)
socket_oobinline
getsockopt(fd, SOL_SOCKET, SO_OOBINLINE)
socket_passcred
getsockopt(fd, SOL_SOCKET, SO_PASSCRED)
socket_peercred
getsockopt(fd, SOL_SOCKET, SO_PEERCRED)—Get credentials of Unix domain socket peer process.
socket_protocol
getsockopt(fd, SOL_SOCKET, SO_PROTOCOL)
socket_recv_buffer_size
getsockopt(fd, SOL_SOCKET, SO_RCVBUF)
socket_reuseaddr
getsockopt(fd, SOL_SOCKET, SO_REUSEADDR)
socket_reuseport
getsockopt(fd, SOL_SOCKET, SO_REUSEPORT)
socket_send_buffer_size
getsockopt(fd, SOL_SOCKET, SO_SNDBUF)
socket_timeout
getsockopt(fd, SOL_SOCKET, id)—Get the sending or receiving timeout.
socket_type
getsockopt(fd, SOL_SOCKET, SO_TYPE)—Returns the type of a socket.
tcp_congestion
getsockopt(fd, IPPROTO_TCP, TCP_CONGESTION)
tcp_cork
getsockopt(fd, IPPROTO_TCP, TCP_CORK)
tcp_keepcnt
getsockopt(fd, IPPROTO_TCP, TCP_KEEPCNT)
tcp_keepidle
getsockopt(fd, IPPROTO_TCP, TCP_KEEPIDLE)
tcp_keepintvl
getsockopt(fd, IPPROTO_TCP, TCP_KEEPINTVL)
tcp_nodelay
getsockopt(fd, IPPROTO_TCP, TCP_NODELAY)
tcp_quickack
getsockopt(fd, IPPROTO_TCP, TCP_QUICKACK)
tcp_thin_linear_timeouts
getsockopt(fd, IPPROTO_TCP, TCP_THIN_LINEAR_TIMEOUTS)
tcp_user_timeout
getsockopt(fd, IPPROTO_TCP, TCP_USER_TIMEOUT)
xdp_mmap_offsets
getsockopt(fd, SOL_XDP, XDP_MMAP_OFFSETS)
xdp_options
getsockopt(fd, SOL_XDP, XDP_OPTIONS)
xdp_statistics
getsockopt(fd, SOL_XDP, XDP_STATISTICS)

Type Aliases§

RawIpv4PathMtuDiscovery
A type for holding raw integer IPv4 Path MTU Discovery options.
RawIpv6PathMtuDiscovery
A type for holding raw integer IPv6 Path MTU Discovery options.