github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/msg/consumer/pools.go (about)

     1  // Copyright (c) 2018 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 consumer
    22  
    23  import (
    24  	"github.com/m3db/m3/src/x/pool"
    25  )
    26  
    27  // MessagePoolOptions are options to use when creating the
    28  // message pool.
    29  type MessagePoolOptions struct {
    30  	PoolOptions pool.ObjectPoolOptions
    31  
    32  	// MaxBufferReuseSize specifies the maximum buffer which can
    33  	// be reused and pooled, if a buffer greater than this
    34  	// is used then it is discarded. Zero specifies no limit.
    35  	MaxBufferReuseSize int
    36  }
    37  
    38  type messagePool struct {
    39  	pool.ObjectPool
    40  	opts MessagePoolOptions
    41  }
    42  
    43  func newMessagePool(opts MessagePoolOptions) *messagePool {
    44  	iOpts := opts.PoolOptions.InstrumentOptions()
    45  	scope := iOpts.MetricsScope()
    46  	return &messagePool{
    47  		ObjectPool: pool.NewObjectPool(
    48  			opts.PoolOptions.SetInstrumentOptions(
    49  				iOpts.SetMetricsScope(
    50  					scope.Tagged(map[string]string{"pool": "message"}),
    51  				),
    52  			),
    53  		),
    54  		opts: opts,
    55  	}
    56  }
    57  
    58  func (p *messagePool) Init() {
    59  	p.ObjectPool.Init(func() interface{} {
    60  		return newMessage(p)
    61  	})
    62  }
    63  
    64  func (p *messagePool) Get() *message {
    65  	return p.ObjectPool.Get().(*message)
    66  }
    67  
    68  func (p *messagePool) Put(m *message) {
    69  	max := p.opts.MaxBufferReuseSize
    70  	if max > 0 && cap(m.Bytes()) > max {
    71  		// Do not return to pool if enforcing max buffer reuse size
    72  		return
    73  	}
    74  	p.ObjectPool.Put(m)
    75  }