leakybuf

Documentation

Overview

Provides leaky buffer, based on the example in Effective Go.

Index

• Constants
• Variables
• type LeakyBuf
  • func NewLeakyBuf(n, bufSize int) *LeakyBuf
  • func (lb *LeakyBuf) Get() (b []byte)
  • func (lb *LeakyBuf) Put(b []byte)

Constants

const (
	GlobalLeakyBufSize = 32 * 1024 // data.len(2) + hmacsha1(10) + data(4096)

)

Variables

var GlobalLeakyBuf = NewLeakyBuf(maxNBuf, GlobalLeakyBufSize)

Types

type LeakyBuf

type LeakyBuf struct {
	// contains filtered or unexported fields
}

func NewLeakyBuf

func NewLeakyBuf(n, bufSize int) *LeakyBuf

NewLeakyBuf creates a leaky buffer which can hold at most n buffer, each with bufSize bytes.

func (*LeakyBuf) Get

func (lb *LeakyBuf) Get() (b []byte)

Get returns a buffer from the leaky buffer or create a new buffer.

func (*LeakyBuf) Put

func (lb *LeakyBuf) Put(b []byte)

Put add the buffer into the free buffer pool for reuse. Panic if the buffer size is not the same with the leaky buffer's. This is intended to expose error usage of leaky buffer.