satcat5::igmp::Address Struct Reference

Detailed Description

Client state for an IGMP multicast subscription.

Classes such as ip::Address and ptp::Client instantiate this object to manage IGMP subscriptions for a specific group address.

See also

igmp_client.h, ip::Address, igmp::Client.

Definition at line 145 of file igmp_client.h.

#include <igmp_client.h>

Collaboration diagram for satcat5::igmp::Address:

Public Member Functions
constexpr	Address ()
	Constructor for an address placeholder. More...
void	join (satcat5::igmp::Client *igmp, const satcat5::ip::Addr &addr)
	Join a multicast group. More...
void	leave (satcat5::igmp::Client *igmp)
	Leave a multicast group. More...

Protected Attributes
satcat5::ip::Addr	m_igmp_group
u32	m_igmp_timer
satcat5::igmp::Address *	m_next

Constructor & Destructor Documentation

Address()

constexpr satcat5::igmp::Address::Address ( )

inlineconstexpr

Constructor for an address placeholder.

Child is responsible for registering with IgmpClient when it wishes to join or leave a multicast group.

Definition at line 150 of file igmp_client.h.

Member Function Documentation

join()

void satcat5::igmp::Address::join ( satcat5::igmp::Client *  igmp, const satcat5::ip::Addr &  addr  )

inline

Join a multicast group.

This is a thin wrapper for igmp::Client::join. The two have the same effect; use whichever method is more convenient.

Parameters

igmp	Local IGMP client.

See also

ip::Stack::igmp.

Parameters

addr	Multicast address/group to be joined. The multicast address must be from the 224.0.0.0/8 block.

Definition at line 162 of file igmp_client.h.

leave()

void satcat5::igmp::Address::leave ( satcat5::igmp::Client *  igmp )

inline

Leave a multicast group.

This is a thin wrapper for igmp::Client::leave. The two have the same effect; use whichever method is more convenient.

Definition at line 168 of file igmp_client.h.

---

The documentation for this struct was generated from the following file:

• igmp_client.h