IgmpGroupMembershipResults Object


Description:

IGMP host-group results.

Parents: IgmpGroupMembership

Relations:

Side name
(Type)
Relative Description
ResultParent
(ResultChild)

IgmpGroupMembership

Use this to connect a results object to an object.

IgmpGroupMembershipResults Writable Attributes

There are no writable attributes.

IgmpGroupMembershipResults Read-Only Attributes

Read-Only Attribute Description
DuplicateJoin

Indicates whether or not the DUT was already forwarding multicast prior to a join being sent.

NOTE: To enable this LED, For interactive tests, under Test Configuration, select All Devices or a device, click the IGMP tab, and select Calculate Latency. For Command Sequencer tests, select the Calculate Join Latency checkbox in the IGMP: Join Groups command.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

DUT was forwarding multicast traffic for this group prior to the join being sent.

FALSE

No duplicate join report detected.

GroupAddr

Group IP multicast address.

Type: ip

Default: 0.0.0.0

GroupHandle

IL group handle.

Type: u32

Default: 0

HostAddr

Host IP address.

Type: ip

Default: 0.0.0.0

JoinFail

Indicates whether or not multicast traffic was received.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Multicast traffic was not received.

FALSE

Multicast traffic was received.

JoinLatency

Time between sending an IGMP join message, and receiving multicast data from the group specified in the join message.

Type: double

Default: 0

JoinTimestamp

Transmit timestamp of the initial IGMP join message.

Type: string

Default: 0

LeaveLatency

Time between sending an IGMP leave message to a multicast group, and when the multicast data stopped traffic.

Type: double

Default: 0

LeaveTimestamp

Transmit timestamp of the IGMP leave message.

Type: string

Default: 0

ResultIf

Object handle returned from the call to create the IGMP group membership object.

Type: u32

Default: 0

State

Current state of the IGMP group.

Type: enum

Default: UNDEFINED

Possible Values:

Value Description
UNDEFINED

Host is in an undefined state.

NON_MEMBER

Host does not belong to the group on the interface. This state applies only to IGMPv1 and IGMPv2 and is the initial state for all memberships on all network interfaces.

DELAYING_MEMBER

Host belongs to the group on the interface and has a report delay timer running for that membership. This state applies to IGMPv1 and IGMPv2only.

IDLE_MEMBER

Host belongs to the group on the interface and does not have a report delay timer running for that membership. This state applies to IGMPv1 and IGMPv2 only.

RETRYING_MEMBER

This state applies to IGMPv1/IGMPv2 hosts when ForceRobustJoin is True. The host is retransmitting its initial join before transitioning from the NON_MEMBER state to the DELAYING_MEMBER or IDLE_MEMBER state.

INCLUDE

Data from the specified sources are filtered and forwarded to the host by the multicast router. This state applies to IGMPv3 only.

EXCLUDE

Data from the specified sources are filtered and not forwarded to the host by the multicast router. This state applies to IGMPv3 only.

StateChangeTimestamp

Timestamp of the IGMP group membership state change.

Type: string

Default: 0