sample_pool.go

// Copyright (c) 2016 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package cm

import "github.com/m3db/m3/src/x/pool"

type samplePool struct {
	pool pool.ObjectPool
}

// NewSamplePool creates a new pool for samples.
func NewSamplePool(opts pool.ObjectPoolOptions) SamplePool {
	return &samplePool{pool: pool.NewObjectPool(opts)}
}

func (p *samplePool) Init() {
	p.pool.Init(func() interface{} {
		return newSample()
	})
}

func (p *samplePool) Get() *Sample {
	return p.pool.Get().(*Sample)
}

func (p *samplePool) Put(sample *Sample) {
	// Reset sample to reduce GC sweep overhead.
	sample.reset()
	p.pool.Put(sample)
}