Class TemporalConnection

Namespace

Temporalio.Client

Assembly

Temporalio.dll

Connection to Temporal.

public sealed class TemporalConnection : ITemporalConnection, IBridgeClientProvider

Inheritance

object

TemporalConnection

Implements

ITemporalConnection

IBridgeClientProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

BridgeClient

Gets the handle to the connected bridge.

public SafeHandle BridgeClient { get; }

Property Value

SafeHandle

OperatorService

Gets the raw operator service.

public OperatorService OperatorService { get; }

Property Value

OperatorService

Options

Gets the options used to create this connection.

public TemporalConnectionOptions Options { get; }

Property Value

TemporalConnectionOptions

RpcMetadata

Gets or sets the current RPC metadata (i.e. the headers). This can be updated which will apply to all future calls the client makes including inside a worker. Setting this value is thread safe.

public IReadOnlyCollection<KeyValuePair<string, string>> RpcMetadata { get; set; }

Property Value

IReadOnlyCollection<KeyValuePair<string, string>>

TestService

Gets the raw gRPC test service.

public TestService TestService { get; }

Property Value

TestService

Remarks

Only the StartTimeSkippingAsync(WorkflowEnvironmentStartTimeSkippingOptions?) environment has this service implemented.

WorkflowService

Gets the raw workflow service.

public WorkflowService WorkflowService { get; }

Property Value

WorkflowService

Methods

CheckHealthAsync(RpcService?, RpcOptions?)

Check health for the given service type.

public Task<bool> CheckHealthAsync(RpcService? service = null, RpcOptions? options = null)

Parameters

service RpcService

Service type to check health for. Defaults to WorkflowService.

options RpcOptions

RPC options for the check call.

Returns

Task<bool>

True if healthy, false otherwise.

ConnectAsync(TemporalConnectionOptions)

Connect to Temporal.

public static Task<TemporalConnection> ConnectAsync(TemporalConnectionOptions options)

Parameters

options TemporalConnectionOptions

Options for connecting.

Returns

Task<TemporalConnection>

The established connection.