web

Documentation

Index

• func ErrorMiddleware(next echo.HandlerFunc) echo.HandlerFunc
• func HTTPErrorHandler(err error, c echo.Context)
• type APIServerStartOptions
• type Api
  • func NewWithManager(manager rpaas.RpaasManager) (*Api, error)
  • func NewWithTargetFactory(targetFactory target.Factory, address, addressTLS string, ...) (*Api, error)
  • func NewWithTargetFactoryWithDefaults(targetFactory target.Factory) (*Api, error)
  • func (a *Api) Start() error
  • func (a *Api) StartWithOptions(options APIServerStartOptions) error
  • func (a *Api) Stop() error

Functions

func ErrorMiddleware

func ErrorMiddleware(next echo.HandlerFunc) echo.HandlerFunc

func HTTPErrorHandler

func HTTPErrorHandler(err error, c echo.Context)

Types

type APIServerStartOptions

type APIServerStartOptions struct {
	DiscardLogging          bool
	ConfigEnableCertManager bool
}

type Api

type Api struct {
	sync.Mutex

	// Address is the network address where the web server will listen on.
	// Defaults to `:9999`.
	Address    string
	TLSAddress string

	// ShutdownTimeout defines the max duration used to wait the web server
	// gracefully shutting down. Defaults to `30 * time.Second`.
	ShutdownTimeout time.Duration
	// contains filtered or unexported fields
}

func NewWithManager

func NewWithManager(manager rpaas.RpaasManager) (*Api, error)

New creates an api instance.

func NewWithTargetFactory

func NewWithTargetFactory(targetFactory target.Factory, address, addressTLS string, shutdownTimeout time.Duration, shutdownChan chan struct{}) (*Api, error)

func NewWithTargetFactoryWithDefaults

func NewWithTargetFactoryWithDefaults(targetFactory target.Factory) (*Api, error)

func (*Api) Start

func (a *Api) Start() error

Start runs the web server.

func (*Api) StartWithOptions

func (a *Api) StartWithOptions(options APIServerStartOptions) error

func (*Api) Stop

func (a *Api) Stop() error

Stop shut down the web server.