ingress

package
v0.17.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 4, 2021 License: AGPL-3.0 Imports: 15 Imported by: 0

Documentation

Overview

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

Index

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
	RpcMetricsEnabled bool // enable GRPC metrics
}

Config defines the configurable options for the ingress server.

type Ingress

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

Ingress 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, e *ingest.Engine, chainID flow.ChainID) *Ingress

New returns a new ingress server.

func (*Ingress) Done

func (i *Ingress) 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 (*Ingress) Ready

func (i *Ingress) 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.

Jump to

Keyboard shortcuts

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