async_task

package module

v1.0.1 Latest Latest Go to latest Published: Nov 2, 2020 License: MIT Imports: 3 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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

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

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

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

This project is following The MIT.

This section is empty.

This section is empty.

This section is empty.

type ErrorHandler func(error)

It is executed if error is raised

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

External interface

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

NewAsyncTask creates an object implemented Keeper interface

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

type OptionFunc func(k *keeper)

func WithErrorHandlerOption(f ErrorHandler) OptionFunc

WithErrorHandlerOption returns a function which sets handler for the error.

func WithQueueSizeOption(size int) OptionFunc

WithQueueSizeOption returns a function which sets queue size.

func WithTimeoutOption(timeout time.Duration) OptionFunc

WithTimeoutOption returns a function which set timeout.

func WithWorkerSizeOption(size int) OptionFunc

WithWorkerSizeOption returns a function which sets worker size.

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

It is the task to dealt with