IgmpGroupMembership Object

HOME | TECHNOLOGIES | TEST CONFIGURATION | SEQUENCER COMMANDS | GUI COMMAND NAMES | ALL COMMANDS | RESULT | PDU | ALL | OBJECT TREE

Description:

Creates blocks of IGMP host group memberships.

Parents: IgmpHostConfig, MldHostConfig

Automatically-created children: Ipv4NetworkBlock

Result children (automatically created): IgmpGroupMembershipResults

Relations:

Side name
(Type)		 Relative Description
ResultChild
(ResultChild)

IgmpGroupMembershipResults

Use this to connect a results object to an object.
MulticastGroup
(SubscribedGroups)

Ipv4Group, Ipv6Group

Relationship between the IGMP group membership object and an IPv4 multicast group object.
MulticastSource
(SubscribedSources)

EmulatedDevice

Relationship between the IGMP group membership object and a host object emulating a multicast source.

IgmpGroupMembership Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
CalculateLatency

Specifies whether or not to interactively calculate join/leave latency for the group associated to this membership.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enables join/leave latency to be calculated interactively. Refer to CalculateLatencyDelay property on the PortConfig to configure the delay to calculate latency.
FALSE

Disables join/leave latency from being calculated interactively.
DeviceGroupMapping

Specifies the mapping between the device and subscribed multicast group within their respective blocks.

Type: enum

Default: MANY_TO_MANY

Possible Values:

Value Description
MANY_TO_MANY

Creates a full mesh of devices and groups.
ONE_TO_ONE

Assigns one device to each group. The mapping stops when it reaches the end of either devices or groups. The extra devices or groups are not mapped.
ROUND_ROBIN

Creates a round robin of devices and groups.
FilterMode

Specifies the filter mode for the associated multicast groups and sources.

Type: enum

Default: EXCLUDE

Possible Values:

Value Description
INCLUDE

Select INCLUDE to enable the host to receive multicast data only from the sources specified in the Source Filters field.
EXCLUDE

Select EXCLUDE to reject multicast data from the sources specified in the Source Filters field.
IsSourceList

Specifies whether sources are defined as a list or range of addresses.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enables the use of a discrete list of user-defined sources.
FALSE

Enables the use of a range of user-defined sources.
UserDefinedSources

Controls the use of user-defined multicast sources.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enables the use of user-defined multicast sources.
FALSE

Disables the use of user-defined multicast sources.

IgmpGroupMembership Read-Only Attributes

There are no read-only attributes.