2018-05-22 06:26:16 +03:00
|
|
|
// 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 (
|
|
|
|
"math"
|
|
|
|
"sync"
|
|
|
|
"sync/atomic"
|
2018-07-06 09:39:24 +03:00
|
|
|
"time"
|
2018-05-22 06:26:16 +03:00
|
|
|
)
|
|
|
|
|
|
|
|
type pf func(interface{}) error
|
|
|
|
|
2018-05-24 18:43:34 +03:00
|
|
|
// PoolWithFunc accept the tasks from client,it limits the total
|
2018-05-22 06:26:16 +03:00
|
|
|
// 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
|
|
|
|
|
2018-05-23 12:21:39 +03:00
|
|
|
// freeSignal is used to notice pool there are available
|
2018-05-22 06:26:16 +03:00
|
|
|
// workers which can be sent to work.
|
|
|
|
freeSignal chan sig
|
|
|
|
|
|
|
|
// 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-05-24 18:43:34 +03:00
|
|
|
// lock for synchronous operation
|
2018-05-22 06:26:16 +03:00
|
|
|
lock sync.Mutex
|
|
|
|
|
2018-05-24 18:43:34 +03:00
|
|
|
// pf is the function for processing tasks
|
2018-05-22 06:26:16 +03:00
|
|
|
poolFunc pf
|
2018-05-24 13:30:58 +03:00
|
|
|
|
|
|
|
once sync.Once
|
2018-05-22 06:26:16 +03:00
|
|
|
}
|
|
|
|
|
2018-07-06 09:39:24 +03:00
|
|
|
func (p *PoolWithFunc) MonitorAndClear() {
|
|
|
|
go func() {
|
|
|
|
for {
|
|
|
|
time.Sleep(p.expiryDuration)
|
|
|
|
currentTime := time.Now()
|
|
|
|
p.lock.Lock()
|
|
|
|
idleWorkers := p.workers
|
|
|
|
n := 0
|
|
|
|
for i, w := range idleWorkers {
|
|
|
|
if currentTime.Sub(w.recycleTime) <= p.expiryDuration {
|
|
|
|
break
|
|
|
|
}
|
|
|
|
n = i
|
|
|
|
w.stop()
|
|
|
|
idleWorkers[i] = nil
|
|
|
|
}
|
2018-07-06 09:56:59 +03:00
|
|
|
if n > 0 {
|
|
|
|
n += 1
|
|
|
|
p.workers = idleWorkers[n:]
|
|
|
|
}
|
2018-07-06 09:39:24 +03:00
|
|
|
p.lock.Unlock()
|
|
|
|
}
|
|
|
|
}()
|
|
|
|
}
|
|
|
|
|
2018-05-22 06:26:16 +03:00
|
|
|
// NewPoolWithFunc generates a instance of ants pool with a specific function.
|
2018-07-06 09:39:24 +03:00
|
|
|
func NewPoolWithFunc(size, expiry int, f pf) (*PoolWithFunc, error) {
|
2018-05-22 06:26:16 +03:00
|
|
|
if size <= 0 {
|
|
|
|
return nil, ErrPoolSizeInvalid
|
|
|
|
}
|
|
|
|
p := &PoolWithFunc{
|
|
|
|
capacity: int32(size),
|
|
|
|
freeSignal: make(chan sig, math.MaxInt32),
|
2018-05-24 13:30:58 +03:00
|
|
|
release: make(chan sig, 1),
|
2018-07-06 10:00:30 +03:00
|
|
|
expiryDuration: time.Duration(expiry) * time.Second,
|
2018-05-22 06:26:16 +03:00
|
|
|
poolFunc: f,
|
|
|
|
}
|
2018-07-06 09:42:26 +03:00
|
|
|
p.MonitorAndClear()
|
2018-05-22 06:26:16 +03:00
|
|
|
return p, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
|
2018-05-22 13:00:15 +03:00
|
|
|
// Serve submit a task to pool
|
2018-05-22 06:26:16 +03:00
|
|
|
func (p *PoolWithFunc) Serve(args interface{}) error {
|
2018-05-24 13:30:58 +03:00
|
|
|
//if atomic.LoadInt32(&p.closed) == 1 {
|
|
|
|
// return ErrPoolClosed
|
|
|
|
//}
|
|
|
|
if len(p.release) > 0 {
|
2018-05-22 06:26:16 +03:00
|
|
|
return ErrPoolClosed
|
|
|
|
}
|
2018-05-22 07:01:00 +03:00
|
|
|
w := p.getWorker()
|
|
|
|
w.sendTask(args)
|
2018-05-22 06:26:16 +03:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Running returns the number of the currently running goroutines
|
2018-05-22 07:01:00 +03:00
|
|
|
func (p *PoolWithFunc) Running() int {
|
2018-05-22 06:26:16 +03:00
|
|
|
return int(atomic.LoadInt32(&p.running))
|
|
|
|
}
|
|
|
|
|
|
|
|
// Free returns the available goroutines to work
|
2018-05-22 07:01:00 +03:00
|
|
|
func (p *PoolWithFunc) Free() int {
|
2018-05-22 06:26:16 +03:00
|
|
|
return int(atomic.LoadInt32(&p.capacity) - atomic.LoadInt32(&p.running))
|
|
|
|
}
|
|
|
|
|
|
|
|
// Cap returns the capacity of this pool
|
2018-05-22 07:01:00 +03:00
|
|
|
func (p *PoolWithFunc) Cap() int {
|
2018-05-22 06:26:16 +03:00
|
|
|
return int(atomic.LoadInt32(&p.capacity))
|
|
|
|
}
|
|
|
|
|
|
|
|
// Release Closed this pool
|
2018-05-22 07:01:00 +03:00
|
|
|
func (p *PoolWithFunc) Release() error {
|
2018-05-24 13:30:58 +03:00
|
|
|
p.once.Do(func() {
|
2018-05-24 14:27:54 +03:00
|
|
|
p.release <- sig{}
|
2018-05-30 07:57:20 +03:00
|
|
|
running := p.Running()
|
|
|
|
for i := 0; i < running; i++ {
|
|
|
|
p.getWorker().stop()
|
|
|
|
}
|
2018-06-22 06:42:05 +03:00
|
|
|
for i := range p.workers{
|
|
|
|
p.workers[i] = nil
|
|
|
|
}
|
2018-05-24 13:30:58 +03:00
|
|
|
})
|
2018-05-22 06:26:16 +03:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// ReSize change the capacity of this pool
|
2018-05-22 07:01:00 +03:00
|
|
|
func (p *PoolWithFunc) ReSize(size int) {
|
2018-05-30 07:57:20 +03:00
|
|
|
if size < p.Cap() {
|
|
|
|
diff := p.Cap() - size
|
|
|
|
for i := 0; i < diff; i++ {
|
|
|
|
p.getWorker().stop()
|
|
|
|
}
|
2018-06-15 06:28:21 +03:00
|
|
|
} else if size == p.Cap() {
|
2018-05-30 07:59:00 +03:00
|
|
|
return
|
2018-05-30 07:57:20 +03:00
|
|
|
}
|
2018-05-22 06:26:16 +03:00
|
|
|
atomic.StoreInt32(&p.capacity, int32(size))
|
|
|
|
}
|
|
|
|
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
|
|
|
|
// getWorker returns a available worker to run the tasks.
|
2018-05-22 07:01:00 +03:00
|
|
|
func (p *PoolWithFunc) getWorker() *WorkerWithFunc {
|
2018-05-22 06:26:16 +03:00
|
|
|
var w *WorkerWithFunc
|
|
|
|
waiting := false
|
|
|
|
|
|
|
|
p.lock.Lock()
|
|
|
|
workers := p.workers
|
|
|
|
n := len(workers) - 1
|
|
|
|
if n < 0 {
|
|
|
|
if p.running >= p.capacity {
|
|
|
|
waiting = true
|
2018-05-24 14:27:54 +03:00
|
|
|
} else {
|
|
|
|
p.running++
|
2018-05-22 06:26:16 +03:00
|
|
|
}
|
|
|
|
} else {
|
2018-06-15 06:28:21 +03:00
|
|
|
<-p.freeSignal
|
2018-05-22 06:26:16 +03:00
|
|
|
w = workers[n]
|
|
|
|
workers[n] = nil
|
|
|
|
p.workers = workers[:n]
|
|
|
|
}
|
|
|
|
p.lock.Unlock()
|
|
|
|
|
|
|
|
if waiting {
|
|
|
|
<-p.freeSignal
|
2018-06-15 06:28:21 +03:00
|
|
|
p.lock.Lock()
|
|
|
|
workers = p.workers
|
|
|
|
l := len(workers) - 1
|
|
|
|
w = workers[l]
|
|
|
|
workers[l] = nil
|
|
|
|
p.workers = workers[:l]
|
|
|
|
p.lock.Unlock()
|
2018-05-22 11:20:01 +03:00
|
|
|
} else if w == nil {
|
2018-05-24 14:27:54 +03:00
|
|
|
w = &WorkerWithFunc{
|
|
|
|
pool: p,
|
|
|
|
args: make(chan interface{}),
|
2018-05-22 06:26:16 +03:00
|
|
|
}
|
2018-05-22 19:46:43 +03:00
|
|
|
w.run()
|
2018-05-22 06:26:16 +03:00
|
|
|
}
|
|
|
|
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()
|
2018-05-22 06:26:16 +03:00
|
|
|
p.lock.Lock()
|
|
|
|
p.workers = append(p.workers, worker)
|
|
|
|
p.lock.Unlock()
|
|
|
|
p.freeSignal <- sig{}
|
|
|
|
}
|