ping

Documentation

Index

• type Engine
  • func New(log zerolog.Logger, state protocol.State, me module.Local, ...) (*Engine, error)
  • func (e *Engine) Done() <-chan struct{}
  • func (e *Engine) Ready() <-chan struct{}

Types

type Engine

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

func New

func New(
	log zerolog.Logger,
	state protocol.State,
	me module.Local,
	metrics module.PingMetrics,
	pingEnabled bool,
	mw network.Middleware,
	nodeInfoFile string,
) (*Engine, error)

func (*Engine) Done

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

Done returns a done channel that is closed once the engine has fully stopped. For the ingestion engine, it only waits for all submit goroutines to end.

func (*Engine) Ready

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

Ready returns a ready channel that is closed once the engine has fully started. For the ingestion engine, we consider the engine up and running upon initialization.