Class PublishStreamEvent

A directive or acknowledgement received from the block node over an open publish stream.

Inheritance

object

PublishStreamEvent

Implements

IEquatable<PublishStreamEvent>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Hiero.BlockNode

Assembly: Hiero.dll

Syntax

[Experimental("HIERO001", UrlFormat = "https://github.com/bugbytesinc/Hiero/blob/main/docs/blocknode-client-plan.md")]
public sealed record PublishStreamEvent : IEquatable<PublishStreamEvent>

Remarks

Delivered in arrival order via Events. The caller MUST consume the event stream: SkipBlock, ResendBlock and BehindPublisher require action before or during subsequent writes.

Properties

BlockNumber

The block number the event refers to (for acknowledgements, cumulative: all blocks up to and including this number).

Declaration

public ulong BlockNumber { get; }

Property Value

Type	Description
ulong

EndReason

The node's termination reason; populated only when Kind is StreamEnded.

Declaration

public PublishStreamEndReason? EndReason { get; }

Property Value

Type	Description
PublishStreamEndReason?

Kind

The kind of directive or acknowledgement.

Declaration

public PublishStreamEventKind Kind { get; }

Property Value

Type	Description
PublishStreamEventKind

Implements

IEquatable<T>