cloud

Documentation

Index

• Variables
• type Config
• type GCPStreamer
  • func NewGCPStreamer(log zerolog.Logger, bucket *storage.BucketHandle, options ...Option) *GCPStreamer
  • func (g *GCPStreamer) Next() (*uploader.BlockData, error)
  • func (g *GCPStreamer) OnBlockFinalized(blockID flow.Identifier)
• type Option
  • func WithBufferSize(size uint) Option
  • func WithCatchupBlocks(blockIDs []flow.Identifier) Option

Variables

var DefaultConfig = Config{
	BufferSize:    32,
	CatchupBlocks: []flow.Identifier{},
}

DefaultConfig is the default configuration for the Google Cloud Streamer.

Types

type Config

type Config struct {
	BufferSize    uint
	CatchupBlocks []flow.Identifier
}

Config is the configuration for a Google Cloud Streamer.

type GCPStreamer

type GCPStreamer struct {
	// contains filtered or unexported fields
}

GCPStreamer is a component that downloads block data from a Google Cloud bucket. It exposes a callback to be used by the consensus follower to notify the Streamer when a new block has been finalized. The streamer will then add that block to the queue, which is consumed by downloading the block data for the identifiers it contains.

func NewGCPStreamer

func NewGCPStreamer(log zerolog.Logger, bucket *storage.BucketHandle, options ...Option) *GCPStreamer

NewGCPStreamer returns a new GCP Streamer using the given bucket and options.

func (*GCPStreamer) Next

func (g *GCPStreamer) Next() (*uploader.BlockData, error)

Next returns the next available block data. It returns an ErrUnavailable if no block data is available at the moment.

func (*GCPStreamer) OnBlockFinalized

func (g *GCPStreamer) OnBlockFinalized(blockID flow.Identifier)

OnBlockFinalized is a callback for the Flow consensus follower. It is called each time a block is finalized by the Flow consensus algorithm.

type Option

type Option func(*Config)

Option is a function that can be applied to a Config.

func WithBufferSize

func WithBufferSize(size uint) Option

WithBufferSize can be used to specify the buffer size for a Google Cloud Streamer to use.

func WithCatchupBlocks

func WithCatchupBlocks(blockIDs []flow.Identifier) Option

WithCatchupBlocks injects a number of block IDs that are already finalized, but for which we still need to download the execution data records.