server

Documentation

Index

• func EncodeNoopError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, ...) func(context.Context, http.ResponseWriter, error) error
• func EncodeNoopResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error
• func Mount(mux goahttp.Muxer, h *Server)
• func MountCORSHandler(mux goahttp.Muxer, h http.Handler)
• func MountNoopHandler(mux goahttp.Muxer, h http.Handler)
• func NewCORSHandler() http.Handler
• func NewNoopHandler(endpoint goa.Endpoint, mux goahttp.Muxer, ...) http.Handler
• func NoopCsvPath() string
• type ErrorNamer
• type MountPoint
• type NoopBadRequestResponseBody
  • func NewNoopBadRequestResponseBody(res *goa.ServiceError) *NoopBadRequestResponseBody
• type NoopForbiddenResponseBody
  • func NewNoopForbiddenResponseBody(res *goa.ServiceError) *NoopForbiddenResponseBody
• type NoopNotFoundResponseBody
  • func NewNoopNotFoundResponseBody(res *goa.ServiceError) *NoopNotFoundResponseBody
• type NoopUnauthorizedResponseBody
  • func NewNoopUnauthorizedResponseBody(res *goa.ServiceError) *NoopUnauthorizedResponseBody
• type Server
  • func New(e *csv.Endpoints, mux goahttp.Muxer, ...) *Server
  • func (s *Server) Service() string
  • func (s *Server) Use(m func(http.Handler) http.Handler)

Functions

func EncodeNoopError

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

EncodeNoopError returns an encoder for errors returned by the noop csv endpoint.

func EncodeNoopResponse

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

EncodeNoopResponse returns an encoder for responses returned by the csv noop endpoint.

func Mount

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

Mount configures the mux to serve the csv endpoints.

func MountCORSHandler

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

MountCORSHandler configures the mux to serve the CORS endpoints for the service csv.

func MountNoopHandler

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

MountNoopHandler configures the mux to serve the "csv" service "noop" endpoint.

func NewCORSHandler

func NewCORSHandler() http.Handler

NewCORSHandler creates a HTTP handler which returns a simple 200 response.

func NewNoopHandler

func NewNoopHandler(
	endpoint goa.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

NewNoopHandler creates a HTTP handler which loads the HTTP request and calls the "csv" service "noop" endpoint.

func NoopCsvPath

func NoopCsvPath() string

NoopCsvPath returns the URL path to the csv service noop HTTP endpoint.

Types

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 NoopBadRequestResponseBody

type NoopBadRequestResponseBody 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"`
}

NoopBadRequestResponseBody is the type of the "csv" service "noop" endpoint HTTP response body for the "bad-request" error.

func NewNoopBadRequestResponseBody

func NewNoopBadRequestResponseBody(res *goa.ServiceError) *NoopBadRequestResponseBody

NewNoopBadRequestResponseBody builds the HTTP response body from the result of the "noop" endpoint of the "csv" service.

type NoopForbiddenResponseBody

type NoopForbiddenResponseBody 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"`
}

NoopForbiddenResponseBody is the type of the "csv" service "noop" endpoint HTTP response body for the "forbidden" error.

func NewNoopForbiddenResponseBody

func NewNoopForbiddenResponseBody(res *goa.ServiceError) *NoopForbiddenResponseBody

NewNoopForbiddenResponseBody builds the HTTP response body from the result of the "noop" endpoint of the "csv" service.

type NoopNotFoundResponseBody

type NoopNotFoundResponseBody 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"`
}

NoopNotFoundResponseBody is the type of the "csv" service "noop" endpoint HTTP response body for the "not-found" error.

func NewNoopNotFoundResponseBody

func NewNoopNotFoundResponseBody(res *goa.ServiceError) *NoopNotFoundResponseBody

NewNoopNotFoundResponseBody builds the HTTP response body from the result of the "noop" endpoint of the "csv" service.

type NoopUnauthorizedResponseBody

type NoopUnauthorizedResponseBody 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"`
}

NoopUnauthorizedResponseBody is the type of the "csv" service "noop" endpoint HTTP response body for the "unauthorized" error.

func NewNoopUnauthorizedResponseBody

func NewNoopUnauthorizedResponseBody(res *goa.ServiceError) *NoopUnauthorizedResponseBody

NewNoopUnauthorizedResponseBody builds the HTTP response body from the result of the "noop" endpoint of the "csv" service.

type Server

type Server struct {
	Mounts []*MountPoint
	Noop   http.Handler
	CORS   http.Handler
}

Server lists the csv service endpoint HTTP handlers.

func New

func New(
	e *csv.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 csv 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.