task

Documentation

Index

• type GoroutineRunner
  • func NewGoroutineRunner() *GoroutineRunner
  • func (*GoroutineRunner) RunTask(ctx context.Context, runnable Runnable) error
• type Runnable
• type Runner
• type SynchronousRunner
  • func NewSynchronousRunner() *SynchronousRunner
  • func (*SynchronousRunner) RunTask(ctx context.Context, runnable Runnable) error

Types

type GoroutineRunner

type GoroutineRunner struct {
}

GoroutineRunner is an implementation of Runner that uses goroutines.

func NewGoroutineRunner

func NewGoroutineRunner() *GoroutineRunner

NewGoroutineRunner creates a new GoroutineRunner instance.

func (*GoroutineRunner) RunTask

func (*GoroutineRunner) RunTask(ctx context.Context, runnable Runnable) error

type Runnable

type Runnable func(context.Context) error

Runnable defines a task that can be ran.

type Runner

type Runner interface {
	// RunTask runs a given task.
	RunTask(ctx context.Context, runnable Runnable) error
}

Runner defines a means of running tasks. This is intended to run tasks with a finite lifetime. For any tasks that should run for the duration of an application, consider using a conventional goroutine.

type SynchronousRunner

type SynchronousRunner struct {
}

SynchronousRunner is a synchronous implementation of Runner, executing the tasks as blocking units of work.

func NewSynchronousRunner

func NewSynchronousRunner() *SynchronousRunner

NewSynchronousRunner creates a new instance of SynchronousRunner.

func (*SynchronousRunner) RunTask

func (*SynchronousRunner) RunTask(ctx context.Context, runnable Runnable) error