github.com/m3db/m3@v1.5.0/src/msg/producer/writer/message_pool.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 writer
    22  
    23  import "github.com/m3db/m3/src/x/pool"
    24  
    25  // messagePool is the pool for message.
    26  type messagePool interface {
    27  	// Init initializes the pool.
    28  	Init()
    29  
    30  	// Get gets a message from the pool.
    31  	Get() *message
    32  
    33  	// Put puts a message to the pool.
    34  	Put(m *message)
    35  }
    36  
    37  type msgPool struct {
    38  	pool.ObjectPool
    39  }
    40  
    41  func newMessagePool(opts pool.ObjectPoolOptions) messagePool {
    42  	iOpts := opts.InstrumentOptions()
    43  	scope := iOpts.MetricsScope()
    44  	p := pool.NewObjectPool(
    45  		opts.SetInstrumentOptions(
    46  			iOpts.SetMetricsScope(
    47  				scope.Tagged(map[string]string{"pool": "message"}),
    48  			),
    49  		),
    50  	)
    51  	return &msgPool{p}
    52  }
    53  
    54  func (p *msgPool) Init() {
    55  	p.ObjectPool.Init(func() interface{} {
    56  		return newMessage()
    57  	})
    58  }
    59  
    60  func (p *msgPool) Get() *message {
    61  	return p.ObjectPool.Get().(*message)
    62  }
    63  
    64  func (p *msgPool) Put(m *message) {
    65  	p.ObjectPool.Put(m)
    66  }