server

package
v0.0.0-...-d2cf98a Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 22, 2024 License: BSD-3-Clause Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DecodeDeviceSummaryRequest 

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

DecodeDeviceSummaryRequest returns a decoder for requests sent to the data device summary endpoint.

func DeviceSummaryDataPath 

func DeviceSummaryDataPath(deviceID string) string

DeviceSummaryDataPath returns the URL path to the data service device summary HTTP endpoint.

func EncodeDeviceSummaryError 

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

EncodeDeviceSummaryError returns an encoder for errors returned by the device summary data endpoint.

func EncodeDeviceSummaryResponse 

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

EncodeDeviceSummaryResponse returns an encoder for responses returned by the data device summary endpoint.

func Mount 

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

Mount configures the mux to serve the data endpoints.

func MountCORSHandler 

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

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

func MountDeviceSummaryHandler 

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

MountDeviceSummaryHandler configures the mux to serve the "data" service "device summary" endpoint.

func NewCORSHandler 

func NewCORSHandler() http.Handler

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

func NewDeviceSummaryHandler 

func NewDeviceSummaryHandler(
	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

NewDeviceSummaryHandler creates a HTTP handler which loads the HTTP request and calls the "data" service "device summary" endpoint.

func NewDeviceSummaryPayload 

func NewDeviceSummaryPayload(deviceID string, auth *string) *data.DeviceSummaryPayload

NewDeviceSummaryPayload builds a data service device summary endpoint payload.

Types

type DeviceDataSummaryResponseBody 

type DeviceDataSummaryResponseBody struct {
	Size  int64 `form:"size" json:"size" xml:"size"`
	First int64 `form:"first" json:"first" xml:"first"`
	Last  int64 `form:"last" json:"last" xml:"last"`
}

DeviceDataSummaryResponseBody is used to define fields on response body types.

type DeviceMetaSummaryResponseBody 

type DeviceMetaSummaryResponseBody struct {
	Size  int64 `form:"size" json:"size" xml:"size"`
	First int64 `form:"first" json:"first" xml:"first"`
	Last  int64 `form:"last" json:"last" xml:"last"`
}

DeviceMetaSummaryResponseBody is used to define fields on response body types.

type DeviceProvisionSummaryResponseBody 

type DeviceProvisionSummaryResponseBody struct {
	Generation string                         `form:"generation" json:"generation" xml:"generation"`
	Created    int64                          `form:"created" json:"created" xml:"created"`
	Updated    int64                          `form:"updated" json:"updated" xml:"updated"`
	Meta       *DeviceMetaSummaryResponseBody `form:"meta" json:"meta" xml:"meta"`
	Data       *DeviceDataSummaryResponseBody `form:"data" json:"data" xml:"data"`
}

DeviceProvisionSummaryResponseBody is used to define fields on response body types.

type DeviceProvisionSummaryResponseBodyCollection 

type DeviceProvisionSummaryResponseBodyCollection []*DeviceProvisionSummaryResponseBody

DeviceProvisionSummaryResponseBodyCollection is used to define fields on response body types.

type DeviceSummaryBadRequestResponseBody 

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

DeviceSummaryBadRequestResponseBody is the type of the "data" service "device summary" endpoint HTTP response body for the "bad-request" error.

func NewDeviceSummaryBadRequestResponseBody 

func NewDeviceSummaryBadRequestResponseBody(res *goa.ServiceError) *DeviceSummaryBadRequestResponseBody

NewDeviceSummaryBadRequestResponseBody builds the HTTP response body from the result of the "device summary" endpoint of the "data" service.

type DeviceSummaryForbiddenResponseBody 

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

DeviceSummaryForbiddenResponseBody is the type of the "data" service "device summary" endpoint HTTP response body for the "forbidden" error.

func NewDeviceSummaryForbiddenResponseBody 

func NewDeviceSummaryForbiddenResponseBody(res *goa.ServiceError) *DeviceSummaryForbiddenResponseBody

NewDeviceSummaryForbiddenResponseBody builds the HTTP response body from the result of the "device summary" endpoint of the "data" service.

type DeviceSummaryNotFoundResponseBody 

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

DeviceSummaryNotFoundResponseBody is the type of the "data" service "device summary" endpoint HTTP response body for the "not-found" error.

func NewDeviceSummaryNotFoundResponseBody 

func NewDeviceSummaryNotFoundResponseBody(res *goa.ServiceError) *DeviceSummaryNotFoundResponseBody

NewDeviceSummaryNotFoundResponseBody builds the HTTP response body from the result of the "device summary" endpoint of the "data" service.

type DeviceSummaryResponseBody 

type DeviceSummaryResponseBody struct {
	Provisions DeviceProvisionSummaryResponseBodyCollection `form:"provisions" json:"provisions" xml:"provisions"`
}

DeviceSummaryResponseBody is the type of the "data" service "device summary" endpoint HTTP response body.

func NewDeviceSummaryResponseBody 

func NewDeviceSummaryResponseBody(res *dataviews.DeviceDataSummaryResponseView) *DeviceSummaryResponseBody

NewDeviceSummaryResponseBody builds the HTTP response body from the result of the "device summary" endpoint of the "data" service.

type DeviceSummaryUnauthorizedResponseBody 

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

DeviceSummaryUnauthorizedResponseBody is the type of the "data" service "device summary" endpoint HTTP response body for the "unauthorized" error.

func NewDeviceSummaryUnauthorizedResponseBody 

func NewDeviceSummaryUnauthorizedResponseBody(res *goa.ServiceError) *DeviceSummaryUnauthorizedResponseBody

NewDeviceSummaryUnauthorizedResponseBody builds the HTTP response body from the result of the "device summary" endpoint of the "data" 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 Server 

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

Server lists the data service endpoint HTTP handlers.

func New 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.