api

package

v0.0.0-...-acd8c0a Latest Latest Go to latest Published: Feb 16, 2016 License: MIT Imports: 16 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

This section is empty.

This section is empty.

This section is empty.

type AuthConfig struct {
	Enabled  bool
	Username []byte
	Password []byte
}

AuthConfig contains all the necessary configuration for basic auth setup.

func (a AuthConfig) String() string

StatusString status string for auth config

type Controller interface {
	//Register takes a router object and allows the controller to add its routes
	Register(router *httprouter.Router)
}

Controller is the interface all of our controllers must implement.

func NewHealthController(startTime time.Time, commit string, roshiURI string) Controller

NewHealthController returns a controller that will display metrics to /metrics

func NewStreamController(service service.StreamService, authConfig AuthConfig) Controller

NewStreamController is the exported constructor for a streams controller

type Error interface {
	error
	Status() int
}

Error represents a handler error. It provides methods for a HTTP status code and embeds the built-in error interface.

type StatusError struct {
	Code int
	Err  error
}

StatusError represents an error with an associated HTTP status code.

func (se StatusError) Error() string

Allows StatusError to satisfy the error interface.

func (se StatusError) Status() int

Status returns our HTTP status code.