graceful

package
v1.13.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 1, 2021 License: MIT Imports: 21 Imported by: 32

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrShutdown  = fmt.Errorf("Graceful Manager called Shutdown")
	ErrHammer    = fmt.Errorf("Graceful Manager called Hammer")
	ErrTerminate = fmt.Errorf("Graceful Manager called Terminate")
)

Errors for context.Err()

View Source 
var (
	// DefaultReadTimeOut default read timeout
	DefaultReadTimeOut time.Duration
	// DefaultWriteTimeOut default write timeout
	DefaultWriteTimeOut time.Duration
	// DefaultMaxHeaderBytes default max header bytes
	DefaultMaxHeaderBytes int
)

Functions

func CloseProvidedListeners 

func CloseProvidedListeners() error

CloseProvidedListeners closes all unused provided listeners.

func GetListener 

func GetListener(network, address string) (net.Listener, error)

GetListener obtains a listener for the local network address. The network must be a stream-oriented network: "tcp", "tcp4", "tcp6", "unix" or "unixpacket". It returns an provided net.Listener for the matching network and address, or creates a new one using net.Listen.

func GetListenerTCP 

func GetListenerTCP(network string, address *net.TCPAddr) (*net.TCPListener, error)

GetListenerTCP announces on the local network address. The network must be: "tcp", "tcp4" or "tcp6". It returns a provided net.Listener for the matching network and address, or creates a new one using net.ListenTCP.

func GetListenerUnix 

func GetListenerUnix(network string, address *net.UnixAddr) (*net.UnixListener, error)

GetListenerUnix announces on the local network address. The network must be: "unix" or "unixpacket". It returns a provided net.Listener for the matching network and address, or creates a new one using net.ListenUnix.

func HTTPListenAndServe 

func HTTPListenAndServe(network, address string, handler http.Handler) error

HTTPListenAndServe listens on the provided network address and then calls Serve to handle requests on incoming connections.

func HTTPListenAndServeTLS 

func HTTPListenAndServeTLS(network, address, certFile, keyFile string, handler http.Handler) error

HTTPListenAndServeTLS listens on the provided network address and then calls Serve to handle requests on incoming connections.

func HTTPListenAndServeTLSConfig 

func HTTPListenAndServeTLSConfig(network, address string, tlsConfig *tls.Config, handler http.Handler) error

HTTPListenAndServeTLSConfig listens on the provided network address and then calls Serve to handle requests on incoming connections.

func InitManager 

func InitManager(ctx context.Context)

InitManager creates the graceful manager in the provided context

func KillParent 

func KillParent()

KillParent sends the kill signal to the parent process if we are a child

func RestartProcess 

func RestartProcess() (int, error)

RestartProcess starts a new process passing it the active listeners. It doesn't fork, but starts a new process using the same environment and arguments as when it was originally started. This allows for a newly deployed binary to be started. It returns the pid of the newly started process when successful.

Types

type CallbackWithContext 

type CallbackWithContext func(ctx context.Context, callback func())

CallbackWithContext is combined runnable and context to watch to see if the caller has finished

type ChannelContext 

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

ChannelContext is a context that wraps a channel and error as a context

func NewChannelContext 

func NewChannelContext(done <-chan struct{}, err error) *ChannelContext

NewChannelContext creates a ChannelContext from a channel and error

func (*ChannelContext) Deadline 

func (ctx *ChannelContext) Deadline() (deadline time.Time, ok bool)

Deadline returns the time when work done on behalf of this context should be canceled. There is no Deadline for a ChannelContext

func (*ChannelContext) Done 

func (ctx *ChannelContext) Done() <-chan struct{}

Done returns the channel provided at the creation of this context. When closed, work done on behalf of this context should be canceled.

func (*ChannelContext) Err 

func (ctx *ChannelContext) Err() error

Err returns nil, if Done is not closed. If Done is closed, Err returns the error provided at the creation of this context

func (*ChannelContext) Value 

func (ctx *ChannelContext) Value(key interface{}) interface{}

Value returns nil for all calls as no values are or can be associated with this context

type Manager 

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

Manager manages the graceful shutdown process

func GetManager 

func GetManager() *Manager

GetManager returns the Manager

func (*Manager) Deadline 

