ants/pool_func.go

234 lines
5.8 KiB
Go
Raw Normal View History

// MIT License
// Copyright (c) 2018 Andy Pan
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
package ants
import (
"sync"
"sync/atomic"
2018-07-06 09:39:24 +03:00
"time"
)
type pf func(interface{})
// PoolWithFunc accept the tasks from client,it limits the total
// of goroutines to a given number by recycling goroutines.
type PoolWithFunc struct {
// capacity of the pool.
capacity int32
// running is the number of the currently running goroutines.
running int32
2018-07-06 09:39:24 +03:00
// expiryDuration set the expired time (second) of every worker.
expiryDuration time.Duration
// workers is a slice that store the available workers.
workers []*WorkerWithFunc
// release is used to notice the pool to closed itself.
release chan sig
2018-08-04 06:12:06 +03:00
// lock for synchronous operation.
lock sync.Mutex
2018-09-30 04:41:47 +03:00
// cond for waiting to get a idle worker
2018-09-29 05:19:17 +03:00
cond *sync.Cond
2018-09-30 04:41:47 +03:00
2018-08-04 06:12:06 +03:00
// pf is the function for processing tasks.
poolFunc pf
2018-05-24 13:30:58 +03:00
once sync.Once
}
2018-08-04 06:12:06 +03:00
// clear expired workers periodically.
2018-07-21 13:50:18 +03:00
func (p *PoolWithFunc) periodicallyPurge() {
2018-07-08 05:38:40 +03:00
heartbeat := time.NewTicker(p.expiryDuration)
2018-07-24 17:30:37 +03:00
for range heartbeat.C {
currentTime := time.Now()
p.lock.Lock()
idleWorkers := p.workers
if len(idleWorkers) == 0 && p.Running() == 0 && len(p.release) > 0 {
2018-07-06 09:39:24 +03:00
p.lock.Unlock()
2018-07-24 17:30:37 +03:00
return
}
2018-08-29 04:53:07 +03:00
n := -1
2018-07-24 17:30:37 +03:00
for i, w := range idleWorkers {
if currentTime.Sub(w.recycleTime) <= p.expiryDuration {
break
}
n = i
w.args <- nil
idleWorkers[i] = nil
2018-07-06 09:39:24 +03:00
}
2018-08-29 04:53:07 +03:00
if n > -1 {
2018-08-29 05:02:41 +03:00
if n >= len(idleWorkers)-1 {
2018-08-08 13:08:06 +03:00
p.workers = idleWorkers[:0]
} else {
2018-08-29 04:53:07 +03:00
p.workers = idleWorkers[n+1:]
2018-08-08 13:08:06 +03:00
}
2018-07-24 17:30:37 +03:00
}
p.lock.Unlock()
}
2018-07-06 09:39:24 +03:00
}
2018-08-04 06:12:06 +03:00
// NewPoolWithFunc generates an instance of ants pool with a specific function.
func NewPoolWithFunc(size int, f pf) (*PoolWithFunc, error) {
return NewTimingPoolWithFunc(size, DefaultCleanIntervalTime, f)
}
2018-08-04 06:12:06 +03:00
// NewTimingPoolWithFunc generates an instance of ants pool with a specific function and a custom timed task.
func NewTimingPoolWithFunc(size, expiry int, f pf) (*PoolWithFunc, error) {
if size <= 0 {
2018-07-12 19:11:42 +03:00
return nil, ErrInvalidPoolSize
}
if expiry <= 0 {
return nil, ErrInvalidPoolExpiry
}
p := &PoolWithFunc{
2018-07-06 15:24:47 +03:00
capacity: int32(size),
release: make(chan sig, 1),
2018-07-06 10:00:30 +03:00
expiryDuration: time.Duration(expiry) * time.Second,
2018-07-06 15:24:47 +03:00
poolFunc: f,
}
2018-09-29 05:19:17 +03:00
p.cond = sync.NewCond(&p.lock)
2018-07-24 17:30:37 +03:00
go p.periodicallyPurge()
return p, nil
}
//-------------------------------------------------------------------------
2018-08-04 06:12:06 +03:00
// Serve submits a task to pool.
func (p *PoolWithFunc) Serve(args interface{}) error {
2018-05-24 13:30:58 +03:00
if len(p.release) > 0 {
return ErrPoolClosed
}
2018-08-03 16:15:11 +03:00
p.getWorker().args <- args
return nil
}
2018-08-04 06:12:06 +03:00
// Running returns the number of the currently running goroutines.
2018-05-22 07:01:00 +03:00
func (p *PoolWithFunc) Running() int {
return int(atomic.LoadInt32(&p.running))
}
2018-08-04 06:12:06 +03:00
// Free returns a available goroutines to work.
2018-05-22 07:01:00 +03:00
func (p *PoolWithFunc) Free() int {
return int(atomic.LoadInt32(&p.capacity) - atomic.LoadInt32(&p.running))
}
2018-08-04 06:12:06 +03:00
// Cap returns the capacity of this pool.
2018-05-22 07:01:00 +03:00
func (p *PoolWithFunc) Cap() int {
return int(atomic.LoadInt32(&p.capacity))
}
2018-08-04 06:12:06 +03:00
// ReSize change the capacity of this pool.
2018-05-22 07:01:00 +03:00
func (p *PoolWithFunc) ReSize(size int) {
2018-07-15 21:33:43 +03:00
if size == p.Cap() {
return
2018-07-15 21:43:38 +03:00
}
atomic.StoreInt32(&p.capacity, int32(size))
diff := p.Running() - size
for i := 0; i < diff; i++ {
p.getWorker().args <- nil
}
}
2018-08-04 06:12:06 +03:00
// Release Closed this pool.
2018-07-15 20:21:23 +03:00
func (p *PoolWithFunc) Release() error {
p.once.Do(func() {
p.release <- sig{}
p.lock.Lock()
idleWorkers := p.workers
for i, w := range idleWorkers {
w.args <- nil
idleWorkers[i] = nil
}
p.workers = nil
p.lock.Unlock()
})
return nil
}
//-------------------------------------------------------------------------
2018-08-04 06:12:06 +03:00
// incRunning increases the number of the currently running goroutines.
2018-08-03 14:28:46 +03:00
func (p *PoolWithFunc) incRunning() {
2018-07-31 06:05:05 +03:00
atomic.AddInt32(&p.running, 1)
}
2018-08-04 06:12:06 +03:00
// decRunning decreases the number of the currently running goroutines.
2018-08-03 14:28:46 +03:00
func (p *PoolWithFunc) decRunning() {
2018-07-31 06:05:05 +03:00
atomic.AddInt32(&p.running, -1)
}
// getWorker returns a available worker to run the tasks.
2018-05-22 07:01:00 +03:00
func (p *PoolWithFunc) getWorker() *WorkerWithFunc {
var w *WorkerWithFunc
waiting := false
p.lock.Lock()
2018-09-29 05:19:17 +03:00
defer p.lock.Unlock()
2018-07-15 20:21:23 +03:00
idleWorkers := p.workers
n := len(idleWorkers) - 1
if n < 0 {
waiting = p.Running() >= p.Cap()
} else {
2018-07-15 20:21:23 +03:00
w = idleWorkers[n]
idleWorkers[n] = nil
p.workers = idleWorkers[:n]
}
if waiting {
2018-09-30 04:40:33 +03:00
for {
2018-09-29 09:58:58 +03:00
p.cond.Wait()
l := len(p.workers) - 1
2018-09-30 04:40:33 +03:00
if l < 0 {
2018-09-29 09:58:58 +03:00
continue
}
w = p.workers[l]
p.workers[l] = nil
p.workers = p.workers[:l]
break
}
2018-05-22 11:20:01 +03:00
} else if w == nil {
2018-05-24 14:27:54 +03:00
w = &WorkerWithFunc{
pool: p,
2018-07-24 17:30:37 +03:00
args: make(chan interface{}, 1),
}
2018-05-22 19:46:43 +03:00
w.run()
2018-08-03 14:28:46 +03:00
p.incRunning()
}
return w
}
// putWorker puts a worker back into free pool, recycling the goroutines.
2018-05-22 07:01:00 +03:00
func (p *PoolWithFunc) putWorker(worker *WorkerWithFunc) {
2018-07-06 09:39:24 +03:00
worker.recycleTime = time.Now()
p.lock.Lock()
p.workers = append(p.workers, worker)
2018-12-01 13:41:42 +03:00
// notify there is available worker
2018-09-29 05:19:17 +03:00
p.cond.Signal()
p.lock.Unlock()
}