MulticastDiscoverySocket

Struct MulticastDiscoverySocket 

Source
pub struct MulticastDiscoverySocket<D: AdvertisementData> { /* private fields */ }

Implementations§

Source§

impl<D: AdvertisementData> MulticastDiscoverySocket<D>

Source

pub fn new_discover_only(cfg: &MulticastDiscoveryConfig) -> Result<Self>

Create new socket for multicast discovery. Announcements are disabled (running without service) Enable feature bincode for passing Encode + Decode types as adv_data

Source

pub fn new_with_service( cfg: &MulticastDiscoveryConfig, service_port: u16, initial_adv_data: D, ) -> Result<Self>

Create new socket for multicast discovery. Announcements are enabled depending on config. Enable feature bincode for passing Encode + Decode types as adv_data

Source

pub fn discover_id(&self) -> u32

Returns discover ID. It is generated randomly, and can be used to detect client application restart.

Source

pub fn running_port(&self) -> MulticastRunningPort

Source

pub fn set_announce_en(&mut self, en: bool)

Setting this to false will disable periodic background announcements during poll() Announcements are performed by periodic sending message Announce (and ExtendAnnounce)

Source

pub fn set_discover_replies_en(&mut self, enable: bool)

Setting this to false will disable automatic replies to Discovery messages

Source

pub fn adv_data(&mut self) -> Option<&mut D>

Guaranteed to return Some(&mut D) if was created with Self::new

Source

pub fn discover(&mut self)

Manually discover all clients on main or backup ports (using Discovery message). Results can be collected by running poll.

Source

pub fn poll(&mut self, discover_msg: impl FnMut(PollResult<'_, D>))

Run poll periodically to handle internal discovery mechanisms:

  • Announce messages periodic sending
  • ExtendAnnounce messages periodic sending (if running on backup port)
  • handling incoming messages (and returning discovery results via discover_msg callback)

It is recommended to call this function in a loop with ~100ms sleep

Trait Implementations§

Source§

impl<D: AdvertisementData> Drop for MulticastDiscoverySocket<D>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V