SignalNotifier Class

Definition

Namespace:

Windows.System.Threading.Core

Runs a method when an event or semaphore is signaled. A timeout value can also be specified, causing the delegate to run after the time span has elapsed if the named event does not occur (or if the semaphore does not reach a signaled state).

Note

The ThreadPool API is supported for desktop as well as UWP apps.

public ref class SignalNotifier sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class SignalNotifier final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class SignalNotifier

Public NotInheritable Class SignalNotifier

Inheritance

Object Platform::Object IInspectable SignalNotifier

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Methods

AttachToEvent(String, SignalHandler, TimeSpan)	Attaches a SignalHandler delegate to an event. The delegated method will run if the event occurs or the time span elapses, whichever comes first.
AttachToEvent(String, SignalHandler)	Attaches a SignalHandler delegate to an event. The delegated method will run the next time the event occurs.
AttachToSemaphore(String, SignalHandler, TimeSpan)	Attaches a SignalHandler delegate to a named semaphore and specifies a timeout value. The delegated method will run when the named semaphore is signaled, or if the time span elapses before the semaphore reaches a signaled state.
AttachToSemaphore(String, SignalHandler)	Attaches a SignalHandler delegate to a named semaphore. The delegated method will run when the named semaphore is signaled.
Enable()	Submits the SignalNotifier to the thread pool.
Terminate()	Terminates the SignalNotifier if it has not already started running.