package
0.38.0-preview.0
Repository: https://github.com/onflow/flow-go.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

HandleSubscription is a generic handler for subscriptions to a specific type.
NewBaseTrackerImpl creates a new instance of BaseTrackerImpl.
NewBlockTracker creates a new BlockTrackerImpl instance.
NewExecutionDataTracker creates a new ExecutionDataTrackerImpl instance.
NewFailedSubscription returns a new subscription that has already failed with the given error and message.
No description provided by the author
NewStreamer creates a new Streamer instance.
No description provided by the author
No description provided by the author
NewSubscriptionHandler creates a new SubscriptionHandler instance.

# Constants

DefaultCacheSize defines the default max number of objects for the execution data cache.
DefaultHeartbeatInterval specifies the block interval at which heartbeat messages should be sent.
DefaultMaxGlobalStreams defines the default max number of streams that can be open at the same time.
DefaultResponseLimit is default max responses per second allowed on a stream.
DefaultSendBufferSize is the default buffer size for the subscription's send channel.
DefaultSendTimeout is the default timeout for sending a message to the client.

# Variables

ErrBlockNotReady represents an error indicating that a block is not yet available or ready.
ErrEndOfData represents an error indicating that no more data available for streaming.

# Structs

BaseTrackerImpl is an implementation of the BaseTracker interface.
BlockTrackerImpl is an implementation of the BlockTracker interface.
ExecutionDataTrackerImpl is an implementation of the ExecutionDataTracker interface.
HeightBasedSubscription is a subscription that retrieves data sequentially by block height.
Streamer represents a streaming subscription that delivers data to clients.
StreamingData represents common streaming data configuration for access and state_stream handlers.
SubscriptionHandler represents common streaming data configuration for creating streaming subscription.
No description provided by the author

# Interfaces

BaseTracker is an interface for a tracker that provides base GetStartHeight method related to both blocks and execution data tracking.
BlockTracker is an interface for tracking blocks and handling block-related operations.
ExecutionDataTracker is an interface for tracking the highest consecutive block height for which we have received a new Execution Data notification.
Streamable represents a subscription that can be streamed.
Subscription represents a streaming request, and handles the communication between the grpc handler and the backend implementation.

# Type aliases

GetDataByHeightFunc is a callback used by subscriptions to retrieve data for a given height.