🐜🐜🐜 ants is a high-performance and low-cost goroutine pool in Go, inspired by fasthttp./ ants 是一个高性能且低损耗的 goroutine 池。
Go to file
Andy Pan 967b0b04e2 optimization 2018-05-22 12:01:00 +08:00
examples update MIT license info 2018-05-20 23:57:48 +08:00
LICENSE Initial commit 2018-05-19 09:13:39 +08:00
README.md Merge branch 'develop' 2018-05-21 12:48:03 +08:00
ants.go update go test and benchmarks test 2018-05-22 11:17:19 +08:00
ants_benchmark_test.go optimization 2018-05-22 12:01:00 +08:00
ants_benchmarks.png update the readme 2018-05-20 23:27:20 +08:00
ants_logo.png init proj 2018-05-19 09:15:54 +08:00
ants_test.go optimization 2018-05-22 12:01:00 +08:00
pool.go format the some comments 2018-05-21 10:37:03 +08:00
pool_func.go optimization 2018-05-22 12:01:00 +08:00
worker.go format the some comments 2018-05-21 10:37:03 +08:00
worker_func.go optimization 2018-05-22 12:01:00 +08:00

README.md

ants

A goroutine pool for Go

godoc for panjf2000/ants goreportcard for panjf2000/ants License

Package ants implements a fixed goroutine pool for managing and recycling a massive number of goroutines, allowing developers to limit the number of goroutines that created by your concurrent programs.

Features:

  • Automatically managing and recycling a massive number of goroutines.
  • Friendly interfaces: submitting tasks, getting the number of running goroutines, readjusting capacity of pool dynamically, closing pool.
  • Efficient in memory usage and it even achieves higher performance than unlimited goroutines in golang.

How to install

go get -u github.com/panjf2000/ants

Or, using glide:

glide get github.com/panjf2000/ants

How to use

If your program will generate a massive number of goroutines and you don't want them to consume a vast amount of memory, with ants, all you need to do is to import ants package and submit all your tasks to the default limited pool created when ants was imported:

package main

import (
	"fmt"
	"github.com/panjf2000/ants"
	"sync"
)

func myFunc() {
	fmt.Println("Hello World!")
}

func main() {
	runTimes := 10000
	var wg sync.WaitGroup
	// submit all your tasks to ants pool
	for i := 0; i < runTimes; i++ {
		wg.Add(1)
		ants.Push(func() {
			myFunc()
			wg.Done()
		})
	}
	wg.Wait()
	fmt.Println("finish all tasks!")
}

Submit tasks

Tasks can be submitted by calling ants.Push(func())

ants.Push(func() {})

Custom limited pool

Ants also supports custom limited pool. You can use the NewPool method to create a pool with the given capacity, as following:

// set 10000 the size of goroutine pool
p, _ := ants.NewPool(10000)
// submit a task
p.Push(func() {})

Readjusting pool capacity

You can change ants pool capacity at any time with ReSize(int):

pool.ReSize(1000) // Readjust its capacity to 1000
pool.ReSize(100000) // Readjust its capacity to 100000

Don't worry about the synchronous problems in this case, this method is thread-safe.

About sequence

All the tasks submitted to ants pool will not be guaranteed to be processed in order, because those tasks distribute among a series of concurrent workers, thus those tasks are processed concurrently.

Benchmarks

In that benchmark-picture, the first and second benchmarks performed test with 100w tasks and the rest of benchmarks performed test with 1000w tasks, both unlimited goroutines and ants pool, and the capacity of this ants goroutine-pool was limited to 5w.

  • BenchmarkGoroutine-4 represent the benchmarks with unlimited goroutines in golang.

  • BenchmarkPoolGroutine-4 represent the benchmarks with a ants pool.

The test data above is a basic benchmark and the more detailed benchmarks will be uploaded later.