server

Documentation

Index

• func ArchiveArchiverPath() string
• func DecodeArchiveRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (interface{}, error)
• func DecodeReadRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (interface{}, error)
• func EncodeArchiveResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error
• func EncodeReadError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, ...) func(context.Context, http.ResponseWriter, error) error
• func EncodeReadResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error
• func Mount(mux goahttp.Muxer, h *Server)
• func MountArchiveHandler(mux goahttp.Muxer, h http.Handler)
• func MountReadHandler(mux goahttp.Muxer, h http.Handler)
• func NewArchiveHandler(endpoint endpoint.Endpoint, mux goahttp.Muxer, ...) http.Handler
• func NewArchivePayload(body *ArchiveRequestBody) *archiver.ArchivePayload
• func NewReadHandler(endpoint endpoint.Endpoint, mux goahttp.Muxer, ...) http.Handler
• func NewReadPayload(id int) *archiver.ReadPayload
• func ReadArchiverPath(id int) string
• func ValidateArchiveRequestBody(body *ArchiveRequestBody) (err error)
• type ArchiveRequestBody
• type ArchiveResponseBody
  • func NewArchiveResponseBody(res *archiverviews.ArchiveMediaView) *ArchiveResponseBody
• type ErrorNamer
• type MountPoint
• type ReadBadRequestResponseBody
  • func NewReadBadRequestResponseBody(res *goa.ServiceError) *ReadBadRequestResponseBody
• type ReadNotFoundResponseBody
  • func NewReadNotFoundResponseBody(res *goa.ServiceError) *ReadNotFoundResponseBody
• type ReadResponseBody
  • func NewReadResponseBody(res *archiverviews.ArchiveMediaView) *ReadResponseBody
• type Server
  • func New(e *archiver.Endpoints, mux goahttp.Muxer, ...) *Server
  • func (s *Server) Service() string
  • func (s *Server) Use(m func(http.Handler) http.Handler)

Functions

func ArchiveArchiverPath

func ArchiveArchiverPath() string

ArchiveArchiverPath returns the URL path to the archiver service archive HTTP endpoint.

func DecodeArchiveRequest

func DecodeArchiveRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (interface{}, error)

DecodeArchiveRequest returns a decoder for requests sent to the archiver archive endpoint.

func DecodeReadRequest

func DecodeReadRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (interface{}, error)

DecodeReadRequest returns a decoder for requests sent to the archiver read endpoint.

func EncodeArchiveResponse

func EncodeArchiveResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error

EncodeArchiveResponse returns an encoder for responses returned by the archiver archive endpoint.

func EncodeReadError

func EncodeReadError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeReadError returns an encoder for errors returned by the read archiver endpoint.

func EncodeReadResponse

func EncodeReadResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error

EncodeReadResponse returns an encoder for responses returned by the archiver read endpoint.

func Mount

func Mount(mux goahttp.Muxer, h *Server)

Mount configures the mux to serve the archiver endpoints.

func MountArchiveHandler

func MountArchiveHandler(mux goahttp.Muxer, h http.Handler)

MountArchiveHandler configures the mux to serve the "archiver" service "archive" endpoint.

func MountReadHandler

func MountReadHandler(mux goahttp.Muxer, h http.Handler)

MountReadHandler configures the mux to serve the "archiver" service "read" endpoint.

func NewArchiveHandler

func NewArchiveHandler(
	endpoint endpoint.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(err error) goahttp.Statuser,
) http.Handler

NewArchiveHandler creates a HTTP handler which loads the HTTP request and calls the "archiver" service "archive" endpoint.

func NewArchivePayload

func NewArchivePayload(body *ArchiveRequestBody) *archiver.ArchivePayload

NewArchivePayload builds a archiver service archive endpoint payload.

func NewReadHandler

func NewReadHandler(
	endpoint endpoint.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(err error) goahttp.Statuser,
) http.Handler

NewReadHandler creates a HTTP handler which loads the HTTP request and calls the "archiver" service "read" endpoint.

func NewReadPayload

func NewReadPayload(id int) *archiver.ReadPayload

NewReadPayload builds a archiver service read endpoint payload.

func ReadArchiverPath

func ReadArchiverPath(id int) string

ReadArchiverPath returns the URL path to the archiver service read HTTP endpoint.

func ValidateArchiveRequestBody

func ValidateArchiveRequestBody(body *ArchiveRequestBody) (err error)

ValidateArchiveRequestBody runs the validations defined on ArchiveRequestBody

Types

type ArchiveRequestBody

