SingleOccurrenceAction Class

A helper class that will properly coordinate any number of Actions from different threads.

Inheritance Hierarchy

SystemObject
GSF.ThreadingSingleOccurrenceAction

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

Syntax

C++

JavaScript

Copy

public class SingleOccurrenceAction

Public Class SingleOccurrenceAction

public ref class SingleOccurrenceAction

type SingleOccurrenceAction = class end

GSF.Threading.SingleOccurrenceAction = function();

Type.createClass(
	'GSF.Threading.SingleOccurrenceAction');

View Source

The SingleOccurrenceAction type exposes the following members.

Constructors

	Name	Description
	SingleOccurrenceAction	Initializes a new instance of the SingleOccurrenceAction class

Top

Properties

	Name	Description
	IsCallbackExecuting	Gets if the callback is executing
	IsCallbackPendingOnBlocks	Gets if the signal action is currently pending. This means all future calls to TryBlockAction will fail.
	IsSignalingCompleted	Gets if all actions associated with the signaling of this class is complete.

Top

Methods

	Name	Description
	BlockAction(Action, Action)	Attempts to block this class from being signaled.
	BlockActionT(FuncT, FuncT)	Attempts to block this class from being signaled.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	ExecuteAndWait	Signals this class and waits for all blockers to exit before calling the .. If called concurrently, the calling thread blocks until the completes. If called from within the , the function returns immediately. The same thread calling this method will always call the . Only one callback will be executed by this class and it will be the first one to call either ExecuteWithoutWait(Action) or ExecuteAndWait(Action).
	ExecuteWithoutWait	Registers this callback to occur once all blocking call complete. This function will return immediately and the callback may or may not be run. Only one callback will be executed by this class and it will be the first one to call either ExecuteWithoutWait(Action) or ExecuteAndWait(Action).
	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)
	ToString	Returns a string that represents the current object. (Inherited from Object)
	TryBlockAction(Action)	Attempts to block this class from being signaled.
	TryBlockAction(Boolean)	Attempts to block this class from being signaled. Be sure to call within a using block.

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

This class is commonly used to properly coordinate the disposal of object. Remarks: Adapted from GSF.Threading.ReaderWriterSpinLock

Reference

GSF.Threading Namespace