github.com/uber-go/tally/v4@v4.1.17/pool.go (about)

     1  // Copyright (c) 2021 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package tally
    22  
    23  // ObjectPool is an minimalistic object pool to avoid
    24  // any circular dependencies on any other object pool.
    25  type ObjectPool struct {
    26  	values chan interface{}
    27  	alloc  func() interface{}
    28  }
    29  
    30  // NewObjectPool creates a new pool.
    31  func NewObjectPool(size int) *ObjectPool {
    32  	return &ObjectPool{
    33  		values: make(chan interface{}, size),
    34  	}
    35  }
    36  
    37  // Init initializes the object pool.
    38  func (p *ObjectPool) Init(alloc func() interface{}) {
    39  	p.alloc = alloc
    40  
    41  	for i := 0; i < cap(p.values); i++ {
    42  		p.values <- p.alloc()
    43  	}
    44  }
    45  
    46  // Get gets an object from the pool.
    47  func (p *ObjectPool) Get() interface{} {
    48  	var v interface{}
    49  	select {
    50  	case v = <-p.values:
    51  	default:
    52  		v = p.alloc()
    53  	}
    54  	return v
    55  }
    56  
    57  // Put puts an object back to the pool.
    58  func (p *ObjectPool) Put(obj interface{}) {
    59  	select {
    60  	case p.values <- obj:
    61  	default:
    62  	}
    63  }