scheduler

Documentation

Index

• type ProcessFunc
• type ScheduledWorkQueue
  • func NewScheduledWorkQueue[T comparable](clock clock.Clock, processFunc ProcessFunc[T]) ScheduledWorkQueue[T]

Types

type ProcessFunc

type ProcessFunc[T comparable] func(T)

ProcessFunc is a function to process an item in the work queue.

type ScheduledWorkQueue

type ScheduledWorkQueue[T comparable] interface {
	// Add will add an item to this queue, executing the ProcessFunc after the
	// Duration has come (since the time Add was called). If an existing Timer
	// for obj already exists, the previous timer will be cancelled.
	Add(T, time.Duration)

	// Forget will cancel the timer for the given object, if the timer exists.
	Forget(T)
}

ScheduledWorkQueue is an interface to describe a queue that will execute the given ProcessFunc with the object given to Add once the time.Duration is up, since the time of calling Add.

func NewScheduledWorkQueue

func NewScheduledWorkQueue[T comparable](clock clock.Clock, processFunc ProcessFunc[T]) ScheduledWorkQueue[T]

NewScheduledWorkQueue will create a new workqueue with the given processFunc