async_task

README

go-async-task

go-async-task is a worker which processes tasks(jobs) asynchronously.

Installation

$ go get -u github.com/gjbae1212/go-async-task

Usage

# create worker 
worker, _ := async_task.NewAsyncTask()

# process task asynchronously
_ = worker.AddTask(ctx, task)

LICENSE

This project is following The MIT.

Documentation

Index

• type ErrorHandler
• type Keeper
  • func NewAsyncTask(opts ...Option) (Keeper, error)
• type Option
• type OptionFunc
  • func WithErrorHandlerOption(f ErrorHandler) OptionFunc
  • func WithQueueSizeOption(size int) OptionFunc
  • func WithTimeoutOption(timeout time.Duration) OptionFunc
  • func WithWorkerSizeOption(size int) OptionFunc
• type Task

Types

type ErrorHandler

type ErrorHandler func(error)

It is executed if error is raised

type Keeper

type Keeper interface {
	AddTask(ctx context.Context, task Task) error
	UnProcessedTaskSize() int
}

External interface

func NewAsyncTask

func NewAsyncTask(opts ...Option) (Keeper, error)

NewAsyncTask creates an object implemented Keeper interface

type Option

type Option interface {
	// contains filtered or unexported methods
}

type OptionFunc

type OptionFunc func(k *keeper)

func WithErrorHandlerOption

func WithErrorHandlerOption(f ErrorHandler) OptionFunc

WithErrorHandlerOption returns a function which sets handler for the error.

func WithQueueSizeOption

func WithQueueSizeOption(size int) OptionFunc

WithQueueSizeOption returns a function which sets queue size.

func WithTimeoutOption

func WithTimeoutOption(timeout time.Duration) OptionFunc

WithTimeoutOption returns a function which set timeout.

func WithWorkerSizeOption

func WithWorkerSizeOption(size int) OptionFunc

WithWorkerSizeOption returns a function which sets worker size.

type Task

type Task interface {
	Process(ctx context.Context) error
}

It is the task to dealt with