server

Documentation

Overview

Package server defines the server's interface

Index

• func ErrorResponse(c *echo.Context, e *errors.ErrorResponse) error
• type Config
• type Server
  • func New(config *Config) *Server
  • func (s *Server) Echo() *echo.Echo
  • func (s *Server) Start()
  • func (s *Server) StartTest() string
  • func (s *Server) Stop()
  • func (s *Server) StopTest()

Functions

func ErrorResponse

func ErrorResponse(c *echo.Context, e *errors.ErrorResponse) error

ErrorResponse returns a JSON error response

Types

type Config

type Config struct {
	Name         string
	Addr         string
	Timeout      time.Duration
	HealthCheck  func() error
	ShutdownFunc func()
	Middleware   []echo.MiddlewareFunc
}

Config is the configuration for the server

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server is an instance of the server

func New

func New(config *Config) *Server

New returns a configured Server struct

func (*Server) Echo

func (s *Server) Echo() *echo.Echo

Echo returns the echo instance for this server

func (*Server) Start

func (s *Server) Start()

Start starts up the server and begins serving traffic

func (*Server) StartTest

func (s *Server) StartTest() string

StartTest starts up the test server and begins serving traffic

func (*Server) Stop

func (s *Server) Stop()

Stop gracefully shuts down the server

func (*Server) StopTest

func (s *Server) StopTest()

StopTest shuts down the test server