Struct neli::socket::NlSocketHandle

source ·

pub struct NlSocketHandle { /* private fields */ }

Expand description

Higher level handle for socket operations.

Implementations§

source §

impl NlSocketHandle

source

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

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

source

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

Equivalent of socket and bind calls.

source

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

Set underlying socket file descriptor to be blocking.

source

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

Set underlying socket file descriptor to be non blocking.

source

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

Determines if underlying file descriptor is blocking.

source

pub fn bind(&self, pid: Option<u32>, groups: &[u32]) -> 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.

source

pub fn add_mcast_membership(&self, groups: &[u32]) -> Result<(), Error>

Join multicast groups for a socket.

source

pub fn drop_mcast_membership(&self, groups: &[u32]) -> Result<(), Error>

Leave multicast groups for a socket.

source

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

List joined groups for a socket.

source

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

Get the PID for the current socket.

source

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

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

source

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

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

source

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

Look up netlink family and multicast group name by ID.

source

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

Convenience function to send an Nlmsghdr struct

source

pub fn recv<'a, T, P>(
 &'a mut self
) -> Result<Option<Nlmsghdr<T, P>>, NlError<T, P>>where
 T: NlType + Debug,
 P: FromBytesWithInput<'a, Input = usize> + Debug,

Convenience function to read a stream of Nlmsghdr structs one by one. Use NlSocketHandle::iter instead for easy iteration over returned packets.

Returns None only in non-blocking contexts if no message can be immediately returned or if the socket has been closed.

source

pub fn recv_all<'a, T, P>(&'a mut self) -> Result<NlBuffer<T, P>, NlError>where
T: NlType + Debug,
P: FromBytesWithInput<'a, Input = usize> + 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.

source