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 common.VersionProvider) (*Controller, error)
  • func (c *Controller) GetCloseNotifyChannel() <-chan struct{}
  • func (c *Controller) GetNetwork() *network.Network
  • func (c *Controller) Identity() identity.Identity
  • func (c *Controller) RegisterXWebHandlerFactory(x xweb.WebHandlerFactory) error
  • func (c *Controller) RegisterXctrl(x xctrl.Xctrl) error
  • func (c *Controller) RegisterXmgmt(x xmgmt.Xmgmt) error
  • func (c *Controller) RegisterXweb(x xweb.Xweb) 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 (
	DefaultProfileMemoryInterval             = 15 * time.Second
	DefaultHealthChecksBoltCheckInterval     = 30 * time.Second
	DefaultHealthChecksBoltCheckTimeout      = 20 * time.Second
	DefaultHealthChecksBoltCheckInitialDelay = 30 * time.Second
)

Types

type Config

type Config struct {
	Id      *identity.TokenId
	Network *network.Options
	Db      *db.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
	}
	Mgmt struct {
		Listener transport.Address
		Options  *channel.Options
	}
	Metrics      *metrics.Config
	HealthChecks struct {
		BoltCheck struct {
			Interval     time.Duration
			Timeout      time.Duration
			InitialDelay time.Duration
		}
	}
	// 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 common.VersionProvider) (*Controller, error)

func (*Controller) GetCloseNotifyChannel

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

func (*Controller) GetNetwork

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

func (*Controller) Identity

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

func (*Controller) RegisterXWebHandlerFactory

func (c *Controller) RegisterXWebHandlerFactory(x xweb.WebHandlerFactory) 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) RegisterXweb

func (c *Controller) RegisterXweb(x xweb.Xweb) 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)