TaskSynchronizedOperation Class

Represents a task-based synchronized operation that cannot run while it is already in progress.

Inheritance Hierarchy

SystemObject
GSF.ThreadingTaskSynchronizedOperation

Namespace: GSF.Threading
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

public class TaskSynchronizedOperation : ISynchronizedOperation

Public Class TaskSynchronizedOperation
	Implements ISynchronizedOperation

public ref class TaskSynchronizedOperation : ISynchronizedOperation

type TaskSynchronizedOperation = 
    class
        interface ISynchronizedOperation
    end

GSF.Threading.TaskSynchronizedOperation = function();

Type.createClass(
	'GSF.Threading.TaskSynchronizedOperation',
	null,
	GSF.Threading.ISynchronizedOperation);

View Source

The TaskSynchronizedOperation type exposes the following members.

Constructors

	Name	Description
	TaskSynchronizedOperation(FuncTask)	Creates a new instance of the TaskSynchronizedOperation class.
	TaskSynchronizedOperation(FuncTask, ActionException)	Creates a new instance of the TaskSynchronizedOperation class.

Top

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.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	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)
	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)
	TryRunOnceAsync	Attempts to execute the action on another thread. Does nothing if the operation is already running.

Top

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)

Top

Remarks

The action performed by the TaskSynchronizedOperation is executed using Run(FuncTask). Pending actions run when the task returned by the asynchronous action is completed. This synchronized operation only supports the async versions of the ISynchronizedOperation interface because the async action cannot be executed synchronously.

Reference

GSF.Threading Namespace