xparallelizer

Documentation

Index

• type Group
  • func NewGroup(options ...GroupOption) *Group
  • func (g *Group) Add(function func()) error
  • func (g *Group) Close()
  • func (g *Group) Wait(options ...WaitOption) error
• type GroupOption
  • func WithJobQueueSize(size int) GroupOption
  • func WithPoolSize(size int) GroupOption
• type GroupOptions
• type WaitOption
  • func WithContext(ctx context.Context) WaitOption
• type WaitOptions

Types

type Group

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

Group a group of workers executing functions concurrently

func NewGroup

func NewGroup(options ...GroupOption) *Group

NewGroup create a new group of workers

func (*Group) Add

func (g *Group) Add(function func()) error

Add adds function to queue of jobs to execute

func (*Group) Close

func (g *Group) Close()

Close closes resources

func (*Group) Wait

func (g *Group) Wait(options ...WaitOption) error

Wait waits until workers finished the jobs in the queue

type GroupOption

type GroupOption func(*GroupOptions)

GroupOption an option for Groups

func WithJobQueueSize

func WithJobQueueSize(size int) GroupOption

WithJobQueueSize sets job size

func WithPoolSize

func WithPoolSize(size int) GroupOption

WithPoolSize sets pool size

type GroupOptions

type GroupOptions struct {
	PoolSize     int
	JobQueueSize int
}

GroupOptions configuration for the Group

type WaitOption

type WaitOption func(*WaitOptions)

WaitOption an option for Waiting

func WithContext

func WithContext(ctx context.Context) WaitOption

WithContext sets context

type WaitOptions

type WaitOptions struct {
	Context context.Context
}

WaitOptions configuration for the Wait