pool

Documentation

Index

• Variables
• type BytePool
  • func (p *BytePool) Get(size int) (buf []byte)
  • func (p *BytePool) Put(buf []byte)
• type FixedGoroutinePool
  • func NewFixedGoroutinePool(options ...fixedOption) *FixedGoroutinePool
  • func (pool *FixedGoroutinePool) Schedule(task func())
  • func (pool *FixedGoroutinePool) Stop()
• type FixedOptions
• type GoroutinePool
• type Option
• type Options
• type Provider
  • func NewSyncPoolProvider[Object any](constructor func() interface{}) Provider[Object]
• type ScalableGroutinePool
  • func NewGoroutinePool(opts ...Option) *ScalableGroutinePool
  • func (p *ScalableGroutinePool) Schedule(task func())
  • func (p *ScalableGroutinePool) Stop()
• type SyncPoolProvider
  • func (provider *SyncPoolProvider[Object]) Acquire() Object
  • func (provider *SyncPoolProvider[Object]) Release(obj Object)
• type Worker
  • func NewWorker(cap int, beforeCloseCallback func(), afterCallback func(w *Worker)) *Worker
  • func (w *Worker) Stop()
  • func (w *Worker) Submit(task f, block bool)

Variables

var (
	// GetByte retrieves a byte slice but uses the global pool
	GetByte = builtinPool.Get
	// PutByte returns a byte slice but uses the global pool
	PutByte = builtinPool.Put
)

Types

type BytePool

type BytePool struct {
	// contains filtered or unexported fields
}

Pool consists of 32 sync.Pool, representing byte slices of length from 0 to 32 in powers of 2.

func (*BytePool) Get

func (p *BytePool) Get(size int) (buf []byte)

Get retrieves a byte slice of the length requested by the caller from pool or allocates a new one.

func (*BytePool) Put

func (p *BytePool) Put(buf []byte)

Put returns the byte slice to the pool.

type FixedGoroutinePool

type FixedGoroutinePool struct {
	// contains filtered or unexported fields
}

FixedGoroutinePool 固定数量的协程池

func NewFixedGoroutinePool

func NewFixedGoroutinePool(options ...fixedOption) *FixedGoroutinePool

func (*FixedGoroutinePool) Schedule

func (pool *FixedGoroutinePool) Schedule(task func())

func (*FixedGoroutinePool) Stop

func (pool *FixedGoroutinePool) Stop()

type FixedOptions

type FixedOptions struct {
	Num   int  // 协程数
	Block bool // 任务已满时是否需要阻塞
}

type GoroutinePool

type GoroutinePool interface {
	// Schedule 调度worker执行任务
	Schedule(task func())

	// Stop 停止工作
	Stop()
}

type Option

type Option func(options *Options)

type Options

type Options struct {
	Max     int32 // maximum number of workers
	Idle    int   // idle number of workers
	Block   bool
	Timeout time.Duration // quit time for worker
}

type Provider

type Provider[Object any] interface {
	Acquire() Object
	Release(obj Object)
}

Provider represents a object provider

func NewSyncPoolProvider

func NewSyncPoolProvider[Object any](constructor func() interface{}) Provider[Object]

type ScalableGroutinePool

type ScalableGroutinePool struct {
	// contains filtered or unexported fields
}

func NewGoroutinePool

func NewGoroutinePool(opts ...Option) *ScalableGroutinePool

func (*ScalableGroutinePool) Schedule

func (p *ScalableGroutinePool) Schedule(task func())

Schedule 执行任务

func (*ScalableGroutinePool) Stop

func (p *ScalableGroutinePool) Stop()

Stop 停止协程池

type SyncPoolProvider

type SyncPoolProvider[Object any] struct {
	// contains filtered or unexported fields
}

func (*SyncPoolProvider[Object]) Acquire

func (provider *SyncPoolProvider[Object]) Acquire() Object

func (*SyncPoolProvider[Object]) Release

func (provider *SyncPoolProvider[Object]) Release(obj Object)

type Worker

type Worker struct {
	// contains filtered or unexported fields
}

func NewWorker

func NewWorker(cap int, beforeCloseCallback func(), afterCallback func(w *Worker)) *Worker

func (*Worker) Stop

func (w *Worker) Stop()

stop this worker.

func (*Worker) Submit

func (w *Worker) Submit(task f, block bool)

Submit sends a task to this worker.