github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/storage/block/result_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 block
    22  
    23  import (
    24  	"github.com/m3db/m3/src/x/pool"
    25  )
    26  
    27  type fetchBlockMetadataResultsPool struct {
    28  	pool     pool.ObjectPool
    29  	capacity int
    30  }
    31  
    32  // NewFetchBlockMetadataResultsPool creates a new fetchBlockMetadataResultsPool
    33  func NewFetchBlockMetadataResultsPool(opts pool.ObjectPoolOptions, capacity int) FetchBlockMetadataResultsPool {
    34  	p := &fetchBlockMetadataResultsPool{pool: pool.NewObjectPool(opts), capacity: capacity}
    35  	p.pool.Init(func() interface{} {
    36  		res := make([]FetchBlockMetadataResult, 0, p.capacity)
    37  		return newPooledFetchBlockMetadataResults(res, p)
    38  	})
    39  	return p
    40  }
    41  
    42  func (p *fetchBlockMetadataResultsPool) Get() FetchBlockMetadataResults {
    43  	return p.pool.Get().(FetchBlockMetadataResults)
    44  }
    45  
    46  func (p *fetchBlockMetadataResultsPool) Put(res FetchBlockMetadataResults) {
    47  	if res == nil || cap(res.Results()) > p.capacity {
    48  		// Don't return nil or large slices back to pool
    49  		return
    50  	}
    51  	res.Reset()
    52  	p.pool.Put(res)
    53  }
    54  
    55  type fetchBlocksMetadataResultsPool struct {
    56  	pool     pool.ObjectPool
    57  	capacity int
    58  }
    59  
    60  // NewFetchBlocksMetadataResultsPool creates a new fetchBlocksMetadataResultsPool
    61  func NewFetchBlocksMetadataResultsPool(opts pool.ObjectPoolOptions, capacity int) FetchBlocksMetadataResultsPool {
    62  	p := &fetchBlocksMetadataResultsPool{pool: pool.NewObjectPool(opts), capacity: capacity}
    63  	p.pool.Init(func() interface{} {
    64  		res := make([]FetchBlocksMetadataResult, 0, capacity)
    65  		return newPooledFetchBlocksMetadataResults(res, p)
    66  	})
    67  	return p
    68  }
    69  
    70  func (p *fetchBlocksMetadataResultsPool) Get() FetchBlocksMetadataResults {
    71  	return p.pool.Get().(FetchBlocksMetadataResults)
    72  }
    73  
    74  func (p *fetchBlocksMetadataResultsPool) Put(res FetchBlocksMetadataResults) {
    75  	if res == nil || cap(res.Results()) > p.capacity {
    76  		// Don't return nil or large slices back to pool
    77  		return
    78  	}
    79  	res.Reset()
    80  	p.pool.Put(res)
    81  }