graceful

README

Package graceful v1.2.0

Default settings

SIGINT and SIGTERM are stopping the application SIGHUB is gracefully restarting it.

Graceful shutdown:

• 1 minute to finish requests
• Then connections cut

Graceful restart:

• Socket file descriptor given to fork/exec child
• 30 minutes to finish requests for old process (can switch to shutdown with a SIGINT/SIGTERM on this process)

Usage

graceful.NewService()

Configuration with options

s := graceful.NewService(
	graceful.WithWaitDuration(30 * time.Second),
	graceful.WithReloadWaitDuration(time.Hour),
	graceful.WithPIDFile("/var/run/service.pid"),
)

err := s.ListenAndServe(ctx, "tcp", ":9000", handler)

Configuration for multiple servers

s := graceful.NewService(
	graceful.WithWaitDuration(30 * time.Second),
	graceful.WithReloadWaitDuration(time.Hour),
	graceful.WithPIDFile("/var/run/service.pid"),
	graceful.WithNumServers(2),
)

err := s.ListenAndServe(ctx, "tcp", ":9000", handler)
err := s.ListenAndServe(ctx, "tcp", ":9001", handler2)

Documentation

Index

• type Option
  • func WithNumServers(n int) Option
  • func WithPIDFile(path string) Option
  • func WithReloadWaitDuration(d time.Duration) Option
  • func WithWaitDuration(d time.Duration) Option
• type Service
  • func NewService(opts ...Option) *Service
  • func (s *Service) DecConnCount(ctx context.Context)
  • func (s *Service) IncConnCount(ctx context.Context)
  • func (s *Service) ListenAndServe(ctx context.Context, proto string, addr string, handler http.Handler) error
  • func (s *Service) ListenAndServeTLS(ctx context.Context, proto string, addr string, handler http.Handler, ...) error

Types

type Option

type Option func(*Service)

func WithNumServers

func WithNumServers(n int) Option

func WithPIDFile

func WithPIDFile(path string) Option

func WithReloadWaitDuration

func WithReloadWaitDuration(d time.Duration) Option

func WithWaitDuration

func WithWaitDuration(d time.Duration) Option

type Service

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

func NewService

func NewService(opts ...Option) *Service

func (*Service) DecConnCount

func (s *Service) DecConnCount(ctx context.Context)

DecConnCount is the same as IncConnCount, but you need to call it when the hijacked connection is stopped

func (*Service) IncConnCount

func (s *Service) IncConnCount(ctx context.Context)

IncConnCount has to be used when connections are hijacked because in this case http.Server doesn't track these connection anymore, but you may not want to cut them abrutely.

func (*Service) ListenAndServe

func (s *Service) ListenAndServe(ctx context.Context, proto string, addr string, handler http.Handler) error

func (*Service) ListenAndServeTLS

func (s *Service) ListenAndServeTLS(ctx context.Context, proto string, addr string, handler http.Handler, tlsConfig *tls.Config) error