server

package
v0.0.0-...-7475c9a Latest Latest
Warning

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

Go to latest
Published: Feb 27, 2021 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AddGoasnmpPath

func AddGoasnmpPath(hostname string) string

AddGoasnmpPath returns the URL path to the goasnmp service add HTTP endpoint.

func DecodeAddRequest

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

DecodeAddRequest returns a decoder for requests sent to the goasnmp add endpoint.

func EncodeAddResponse

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

EncodeAddResponse returns an encoder for responses returned by the goasnmp add endpoint.

func EncodeListResponse

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

EncodeListResponse returns an encoder for responses returned by the goasnmp list endpoint.

func ListGoasnmpPath

func ListGoasnmpPath() string

ListGoasnmpPath returns the URL path to the goasnmp service list HTTP endpoint.

func Mount

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

Mount configures the mux to serve the goasnmp endpoints.

func MountAddHandler

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

MountAddHandler configures the mux to serve the "goasnmp" service "add" endpoint.

func MountGenHTTPOpenapiJSON

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

MountGenHTTPOpenapiJSON configures the mux to serve GET request made to "/openapi.json".

func MountListHandler

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

MountListHandler configures the mux to serve the "goasnmp" service "list" endpoint.

func NewAddHandler

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

NewAddHandler creates a HTTP handler which loads the HTTP request and calls the "goasnmp" service "add" endpoint.

func NewAddPayload

func NewAddPayload(body struct {
	// Whether or not to walk public tree
	Public *bool `form:"Public" json:"Public" xml:"Public"`
	// Whether or not Ondemand polling is supported
	OnDemand *bool `form:"OnDemand" json:"OnDemand" xml:"OnDemand"`
}, hostname string) *goasnmp.AddPayload

NewAddPayload builds a goasnmp service add endpoint payload.

func NewListHandler

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

NewListHandler creates a HTTP handler which loads the HTTP request and calls the "goasnmp" service "list" endpoint.

Types

type AddResponseBody

type AddResponseBody struct {
	// Whether or not to walk public tree
	Public *bool `form:"public,omitempty" json:"public,omitempty" xml:"public,omitempty"`
	// Whether or not Ondemand polling is supported
	OnDemand *bool `form:"on_demand,omitempty" json:"on_demand,omitempty" xml:"on_demand,omitempty"`
}

AddResponseBody is the type of the "goasnmp" service "add" endpoint HTTP response body.

func NewAddResponseBody

func NewAddResponseBody(res *goasnmpviews.HostView) *AddResponseBody

NewAddResponseBody builds the HTTP response body from the result of the "add" endpoint of the "goasnmp" 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 HostResponse

type HostResponse struct {
	// Whether or not to walk public tree
	Public *bool `form:"public,omitempty" json:"public,omitempty" xml:"public,omitempty"`
	// Whether or not Ondemand polling is supported
	OnDemand *bool `form:"on_demand,omitempty" json:"on_demand,omitempty" xml:"on_demand,omitempty"`
}

HostResponse is used to define fields on response body types.

type HostResponseCollection

type HostResponseCollection []*HostResponse

HostResponseCollection is the type of the "goasnmp" service "list" endpoint HTTP response body.

func NewHostResponseCollection

func NewHostResponseCollection(res goasnmpviews.HostCollectionView) HostResponseCollection

NewHostResponseCollection builds the HTTP response body from the result of the "list" endpoint of the "goasnmp" service.

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
	List   http.Handler
	Add    http.Handler
}

Server lists the goasnmp service endpoint HTTP handlers.

func New

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL