Class TaskOrchestrationDispatcher

Namespace

DurableTask.Core

Assembly

DurableTask.Core.dll

Dispatcher for orchestrations to handle processing and renewing, completion of orchestration events

public class TaskOrchestrationDispatcher

Inheritance

object

TaskOrchestrationDispatcher

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

IncludeDetails

Gets or sets flag whether to include additional details in error messages

public bool IncludeDetails { get; set; }

Property Value

bool

IncludeParameters

Gets or sets flag whether to pass orchestration input parameters to sub orchestrations

public bool IncludeParameters { get; set; }

Property Value

bool

Methods

OnFetchWorkItemAsync(TimeSpan, CancellationToken)

Method to get the next work item to process within supplied timeout

protected Task<TaskOrchestrationWorkItem> OnFetchWorkItemAsync(TimeSpan receiveTimeout, CancellationToken cancellationToken)

Parameters

receiveTimeout TimeSpan

The max timeout to wait

cancellationToken CancellationToken

A cancellation token used to cancel a fetch operation.

Returns

Task<TaskOrchestrationWorkItem>

A new TaskOrchestrationWorkItem

OnProcessWorkItemAsync(TaskOrchestrationWorkItem)

Method to process a new work item

protected Task<bool> OnProcessWorkItemAsync(TaskOrchestrationWorkItem workItem)

Parameters

workItem TaskOrchestrationWorkItem

The work item to process

Returns

Task<bool>

StartAsync()

Starts the dispatcher to start getting and processing orchestration events

public Task StartAsync()

Returns

Task

StopAsync(bool)

Stops the dispatcher to stop getting and processing orchestration events

public Task StopAsync(bool forced)

Parameters

forced bool

Flag indicating whether to stop gracefully or immediately

Returns

Task