mpool

Documentation

Overview

Package mpool provides recycleable memory buffer to reduce gc.

Based upon slab class allocation algorithm.

Index

• Variables
• func AccessLogLineBufferGet() []byte
• func AccessLogLineBufferPut(b []byte)
• func BytesBufferGet() *bytes.Buffer
• func BytesBufferPut(b *bytes.Buffer)
• type Intern
  • func NewIntern() *Intern
  • func (this *Intern) String(s string) string
• type Message
  • func NewMessage(size int) *Message
  • func (this *Message) Free() (recycled bool)

Variables

var ErrorMessageOverflow = errors.New("message overflow")

Functions

func AccessLogLineBufferGet

func AccessLogLineBufferGet() []byte

func AccessLogLineBufferPut

func AccessLogLineBufferPut(b []byte)

func BytesBufferGet

func BytesBufferGet() *bytes.Buffer

func BytesBufferPut

func BytesBufferPut(b *bytes.Buffer)

Types

type Intern

type Intern struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewIntern

func NewIntern() *Intern

func (*Intern) String

func (this *Intern) String(s string) string

type Message

type Message struct {
	Body []byte
	// contains filtered or unexported fields
}

Message encapsulates the messages that we exchange back and forth.

func NewMessage

func NewMessage(size int) *Message

NewMessage is the supported way to obtain a new Message. This makes use of a "slab allocator" which greatly reduces the load on the garbage collector.

func (*Message) Free

func (this *Message) Free() (recycled bool)

Free decrements the reference count on a message, and releases its resources if no further references remain. While this is not strictly necessary thanks to GC, doing so allows for the resources to be recycled without engaging GC. This can have rather substantial benefits for performance.