type ArchiveRequestBody struct {
	// HTTP status
	Status *int `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// HTTP response body content
	Body *string `form:"body,omitempty" json:"body,omitempty" xml:"body,omitempty"`
}

ArchiveRequestBody is the type of the "archiver" service "archive" endpoint HTTP request body.

type ArchiveResponseBody

type ArchiveResponseBody struct {
	// The archive resouce href
	Href string `form:"href" json:"href" xml:"href"`
	// HTTP status
	Status int `form:"status" json:"status" xml:"status"`
	// HTTP response body content
	Body string `form:"body" json:"body" xml:"body"`
}

ArchiveResponseBody is the type of the "archiver" service "archive" endpoint HTTP response body.

func NewArchiveResponseBody

func NewArchiveResponseBody(res *archiverviews.ArchiveMediaView) *ArchiveResponseBody

NewArchiveResponseBody builds the HTTP response body from the result of the "archive" endpoint of the "archiver" service.

type ErrorNamer

type ErrorNamer interface {
	ErrorName() string
}

ErrorNamer is an interface implemented by generated error structs that exposes the name of the error as defined in the design.

type MountPoint

type MountPoint struct {
	// Method is the name of the service method served by the mounted HTTP handler.
	Method string
	// Verb is the HTTP method used to match requests to the mounted handler.
	Verb string
	// Pattern is the HTTP request path pattern used to match requests to the
	// mounted handler.
	Pattern string
}

MountPoint holds information about the mounted endpoints.

type ReadBadRequestResponseBody

type ReadBadRequestResponseBody struct {
	// Name is the name of this class of errors.
	Name string `form:"name" json:"name" xml:"name"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID string `form:"id" json:"id" xml:"id"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message string `form:"message" json:"message" xml:"message"`
	// Is the error temporary?
	Temporary bool `form:"temporary" json:"temporary" xml:"temporary"`
	// Is the error a timeout?
	Timeout bool `form:"timeout" json:"timeout" xml:"timeout"`
	// Is the error a server-side fault?
	Fault bool `form:"fault" json:"fault" xml:"fault"`
}

ReadBadRequestResponseBody is the type of the "archiver" service "read" endpoint HTTP response body for the "bad_request" error.

func NewReadBadRequestResponseBody

func NewReadBadRequestResponseBody(res *goa.ServiceError) *ReadBadRequestResponseBody

NewReadBadRequestResponseBody builds the HTTP response body from the result of the "read" endpoint of the "archiver" service.

type ReadNotFoundResponseBody

type ReadNotFoundResponseBody struct {
	// Name is the name of this class of errors.
	Name string `form:"name" json:"name" xml:"name"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID string `form:"id" json:"id" xml:"id"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message string `form:"message" json:"message" xml:"message"`
	// Is the error temporary?
	Temporary bool `form:"temporary" json:"temporary" xml:"temporary"`
	// Is the error a timeout?
	Timeout bool `form:"timeout" json:"timeout" xml:"timeout"`
	// Is the error a server-side fault?
	Fault bool `form:"fault" json:"fault" xml:"fault"`
}

ReadNotFoundResponseBody is the type of the "archiver" service "read" endpoint HTTP response body for the "not_found" error.

func NewReadNotFoundResponseBody

func NewReadNotFoundResponseBody(res *goa.ServiceError) *ReadNotFoundResponseBody

NewReadNotFoundResponseBody builds the HTTP response body from the result of the "read" endpoint of the "archiver" service.

type ReadResponseBody

type ReadResponseBody struct {
	// The archive resouce href
	Href string `form:"href" json:"href" xml:"href"`
	// HTTP status
	Status int `form:"status" json:"status" xml:"status"`
	// HTTP response body content
	Body string `form:"body" json:"body" xml:"body"`
}

ReadResponseBody is the type of the "archiver" service "read" endpoint HTTP response body.

func NewReadResponseBody

func NewReadResponseBody(res *archiverviews.ArchiveMediaView) *ReadResponseBody

NewReadResponseBody builds the HTTP response body from the result of the "read" endpoint of the "archiver" service.

type Server

type Server struct {
	Mounts  []*MountPoint
	Archive http.Handler
	Read    http.Handler
}

Server lists the archiver service endpoint HTTP handlers.

func New

func New(
	e *archiver.Endpoints,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(err error) goahttp.Statuser,
) *Server

New instantiates HTTP handlers for all the archiver service endpoints using the provided encoder and decoder. The handlers are mounted on the given mux using the HTTP verb and path defined in the design. errhandler is called whenever a response fails to be encoded. formatter is used to format errors returned by the service methods prior to encoding. Both errhandler and formatter are optional and can be nil.

func (*Server) Service

func (s *Server) Service() string

Service returns the name of the service served.

func (*Server) Use

func (s *Server) Use(m func(http.Handler) http.Handler)

Use wraps the server handlers with the given middleware.