rpc

package

v0.9.4 Latest Latest Go to latest Published: Sep 29, 2020 License: AGPL-3.0 Imports: 14 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/onflow/flow-go

Links

Open Source Insights

Documentation ¶

Index ¶

type Config
type Engine
- func New(log zerolog.Logger, config Config, e *ingestion.Engine, blocks storage.Blocks, ...) *Engine
- func (e *Engine) Done() <-chan struct{}
- func (e *Engine) Ready() <-chan struct{}

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	ListenAddr string
	MaxMsgSize int // In bytes
}

Config defines the configurable options for the gRPC server.

type Engine ¶

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

Engine implements a gRPC server with a simplified version of the Observation API.

func New ¶

func New(
	log zerolog.Logger,
	config Config,
	e *ingestion.Engine,
	blocks storage.Blocks,
	events storage.Events,
	exeResults storage.ExecutionResults,
	txResults storage.TransactionResults,
	chainID flow.ChainID) *Engine

New returns a new RPC engine.

func (*Engine) Done ¶

func (e *Engine) Done() <-chan struct{}

Done returns a done channel that is closed once the engine has fully stopped. It sends a signal to stop the gRPC server, then closes the channel.

func (*Engine) Ready ¶

func (e *Engine) Ready() <-chan struct{}

Ready returns a ready channel that is closed once the engine has fully started. The RPC engine is ready when the gRPC server has successfully started.

Source Files ¶

View all Source files

engine.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL