Class SubscribeTopicParams

Inheritance

Object

SubscribeTopicParams

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Hashgraph

Assembly: Hashgraph.dll

Syntax

public class SubscribeTopicParams

Properties

CancellationToken

Optional cancelation token, that when set, closes the mirror node connection and optionally the .net channel (if configured to do so), and causes the SubscribeTopic method to return without error. Default is "none", the method can be completed by signaling the receiving .net channel as completed.

Declaration

public CancellationToken CancellationToken { get; set; }

Property Value

Type	Description
CancellationToken

CompleteChannelWhenFinished

Indicate that the .net channel should be "completed" when the streaming connection to the mirror node completes, both for planned and faulted reasons. Default is true. Set to false to re-use the channel or for scenarios where it may be combined and multiplexed with other channel combinations.

Declaration

public bool CompleteChannelWhenFinished { get; set; }

Property Value

Type	Description
Boolean

Ending

Optional, filter for messages which reached consensus before this time. If not set, it will stream indefinitely.

Declaration

public DateTime? Ending { get; set; }

Property Value

Type	Description
Nullable<DateTime>

MaxCount

Optional, the maximum number of topic messages to return before completing the call, if set to 0 it will stream messages indefinitely until the stream terminates by other means.

Declaration

public ulong MaxCount { get; set; }

Property Value

Type	Description
UInt64

MessageWriter

.NET system threadding channel writer receiving messages streamed from the server. Messages can be read from the stream by calling code without blocking the incoming stream of messages from the mirror node. Completing the stream will close the streaming connection to the mirror node and cause this method to return without error.

Declaration

public ChannelWriter<TopicMessage> MessageWriter { get; set; }

Property Value

Type	Description
ChannelWriter<TopicMessage>

Starting

Optional, filter for messages which reached consensus on or after this time. If not set, messages occurring from the current time forward are returned.

Declaration

public DateTime? Starting { get; set; }

Property Value

Type	Description
Nullable<DateTime>

Topic

The Message's Topic.

Declaration

public Address Topic { get; set; }

Property Value

Type	Description
Address