FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
vl_api_igmp_group_t Struct Reference

Used by a 'host' to enable the reception/listening of packets for a specific multicast group. More...

Data Fields

vl_api_filter_mode_t filter
 
u8 n_srcs
 
u32 sw_if_index
 
vl_api_ip4_address_t gaddr
 
vl_api_ip4_address_t saddrs [n_srcs]
 

Detailed Description

Used by a 'host' to enable the reception/listening of packets for a specific multicast group.

For each socket on which IPMulticastListen has been invoked, the system records the desired multicast reception state for that socket. That state conceptually consists of a set of records of the form:

(interface, multicast-address, filter-mode, source-list)

The socket state evolves in response to each invocation of IPMulticastListen on the socket, as follows:

o If the requested filter mode is INCLUDE and the requested source list is empty, then the entry corresponding to the requested interface and multicast address is deleted if present. If no such entry is present, the request is ignored.

o If the requested filter mode is EXCLUDE or the requested source list is non-empty, then the entry corresponding to the requested interface and multicast address, if present, is changed to contain the requested filter mode and source list. If no such entry is present, a new entry is created, using the parameters specified in the request.

Template Parameters
client_index- opaque cookie to identify the sender
context- sender context, to match reply w/ request
sw_if_index- interface sw index
filter- filter mode
saddr- source address
gaddr- group address

Definition at line 64 of file igmp.api.

Field Documentation

◆ filter

vl_api_filter_mode_t vl_api_igmp_group_t::filter

Definition at line 66 of file igmp.api.

◆ gaddr

vl_api_ip4_address_t vl_api_igmp_group_t::gaddr

Definition at line 69 of file igmp.api.

◆ n_srcs

u8 vl_api_igmp_group_t::n_srcs

Definition at line 67 of file igmp.api.

◆ saddrs

vl_api_ip4_address_t vl_api_igmp_group_t::saddrs[n_srcs]

Definition at line 70 of file igmp.api.

◆ sw_if_index

u32 vl_api_igmp_group_t::sw_if_index

Definition at line 68 of file igmp.api.


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