SignalNotifier SignalNotifier SignalNotifier SignalNotifier Class
Definition
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 Windows Store apps.
public : sealed class SignalNotifier : ISignalNotifierpublic sealed class SignalNotifier : ISignalNotifierPublic NotInheritable Class SignalNotifier Implements ISignalNotifier// This API is not available in Javascript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Methods
AttachToEvent(String, SignalHandler) AttachToEvent(String, SignalHandler) AttachToEvent(String, SignalHandler) AttachToEvent(String, SignalHandler)
Attaches a SignalHandler delegate to an event. The delegated method will run the next time the event occurs.
public : static SignalNotifier AttachToEvent(PlatForm::String name, SignalHandler handler)public static SignalNotifier AttachToEvent(String name, SignalHandler handler)Public Static Function AttachToEvent(name As String, handler As SignalHandler) As SignalNotifier// This API is not available in Javascript.
- name
- PlatForm::String String String String
Indicates the event that causes the method to run.
Indicates the method that will run in response to the event.
The resulting SignalNotifier object.
- See Also
AttachToEvent(String, SignalHandler, TimeSpan) AttachToEvent(String, SignalHandler, TimeSpan) AttachToEvent(String, SignalHandler, TimeSpan) 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.
public : static SignalNotifier AttachToEvent(PlatForm::String name, SignalHandler handler, TimeSpan timeout)public static SignalNotifier AttachToEvent(String name, SignalHandler handler, TimeSpan timeout)Public Static Function AttachToEvent(name As String, handler As SignalHandler, timeout As TimeSpan) As SignalNotifier// This API is not available in Javascript.
- name
- PlatForm::String String String String
Indicates the event that causes the method to run.
Indicates the method that will run in response to the event, or when the time span elapses, whichever comes first.
- timeout
- TimeSpan TimeSpan TimeSpan TimeSpan
Indicates the amount of time to continue waiting for the event before running the handler method.
The resulting SignalNotifier object.
- See Also
AttachToSemaphore(String, SignalHandler) AttachToSemaphore(String, SignalHandler) AttachToSemaphore(String, SignalHandler) AttachToSemaphore(String, SignalHandler)
Attaches a SignalHandler delegate to a named semaphore. The delegated method will run when the named semaphore is signaled.
public : static SignalNotifier AttachToSemaphore(PlatForm::String name, SignalHandler handler)public static SignalNotifier AttachToSemaphore(String name, SignalHandler handler)Public Static Function AttachToSemaphore(name As String, handler As SignalHandler) As SignalNotifier// This API is not available in Javascript.
- name
- PlatForm::String String String String
Names the semaphore that signals the method to run.
Indicates the delegate that will run in response to the named semaphore entering the signaled state.
The resulting SignalNotifier object.
- See Also
AttachToSemaphore(String, SignalHandler, TimeSpan) AttachToSemaphore(String, SignalHandler, TimeSpan) AttachToSemaphore(String, SignalHandler, TimeSpan) 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.
public : static SignalNotifier AttachToSemaphore(PlatForm::String name, SignalHandler handler, TimeSpan timeout)public static SignalNotifier AttachToSemaphore(String name, SignalHandler handler, TimeSpan timeout)Public Static Function AttachToSemaphore(name As String, handler As SignalHandler, timeout As TimeSpan) As SignalNotifier// This API is not available in Javascript.
- name
- PlatForm::String String String String
Names the semaphore that signals the method to run.
Indicates the delegate that will run in response to the named semaphore entering the signaled state.
- timeout
- TimeSpan TimeSpan TimeSpan TimeSpan
Indicates the amount of time to continue waiting for the named semaphore before running the delegate.
The resulting SignalNotifier object.
- See Also
Enable() Enable() Enable() Enable()
Submits the SignalNotifier to the thread pool.
public : void Enable()public void Enable()Public Function Enable() As void// This API is not available in Javascript.
Terminate() Terminate() Terminate() Terminate()
Terminates the SignalNotifier if it has not already started running.
public : void Terminate()public void Terminate()Public Function Terminate() As void// This API is not available in Javascript.