Struct neli::socket::NlSocketHandle

pub struct NlSocketHandle { /* fields omitted */ }

Higher level handle for socket operations.

Implementations

impl NlSocketHandle

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: U32Bitmask
) -> 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: U32Bitmask) -> 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 add_mcast_membership(&self, groups: U32Bitmask) -> Result<(), Error>

Join multicast groups for a socket.

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

Leave multicast groups for a socket.

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

List joined groups for a socket.

pub fn resolve_genl_family(&mut self, family_name: &str) -> Result<u16, NlError>

Convenience function for resolving a str containing the generic netlink family name to a numeric generic netlink ID.

pub fn resolve_nl_mcast_group(
    &mut self,
    family_name: &str,
    mcast_name: &str
) -> Result<u32, NlError>

Convenience function for resolving a str containing the multicast group name to a numeric multicast group ID.

pub fn lookup_id(&mut self, id: u32) -> Result<(String, String), NlError>

Look up netlink family and multicast group name by ID.

pub fn send<T, P>(&mut self, msg: Nlmsghdr<T, P>) -> Result<(), NlError> where
    T: Nl + NlType + Debug,
    P: Nl + Debug, 

Convenience function to send an Nlmsghdr struct

pub fn recv<T, P>(&mut self) -> Result<Option<Nlmsghdr<T, P>>, NlError> where
    T: Nl + NlType + Debug,
    P: Nl + Debug, 

Convenience function to begin receiving a stream of Nlmsghdr structs.

pub fn recv_all<T, P>(&mut self) -> Result<NlBuffer<T, P>, NlError> where
    T: Nl + NlType + Debug,
    P: Nl + Debug, 

Parse all Nlmsghdr structs sent in one network packet and return them all in a list.

Failure to parse any packet will cause the entire operation to fail. If an error is detected at the application level, this method will discard any non-error Nlmsghdr structs and only return the error. This method checks for ACKs. For a more granular approach, use either NlSocketHandle::recv or NlSocketHandle::iter.

pub fn iter<P>(
    &mut self,
    iter_indefinitely: bool
) -> NlMessageIter<'_, NlTypeWrapper, P> where
    P: Nl + Debug, 

Return an iterator object

The argument iterate_indefinitely is documented in more detail in NlMessageIter

Trait Implementations

impl AsRawFd for NlSocketHandle

pub fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl From<NlSocketHandle> for NlSocket

pub fn from(s: NlSocketHandle) -> Self

Performs the conversion.

impl FromRawFd for NlSocketHandle

pub unsafe fn from_raw_fd(fd: RawFd) -> Self

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

impl IntoRawFd for NlSocketHandle

pub fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.