sentry

Documentation

Index

• Constants
• Variables
• func Enabled() bool
• type Worker
  • func New(backend api.LocalBackend, identity *identity.Identity) (*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 (
	// CfgEnabled enables the sentry worker.
	CfgEnabled = "worker.sentry.enabled"
	// CfgControlPort configures the sentry worker's control port.
	CfgControlPort = "worker.sentry.control.port"
	// CfgAuthorizedControlPubkeys configures the public keys of upstream nodes
	// that are allowed to connect to the sentry control endpoint.
	CfgAuthorizedControlPubkeys = "worker.sentry.control.authorized_pubkey"
)

Variables

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

Flags has the configuration flags.

Functions

func Enabled

func Enabled() bool

Enabled returns true if Sentry worker is enabled.

Types

type Worker

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

Worker is a sentry node worker providing its address(es) to other nodes and enabling them to hide their real address(es).

func New

func New(backend api.LocalBackend, identity *identity.Identity) (*Worker, error)

New creates a new sentry 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 true 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 service.

func (*Worker) Stop

func (w *Worker) Stop()

Stop halts the service.