rpc

package

v0.26.8-execution-fix-... Latest Latest Go to latest Published: Jun 14, 2022 License: AGPL-3.0 Imports: 13 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 ¶

Overview ¶

Package rpc implements accepting transactions into the system. It implements a subset of the Observation API.

Index ¶

type Backend
type Config
type Engine
- func New(config Config, backend Backend, log zerolog.Logger, chainID flow.ChainID) *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 Backend ¶

type Backend interface {
	// ProcessTransaction handles validating and ingesting a new transaction,
	// ultimately for inclusion in a future collection.
	ProcessTransaction(*flow.TransactionBody) error
}

Backend defines the core functionality required by the RPC API.

type Config ¶

type Config struct {
	ListenAddr        string
	MaxMsgSize        int  // in bytes
	RpcMetricsEnabled bool // enable GRPC metrics
}

Config defines the configurable options for the ingress server.

type Engine ¶

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

Engine implements a gRPC server with a simplified version of the Observation API to enable receiving transactions into the system.

func New ¶

func New(config Config, backend Backend, log zerolog.Logger, chainID flow.ChainID) *Engine

New returns a new ingress server.

func (*Engine) Done ¶

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

Done returns a done channel that is closed once the module 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 module has fully started. The ingress module is ready when the gRPC server has successfully started.

Source Files ¶

View all Source files

engine.go

Directories ¶

Path	Synopsis
mock

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