job

Documentation

Index

• func ErrInternalError(err error) render.Renderer
• func ErrInvalidRequest(err error) render.Renderer
• func ErrNotFound(err error) render.Renderer
• func Routes(db *mgo.Database) *chi.Mux
• type AuthCtxKey
• type ErrResponse
  • func (e *ErrResponse) Render(w http.ResponseWriter, r *http.Request) error
• type JobRequest
  • func (j *JobRequest) Bind(req *http.Request) error
• type JobRouter

Functions

func ErrInternalError

func ErrInternalError(err error) render.Renderer

ErrInternalError return internal error

func ErrInvalidRequest

func ErrInvalidRequest(err error) render.Renderer

ErrInvalidRequest return an invalid http request

func ErrNotFound

func ErrNotFound(err error) render.Renderer

ErrNotFound return a not found error

func Routes

func Routes(db *mgo.Database) *chi.Mux

Routes Route handlers for jobs

Types

type AuthCtxKey

type AuthCtxKey string

AuthCtxKey context key for authentication state & policy map

type ErrResponse

type ErrResponse struct {
	Err            error `json:"-"` // low-level runtime error
	HTTPStatusCode int   `json:"-"` // http response status code

	StatusText string `json:"status"`          // user-level status message
	AppCode    int64  `json:"code,omitempty"`  // application-specific error code
	ErrorText  string `json:"error,omitempty"` // application-level error message, for debugging
}

ErrResponse struct for http error responses

func (*ErrResponse) Render

func (e *ErrResponse) Render(w http.ResponseWriter, r *http.Request) error

Render to render a http return code

type JobRequest

type JobRequest jobqueues.Job // nolint

JobRequest localises jobqueues.Job in this module

func (*JobRequest) Bind

func (j *JobRequest) Bind(req *http.Request) error

Bind Binder of decoded request payload

type JobRouter

type JobRouter struct {
	Db *mgo.Database
}

JobRouter holds config state, e.g. the handle for the database