Class TemporalConnection
- Namespace
- Temporalio.Client
- Assembly
- Temporalio.dll
Connection to Temporal.
public sealed class TemporalConnection : ITemporalConnection, IBridgeClientProvider
- Inheritance
-
TemporalConnection
- Implements
- Inherited Members
Properties
BridgeClient
Gets the handle to the connected bridge.
public SafeHandle BridgeClient { get; }
Property Value
OperatorService
Gets the raw operator service.
public OperatorService OperatorService { get; }
Property Value
Options
Gets the options used to create this connection.
public TemporalConnectionOptions Options { get; }
Property Value
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
TestService
Gets the raw gRPC test service.
public TestService TestService { get; }
Property Value
Remarks
Only the StartTimeSkippingAsync(WorkflowEnvironmentStartTimeSkippingOptions?) environment has this service implemented.
WorkflowService
Gets the raw workflow service.
public WorkflowService WorkflowService { get; }
Property Value
Methods
CheckHealthAsync(RpcService?, RpcOptions?)
Check health for the given service type.
public Task<bool> CheckHealthAsync(RpcService? service = null, RpcOptions? options = null)
Parameters
service
RpcServiceService type to check health for. Defaults to WorkflowService.
options
RpcOptionsRPC options for the check call.
Returns
ConnectAsync(TemporalConnectionOptions)
Connect to Temporal.
public static Task<TemporalConnection> ConnectAsync(TemporalConnectionOptions options)
Parameters
options
TemporalConnectionOptionsOptions for connecting.
Returns
- Task<TemporalConnection>
The established connection.