Layer4.Mld.Schedule.StopListening Class Reference

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

Definition at line 8842 of file api.tcl.

Method documentation

Layer4.Mld.Schedule.StopListening::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 8855 of file api.tcl.

Layer4.Mld.Schedule.StopListening::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 8875 of file api.tcl.

Layer4.Mld.Schedule.StopListening::Start

Starts the scheduled action.

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

Definition at line 8888 of file api.tcl.

Layer4.Mld.Schedule.StopListening::Stop

Stops the running scheduled action.

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

Definition at line 8896 of file api.tcl.