Class TimerManagerBase

Inheritance

↳ object

    ↳ TimerManagerBase

        ↳ MultiServerTimeManager

        ↳ SingleServerTimerManager

Inherited Members

Equals(object)

Equals(object, object)

GetHashCode()

GetType()

MemberwiseClone()

ReferenceEquals(object, object)

ToString()

Namespace: OptimaJet.Workflow.Core.Runtime.Timers

Assembly: OptimaJet.Workflow.Core.dll

Syntax

public abstract class TimerManagerBase

Constructors

TimerManagerBase()

Timer manager constructor

Declaration

public TimerManagerBase()

Properties

ImmediateTimerValue

Value of Unspecified Timer which indicates that the timer transition will be executed immediately

Declaration

public string ImmediateTimerValue { get; }

Property value

Type	Description
string

InfinityTimerValue

Value of Unspecified Timer which indicates that the timer transition will be never executed

Declaration

public string InfinityTimerValue { get; }

Property value

Type	Description
string

DefaultWaitTimeout

Wait timeout for start/stop operations in milliseconds. Default value is 1000.

Declaration

public int DefaultWaitTimeout { get; set; }

Property value

Type	Description
int

Stopped

Declaration

protected abstract bool Stopped { get; }

Property value

Type	Description
bool

Methods

RequestTimerValueAsync(ProcessInstance, ActivityDefinition)

Sends request for timer value for all timer transitions that are outgoing from the CurrentActivity if timer value is equal 0 or -1

Declaration

public Task RequestTimerValueAsync(ProcessInstance processInstance, ActivityDefinition activity = null)

Parameters

Type	Name	Description
ProcessInstance	processInstance	Process instance
ActivityDefinition	activity

Returns

Type	Description
Task

GetTransitionsForImmediateExecution(ProcessInstance, ActivityDefinition)

Returns transitions triggered by a timer which value is equal to 0

Declaration

public IEnumerable<TransitionDefinition> GetTransitionsForImmediateExecution(ProcessInstance processInstance, ActivityDefinition activity = null)

Parameters

Type	Name	Description
ProcessInstance	processInstance	Process instance
ActivityDefinition	activity

Returns

Type	Description
IEnumerable<TransitionDefinition>

SetTimerValue(ProcessInstance, string, DateTime)

Sets new value of named timer

Declaration

public void SetTimerValue(ProcessInstance processInstance, string timerName, DateTime newValue)

Parameters

Type	Name	Description
ProcessInstance	processInstance	Process instance
string	timerName	Timer name in Scheme
DateTime	newValue	New value of the timer

SetTimerValue(Guid, string, DateTime)

Sets new value of named timer

Declaration

public Task SetTimerValue(Guid processId, string timerName, DateTime newValue)

Parameters

Type	Name	Description
Guid	processId	Process id
string	timerName	Timer name in Scheme
DateTime	newValue	New value of the timer

Returns

Type	Description
Task

StopTimerInternal()

Declaration

protected abstract void StopTimerInternal()

StartTimerInternalAsync()

Declaration

protected abstract Task StartTimerInternalAsync()

Returns

Type	Description
Task

ResetTimerValue(ProcessInstance, string)

Resets value of named timer

Declaration

public void ResetTimerValue(ProcessInstance processInstance, string timerName)

Parameters

Type	Name	Description
ProcessInstance	processInstance	Process instance
string	timerName	Timer name in Scheme

ResetTimerValue(Guid, string)

Resets value of named timer

Declaration

public Task ResetTimerValue(Guid processId, string timerName)

Parameters

Type	Name	Description
Guid	processId	Process id
string	timerName	Timer name in Scheme

Returns

Type	Description
Task

RegisterTimersAsync(ProcessInstance)

Register all timers for all outgoing timer transitions for current activity of the specified process. All timers registered before which are present in transitions will be rewritten except timers marked as NotOverrideIfExists TimerDefinition

Declaration

public Task RegisterTimersAsync(ProcessInstance processInstance)

Parameters

Type	Name	Description
ProcessInstance	processInstance	Process instance whose timers need to be registered

Returns

Type	Description
Task

ClearAndRegisterTimersAsync(ProcessInstance)

Clear timers TimerManagerBase.ClearTimersAsync(ProcessInstance) and then register new timers TimerManagerBase.RegisterTimersAsync(ProcessInstance)

Declaration

public Task ClearAndRegisterTimersAsync(ProcessInstance processInstance)

Parameters

Type	Name	Description
ProcessInstance	processInstance	Process instance whose timers need to be cleared an registered

Returns

Type	Description
Task

ClearTimersAsync(ProcessInstance)

Clear all registered timers except present in outgoing timer transitions for current activity of the specified process and marked as NotOverrideIfExists TimerDefinition

Declaration

public Task ClearTimersAsync(ProcessInstance processInstance)

Parameters

Type	Name	Description
ProcessInstance	processInstance	Process instance whose timers need to be cleared

Returns

Type	Description
Task

Refresh()

Refresh interval of the timer

Declaration

public abstract void Refresh()

GetTimersToRegister(ProcessDefinition, string)

Declaration

public List<TimerToRegister> GetTimersToRegister(ProcessDefinition processDefinition, string activityName)

Parameters

Type	Name	Description
ProcessDefinition	processDefinition
string	activityName

Returns

Type	Description
List<TimerToRegister>

GetTimersToRegister(ProcessInstance, string)

Declaration

public List<TimerToRegister> GetTimersToRegister(ProcessInstance processInstance, string activityName)

Parameters

Type	Name	Description
ProcessInstance	processInstance
string	activityName

Returns

Type	Description
List<TimerToRegister>

Fields

_startStopSemaphore

Declaration

protected readonly SemaphoreSlim _startStopSemaphore

Returns

Type	Description
SemaphoreSlim

_runtime

Declaration

protected WorkflowRuntime _runtime

Returns

Type	Description
WorkflowRuntime

Events

OnNeedTimerValue

Raises when the timer value must be obtained

Declaration

public event EventHandler<NeedTimerValueEventArgs> OnNeedTimerValue

Returns

Type	Description
EventHandler<NeedTimerValueEventArgs>

OnNeedTimerValueAsync

Raises when the timer value must be obtained

Declaration

public event AsyncEventHandler<NeedTimerValueEventArgs> OnNeedTimerValueAsync

Returns

Type	Description
AsyncEventHandler<NeedTimerValueEventArgs>

Extension Methods

• Extensions.CastAs<T>(object)
• Extensions.ExtendedEquals(object, object)
• Extensions.TryCast<T>(object, out T)