Class WorkflowStreamClientTopicHandle

Namespace

Temporalio.Extensions.WorkflowStreams

Assembly

Temporalio.Extensions.WorkflowStreams.dll

A client-side handle bound to one topic.

public sealed class WorkflowStreamClientTopicHandle

Inheritance

object

WorkflowStreamClientTopicHandle

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(object?, bool)

Converts and buffers a value for publication on this topic.

public void Publish(object? value, bool forceFlush = false)

Parameters

value object

The value or pre-built Temporal payload to publish.

forceFlush bool

Whether to wake the asynchronous flusher immediately.

SubscribeAsync(long)

Creates a reusable subscription to this topic.

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

Parameters

fromOffset long

The global offset at which to begin.

Returns

IAsyncEnumerable<WorkflowStreamItem>

A reusable asynchronous stream.