Struct ipcon_sys::ipcon::Ipcon

pub struct Ipcon { /* private fields */ }

IPCON peer.

Implementations

impl Ipcon

pub fn to_handler(u: usize) -> *mut c_void

pub unsafe fn from_handler(h: *mut c_void) -> usize

Safety

pub fn new(peer_name: Option<&str>, flag: Option<IpconFlag>) -> Option<Ipcon>

Create an IPEON peer. If the name is ommited, an anonymous will be created. Following flags can be specified with bitwise OR (|).

• IPF_DISABLE_KEVENT_FILTER
  By default, IPCON kernel module will only delivery the add/remove notification of peers and groups which are considerred to be interested by the peer. If this flag is enabled, all notification will be deliveried by IPCON kernel module.
• IPF_SND_IF
  Use message sending interface.
• IPF_RCV_IF
  Use message receiving interface.
• IPF_DEFULT
  This is same to IPF_RCV_IF | IPF_SND_IF.

pub fn get_read_fd(&self) -> Option<i32>

Retrieve netlink socket file descriptor of message receiving interface.

pub fn get_write_fd(&self) -> Option<i32>

Retrieve netlink socket file descriptor of message sending interface.

pub fn get_ctrl_fd(&self) -> Option<i32>

Retrieve netlink socket file descriptor of control interface.

pub fn is_peer_present(&self, peer: &str) -> bool

Inquiry whether a peer is present.

pub fn is_group_present(&self, peer: &str, group: &str) -> bool

Inquiry whether the group of a peer is present.

pub fn receive_msg(&self) -> Result<IpconMsg>

Receive IPCON message. This function will fail if the peer doesn’t enable IPF_RCV_IF.

pub fn send_unicast_msg(&self, peer: &str, buf: Bytes) -> Result<()>

Send an unicast IPCON message to a speicific peer. This function will fail if the peer doesn’t enable IPF_SND_IF.

pub fn send_unicast_msg_by_ref(&self, peer: &str, buf: &Bytes) -> Result<()>

Send an unicast IPCON message to a speicific peer. This function will fail if the peer doesn’t enable IPF_SND_IF.

pub fn register_group(&self, group: &str) -> Result<()>

Register a multicast group.

pub fn unregister_group(&self, group: &str) -> Result<()>

Unregister a multicast group.

pub fn join_group(&self, peer: &str, group: &str) -> Result<()>

Subscribe a multicast group of a peer.

pub fn leave_group(&self, peer: &str, group: &str) -> Result<()>

Unsubscribe a multicast group of a peer.

pub fn send_multicast(&self, group: &str, buf: Bytes, sync: bool) -> Result<()>

Send multicast messages to an owned group.

pub fn send_multicast_by_ref(
    &self,
    group: &str,
    buf: &Bytes,
    sync: bool
) -> Result<()>

Send multicast messages to an owned group.

pub fn receive_msg_timeout(&self, tv_sec: u32, tv_usec: u32) -> Result<IpconMsg>

Receiving message with timeout. receive_msg() will block until a message come. receive_msg_timeout() adds a timeout to it.The timeout is specified with seconds and microseconds.

pub fn receive_msg_nonblock(&self) -> Result<IpconMsg>

Receiving message without block. This is same to receive_msg_timeout(0, 0);

Trait Implementations

impl Drop for Ipcon

fn drop(&mut self)

Executes the destructor for this type.