api

Documentation

Index

• type AuthConfig
  • func (a AuthConfig) String() string
• type Controller
  • func NewHealthController(startTime time.Time, commit string, roshiURI string) Controller
  • func NewStreamController(service service.StreamService, authConfig AuthConfig) Controller
• type Error
• type StatusError
  • func (se StatusError) Error() string
  • func (se StatusError) Status() int

Types

type AuthConfig

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

AuthConfig contains all the necessary configuration for basic auth setup.

func (AuthConfig) String

func (a AuthConfig) String() string

StatusString status string for auth config

type Controller

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

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

NewHealthController returns a controller that will display metrics to /metrics

func NewStreamController

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

NewStreamController is the exported constructor for a streams controller

type Error

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

type StatusError struct {
	Code int
	Err  error
}

StatusError represents an error with an associated HTTP status code.

func (StatusError) Error

func (se StatusError) Error() string

Allows StatusError to satisfy the error interface.

func (StatusError) Status

func (se StatusError) Status() int

Status returns our HTTP status code.