router

Documentation

Index

• Constants
• func LoadConfigMap(path string) (map[interface{}]interface{}, error)
• func LoadIdentityConfigFromMap(cfgmap map[interface{}]interface{}) (*identity.Config, error)
• func SetConfigMapFlags(cfgmap map[interface{}]interface{}, flags map[string]*pflag.Flag)
• type Config
  • func LoadConfig(path string) (*Config, error)
  • func (config *Config) Configure(sub config.Subconfig) error
  • func (config *Config) CreateBackup() (string, error)
  • func (config *Config) Save() error
  • func (config *Config) SetFlags(flags map[string]*pflag.Flag)
  • func (config *Config) UpdateControllerEndpoint(address string) error
• type Router
  • func Create(config *Config, versionProvider common.VersionProvider) *Router
  • func (self *Router) Channel() channel2.Channel
  • func (self *Router) DefaultRequestTimeout() time.Duration
  • func (self *Router) GetConfig() *Config
  • func (self *Router) GetMetricsRegistry() metrics.UsageRegistry
  • func (self *Router) GetVersionInfo() common.VersionProvider
  • func (self *Router) HandleDebug(conn io.ReadWriter) error
  • func (self *Router) MetricsRegistry() metrics.UsageRegistry
  • func (self *Router) RegisterDebugOp(opId byte, f func(c *bufio.ReadWriter) error)
  • func (self *Router) RegisterDefaultDebugOps()
  • func (self *Router) RegisterXWebHandlerFactory(x xweb.WebHandlerFactory) error
  • func (self *Router) RegisterXctrl(x xctrl.Channel2Xctrl) error
  • func (self *Router) RegisterXweb(x xweb.Xweb) error
  • func (self *Router) Run() error
  • func (self *Router) Shutdown() error
  • func (self *Router) Start() error
• type RouterMonitor

Constants

const (
	// FlagsCfgMapKey is used as a key in the source configuration map to pass flags from
	// higher levels (i.e. CLI arguments) down through the stack w/o colliding w/ file
	// based configuration values
	FlagsCfgMapKey = "@flags"

	// PathMapKey is used to store a loaded configuration file's source path
	PathMapKey = "@file"

	// CtrlMapKey is the string key for the ctrl section
	CtrlMapKey = "ctrl"

	// CtrlEndpointMapKey is the string key for the ctrl.endpoint section
	CtrlEndpointMapKey = "endpoint"
)

const (
	TimeFormatYear    = "2006"
	TimeFormatMonth   = "01"
	TimeFormatDay     = "02"
	TimeFormatHour    = "15"
	TimeFormatMinute  = "04"
	TimeFormatSeconds = "05"
	TimestampFormat   = TimeFormatYear + TimeFormatMonth + TimeFormatDay + TimeFormatHour + TimeFormatMinute + TimeFormatSeconds
)

const (
	DumpForwarderTables byte = 1
	UpdateRoute         byte = 2
	CloseControlChannel byte = 3
	OpenControlChannel  byte = 4
)

Functions

func LoadConfigMap

func LoadConfigMap(path string) (map[interface{}]interface{}, error)

func LoadIdentityConfigFromMap

func LoadIdentityConfigFromMap(cfgmap map[interface{}]interface{}) (*identity.Config, error)

func SetConfigMapFlags

func SetConfigMapFlags(cfgmap map[interface{}]interface{}, flags map[string]*pflag.Flag)

Types

type Config

type Config struct {
	Id        *identity.TokenId
	Forwarder *forwarder.Options
	Trace     struct {
		Handler *channel2.TraceHandler
	}
	Profile struct {
		Memory struct {
			Path     string
			Interval time.Duration
		}
		CPU struct {
			Path string
		}
	}
	Ctrl struct {
		Endpoint              transport.Address
		DefaultRequestTimeout time.Duration
		Options               *channel2.Options
	}
	Link struct {
		Listeners []map[interface{}]interface{}
		Dialers   []map[interface{}]interface{}
	}
	Dialers   map[string]xgress.OptionsData
	Listeners []listenerBinding
	Transport map[interface{}]interface{}
	Metrics   struct {
		ReportInterval   time.Duration
		MessageQueueSize int
	}
	HealthChecks struct {
		CtrlPingCheck struct {
			Interval     time.Duration
			Timeout      time.Duration
			InitialDelay time.Duration
		}
	}
	Plugins []string
	// contains filtered or unexported fields
}

func LoadConfig

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

func (*Config) Configure

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

func (*Config) CreateBackup

func (config *Config) CreateBackup() (string, error)

CreateBackup will attempt to use the current path value to create a backup of the file on disk. The resulting file path is returned.

func (*Config) Save

func (config *Config) Save() error

Save attempts to take the current config's src attribute and Save it as yaml to the path value.

func (*Config) SetFlags

func (config *Config) SetFlags(flags map[string]*pflag.Flag)

func (*Config) UpdateControllerEndpoint

func (config *Config) UpdateControllerEndpoint(address string) error

UpdateControllerEndpoint updates the runtime configuration address of the controller and the internal map configuration.

type Router

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

func Create

func Create(config *Config, versionProvider common.VersionProvider) *Router

func (*Router) Channel

func (self *Router) Channel() channel2.Channel

func (*Router) DefaultRequestTimeout

func (self *Router) DefaultRequestTimeout() time.Duration

func (*Router) GetConfig

func (self *Router) GetConfig() *Config

func (*Router) GetMetricsRegistry

func (self *Router) GetMetricsRegistry() metrics.UsageRegistry

func (*Router) GetVersionInfo

func (self *Router) GetVersionInfo() common.VersionProvider

func (*Router) HandleDebug

func (self *Router) HandleDebug(conn io.ReadWriter) error

func (*Router) MetricsRegistry

func (self *Router) MetricsRegistry() metrics.UsageRegistry

func (*Router) RegisterDebugOp

func (self *Router) RegisterDebugOp(opId byte, f func(c *bufio.ReadWriter) error)

func (*Router) RegisterDefaultDebugOps

func (self *Router) RegisterDefaultDebugOps()

func (*Router) RegisterXWebHandlerFactory

func (self *Router) RegisterXWebHandlerFactory(x xweb.WebHandlerFactory) error

func (*Router) RegisterXctrl

func (self *Router) RegisterXctrl(x xctrl.Channel2Xctrl) error

func (*Router) RegisterXweb

func (self *Router) RegisterXweb(x xweb.Xweb) error

func (*Router) Run

func (self *Router) Run() error

func (*Router) Shutdown

func (self *Router) Shutdown() error

func (*Router) Start

func (self *Router) Start() error

type RouterMonitor

type RouterMonitor interface {
	Monitor()
}