IgmpMldJoinGroupsCommand Object


Description:

Instructs the host block to join a multicast group.

Can be used with Command Sequencer: Yes

GUI Command Name: IGMP/MLD: Join Groups

Parents: Project, Sequencer, StcSystem

IgmpMldJoinGroupsCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
BlockList

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

Type: handle

Default: 0

CalculateLatency

Controls calculation of join latencies.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable calculation of join latencies.

FALSE

Disable calculation of join latencies.

JoinFailedRetryCounter

Number of of times a join attempt failed.

Type: u8

Default: 0

JoinLeaveDelay

Time (in seconds) to wait before sending joins.

Type: u32

Default: 0

RxDataDuration

Time (in seconds) to wait before ca;ci;atomg latency calculation.

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 will wait for all reports to be transmitted before completing.

FALSE

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

IgmpMldJoinGroupsCommand Read-Only Attributes

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