server

Documentation

Index

• type Monitor
  • func NewMonitor(ttl time.Duration) *Monitor
  • func (m *Monitor) Monitor(hrt heart.Heart, sdc <-chan struct{}) (bool, error)
• type Server
  • func New(cfg config.Config, listeners []net.Listener) (*Server, error)
  • func (s *Server) GetApiServerListeners() []net.Listener
  • func (s *Server) Kill()
  • func (s *Server) MarshalJSON() ([]byte, error)
  • func (s *Server) Purge()
  • func (s *Server) Run()
  • func (s *Server) SetReconfigServer(isReconfigServer bool)
  • func (s *Server) SetRestartServer(isRestartServer bool)
  • func (s *Server) Supervise()

Types

type Monitor

type Monitor struct {
	TTL time.Duration
	// contains filtered or unexported fields
}

func NewMonitor

func NewMonitor(ttl time.Duration) *Monitor

func (*Monitor) Monitor

func (m *Monitor) Monitor(hrt heart.Heart, sdc <-chan struct{}) (bool, error)

Monitor periodically checks the given Heart to make sure it beats successfully. If the heartbeat check fails for any reason, an error is returned. If the supplied channel is closed, Monitor returns true and a nil error.

type Server

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

func New

func New(cfg config.Config, listeners []net.Listener) (*Server, error)

func (*Server) GetApiServerListeners

func (s *Server) GetApiServerListeners() []net.Listener

func (*Server) Kill

func (s *Server) Kill()

Kill is used to gracefully terminate the server by triggering the Monitor to shut down

func (*Server) MarshalJSON

func (s *Server) MarshalJSON() ([]byte, error)

func (*Server) Purge

func (s *Server) Purge()

func (*Server) Run

func (s *Server) Run()

func (*Server) SetReconfigServer

func (s *Server) SetReconfigServer(isReconfigServer bool)

func (*Server) SetRestartServer

func (s *Server) SetRestartServer(isRestartServer bool)

func (*Server) Supervise

func (s *Server) Supervise()

Supervise monitors the life of the Server and coordinates its shutdown. A shutdown occurs when the monitor returns, either because a health check fails or a user triggers a shutdown. If the shutdown is due to a health check failure, the Server is restarted. Supervise will block shutdown until all components have finished shutting down or a timeout occurs; if this happens, the Server will not automatically be restarted.