bp

README

bufferpool

A simple go package for recycling memory buffers of type byte.Buffer with a pre-allocated underlying slice

Documentation

Index

• type BP
  • func New(bufsz int) *BP
  • func (bp *BP) Shutdown()

Types

type BP

type BP struct {
	Get   <-chan *bytes.Buffer // Get a buffer from the pool
	Give  chan<- *bytes.Buffer // Give a buffer to be stored in the pool
	Makes int                  // total buffers allocated
	// contains filtered or unexported fields
}

BP includes Get and Give directional channels for retrieving and returning buffers

func New

func New(bufsz int) *BP

New initalizes a new buffer pool

func (*BP) Shutdown

func (bp *BP) Shutdown()

Shutdown terminates the pool, closing the Get and Give channels and freeing pool buffers to be garbage collected