draining

package

v0.0.0-...-e560ebb Latest Latest Go to latest Published: Jul 13, 2021 License: BSD-3-Clause Imports: 1 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

chromium.googlesource.com/infra/infra

Documentation ¶

Overview ¶

Package draining implements a draining state on contexts.

Index ¶

func C(ctx context.Context) <-chan struct{}
func IsDraining(ctx context.Context) bool
func WithDraining(ctx context.Context) (context.Context, func())

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func C ¶

func C(ctx context.Context) <-chan struct{}

C returns a channel associated with the draining context. The channel is closed when the context is draining. If the context is not set up for draining, return nil (nil channels block forever on receive).

func IsDraining ¶

func IsDraining(ctx context.Context) bool

IsDraining checks whether the context is draining. If the context is not set up for draining, return false.

func WithDraining ¶

func WithDraining(ctx context.Context) (context.Context, func())

WithDraining returns a context that can be marked as draining by calling the returned function.

Types ¶

This section is empty.

Source Files ¶

View all Source files

draining.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL