draining

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())

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.