Class SubscribeBlockItemStreamParams

The parameters for subscribing to a block node's block stream at the item level: each item is delivered the moment its frame arrives, before its block completes — the low-latency mode.

Inheritance

object

SubscribeBlockItemStreamParams

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 class SubscribeBlockItemStreamParams

Remarks

This mode trades every safety the assembled mode provides for latency: no buffering until block completion (an item can be delivered a second or more before its block's boundary marker), no duplicate dropping, and no structural verification. A resent block is delivered again under the same block number. Use the assembled SubscribeBlockStreamParams mode unless milliseconds matter and the consumer can reconcile provisional data — see StreamedBlockItem for the contract.

Properties

CancellationToken

An optional token that can interrupt the subscription; firing it completes the subscription normally.

Declaration

public CancellationToken CancellationToken { get; set; }

Property Value

Type	Description
CancellationToken

CompleteChannelWhenFinished

When 

true

(the default), the ItemWriter channel is marked complete when the subscription finishes for any reason.

Declaration

public bool CompleteChannelWhenFinished { get; set; }

Property Value

Type	Description
bool

EndingBlockNumber

The last block number to stream (inclusive).  A 

null

value streams indefinitely.

Declaration

public ulong? EndingBlockNumber { get; set; }

Property Value

Type	Description
ulong?

GapPolicy

The reaction to block-number gaps and transport drops; defaults to Resubscribe, resuming from the last completed block + 1. Verification levels do not apply to item-level delivery.

Declaration

public BlockStreamGapPolicy GapPolicy { get; set; }

Property Value

Type	Description
BlockStreamGapPolicy

ItemWriter

The .NET Channel receiving each StreamedBlockItem as its frame arrives.

Declaration

public ChannelWriter<StreamedBlockItem> ItemWriter { get; set; }

Property Value

Type	Description
ChannelWriter<StreamedBlockItem>

StartingBlockNumber

The first block number to stream.  A 

null

value starts at the node's latest available block (tailing mode).

Declaration

public ulong? StartingBlockNumber { get; set; }

Property Value

Type	Description
ulong?