mb

README

mb

Message batching queue

Documentation

Overview

Package mb - queue with message batching feature

Index

• Variables
• type MB
  • func New(size int) *MB
  • func (mb *MB) Add(msgs ...interface{}) (err error)
  • func (mb *MB) Close() (err error)
  • func (mb *MB) Len() (l int)
  • func (mb *MB) Stats() (addCount, addMsgsCount, getCount, getMsgsCount int64)
  • func (mb *MB) Wait() (msgs []interface{})
  • func (mb *MB) WaitMax(max int) (msgs []interface{})

Variables

var ErrClosed = errors.New("MB closed")

ErrClosed is returned when you add message to closed queue

var ErrTooManyMessages = errors.New("Too many messages")

ErrTooManyMessages means that adding more messages (at one call) than the limit

Types

type MB

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

MB - message batching object Implements queue. Based on condition variables

func New

func New(size int) *MB

New returns a new MB with given queue size. size <= 0 means unlimited

func (*MB) Add

func (mb *MB) Add(msgs ...interface{}) (err error)

Add - adds new messages to queue. When queue is closed - returning ErrClosed When count messages bigger then queue size - returning ErrTooManyMessages When the queue is full - wait until will free place

func (*MB) Close

func (mb *MB) Close() (err error)

Close closes the queue All added messages will be available for Wait

func (*MB) Len

func (mb *MB) Len() (l int)

Len returning current size of queue

func (*MB) Stats

func (mb *MB) Stats() (addCount, addMsgsCount, getCount, getMsgsCount int64)

Stats returning current statistic of queue usage addCount - count of calls Add addMsgsCount - count of added messages getCount - count of calls Wait getMsgsCount - count of issued messages

func (*MB) Wait

func (mb *MB) Wait() (msgs []interface{})

Wait until anybody add message Returning array of accumulated messages When queue will be closed length of array will be 0

func (*MB) WaitMax

func (mb *MB) WaitMax(max int) (msgs []interface{})

WaitMax it's Wait with limit of maximum returning array size