DispatchSource.Data Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Base class for dispatch sources that allow applications to trigger an event handler on the target queue.
public class DispatchSource.Data : CoreFoundation.DispatchSourcetype DispatchSource.Data = class
inherit DispatchSource- Inheritance
- Derived
Remarks
Applications can post data onto a DispatchSource.Data by calling the MergeData(IntPtr) method. The data is surfaced is then available in to the handler in the PendingData property.
If multiple calls to MergeData are done, the result surfaced by PendingData will depend on whether you created a DispatchSource.DataAdd which will add the values together or a DispatchSource.DataOr which will or the values together.
Properties
| Name | Description |
|---|---|
| Handle | (Inherited from DisposableObject) |
| IsCanceled |
Determine whether the specified source has been canceled. (Inherited from DispatchSource) |
| Owns | (Inherited from DisposableObject) |
| PendingData |
Retrieves the data that has been posted for this event source. |
Methods
| Name | Description |
|---|---|
| Activate() | (Inherited from DispatchObject) |
| Cancel() |
Asynchronously cancels the dispatch source. (Inherited from DispatchSource) |
| ClearHandle() | (Inherited from DisposableObject) |
| Dispose() | (Inherited from DisposableObject) |
| Dispose(Boolean) |
Releases the resources used by the DispatchSource object. (Inherited from DispatchSource) |
| Equals(Object) | (Inherited from DisposableObject) |
| GetCheckedHandle() | (Inherited from DisposableObject) |
| GetHashCode() | (Inherited from DisposableObject) |
| InitializeHandle(NativeHandle) | (Inherited from DisposableObject) |
| MergeData(IntPtr) |
Posts the specific value and triggers the event handler on the target queue. |
| Release() | (Inherited from DispatchObject) |
| Resume() |
Resumes the dispatch source. (Inherited from DispatchSource) |
| Retain() | (Inherited from DispatchObject) |
| SetCancelHandler(Action) |
Provides a cancellation handler (Inherited from DispatchSource) |
| SetEventHandler(Action) |
Specified a handler to execute when events are received on the dispatch source. (Inherited from DispatchSource) |
| SetRegistrationHandler(Action) |
Provides a registration handler (Inherited from DispatchSource) |
| SetTargetQueue(DispatchQueue) | (Inherited from DispatchObject) |
| Suspend() |
Suspends the dispatch source. (Inherited from DispatchSource) |
Extension Methods
| Name | Description |
|---|---|
| GetHandle(INativeObject) | |
| GetNonNullHandle(INativeObject, String) | |