|
Synchronized
|
Base class for operations that cannot run while they is already in progress.
Inheritance Hierarchy
Namespace: GSF.Threading
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta
Syntaxpublic abstract class SynchronizedOperationBase : ISynchronizedOperation
The SynchronizedOperationBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SynchronizedOperationBase(Action) | Creates a new instance of the SynchronizedOperationBase class. |
| SynchronizedOperationBase(Action, ActionException) | Creates a new instance of the SynchronizedOperationBase class. |
Properties| Name | Description | |
|---|---|---|
 | IsPending | Gets a value to indiate whether the synchronized operation has an additional operation that is pending execution after the currently running action has completed. |
| IsRunning | Gets a value to indicate whether the synchronized operation is currently executing its action. |
Methods| Name | Description | |
|---|---|---|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExecuteAction | Executes the action once on the current thread. |
| ExecuteActionAsync | Executes the action on a separate thread. |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Run | Executes the action on this thread or marks the operation as pending if the operation is already running. |
| RunOnce | Executes the action on this thread or marks the operation as pending if the operation is already running. |
| RunOnceAsync | Executes the action on another thread or marks the operation as pending if the operation is already running. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryRun | Attempts to execute the action on this thread. Does nothing if the operation is already running. |
| TryRunOnce | Attempts to execute the action on this thread. Does nothing if the operation is already running. |
| TryRunOnceAsync | Attempts to execute the action on another thread. Does nothing if the operation is already running. |
Extension Methods| Name | Description | |
|---|---|---|
 | GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| GetEnumValueOrDefaultT |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
Remarks
This class handles the synchronization between the methods defined in the
ISynchronizedOperation interface. Implementers should only need
to implement the ExecuteActionAsync method to provide a mechanism
for executing the action on a separate thread.
See AlsoReference
Inheritance Hierarchy