waitpool

Documentation

Overview

Package waitpool provides a bounded sync.Pool.

Index

• type WaitPool
  • func New[T any](max uint32, new func() T) *WaitPool[T]
  • func (p *WaitPool[T]) Count() int
  • func (p *WaitPool[T]) Get() T
  • func (p *WaitPool[T]) Put(x T)

Types

type WaitPool

type WaitPool[T any] struct {
	// contains filtered or unexported fields
}

WaitPool is a bounded sync.Pool. It is safe for concurrent use.

func New

func New[T any](max uint32, new func() T) *WaitPool[T]

New creates a new WaitPool with a maximum size of max. If max is 0, the pool is unbounded.

func (*WaitPool[T]) Count

func (p *WaitPool[T]) Count() int

Count returns the number of items in use.

func (*WaitPool[T]) Get

func (p *WaitPool[T]) Get() T

Get returns an item from the pool. If the pool is bounded and all items are in use, Get will block until an item is available.

func (*WaitPool[T]) Put

func (p *WaitPool[T]) Put(x T)

Put adds x to the pool.