ChangeSignaling Method

Definition

Namespace

Cuemon.Runtime

Assemblies

Cuemon.Core.dll

Source

src/Cuemon.Core/Runtime/Watcher.cs

ChangeSignaling(TimeSpan)

Changes the signaling timer of the Watcher.

public void ChangeSignaling(TimeSpan dueTime)

Parameters

dueTime TimeSpan

A TimeSpan representing the amount of time to delay before the Watcher starts signaling. Specify negative one (-1) milliseconds to prevent the signaling from starting. Specify zero (0) to start the signaling immediately.

ChangeSignaling(TimeSpan, TimeSpan)

Changes the signaling timer of the Watcher.

public virtual void ChangeSignaling(TimeSpan dueTime, TimeSpan period)

Parameters

dueTime TimeSpan

A TimeSpan representing the amount of time to delay before the Watcher starts signaling. Specify negative one (-1) milliseconds to prevent the signaling from starting. Specify zero (0) to start the signaling immediately.

period TimeSpan

The time interval between periodic signaling. Specify negative one (-1) milliseconds to disable periodic signaling.

Remarks

If dueTime is zero (0), the signaling is started immediately. If dueTime is negative one (-1) milliseconds, the signaling is never started; and the underlying timer is disabled, but can be re-enabled by specifying a positive value for dueTime. If period is zero (0) or negative one (-1) milliseconds, and dueTime is positive, the signaling is done once; the periodic behavior of the underlying timer is disabled, but can be re-enabled by specifying a value greater than zero for period.