config

package

v0.0.0-...-8ac874d Latest Latest Go to latest Published: Mar 29, 2016 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/advancedlogic/kite

Links

Open Source Insights

Documentation ¶

Overview ¶

Package config contains a Config struct for kites.

Constants ¶

View Source

const (
	WebSocket = iota
	XHRPolling
)

Variables ¶

View Source

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

DefaultConfig contains the default settings.

View Source

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

Functions ¶

This section is empty.

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL