frostfs-node/pkg/util/worker_pool.go

55 lines
1.4 KiB
Go
Raw Permalink Normal View History

package util
import (
"github.com/panjf2000/ants/v2"
"go.uber.org/atomic"
)
// WorkerPool represents a tool to control
// the execution of go-routine pool.
type WorkerPool interface {
// Submit queues a function for execution
// in a separate routine.
//
// Implementation must return any error encountered
// that prevented the function from being queued.
Submit(func()) error
// Release releases worker pool resources. All `Submit` calls will
// finish with ErrPoolClosed. It doesn't wait until all submitted
// functions have returned so synchronization must be achieved
// via other means (e.g. sync.WaitGroup).
Release()
}
// pseudoWorkerPool represents a pseudo worker pool which executes the submitted job immediately in the caller's routine.
type pseudoWorkerPool struct {
closed atomic.Bool
}
// ErrPoolClosed is returned when submitting task to a closed pool.
var ErrPoolClosed = ants.ErrPoolClosed
// NewPseudoWorkerPool returns a new instance of a synchronous worker pool.
func NewPseudoWorkerPool() WorkerPool {
return &pseudoWorkerPool{}
}
// Submit executes the passed function immediately.
//
// Always returns nil.
func (p *pseudoWorkerPool) Submit(fn func()) error {
if p.closed.Load() {
return ErrPoolClosed
}
fn()
return nil
}
// Release implements the WorkerPool interface.
func (p *pseudoWorkerPool) Release() {
p.closed.Store(true)
}