github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/encoding/iterator_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 encoding
    22  
    23  import (
    24  	"github.com/m3db/m3/src/x/pool"
    25  )
    26  
    27  type readerIteratorPool struct {
    28  	pool pool.ObjectPool
    29  }
    30  
    31  // NewReaderIteratorPool creates a new pool for ReaderIterators.
    32  func NewReaderIteratorPool(opts pool.ObjectPoolOptions) ReaderIteratorPool {
    33  	return &readerIteratorPool{pool: pool.NewObjectPool(opts)}
    34  }
    35  
    36  func (p *readerIteratorPool) Init(alloc ReaderIteratorAllocate) {
    37  	p.pool.Init(func() interface{} {
    38  		return alloc(nil, nil)
    39  	})
    40  }
    41  
    42  func (p *readerIteratorPool) Get() ReaderIterator {
    43  	return p.pool.Get().(ReaderIterator)
    44  }
    45  
    46  func (p *readerIteratorPool) Put(iter ReaderIterator) {
    47  	p.pool.Put(iter)
    48  }
    49  
    50  type multiReaderIteratorPool struct {
    51  	pool pool.ObjectPool
    52  }
    53  
    54  // NewMultiReaderIteratorPool creates a new pool for MultiReaderIterators.
    55  func NewMultiReaderIteratorPool(opts pool.ObjectPoolOptions) MultiReaderIteratorPool {
    56  	return &multiReaderIteratorPool{pool: pool.NewObjectPool(opts)}
    57  }
    58  
    59  func (p *multiReaderIteratorPool) Init(alloc ReaderIteratorAllocate) {
    60  	p.pool.Init(func() interface{} {
    61  		return NewMultiReaderIterator(alloc, p)
    62  	})
    63  }
    64  
    65  func (p *multiReaderIteratorPool) Get() MultiReaderIterator {
    66  	return p.pool.Get().(MultiReaderIterator)
    67  }
    68  
    69  func (p *multiReaderIteratorPool) Put(iter MultiReaderIterator) {
    70  	p.pool.Put(iter)
    71  }