Class WorkflowStreamClientTopicHandle<T>

Namespace

Temporalio.Extensions.WorkflowStreams

Assembly

Temporalio.Extensions.WorkflowStreams.dll

A strongly typed client-side handle bound to one topic.

public sealed class WorkflowStreamClientTopicHandle<T>

Type Parameters

T

Type of values published to and received from the topic.

Inheritance

object

WorkflowStreamClientTopicHandle<T>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

WARNING: Workflow Streams is experimental and may change.

Properties

Name

Gets the topic name.

public string Name { get; }

Property Value

string

Methods

Publish(Payload, bool)

Buffers a pre-built Temporal payload for publication on this topic.

public void Publish(Payload payload, bool forceFlush = false)

Parameters

payload Payload

The payload to publish.

forceFlush bool

Whether to wake the asynchronous flusher immediately.

Publish(T, bool)

Converts and buffers a value for publication on this topic.

public void Publish(T value, bool forceFlush = false)

Parameters

value T

The value to publish.

forceFlush bool

Whether to wake the asynchronous flusher immediately.

SubscribeAsync(long)

Creates a reusable subscription to this topic.

public IAsyncEnumerable<WorkflowStreamItem<T>> SubscribeAsync(long fromOffset = 0)

Parameters

fromOffset long

The global offset at which to begin.

Returns

IAsyncEnumerable<WorkflowStreamItem<T>>

A reusable asynchronous stream.