func (g *Manager) Deadline() (deadline time.Time, ok bool)

Deadline returns nil as there is no fixed Deadline for the manager, it allows the manager to be viewed as a context.Context

func (*Manager) DoGracefulRestart added in v1.12.0 

func (g *Manager) DoGracefulRestart()

DoGracefulRestart causes a graceful restart

func (*Manager) DoGracefulShutdown added in v1.12.0 

func (g *Manager) DoGracefulShutdown()

DoGracefulShutdown causes a graceful shutdown

func (*Manager) DoImmediateHammer added in v1.12.0 

func (g *Manager) DoImmediateHammer()

DoImmediateHammer causes an immediate hammer

func (*Manager) Done 

func (g *Manager) Done() <-chan struct{}

Done allows the manager to be viewed as a context.Context, it returns a channel that is closed when the server is finished terminating

func (*Manager) Err 

func (g *Manager) Err() error

Err allows the manager to be viewed as a context.Context done at Terminate, it returns ErrTerminate

func (*Manager) HammerContext 

func (g *Manager) HammerContext() context.Context

HammerContext returns a context.Context that is Done at hammer Callers using this context should ensure that they are registered as a running server in order that they are waited for.

func (*Manager) InformCleanup 

func (g *Manager) InformCleanup()

InformCleanup tells the cleanup wait group that we have either taken a listener or will not be taking a listener

func (*Manager) IsChild 

func (g *Manager) IsChild() bool

IsChild returns if the current process is a child of previous Gitea process

func (*Manager) IsHammer 

func (g *Manager) IsHammer() <-chan struct{}

IsHammer returns a channel which will be closed at hammer The order of closure is IsShutdown, IsHammer (potentially), IsTerminate Servers running within the running server wait group should respond to IsHammer if not shutdown already

func (*Manager) IsShutdown 

func (g *Manager) IsShutdown() <-chan struct{}

IsShutdown returns a channel which will be closed at shutdown. The order of closure is IsShutdown, IsHammer (potentially), IsTerminate

func (*Manager) IsTerminate 

func (g *Manager) IsTerminate() <-chan struct{}

IsTerminate returns a channel which will be closed at terminate The order of closure is IsShutdown, IsHammer (potentially), IsTerminate IsTerminate will only close once all running servers have stopped

func (*Manager) RegisterServer 

func (g *Manager) RegisterServer()

RegisterServer registers the running of a listening server, in the case of unix this means that the parent process can now die. Any call to RegisterServer must be matched by a call to ServerDone

func (*Manager) RunAtHammer 

func (g *Manager) RunAtHammer(ctx context.Context, hammer func())

RunAtHammer creates a go-routine to run the provided function at shutdown

func (*Manager) RunAtShutdown 

func (g *Manager) RunAtShutdown(ctx context.Context, shutdown func())

RunAtShutdown creates a go-routine to run the provided function at shutdown

func (*Manager) RunAtTerminate 

func (g *Manager) RunAtTerminate(ctx context.Context, terminate func())

RunAtTerminate adds to the terminate wait group and creates a go-routine to run the provided function at termination

func (*Manager) RunWithShutdownChan 

func (g *Manager) RunWithShutdownChan(run RunnableWithShutdownChan)

RunWithShutdownChan takes a function that has channel to watch for shutdown and atTerminate callbacks After the atShutdown channel is closed, the main function must return once shutdown is complete. (Optionally IsHammer may be waited for instead however, this should be avoided if possible.) The callback function provided to atTerminate must return once termination is complete. Please note that use of the atTerminate function will create a go-routine that will wait till terminate - users must therefore be careful to only call this as necessary.

func (*Manager) RunWithShutdownContext 

func (g *Manager) RunWithShutdownContext(run func(context.Context))

RunWithShutdownContext takes a function that has a context to watch for shutdown. After the provided context is Done(), the main function must return once shutdown is complete. (Optionally the HammerContext may be obtained and waited for however, this should be avoided if possible.)

func (*Manager) RunWithShutdownFns 

func (g *Manager) RunWithShutdownFns(run RunnableWithShutdownFns)

