WaitTrigger

ISignal ILatch.WaitTrigger(double timeout)

Waits until the latch is triggered, or the timeout interval is exceeded.

Parameters

timeout – Interval in seconds to wait for trigger. Negative value means infinite.

Returns

ISignal – Data source signal.

Throws

• InvalidArgumentException – Invalid timeout specified (NaN).

• InvalidOperationException – Latch state not “Waiting” or “Triggered”.

• OutOfResourcesException – No resources available to wait for trigger.

• TimeoutException – Timeout interval exceeded while waiting for trigger.

• CommunicationErrorException – Protocol error.

• ConnectionLostException – Connection to controller lost.

• RebootedException – Controller has been rebooted since this object reference was retrieved, invalidating this reference.

• System.ObjectDisposedException – Object is disposed.

Remarks

Returns at entry of LatchState.Triggered. Additionally, if configured with LatchTriggerMode.OneShot, this function also returns if the latch is already triggered. Execution requires one subscription resource.