titan

Documentation

Index

• type Core
  • func NewCore(options ...CoreOption) (*Core, error)
  • func (c *Core) Live(ctx context.Context) bool
  • func (c *Core) Ready(ctx context.Context) bool
• type CoreOption
  • func OptionMetricsCollector(collector *metrics.Collector) CoreOption

Types

type Core

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

Core defines high-level methods for titan's external operations.

func NewCore

func NewCore(options ...CoreOption) (*Core, error)

NewCore returns a fully initialized Core.

func (*Core) Live

func (c *Core) Live(ctx context.Context) bool

Live returns true if the Core is running correctly.

func (*Core) Ready

func (c *Core) Ready(ctx context.Context) bool

Ready returns true if the Core is ready to serve requests.

type CoreOption

type CoreOption func(*Core)

CoreOption applies a parameter to a Core.

func OptionMetricsCollector

func OptionMetricsCollector(collector *metrics.Collector) CoreOption

OptionMetricsCollector sets the http.Handler to use for the metrics endpoint.