task

Documentation

Index

• func IsCancelled(ctx context.Context) bool
• func NewCancellableContext(timeout time.Duration) (ctx context.Context, cancel context.CancelFunc)
• func NewCancellableContextWithLog(maxCancelTimeout time.Duration, logLevel string, fields logrus.Fields) (ctx context.Context, cancel context.CancelFunc, log *logrus.Entry)
• func Sleep(ctx context.Context, duration time.Duration) (wasInterrupted bool)
• type Runnable
• type Runner
• type RunnerRepository
  • func NewRunnerRepository() *RunnerRepository
  • func (repo *RunnerRepository) Start(ctx context.Context, runnable Runnable, params ...interface{}) *Task
  • func (repo *RunnerRepository) WaitUntilAllDone()
• type SignalHandler
  • func (sh *SignalHandler) Run(ctx context.Context, params ...interface{}) error
• type Task

Functions

func IsCancelled

func IsCancelled(ctx context.Context) bool

IsCancelled returns true if the context is cancelled, false otherwise, without blocking

func NewCancellableContext

func NewCancellableContext(timeout time.Duration) (ctx context.Context, cancel context.CancelFunc)

NewCancellableContext creates a cancellable context that handles interrupt events timeout is the time after which the process will exit if not terminated after the context is cancelled

func NewCancellableContextWithLog

func NewCancellableContextWithLog(maxCancelTimeout time.Duration, logLevel string, fields logrus.Fields) (ctx context.Context, cancel context.CancelFunc, log *logrus.Entry)

NewCancellableContextWithLog returns a cancellable context that handles interrupt signal. maxCancelTimeout is the timeout after which the process is exited if not already terminated logLevel : logrus log levels

func Sleep

func Sleep(ctx context.Context, duration time.Duration) (wasInterrupted bool)

Sleep is an interruptible time.Sleep version It returns true if it was interrupted by context cancellation, false otherwise

Types

type Runnable

type Runnable interface {
	Run(ctx context.Context, params ...interface{}) error
}

Runnable implements a Run function

type Runner

type Runner interface {
	Start(ctx context.Context, runnable Runnable, params ...interface{}) *Task
	WaitUntilAllDone()
}

type RunnerRepository

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

func NewRunnerRepository

func NewRunnerRepository() *RunnerRepository

func (*RunnerRepository) Start

func (repo *RunnerRepository) Start(ctx context.Context, runnable Runnable, params ...interface{}) *Task

func (*RunnerRepository) WaitUntilAllDone

func (repo *RunnerRepository) WaitUntilAllDone()

type SignalHandler

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

SignalHandler allows to cancel a cancellable context on os interrupt signal reception

func (*SignalHandler) Run

func (sh *SignalHandler) Run(ctx context.Context, params ...interface{}) error

Run takes a context and a context.CancelFunc as second parameter. if the third parameter is a time.Duration, the program forces exit after that timeout Wned the process receives an interrupt signal, the cancel function is called. Run is non blocking, it creates a goroutine to catch interrupt signal

type Task

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