Subsystem.SetTriggers Method (Subsystem.TriggerKinds())

This method sets the specified triggers to happen when certain kinds of events are generated. Each element of array triggers specifies the triggers to set for the kind of event specified by the enumerator in enumeration Monitor.MF_EVENT_KIND that corresponds to the index in the array. Array triggers must contain exacly MF_EVENT_KIND.MF_EVENT_KIND_MAX elements, otherwise an exception of type wRTOSException is thrown. The triggers to be set correspond to the bits that are set in each element of this array. If the Subsystem is not started, this throws method an exception of type wRTOSException containing an explanatory error message. This method can be called when monitoring is stopped or started. It takes effect immediately. If any of the specified triggers are already set, they remain set. These flag enumerators can be mixed with each other using bitwise operators.

Session triggers set programmatically from monitor event MF_EVENT_KIND_CUSTOM are ignored.

The following kinds of monitoring events cannot have triggers set on them. Attempting to do so will cause an exception of type wRTOSException to be thrown:

MF_EVENT_KIND_RESERVED (Reserved)
MF_EVENT_KIND_MARKER (Marker)
MF_EVENT_KIND_SUBSYSTEM_STOP (Subsystem Stop)
MF_EVENT_KIND_FAST_SEMAPHORE_ACQUIRE (Fast Semaphore Acquire)
MF_EVENT_KIND_FAST_SEMAPHORE_RELEASE (Fast Semaphore Release)
MF_EVENT_KIND_FAST_SEMAPHORE_RELEASE_ALL (Fast Semaphore Release All)
MF_EVENT_KIND_WFSOEX_WAIT (RtWaitForSingleObjectEx Wait)
MF_EVENT_KIND_WFMOEX_WAIT (WaitForMultipleObjectEx Wait)
MF_EVENT_KIND_THREAD_SLEEP (Thread Sleep)

Triggers do not persist after the wRTOS Subsystem stops. If persistence is desired, it is the client's responsibility to save trigger state before the Subsystem stops and to restore it when the Subsystem starts. This method is thread-safe and executes atomically across all processes with respect to all other trigger-related methods.

IMPORTANT: This method only accumulates new triggers. It never resets a trigger. Thus, if a given kind of event has trigger X set, and this method is called to set only trigger Y for that kind of event, then that kind of event ends up with both trigger X and Y set.

Namespace: IntervalZero.MaxRT.wRTOS.Monitor
Assembly: IntervalZero.MaxRT.wRTOS (in IntervalZero.MaxRT.wRTOS.dll) Version: 1.0.0.0 (File version: 1.0.0)

Syntax

Copy

public void SetTriggers(
    Subsystem.TriggerKinds[] triggers
)

Parameters

triggers

Type: IntervalZero.MaxRT.wRTOS.Monitor.Subsystem.TriggerKinds

Implements

IMonitorSubsystem.SetTriggers (Subsystem.TriggerKinds)

Exceptions

Exception	Condition
wRTOSException	Thrown if this method is used without the wRTOS Runtime installed.