controller

Documentation

Index

• Constants
• type Config
  • func LoadConfig(path string) (*Config, error)
  • func (config *Config) Configure(sub config.Subconfig) error
• type Controller
  • func NewController(cfg *Config, versionProvider versions.VersionProvider) (*Controller, error)
  • func (c *Controller) GetCloseNotify() <-chan struct{}
  • func (c *Controller) GetCloseNotifyChannel() <-chan struct{}
  • func (c *Controller) GetCommandDispatcher() command.Dispatcher
  • func (c *Controller) GetDb() boltz.Db
  • func (c *Controller) GetEventDispatcher() event.Dispatcher
  • func (c *Controller) GetId() *identity.TokenId
  • func (c *Controller) GetMetricsRegistry() metrics.Registry
  • func (c *Controller) GetNetwork() *network.Network
  • func (c *Controller) GetOptions() *network.Options
  • func (c *Controller) GetVersionProvider() versions.VersionProvider
  • func (c *Controller) GetXWebInstance() xweb.Instance
  • func (self *Controller) HandleCustomAgentAsyncOp(conn net.Conn) error
  • func (self *Controller) HandleCustomAgentOp(conn net.Conn) error
  • func (c *Controller) Identity() identity.Identity
  • func (c *Controller) IsRaftEnabled() bool
  • func (self *Controller) RegisterAgentBindHandler(bindHandler channel.BindHandler)
  • func (self *Controller) RegisterAgentOpHandler(opId byte, f func(c *bufio.ReadWriter) error)
  • func (c *Controller) RegisterXctrl(x xctrl.Xctrl) error
  • func (c *Controller) RegisterXmgmt(x xmgmt.Xmgmt) error
  • func (c *Controller) Run() error
  • func (c *Controller) Shutdown()
• type CtrlOptions
• type OnConnectSettingsHandler
  • func (o OnConnectSettingsHandler) RouterConnected(r *network.Router)
  • func (o *OnConnectSettingsHandler) RouterDisconnected(r *network.Router)

Constants

const (
	AgentAppId byte = 1

	AgentIdHeader      = 10
	AgentAddrHeader    = 11
	AgentIsVoterHeader = 12
)

const (
	DefaultProfileMemoryInterval             = 15 * time.Second
	DefaultHealthChecksBoltCheckInterval     = 30 * time.Second
	DefaultHealthChecksBoltCheckTimeout      = 20 * time.Second
	DefaultHealthChecksBoltCheckInitialDelay = 30 * time.Second

	DefaultRaftCommandHandlerMaxQueueSize = 1000
	DefaultRaftCommandHandlerMaxWorkers   = 10
)

Types

type Config

type Config struct {
	Id      *identity.TokenId
	Raft    *raft.Config
	Network *network.Options
	Db      boltz.Db
	Trace   struct {
		Handler *channel.TraceHandler
	}
	Profile struct {
		Memory struct {
			Path     string
			Interval time.Duration
		}
		CPU struct {
			Path string
		}
	}
	Ctrl struct {
		Listener transport.Address
		Options  *CtrlOptions
	}
	HealthChecks struct {
		BoltCheck struct {
			Interval     time.Duration
			Timeout      time.Duration
			InitialDelay time.Duration
		}
	}
	SyncRaftToDb bool
	// contains filtered or unexported fields
}

func LoadConfig

func LoadConfig(path string) (*Config, error)

func (*Config) Configure

func (config *Config) Configure(sub config.Subconfig) error

type Controller

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

func NewController

func NewController(cfg *Config, versionProvider versions.VersionProvider) (*Controller, error)

func (*Controller) GetCloseNotify

func (c *Controller) GetCloseNotify() <-chan struct{}

func (*Controller) GetCloseNotifyChannel

func (c *Controller) GetCloseNotifyChannel() <-chan struct{}

func (*Controller) GetCommandDispatcher

func (c *Controller) GetCommandDispatcher() command.Dispatcher

func (*Controller) GetDb

func (c *Controller) GetDb() boltz.Db

func (*Controller) GetEventDispatcher

func (c *Controller) GetEventDispatcher() event.Dispatcher

func (*Controller) GetId

func (c *Controller) GetId() *identity.TokenId

func (*Controller) GetMetricsRegistry

func (c *Controller) GetMetricsRegistry() metrics.Registry

func (*Controller) GetNetwork

func (c *Controller) GetNetwork() *network.Network

func (*Controller) GetOptions

func (c *Controller) GetOptions() *network.Options

func (*Controller) GetVersionProvider

func (c *Controller) GetVersionProvider() versions.VersionProvider

func (*Controller) GetXWebInstance

func (c *Controller) GetXWebInstance() xweb.Instance

func (*Controller) HandleCustomAgentAsyncOp

func (self *Controller) HandleCustomAgentAsyncOp(conn net.Conn) error

func (*Controller) HandleCustomAgentOp

func (self *Controller) HandleCustomAgentOp(conn net.Conn) error

func (*Controller) Identity

func (c *Controller) Identity() identity.Identity

func (*Controller) IsRaftEnabled

func (c *Controller) IsRaftEnabled() bool

func (*Controller) RegisterAgentBindHandler

func (self *Controller) RegisterAgentBindHandler(bindHandler channel.BindHandler)

func (*Controller) RegisterAgentOpHandler

func (self *Controller) RegisterAgentOpHandler(opId byte, f func(c *bufio.ReadWriter) error)

func (*Controller) RegisterXctrl

func (c *Controller) RegisterXctrl(x xctrl.Xctrl) error

func (*Controller) RegisterXmgmt

func (c *Controller) RegisterXmgmt(x xmgmt.Xmgmt) error

func (*Controller) Run

func (c *Controller) Run() error

func (*Controller) Shutdown

func (c *Controller) Shutdown()

type CtrlOptions

type CtrlOptions struct {
	*channel.Options
	NewListener *transport.Address
}

CtrlOptions extends channel.Options to include support for additional, non-channel specific options (e.g. NewListener)

type OnConnectSettingsHandler

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

OnConnectSettingsHandler sends a ctrl_pb.ContentType_SettingsType message when routers connect if necessary Settings are a map of int32 -> []byte data. The type should be used to determine how the setting's []byte array is consumed.

func (OnConnectSettingsHandler) RouterConnected

func (o OnConnectSettingsHandler) RouterConnected(r *network.Router)

func (*OnConnectSettingsHandler) RouterDisconnected

func (o *OnConnectSettingsHandler) RouterDisconnected(r *network.Router)