README
¶
grpool
Introduction
grpool is a groutine pool which can provide a fixed size of capacity, recycle the stale workers.
Installation
go get -u github.com/POABOB/grpool
How to use
If you want to process a massive number of jobs, you don't need to use the same number of goroutines. It's wasteful to use excessive memory, leading to high consumption.
A Simple Example with Default Pool
package main
import (
"fmt"
"strconv"
"sync"
"sync/atomic"
"github.com/POABOB/grpool"
)
var wg sync.WaitGroup
var count int32 = 0
func main() {
// Use default Pool Will use the math.MaxInt32 of capacity.
pool := grpool.NewDefaultPool()
// Release worker resource
defer pool.Release()
for i := 0; i < 10000; i++ {
wg.Add(1)
_ = pool.Schedule(func() {
printFunc(i)
})
}
wg.Wait()
fmt.Printf("running goroutines: %d\n", pool.Running())
}
func printFunc(i int) {
atomic.AddInt32(&count, 1)
fmt.Println("Hello World! I am worker" + strconv.Itoa(i) + " from goroutine pool.")
wg.Done()
}
Limit the goroutines and pre-alloc it
package main
import (
"fmt"
"strconv"
"sync"
"sync/atomic"
"github.com/POABOB/grpool"
)
var count int32 = 0
var wg sync.WaitGroup
func main() {
// init a capacity of 18 goroutine pool with preallocing the space.
pool, _ := grpool.NewPool(18, grpool.WithPreAlloc(true))
// Release worker resource
defer pool.Release()
for i := 0; i < 10; i++ {
wg.Add(1)
_ = pool.Schedule(func() {
printFunc(i)
})
}
wg.Wait()
fmt.Printf("running goroutines: %d\n", pool.Running())
}
func printFunc(i int) {
atomic.AddInt32(&count, 1)
fmt.Println("Hello World! I am worker" + strconv.Itoa(i) + " from goroutine pool.")
wg.Done()
}
Use non-blocking pool
pool, err := grpool.NewPool(1000, grpool.WithNonblocking(true))
Customize panic handler
func ph(v interface{}) {
// dosomething...
fmt.Printf("[panic occurred]: %v\n", v)
}
pool, err := grpool.NewPool(1000, grpool.WithPanicHandler(ph))
Customize the time interval of clear stale worker
pool, err := grpool.NewPool(1000, grpool.WithExpiryDuration(time.Second * 5))
License
Documentation
¶
Index ¶
Constants ¶
View Source
const ( // 預設 Pool 最大容量 DefaultPoolSize = 10_000_000 // 預設每 1 秒清理一次 Pool DefaultCleanIntervalTime = time.Second )
View Source
const ( // Pool 開啟 OPENED = 0 // Pool 關閉 CLOSED = 1 )
Pool 狀態
Variables ¶
View Source
var ( ErrLackPoolFunc = errors.New("must provide func for pool") ErrInvalidPoolExpiry = errors.New("invalid pool expiry") ErrPoolClosed = errors.New("pool has been closed") ErrPoolOverload = errors.New("too many goroutines blocked or Nonblocking is set") ErrInvalidPreAllocSize = errors.New("can not set up a negative capacity under PreAlloc mode") ErrTimeout = errors.New("operation timed out") )
定義各種錯誤
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option func(opts *Options)
參數設定
func WithNonblocking ¶
若為 true，代表沒有有用的 Worker 時，會直接 ErrPoolOverload
type Options ¶
type Options struct {
// 過期時間: 用於定時清理過期的 Worker (只要太久沒被使用的 Worker 就會被清理)，預設為 1 秒
ExpiryDuration time.Duration
// 是否提前申請空間，大量執行需求中使用
PreAlloc bool
// Nonblocking 用來阻塞任務
// 若設定為 true，就會返回 ErrPoolOverload 錯誤
Nonblocking bool
// 用來處理 worker panic 發生的事件
PanicHandler func(interface{})
// 若設定為 true，Worker 就不會被自動清除
DisableClear bool
}
該設定會被用來引入至 Pool 中
Source Files
Click to show internal directories.
Click to hide internal directories.