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

     1  // Copyright (c) 2016 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 policy
    22  
    23  import "github.com/m3db/m3/src/x/pool"
    24  
    25  // PoliciesPool provides a pool for variable-sized policy slices.
    26  type PoliciesPool interface {
    27  	// Init initializes the pool.
    28  	Init()
    29  
    30  	// Get provides a policy slice from the pool.
    31  	Get(capacity int) []Policy
    32  
    33  	// Put returns a policy slice to the pool.
    34  	Put(value []Policy)
    35  }
    36  
    37  type policiesPool struct {
    38  	pool pool.BucketizedObjectPool
    39  }
    40  
    41  // NewPoliciesPool creates a new policies pool.
    42  func NewPoliciesPool(sizes []pool.Bucket, opts pool.ObjectPoolOptions) PoliciesPool {
    43  	return &policiesPool{pool: pool.NewBucketizedObjectPool(sizes, opts)}
    44  }
    45  
    46  func (p *policiesPool) Init() {
    47  	p.pool.Init(func(capacity int) interface{} {
    48  		return make([]Policy, 0, capacity)
    49  	})
    50  }
    51  
    52  func (p *policiesPool) Get(capacity int) []Policy {
    53  	return p.pool.Get(capacity).([]Policy)
    54  }
    55  
    56  func (p *policiesPool) Put(value []Policy) {
    57  	value = value[:0]
    58  	p.pool.Put(value, cap(value))
    59  }