opio

Documentation

Index

• Variables
• func BlockOnInterrupts(signals ...os.Signal)
• func BlockOnInterruptsContext(ctx context.Context, signals ...os.Signal)
• func CancelOnInterrupt(ctx context.Context) context.Context
• func WithBlocker(ctx context.Context, fn BlockFn) context.Context
• func WithInterruptBlocker(ctx context.Context) context.Context
• type BlockFn
  • func BlockerFromContext(ctx context.Context) BlockFn

Variables

var DefaultInterruptSignals = []os.Signal{
	os.Interrupt,
	os.Kill,
	syscall.SIGTERM,
	syscall.SIGQUIT,
}

DefaultInterruptSignals is a set of default interrupt signals.

Functions

func BlockOnInterrupts

func BlockOnInterrupts(signals ...os.Signal)

BlockOnInterrupts blocks until a SIGTERM is received. Passing in signals will override the default signals.

func BlockOnInterruptsContext

func BlockOnInterruptsContext(ctx context.Context, signals ...os.Signal)

BlockOnInterruptsContext blocks until a SIGTERM is received. Passing in signals will override the default signals. The function will stop blocking if the context is closed.

func CancelOnInterrupt

func CancelOnInterrupt(ctx context.Context) context.Context

CancelOnInterrupt cancels the given context on interrupt. If a BlockFn is attached to the context, this is used as interrupt-blocking. If not, then the context blocks on a manually handled interrupt signal.

func WithBlocker

func WithBlocker(ctx context.Context, fn BlockFn) context.Context

WithBlocker overrides the interrupt blocker value, e.g. to insert a block-function for testing CLI shutdown without actual process signals.

func WithInterruptBlocker

func WithInterruptBlocker(ctx context.Context) context.Context

WithInterruptBlocker attaches an interrupt handler to the context, which continues to receive signals after every block. This helps functions block on individual consecutive interrupts.

Types

type BlockFn

type BlockFn func(ctx context.Context)

BlockFn simply blocks until the implementation of the blocker interrupts it, or till the given context is cancelled.

func BlockerFromContext

func BlockerFromContext(ctx context.Context) BlockFn

BlockerFromContext returns a BlockFn that blocks on interrupts when called.