github.com/mysteriumnetwork/node@v0.0.0-20240516044423-365054f76801/services/wireguard/endpoint/proxyclient/buffers.go (about)

     1  /*
     2   * Copyright (C) 2022 The "MysteriumNetwork/node" Authors.
     3   *
     4   * This program is free software: you can redistribute it and/or modify
     5   * it under the terms of the GNU General Public License as published by
     6   * the Free Software Foundation, either version 3 of the License, or
     7   * (at your option) any later version.
     8   *
     9   * This program is distributed in the hope that it will be useful,
    10   * but WITHOUT ANY WARRANTY; without even the implied warranty of
    11   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    12   * GNU General Public License for more details.
    13   *
    14   * You should have received a copy of the GNU General Public License
    15   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    16   */
    17  
    18  package proxyclient
    19  
    20  import (
    21  	"sync"
    22  )
    23  
    24  // BufferPool represent a buffer sync pool
    25  type BufferPool struct {
    26  	sp sync.Pool
    27  }
    28  
    29  // NewBufferPool create a new buffer pool of slice with some length and capacity
    30  func NewBufferPool(size int) (pool *BufferPool) {
    31  	return &BufferPool{
    32  		sp: sync.Pool{
    33  			New: func() interface{} {
    34  				return make([]byte, size, size) // buffer don't grow
    35  			},
    36  		},
    37  	}
    38  }
    39  
    40  // Get return some buffer from pool or create new one
    41  func (pool *BufferPool) Get() (buffer []byte) {
    42  	return pool.sp.Get().([]byte)
    43  }
    44  
    45  // Put get some buffer and place back it to pool
    46  func (pool *BufferPool) Put(buffer []byte) {
    47  	// not necessary to clean buffer
    48  	pool.sp.Put(buffer)
    49  }