RunWithShutdownFns takes a function that has both atShutdown and atTerminate callbacks After the callback to atShutdown is called and is complete, the main function must return. Similarly the callback function provided to atTerminate must return once termination is complete. Please note that use of the atShutdown and atTerminate callbacks will create go-routines that will wait till their respective signals - users must therefore be careful to only call these as necessary. If run is not expected to run indefinitely RunWithShutdownChan is likely to be more appropriate.

func (*Manager) ServerDone 

func (g *Manager) ServerDone()

ServerDone declares a running server done and subtracts one from the running server wait group. Users probably do not want to call this and should use one of the RunWithShutdown* functions

func (*Manager) ShutdownContext 

func (g *Manager) ShutdownContext() context.Context

ShutdownContext returns a context.Context that is Done at shutdown Callers using this context should ensure that they are registered as a running server in order that they are waited for.

func (*Manager) TerminateContext 

func (g *Manager) TerminateContext() context.Context

TerminateContext returns a context.Context that is Done at terminate Callers using this context should ensure that they are registered as a terminating server in order that they are waited for.

func (*Manager) Value 

func (g *Manager) Value(key interface{}) interface{}

Value allows the manager to be viewed as a context.Context done at Terminate, it has no values

func (*Manager) WaitForServers 

func (g *Manager) WaitForServers()

WaitForServers waits for all running servers to finish. Users should probably instead use AtTerminate or IsTerminate

func (*Manager) WaitForTerminate 

func (g *Manager) WaitForTerminate()

WaitForTerminate waits for all terminating actions to finish. Only the main go-routine should use this

type RunnableWithShutdownChan 

type RunnableWithShutdownChan func(atShutdown <-chan struct{}, atTerminate CallbackWithContext)

RunnableWithShutdownChan is a runnable with functions to run at shutdown and terminate. After the atShutdown channel is closed, the main function must return once shutdown is complete. (Optionally IsHammer may be waited for instead however, this should be avoided if possible.) The callback function provided to atTerminate must return once termination is complete. Please note that use of the atTerminate function will create a go-routine that will wait till terminate - users must therefore be careful to only call this as necessary.

type RunnableWithShutdownFns 

type RunnableWithShutdownFns func(atShutdown, atTerminate func(context.Context, func()))

RunnableWithShutdownFns is a runnable with functions to run at shutdown and terminate After the callback to atShutdown is called and is complete, the main function must return. Similarly the callback function provided to atTerminate must return once termination is complete. Please note that use of the atShutdown and atTerminate callbacks will create go-routines that will wait till their respective signals - users must therefore be careful to only call these as necessary. If run is not expected to run indefinitely RunWithShutdownChan is likely to be more appropriate.

type ServeFunction 

type ServeFunction = func(net.Listener) error

ServeFunction represents a listen.Accept loop

type Server 

type Server struct {
	BeforeBegin func(network, address string)
	OnShutdown  func()
	// contains filtered or unexported fields
}

Server represents our graceful server

func NewServer 

func NewServer(network, address string) *Server

NewServer creates a server on network at provided address

func (*Server) ListenAndServe 

func (srv *Server) ListenAndServe(serve ServeFunction) error

ListenAndServe listens on the provided network address and then calls Serve to handle requests on incoming connections.

func (*Server) ListenAndServeTLS 

func (srv *Server) ListenAndServeTLS(certFile, keyFile string, serve ServeFunction) error

ListenAndServeTLS listens on the provided network address and then calls Serve to handle requests on incoming TLS connections.

Filenames containing a certificate and matching private key for the server must be provided. If the certificate is signed by a certificate authority, the certFile should be the concatenation of the server's certificate followed by the CA's certificate.

func (*Server) ListenAndServeTLSConfig 

func (srv *Server) ListenAndServeTLSConfig(tlsConfig *tls.Config, serve ServeFunction) error

ListenAndServeTLSConfig listens on the provided network address and then calls Serve to handle requests on incoming TLS connections.

func (*Server) Serve 

func (srv *Server) Serve(serve ServeFunction) error

Serve accepts incoming HTTP connections on the wrapped listener l, creating a new service goroutine for each. The service goroutines read requests and then call handler to reply to them. Handler is typically nil, in which case the DefaultServeMux is used.

In addition to the standard Serve behaviour each connection is added to a sync.Waitgroup so that all outstanding connections can be served before shutting down the server.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.