Layer4.Igmp.Schedule.Join Class Reference

Use this class to configure the source-specific properties of an IGMPv3 Multicast session. More...

Methods
	Description.Get
	Returns a textual description of the object.
	InitialTimeToWait.Get
	Returns the time when the action is scheduled. This time is set using InitialTimeToWait.Set At that time, the first frame will be sent. More...
	InitialTimeToWait.Set time
	Sets the time when the action will be scheduled. That is, when the first frame will be sent. More...
	Parent.Get
	Returns the parent object.
	Start
	Starts the scheduled action. More...
	Stop
	Stops the running scheduled action. More...

Class overview

Use this class to configure the source-specific properties of an IGMPv3 Multicast session.

Source-specific multicast (SSM) is a method of delivering multicast packets in which the only packets that are delivered to a receiver are those originating from a specific source address requested by the receiver. By so limiting the source, SSM reduces demands on the network and improves security.

SSM is possible in IPv4's IGMPv3 and IPv6's MLDv2, but this class can be used to configure IGMPv3 only.

You can set a filter to include or exclude a list of multicast sources.

This action is a schedule, so after configuring it, it needs to be started. See Start

Use Layer4.Igmpv1MemberSession::Schedule.Add $truetype{join} or Layer4.Igmpv2MemberSession::Schedule.Add $truetype{join} to get an object of this class.

Definition at line 8036 of file api.tcl.

Method documentation

Layer4.Igmp.Schedule.Join::InitialTimeToWait.Get

Returns the time when the action is scheduled. This time is set using InitialTimeToWait.Set At that time, the first frame will be sent.

Returns

The initial time to wait in nanoseconds.

Definition at line 8049 of file api.tcl.

Layer4.Igmp.Schedule.Join::InitialTimeToWait.Set			time

Sets the time when the action will be scheduled. That is, when the first frame will be sent.

Parameters

time	The time when the action will be scheduled. Valid range: 0 to <max_uint64>[ns] Where <max_uint64> 0xFFFFFFFFFFFFFFFF = 18446744073709551615 = maximum unsigned 64bit integer)

Sets the initial time to wait before the first frame will be sent. By default, the unit has a nanosecond resolution. But you can also provide a time unit.

The schedule can be started using Start

Exceptions

<tcl_error>

Failed to parse time string: When the value could not be interpreted as a valid time string

Example

Set the initial time to wait to 9 ns

$schedule InitialTimeToWait.Set 9

Set the initial time to wait to 1.25 milliseconds

$icmpSession Echo.Loop.Interval.Set 1250us

Set the initial time to wait to 9 ms

$schedule InitialTimeToWait.Set 9ms

Set the initial time to wait to 9 hours

$schedule InitialTimeToWait.Set 9h

Definition at line 8069 of file api.tcl.

Layer4.Igmp.Schedule.Join::Start

Starts the scheduled action.

The first packet will be sent after the initial time to wait.

Definition at line 8082 of file api.tcl.

Layer4.Igmp.Schedule.Join::Stop

Stops the running scheduled action.

If the action has not been started, nothing will happen.

Definition at line 8090 of file api.tcl.