meari

Documentation

Overview

Package meari provides a simple webserver feature to enable interactive actions such as MTR looking glass.

Index

• type DefaultServer
  • func NewDefaultServer(opts *Options) *DefaultServer
  • func (s *DefaultServer) Address() string
  • func (s *DefaultServer) GET(path string, handler echo.HandlerFunc)
  • func (s *DefaultServer) Serve() error
  • func (s *DefaultServer) Shutdown(c context.Context) error
• type Options
• type Server
  • func NewServer(c common.Context, opts *common.Options) (Server, error)

Types

type DefaultServer

type DefaultServer struct {
	*echo.Echo
	// contains filtered or unexported fields
}

DefaultServer is a "echo" based simple webserver that implements the Server interface.

func NewDefaultServer

func NewDefaultServer(opts *Options) *DefaultServer

NewDefaultServer initializes an instance of defaultServer, registers the "root" handler, and returns it as a Server. Currently, Server works as a singleton.

func (*DefaultServer) Address

func (s *DefaultServer) Address() string

Address implements the Server interface.

func (*DefaultServer) GET

func (s *DefaultServer) GET(path string, handler echo.HandlerFunc)

GET implements the Server interface.

func (*DefaultServer) Serve

func (s *DefaultServer) Serve() error

Serve implements the Server interface.

func (*DefaultServer) Shutdown

func (s *DefaultServer) Shutdown(c context.Context) error

Shutdown implements the Server interface.

type Options

type Options struct {
	Logger  common.Logger
	Address string
}

Options is a basic structure that contains all options for the Server implementation.

type Server

type Server interface {
	// Address returns the address on which the server is listening.
	Address() string
	// Serve starts the webserver and wait until the server stops.
	// It has the same behavior of `(http.Server).Serve()` and always returns
	// non-nil error. Expected error is `http.ErrServerClosed`.
	Serve() error
	// Shutdown stops the webserver gracefully.
	// It is equivalent to `(http.Server).Shutdown()`
	Shutdown(context context.Context) error
	// GET registers a new GET route for the given path with the given request handler.
	GET(path string, handler echo.HandlerFunc)
}

Server is an interface for the built-in webserver.

func NewServer

func NewServer(c common.Context, opts *common.Options) (Server, error)

NewServer initializes a new `defaultServer`, registers all available request handlers, then returns the Server instance.