ping

Documentation

Index

• Constants
• type Engine
  • func New(log zerolog.Logger, idProvider id.IdentityProvider, ...) (*Engine, error)
  • func (e *Engine) Done() <-chan struct{}
  • func (e *Engine) Ready() <-chan struct{}

Constants

const PingInterval = time.Minute

const PingTimeout = time.Second * 4

PingTimeout is maximum time to wait for a ping reply from a remote node

Types

type Engine

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

func New

func New(
	log zerolog.Logger,
	idProvider id.IdentityProvider,
	idTranslator p2p.IDTranslator,
	me module.Local,
	metrics module.PingMetrics,
	pingEnabled bool,
	nodeInfoFile string,
	pingService network.PingService,
) (*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.