ants

Documentation

Index

• Constants
• type Middleware
• type Task
• type Wrapper
  • func NewWrapper(pool *ants.Pool, middlewares ...Middleware) *Wrapper
  • func (a *Wrapper) AsyncSubmit(ctx context.Context, task Task) error
  • func (a *Wrapper) Submit(ctx context.Context, task Task, wg *sync.WaitGroup) error

Constants

const (
	PluginsRoot = "ignite.ants.plugins"
)

Types

type Middleware

type Middleware interface {

	// Before method you perform before the task
	Before(ctx context.Context) context.Context

	// After method you perform after the task
	After(ctx context.Context)
}

Middleware interface for task middlewares

type Task

type Task func(ctx context.Context) context.Context

Task interface for tasks

type Wrapper

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

Wrapper

func NewWrapper

func NewWrapper(pool *ants.Pool, middlewares ...Middleware) *Wrapper

NewWrapper generates an instance of giants wrapper.

func (*Wrapper) AsyncSubmit

func (a *Wrapper) AsyncSubmit(ctx context.Context, task Task) error

AsyncSubmit sends a task to ant

func (*Wrapper) Submit

func (a *Wrapper) Submit(ctx context.Context, task Task, wg *sync.WaitGroup) error

Submit sends a task to ant, needs a sync.WaitGroup