|
Long
|
Represents a long-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.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867
Syntaxpublic class LongSynchronizedOperation : SynchronizedOperationBase
The LongSynchronizedOperation type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | LongSynchronizedOperation(Action) | Creates a new instance of the LongSynchronizedOperation class. |
| LongSynchronizedOperation(Action, ActionException) | Creates a new instance of the LongSynchronizedOperation class. |
Properties| Name | Description | |
|---|---|---|
 | IsBackground | Gets or sets whether or not the thread executing the action is a background thread. |
| 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 on a separate thread.
(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 LongSynchronizedOperation is executed on
its own dedicated thread when running the operation asynchronously. When running on
its own thread, the action is executed in a tight loop until all pending operations
have been completed. This type of synchronized operation should be preferred if
operations may take a long time, block the thread, or put it to sleep. It is also
recommended to prefer this type of operation if the speed of the operation is not
critical or if completion of the operation is critical, such as when saving data
to a file.
See Also