Struct NlSocket

pub struct NlSocket { /* private fields */ }

Low level access to a netlink socket.

Implementations

impl NlSocket

pub fn new(proto: NlFamily) -> Result<Self, Error>

Wrapper around socket() syscall filling in the netlink-specific information.

pub fn connect( proto: NlFamily, pid: Option<u32>, groups: Groups, ) -> Result<Self, Error>

Equivalent of socket and bind calls.

pub fn block(&self) -> Result<(), Error>

Set underlying socket file descriptor to be blocking.

pub fn nonblock(&self) -> Result<(), Error>

Set underlying socket file descriptor to be non blocking.

pub fn is_blocking(&self) -> Result<bool, Error>

Determines if underlying file descriptor is blocking.

pub fn bind(&self, pid: Option<u32>, groups: Groups) -> Result<(), Error>

Use this function to bind to a netlink ID and subscribe to groups. See netlink(7) man pages for more information on netlink IDs and groups.

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

Set the size of the receive buffer for the socket.

This can be useful when communicating with a service that sends a high volume of messages (especially multicast), and your application cannot process them fast enough, leading to the kernel dropping messages. A larger buffer may help mitigate this.

The value passed is a hint to the kernel to set the size of the receive buffer. The kernel will double the value provided to account for bookkeeping overhead. The doubled value is capped by the value in /proc/sys/net/core/rmem_max.

The default value is /proc/sys/net/core/rmem_default

See socket(7) documentation for SO_RCVBUF for more information.

pub fn add_mcast_membership(&self, groups: Groups) -> Result<(), Error>

Join multicast groups for a socket.

pub fn drop_mcast_membership(&self, groups: Groups) -> Result<(), Error>

Leave multicast groups for a socket.

pub fn list_mcast_membership(&self) -> Result<NetlinkBitArray, Error>

List joined groups for a socket.

pub fn send<B>(&self, buf: B, flags: Msg) -> Result<size_t, Error>

where B: AsRef<[u8]>,

Send message encoded as byte slice to the netlink ID specified in the netlink header Nlmsghdr

pub fn recv<B>(&self, buf: B, flags: Msg) -> Result<(size_t, Groups), Error>

where B: AsMut<[u8]>,

Receive message encoded as byte slice from the netlink socket.

pub fn pid(&self) -> Result<u32, Error>

Get the PID for this socket.

pub fn enable_ext_ack(&self, enable: bool) -> Result<(), Error>

If true is passed in, enable extended ACKs for this socket. If false is passed in, disable extended ACKs for this socket.

pub fn get_ext_ack_enabled(&self) -> Result<bool, Error>

Return true if an extended ACK is enabled for this socket.

pub fn enable_strict_checking(&self, enable: bool) -> Result<(), Error>

If true is passed in, enable strict checking for this socket. If false is passed in, disable strict checking for for this socket. Only supported by NlFamily::Route sockets. Requires Linux >= 4.20.

pub fn get_strict_checking_enabled(&self) -> Result<bool, Error>

Return true if strict checking is enabled for this socket. Only supported by NlFamily::Route sockets. Requires Linux >= 4.20.

Trait Implementations

impl AsRawFd for NlSocket

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Drop for NlSocket

fn drop(&mut self)

Closes underlying file descriptor to avoid file descriptor leaks.

impl From<NlSocketHandle> for NlSocket

fn from(s: NlSocketHandle) -> Self

Converts to this type from the input type.

impl FromRawFd for NlSocket

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.

impl IntoRawFd for NlSocket

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.