server

Documentation

Index

• func DecodeDownloadObjectRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)
• func DownloadObjectKs3Path(bucket string, key string) string
• func EncodeDownloadObjectResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error
• func Mount(mux goahttp.Muxer, h *Server)
• func MountDownloadObjectHandler(mux goahttp.Muxer, h http.Handler)
• func NewDownloadObjectHandler(endpoint goa.Endpoint, mux goahttp.Muxer, ...) http.Handler
• func NewDownloadObjectPayload(bucket string, key string) *ks3.DownloadObjectPayload
• type MountPoint
• type Server
  • func New(e *ks3.Endpoints, mux goahttp.Muxer, ...) *Server
  • func (s *Server) MethodNames() []string
  • func (s *Server) Mount(mux goahttp.Muxer)
  • func (s *Server) Service() string
  • func (s *Server) Use(m func(http.Handler) http.Handler)

Functions

func DecodeDownloadObjectRequest

func DecodeDownloadObjectRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeDownloadObjectRequest returns a decoder for requests sent to the ks3 download-object endpoint.

func DownloadObjectKs3Path

func DownloadObjectKs3Path(bucket string, key string) string

DownloadObjectKs3Path returns the URL path to the ks3 service download-object HTTP endpoint.

func EncodeDownloadObjectResponse

func EncodeDownloadObjectResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeDownloadObjectResponse returns an encoder for responses returned by the ks3 download-object endpoint.

func Mount

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

Mount configures the mux to serve the ks3 endpoints.

func MountDownloadObjectHandler

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

MountDownloadObjectHandler configures the mux to serve the "ks3" service "download-object" endpoint.

func NewDownloadObjectHandler

func NewDownloadObjectHandler(
	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(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewDownloadObjectHandler creates a HTTP handler which loads the HTTP request and calls the "ks3" service "download-object" endpoint.

func NewDownloadObjectPayload

func NewDownloadObjectPayload(bucket string, key string) *ks3.DownloadObjectPayload

NewDownloadObjectPayload builds a ks3 service download-object endpoint payload.

Types

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 Server

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

Server lists the ks3 service endpoint HTTP handlers.

func New

func New(
	e *ks3.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(ctx context.Context, err error) goahttp.Statuser,
) *Server

New instantiates HTTP handlers for all the ks3 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) MethodNames

func (s *Server) MethodNames() []string

MethodNames returns the methods served.

func (*Server) Mount

func (s *Server) Mount(mux goahttp.Muxer)

Mount configures the mux to serve the ks3 endpoints.

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.