workerpool

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 5, 2017 License: MIT Imports: 3 Imported by: 2

README

Vardius - worker-pool

Build Status Go Report Card codecov license

Go simple async worker pool.

ABOUT

Contributors:

Want to contribute ? Feel free to send pull requests!

Have problems, bugs, feature ideas? We are using the github issue tracker to manage them.

HOW TO USE

  1. GoDoc

Basic example

package main

import (
    "fmt"
    "sync"

    "github.com/vardius/worker-pool"
)

func main() {
    var wg sync.WaitGroup

    poolSize: 1
    jobsAmount: 3
    workersAmount: 2

    // create new pool
    pool := workerpool.New(poolSize)
    out := make(chan int, jobsAmount)

    pool.Start(workersAmount, func(i int) {
        defer wg.Done()
        out <- i
    })

    wg.Add(workersAmount)

    for i := 0; i < jobsAmount; i++ {
        pool.Delegate(i)
    }

    go func() {
        // stop all workers after jobs are done
        wg.Wait()
        close(out)
        pool.Stop()
    }()

    sum := 0
    for n := range out {
        sum += n
    }

    fmt.Println(sum)
}

License

This package is released under the MIT license. See the complete license in the package:

LICENSE

Documentation

Overview

Package workerpool provides simple async workers

Basic example:

package main

import (
	"fmt"
	"sync"

	"github.com/vardius/worker-pool"
)

func main() {
	var wg sync.WaitGroup

	poolSize: 1
	jobsAmount: 3
	workersAmount: 2

	// create new pool
	pool := workerpool.New(poolSize)
	out := make(chan int, jobsAmount)

	pool.Start(workersAmount, func(i int) {
		defer wg.Done()
		out <- i
	})

	wg.Add(workersAmount)

	for i := 0; i < jobsAmount; i++ {
		pool.Delegate(i)
	}

	go func() {
		// stop all workers after jobs are done
		wg.Wait()
		close(out)
		pool.Stop()
	}()

	sum := 0
	for n := range out {
		sum += n
	}

	fmt.Println(sum)
}

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Pool

type Pool interface {
	Delegate(args ...interface{})
	Start(maxWorkers int, fn interface{}) error
	Stop()
}

Pool implements worker pool

func New

func New(queueLength int) Pool

New creates new worker pool with a given job queue length

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL