config

Documentation

Overview

Package config contains a Config struct for kites.

Index

• Constants
• Variables
• type Config
  • func Get() (*Config, error)
  • func MustGet() *Config
  • func New() *Config
  • func (c *Config) Copy() *Config
  • func (c *Config) ReadEnvironmentVariables() error
  • func (c *Config) ReadKiteKey() error
• type Transport
  • func (t Transport) String() string

Constants

const (
	WebSocket = iota
	XHRPolling
)

Variables

var DefaultConfig = &Config{
	Username:    "unknown",
	Environment: "unknown",
	Region:      "unknown",
	IP:          "0.0.0.0",
	Port:        0,
	Transport:   WebSocket,
}

DefaultConfig contains the default settings.

var Transports = map[string]Transport{
	"WebSocket":  WebSocket,
	"XHRPolling": XHRPolling,
}

Types

type Config

type Config struct {
	// Options for Kite
	Username              string
	Environment           string
	Region                string
	Id                    string
	KiteKey               string
	DisableAuthentication bool
	DisableConcurrency    bool
	Transport             Transport

	// Options for Server
	IP   string
	Port int

	KontrolURL  string
	KontrolKey  string
	KontrolUser string
}

Options is passed to kite.New when creating new instance.

func Get

func Get() (*Config, error)

func MustGet

func MustGet() *Config

func New

func New() *Config

New returns a new Config initialized with defaults.

func (*Config) Copy

func (c *Config) Copy() *Config

Copy returns a new copy of the config object.

func (*Config) ReadEnvironmentVariables

func (c *Config) ReadEnvironmentVariables() error

func (*Config) ReadKiteKey

func (c *Config) ReadKiteKey() error

ReadKiteKey parsed the user's kite key and returns a new Config.

type Transport

type Transport int

Transport defines the underlying transport to be used

func (Transport) String

func (t Transport) String() string