Skip to content

clifecycle: add SetStopTimeout to make the shutdown grace period configurable #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ironAtom wants to merge 1 commit into
base: main
Choose a base branch
from
Open

clifecycle: add SetStopTimeout to make the shutdown grace period configurable #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions clifecycle/lifecycle.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,18 @@ func (lc *Lifecycle) OnStop(fn func(ctx context.Context) error) {
lc.onStop = append(lc.onStop, fn)
}

// SetStopTimeout overrides how long Stop waits for background goroutines to
// complete before running cleanup funcs and canceling the lifecycle context.
// Defaults to 30 seconds. Apps whose background work is bounded by a longer
// deadline should set this above that deadline so graceful shutdown does not
// force-quit work that is about to finish.
//
// Call this during app initialization, before Stop may run; it must not be
// called concurrently with Stop.
func (lc *Lifecycle) SetStopTimeout(d time.Duration) {
lc.stopTimeout = d
}

// Go starts a background goroutine that will be waited for during shutdown.
// The goroutine should return when the context is done or when its work is complete.
//
Expand Down