consensus

Documentation

Overview

Package consensus implements publicly accessible consensus services.

Index

• Constants
• Variables
• func Enabled() bool
• type Worker
  • func New(commonWorker *workerCommon.Worker, registration *registration.Worker) (*Worker, error)
  • func (w *Worker) Cleanup()
  • func (w *Worker) Enabled() bool
  • func (w *Worker) Name() string
  • func (w *Worker) Quit() <-chan struct{}
  • func (w *Worker) Start() error
  • func (w *Worker) Stop()

Constants

const (
	// CfgWorkerEnabled enables the consensus RPC services worker.
	CfgWorkerEnabled = "worker.consensusrpc.enabled"
)

Variables

var Flags = flag.NewFlagSet("", flag.ContinueOnError)

Flags has the configuration flags.

Functions

func Enabled

func Enabled() bool

Enabled reads our enabled flag from viper.

Types

type Worker

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

Worker is a worker providing publicly accessible consensus services.

Currently this only exposes the consensus light client service.

func New

func New(commonWorker *workerCommon.Worker, registration *registration.Worker) (*Worker, error)

New creates a new public consensus services worker.

func (*Worker) Cleanup

func (w *Worker) Cleanup()

Cleanup performs the service specific post-termination cleanup.

func (*Worker) Enabled

func (w *Worker) Enabled() bool

Enabled returns if worker is enabled.

func (*Worker) Name

func (w *Worker) Name() string

Name returns the service name.

func (*Worker) Quit

func (w *Worker) Quit() <-chan struct{}

Quit returns a channel that will be closed when the service terminates.

func (*Worker) Start

func (w *Worker) Start() error

Start starts the worker.

func (*Worker) Stop

func (w *Worker) Stop()

Stop halts the service.