Class SimplePlugin

Namespace

Temporalio.Common

Assembly

Temporalio.dll

A simple plugin that implements both client and worker plugin interfaces.

public class SimplePlugin : ITemporalClientPlugin, ITemporalWorkerPlugin

Inheritance

object

SimplePlugin

Implements

ITemporalClientPlugin

ITemporalWorkerPlugin

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

WARNING: This API is experimental and may change in the future.

Constructors

SimplePlugin(string, SimplePluginOptions?)

Initializes a new instance of the SimplePlugin class.

public SimplePlugin(string name, SimplePluginOptions? options = null)

Parameters

name string

The plugin name.

options SimplePluginOptions

The plugin options.

Properties

Name

Gets the plugin name.

public string Name { get; }

Property Value

string

Options

Gets the plugin options.

public SimplePluginOptions Options { get; }

Property Value

SimplePluginOptions

Methods

ConfigureClient(TemporalClientOptions)

Configures the client options.

public virtual void ConfigureClient(TemporalClientOptions options)

Parameters

options TemporalClientOptions

The client options to configure.

ConfigureReplayer(WorkflowReplayerOptions)

Configures the replayer options.

public virtual void ConfigureReplayer(WorkflowReplayerOptions options)

Parameters

options WorkflowReplayerOptions

The replayer options to configure.

ConfigureWorker(TemporalWorkerOptions)

Configures the worker options.

public virtual void ConfigureWorker(TemporalWorkerOptions options)

Parameters

options TemporalWorkerOptions

The worker options to configure.

ConnectAsync(TemporalClientConnectOptions, Func<TemporalClientConnectOptions, Task<TemporalConnection>>)

Handles temporal connection asynchronously.

public virtual Task<TemporalConnection> ConnectAsync(TemporalClientConnectOptions options, Func<TemporalClientConnectOptions, Task<TemporalConnection>> continuation)

Parameters

options TemporalClientConnectOptions

The connection options.

continuation Func<TemporalClientConnectOptions, Task<TemporalConnection>>

The continuation function.

Returns

Task<TemporalConnection>

A task representing the asynchronous operation.

ReplayWorkflowsAsync(WorkflowReplayer, Func<WorkflowReplayer, IAsyncEnumerable<WorkflowReplayResult>>, CancellationToken)

Runs the replayer asynchronously.

public virtual IAsyncEnumerable<WorkflowReplayResult> ReplayWorkflowsAsync(WorkflowReplayer replayer, Func<WorkflowReplayer, IAsyncEnumerable<WorkflowReplayResult>> continuation, CancellationToken cancellationToken)

Parameters

replayer WorkflowReplayer

The replayer to run.

continuation Func<WorkflowReplayer, IAsyncEnumerable<WorkflowReplayResult>>

The continuation function.

cancellationToken CancellationToken

Cancellation token to stop the replay.

Returns

IAsyncEnumerable<WorkflowReplayResult>

A task representing the asynchronous operation.

ReplayWorkflowsAsync(WorkflowReplayer, Func<WorkflowReplayer, CancellationToken, Task<IEnumerable<WorkflowReplayResult>>>, CancellationToken)

Runs the replayer asynchronously.

public virtual Task<IEnumerable<WorkflowReplayResult>> ReplayWorkflowsAsync(WorkflowReplayer replayer, Func<WorkflowReplayer, CancellationToken, Task<IEnumerable<WorkflowReplayResult>>> continuation, CancellationToken cancellationToken)

Parameters

replayer WorkflowReplayer

The replayer to run.

continuation Func<WorkflowReplayer, CancellationToken, Task<IEnumerable<WorkflowReplayResult>>>

The continuation function.

cancellationToken CancellationToken

Cancellation token to stop the replay.

Returns

Task<IEnumerable<WorkflowReplayResult>>

A task representing the asynchronous operation.

RunWorkerAsync<TResult>(TemporalWorker, Func<TemporalWorker, CancellationToken, Task<TResult>>, CancellationToken)

Runs the worker asynchronously.

public virtual Task<TResult> RunWorkerAsync<TResult>(TemporalWorker worker, Func<TemporalWorker, CancellationToken, Task<TResult>> continuation, CancellationToken stoppingToken)

Parameters

worker TemporalWorker

The worker to run.

continuation Func<TemporalWorker, CancellationToken, Task<TResult>>

The continuation function.

stoppingToken CancellationToken

Cancellation token to stop the worker.

Returns

Task<TResult>

A task representing the asynchronous operation.

Type Parameters

TResult

Result type. For most worker run calls, this is ValueTuple.