slotctx

Documentation

Index

• type PrioritySlot
  • func NewPriority() *PrioritySlot
  • func (s *PrioritySlot) Shutdown()
  • func (s *PrioritySlot) Stop()
  • func (s *PrioritySlot) Use(ctx context.Context, priority int) context.Context
• type Slot
  • func New() *Slot
  • func (s *Slot) Stop()
  • func (s *Slot) Use(ctx context.Context) context.Context

Types

type PrioritySlot

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

PrioritySlot is a slot in which only one context can thrive.

func NewPriority

func NewPriority() *PrioritySlot

func (*PrioritySlot) Shutdown

func (s *PrioritySlot) Shutdown()

Shutdown disables the slot forever.

func (*PrioritySlot) Stop

func (s *PrioritySlot) Stop()

Stop cancels the running task if there is one.

func (*PrioritySlot) Use

func (s *PrioritySlot) Use(ctx context.Context, priority int) context.Context

Use derives a new context. Whichever of the argument and the incumbent are lower priority is canceled. In a tie the incumbent is canceled.

type Slot

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

Slot is a slot in which only one context can thrive.

func New

func New() *Slot

func (*Slot) Stop

func (s *Slot) Stop()

Stop cancels the running task if there is one.

func (*Slot) Use

func (s *Slot) Use(ctx context.Context) context.Context

Use derives a context bound to the slot. Cancels any context previously bound to the slot.