handler

Documentation

Index

• func Register(name string, creator Creator) error
• type Creator
  • func Get(name string) (Creator, error)
• type Handler
• type QualityValue
  • func ParseAcceptEncoding(header http.Header) []QualityValue

Functions

func Register

func Register(name string, creator Creator) error

Register registers the 'creator' Creator under provided 'name'.

Types

type Creator

type Creator func(*controller.Controller, *config.Router, ...*httprouter.Router) Handler

Creator is the function used to create new router instance.

func Get

func Get(name string) (Creator, error)

Get gets the handler registered under provided 'name'.

type Handler

type Handler interface {
	// SetRoutes sets the routes for all the models stored in the handler's controller.
	SetRoutes() error
	// SetModelRoutes sets the routes for a single model within a handler.
	// The 'model' might be a struct instance or the neuron mapping.ModelStruct.
	SetModelRoutes(model interface{}) error
	// Router returns  httprouter implementation.
	Router() *httprouter.Router
}

Handler is the interface used as the neuron API handlers.

type QualityValue

type QualityValue struct {
	Value   string
	Quality float64
}

QualityValue is the structure that contains quality - value pair.

func ParseAcceptEncoding

func ParseAcceptEncoding(header http.Header) []QualityValue

ParseAcceptEncoding parses 'Accept-Encoding' header values sorted by it's quality.