github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/metrics/aggregation/types_pool.go (about)

     1  // Copyright (c) 2017 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 aggregation
    22  
    23  import "github.com/m3db/m3/src/x/pool"
    24  
    25  // TypesAlloc allocates new aggregation types.
    26  type TypesAlloc func() Types
    27  
    28  // TypesPool provides a pool of aggregation types.
    29  type TypesPool interface {
    30  	// Init initializes the aggregation types pool.
    31  	Init(alloc TypesAlloc)
    32  
    33  	// Get gets an empty list of aggregation types from the pool.
    34  	Get() Types
    35  
    36  	// Put returns aggregation types to the pool.
    37  	Put(value Types)
    38  }
    39  
    40  type typesPool struct {
    41  	pool pool.ObjectPool
    42  }
    43  
    44  // NewTypesPool creates a new pool for aggregation types.
    45  func NewTypesPool(opts pool.ObjectPoolOptions) TypesPool {
    46  	return &typesPool{pool: pool.NewObjectPool(opts)}
    47  }
    48  
    49  func (p *typesPool) Init(alloc TypesAlloc) {
    50  	p.pool.Init(func() interface{} {
    51  		return alloc()
    52  	})
    53  }
    54  
    55  func (p *typesPool) Get() Types {
    56  	return p.pool.Get().(Types)
    57  }
    58  
    59  func (p *typesPool) Put(value Types) {
    60  	p.pool.Put(value[:0])
    61  }