github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/aggregator/aggregation/quantile/cm/stream_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 cm
    22  
    23  import "sync"
    24  
    25  // StreamPool is a pool of streams, wrapping sync.Pool.
    26  type StreamPool struct {
    27  	pool *sync.Pool
    28  }
    29  
    30  // NewStreamPool creates a new StreamPool.
    31  func NewStreamPool(opts Options) StreamPool {
    32  	return StreamPool{
    33  		pool: &sync.Pool{
    34  			New: func() interface{} {
    35  				return NewStream(opts)
    36  			},
    37  		},
    38  	}
    39  }
    40  
    41  // Get returns a new Stream from the pool.
    42  func (p StreamPool) Get() *Stream {
    43  	return p.pool.Get().(*Stream) //nolint:errcheck
    44  }
    45  
    46  // Put puts a Stream back into the pool.
    47  func (p StreamPool) Put(s *Stream) {
    48  	p.pool.Put(s)
    49  }