IgmpMldLeaveGroupsCommand Object


Description:

Instructs the host block to leave a multicast group.

Can be used with Command Sequencer: Yes

GUI Command Name: IGMP/MLD: Leave Groups

Parents: Project, Sequencer, StcSystem

IgmpMldLeaveGroupsCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
BlockList

List of multicast host block handles to apply the leave group command.

Type: handle

Default: 0

CalculateLatency

Controls calculation of leave latencies.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable calculation of leave latencies.

FALSE

Disable calculation of leave latencies.

JoinLeaveDelay

Time (in seconds) to wait before sending leaves.

Type: u32

Default: 0

RxDataDuration

See IgmpMldJoinGroupsCommand.

Type: u32

Default: 10

WaitForTxReports

Controls whether command should wait for all reports to be transmitted. Available only in the Command Sequencer..

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Command waits for all reports to be transmitted before completing.

FALSE

Command does not wait for all reports to be transmitted before completing.

IgmpMldLeaveGroupsCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status