webserver

Documentation

Index

• Constants
• Variables
• type Server
  • func NewServer(logger *zap.Logger, fiberConfig fiber.Config, appConfig *config.Config, ...) *Server
  • func (s *Server) DeRegisterConsul() error
  • func (s *Server) Finalize()
  • func (s *Server) GetApp() *fiber.App
  • func (s *Server) GetService() service.IService
  • func (s *Server) GetStatus() ServerStatus
  • func (s *Server) GetWebAPIServer() *web.WebAPIServer
  • func (s *Server) GetWebConfig() *config.WebServerConfig
  • func (s *Server) HandleSignals() error
  • func (s *Server) Initialize(ctx context.Context, options ...ServerOption) error
  • func (s *Server) Listen()
  • func (s *Server) RegisterConsul() error
  • func (s *Server) RequestRestartServer()
  • func (s *Server) RequestShutdownServer()
  • func (s *Server) SetStatus(status ServerStatus)
  • func (s *Server) Shutdown() error
  • func (s *Server) Start() error
• type ServerOption
• type ServerStatus

Constants

const (
	ServerStatusNone = iota
	ServerStatusInitialized
	ServerStatusRunning
	ServerStatusStopping
)

Variables

var ErrRequestRestart = errors.New("ErrRequestRestart")

Types

type Server

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

func NewServer

func NewServer(logger *zap.Logger, fiberConfig fiber.Config, appConfig *config.Config, service service.IService) *Server

func (*Server) DeRegisterConsul

func (s *Server) DeRegisterConsul() error

func (*Server) Finalize

func (s *Server) Finalize()

func (*Server) GetApp

func (s *Server) GetApp() *fiber.App

func (*Server) GetService

func (s *Server) GetService() service.IService

func (*Server) GetStatus

func (s *Server) GetStatus() ServerStatus

func (*Server) GetWebAPIServer

func (s *Server) GetWebAPIServer() *web.WebAPIServer

func (*Server) GetWebConfig

func (s *Server) GetWebConfig() *config.WebServerConfig

func (*Server) HandleSignals

func (s *Server) HandleSignals() error

func (*Server) Initialize

func (s *Server) Initialize(ctx context.Context, options ...ServerOption) error

func (*Server) Listen

func (s *Server) Listen()

func (*Server) RegisterConsul

func (s *Server) RegisterConsul() error

func (*Server) RequestRestartServer

func (s *Server) RequestRestartServer()

func (*Server) RequestShutdownServer

func (s *Server) RequestShutdownServer()

func (*Server) SetStatus

func (s *Server) SetStatus(status ServerStatus)

func (*Server) Shutdown

func (s *Server) Shutdown() error

func (*Server) Start

func (s *Server) Start() error

type ServerOption

type ServerOption func(*Server)

Option is a functional option type that allows us to configure the Server.

type ServerStatus

type ServerStatus int