|
Short
|
Represents a short-running synchronized operation
that cannot run while it is already in progress.
Inheritance Hierarchy
Namespace: GSF.Threading
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.218-beta+101eee949414e414795e55a6e73d88938f0177b8
Syntaxpublic class ShortSynchronizedOperation : SynchronizedOperationBase
The ShortSynchronizedOperation type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ShortSynchronizedOperation(Action) | Creates a new instance of the ShortSynchronizedOperation class. |
| ShortSynchronizedOperation(Action, ActionException) | Creates a new instance of the ShortSynchronizedOperation 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.
(Inherited from SynchronizedOperationBase) |
| IsRunning |
Gets a value to indicate whether the synchronized
operation is currently executing its action.
(Inherited from SynchronizedOperationBase) |
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.
(Inherited from SynchronizedOperationBase) |
| ExecuteActionAsync |
Executes the action in an asynchronous loop on
the thread pool, as long as the operation is pending.
(Overrides SynchronizedOperationBaseExecuteActionAsync) |
| 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.
(Inherited from SynchronizedOperationBase) |
| RunOnce |
Executes the action on this thread or marks the
operation as pending if the operation is already running.
(Inherited from SynchronizedOperationBase) |
| RunOnceAsync |
Executes the action on another thread or marks the
operation as pending if the operation is already running.
(Inherited from SynchronizedOperationBase) |
| 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.
(Inherited from SynchronizedOperationBase) |
| TryRunOnce |
Attempts to execute the action on this thread.
Does nothing if the operation is already running.
(Inherited from SynchronizedOperationBase) |
| TryRunOnceAsync |
Attempts to execute the action on another thread.
Does nothing if the operation is already running.
(Inherited from SynchronizedOperationBase) |
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
The action performed by the ShortSynchronizedOperation is executed on
the ThreadPool when running the operation asynchronously. When the
operation is set to pending, the action is executed in an asynchronous loop on the
thread pool until all pending operations have been completed. Since the action is
executed on the thread pool, it is best if it can be executed quickly, without
blocking the thread or putting it to sleep. If completion of the operation is
critical, such as when saving data to a file, this type of operation should not
be used since thread pool threads are background threads and will not prevent the
program from ending before the operation is complete.
See Also