server

Documentation

Index

• Variables
• func HTTPError(w http.ResponseWriter, httpErr int, msg string, err error)
• func JSONHandler(actual http.Handler) http.HandlerFunc
• type Route
• type Router
  • func NewRouter() *Router
  • func (router *Router) AddHandler(args RouterArguments)
  • func (router *Router) Handler() http.Handler
• type RouterArguments
• type SnickersServer
  • func New(log lager.Logger, config gonfig.Gonfig, listenNetwork string, ...) *SnickersServer
  • func (sn *SnickersServer) CreateJob(w http.ResponseWriter, r *http.Request)
  • func (sn *SnickersServer) CreatePreset(w http.ResponseWriter, r *http.Request)
  • func (sn *SnickersServer) DeleteJob(w http.ResponseWriter, r *http.Request)
  • func (sn *SnickersServer) DeletePreset(w http.ResponseWriter, r *http.Request)
  • func (sn *SnickersServer) GetJobDetails(w http.ResponseWriter, r *http.Request)
  • func (sn *SnickersServer) GetPresetDetails(w http.ResponseWriter, r *http.Request)
  • func (sn *SnickersServer) Handler() http.Handler
  • func (sn *SnickersServer) ListJobs(w http.ResponseWriter, r *http.Request)
  • func (sn *SnickersServer) ListPresets(w http.ResponseWriter, r *http.Request)
  • func (sn *SnickersServer) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (sn *SnickersServer) Start(keep bool) error
  • func (sn *SnickersServer) StartJob(w http.ResponseWriter, r *http.Request)
  • func (sn *SnickersServer) Stop() error
  • func (sn *SnickersServer) UpdatePreset(w http.ResponseWriter, r *http.Request)

Variables

var Routes = map[Route]RouterArguments{

	CreateJob:     RouterArguments{Path: "/jobs", Method: http.MethodPost},
	ListJobs:      RouterArguments{Path: "/jobs", Method: http.MethodGet},
	GetJobDetails: RouterArguments{Path: "/jobs/{jobID}", Method: http.MethodGet},
	DeleteJob:     RouterArguments{Path: "/jobs/{jobID}", Method: http.MethodDelete},
	StartJob:      RouterArguments{Path: "/jobs/{jobID}/start", Method: http.MethodPost},

	CreatePreset:     RouterArguments{Path: "/presets", Method: http.MethodPost},
	UpdatePreset:     RouterArguments{Path: "/presets", Method: http.MethodPut},
	ListPresets:      RouterArguments{Path: "/presets", Method: http.MethodGet},
	GetPresetDetails: RouterArguments{Path: "/presets/{presetName}", Method: http.MethodGet},
	DeletePreset:     RouterArguments{Path: "/presets/{presetName}", Method: http.MethodDelete},
}

Functions

func HTTPError

func HTTPError(w http.ResponseWriter, httpErr int, msg string, err error)

HTTPError is a helper to return errors on handlers

func JSONHandler

func JSONHandler(actual http.Handler) http.HandlerFunc

JSONHandler adds json headers

Types

type Route

type Route int

const (
	CreateJob Route = iota
	DeleteJob
	ListJobs
	GetJobDetails
	StartJob
	CreatePreset
	UpdatePreset
	ListPresets
	GetPresetDetails
	DeletePreset
)

type Router

type Router struct {
	// contains filtered or unexported fields
}

func NewRouter

func NewRouter() *Router

func (*Router) AddHandler

func (router *Router) AddHandler(args RouterArguments)

func (*Router) Handler

func (router *Router) Handler() http.Handler

type RouterArguments

type RouterArguments struct {
	Handler http.HandlerFunc
	Path    string
	Method  string
}

type SnickersServer

type SnickersServer struct {
	net.Listener
	// contains filtered or unexported fields
}

func New

func New(log lager.Logger, config gonfig.Gonfig, listenNetwork string, listenAddr string, db db.Storage) *SnickersServer

func (*SnickersServer) CreateJob

func (sn *SnickersServer) CreateJob(w http.ResponseWriter, r *http.Request)

CreateJob creates a job

func (*SnickersServer) CreatePreset

func (sn *SnickersServer) CreatePreset(w http.ResponseWriter, r *http.Request)

CreatePreset creates a preset

func (*SnickersServer) DeleteJob

func (sn *SnickersServer) DeleteJob(w http.ResponseWriter, r *http.Request)

DeleteJob deletes a job

func (*SnickersServer) DeletePreset

func (sn *SnickersServer) DeletePreset(w http.ResponseWriter, r *http.Request)

DeletePreset creates a preset

func (*SnickersServer) GetJobDetails

func (sn *SnickersServer) GetJobDetails(w http.ResponseWriter, r *http.Request)

GetJobDetails returns the details of a given job

func (*SnickersServer) GetPresetDetails

func (sn *SnickersServer) GetPresetDetails(w http.ResponseWriter, r *http.Request)

GetPresetDetails returns the details of a given preset

func (*SnickersServer) Handler

func (sn *SnickersServer) Handler() http.Handler

func (*SnickersServer) ListJobs

func (sn *SnickersServer) ListJobs(w http.ResponseWriter, r *http.Request)

ListJobs lists all jobs

func (*SnickersServer) ListPresets

func (sn *SnickersServer) ListPresets(w http.ResponseWriter, r *http.Request)

ListPresets list all presets available

func (*SnickersServer) ServeHTTP

func (sn *SnickersServer) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*SnickersServer) Start

func (sn *SnickersServer) Start(keep bool) error

func (*SnickersServer) StartJob

func (sn *SnickersServer) StartJob(w http.ResponseWriter, r *http.Request)

StartJob triggers an encoding process

func (*SnickersServer) Stop

func (sn *SnickersServer) Stop() error

func (*SnickersServer) UpdatePreset

func (sn *SnickersServer) UpdatePreset(w http.ResponseWriter, r *http.Request)

UpdatePreset updates a preset