pool

README

go-common/pool

This repository contains the go-common/pool library.

To install:

go get github.com/ugorji/go-common/pool

Package Documentation

Package pool manages a pool of resources.

Exported Package API

func Must(v interface{}, err error) interface{}
type Action uint8
    const GET Action = iota ...
type Fn func(v interface{}, a Action, currentLen int) (interface{}, error)
type T struct{ ... }
    func New(fn Fn, load, capacity int) (t *T, err error)

Documentation

Overview

Package pool manages a pool of resources.

Index

• func Must(v interface{}, err error) interface{}
• type Action
• type Fn
• type T
  • func New(fn Fn, load, capacity int) (t *T, err error)
  • func (p *T) Drain() error
  • func (p *T) Get(t time.Duration) (v interface{}, err error)
  • func (p *T) Put(v interface{}) (err error)

Functions

func Must

func Must(v interface{}, err error) interface{}

Types

type Action

type Action uint8

const (
	GET Action = iota
	PUT
	DISPOSE
)

type Fn

type Fn func(v interface{}, a Action, currentLen int) (interface{}, error)

type T

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

T is a simple structure that maintains a pool. It offloads the heavy duty of whether a value should be returned to the fn function. This way, a user can determine when/how objects are returned.

func New

func New(fn Fn, load, capacity int) (t *T, err error)

Creates a new Pool.

• fn: callback function called after GET and before PUT. allows user to create new object or modify one.
• initCapacity: preloads this many by calling Get and Put that many times.

func (*T) Drain

func (p *T) Drain() error

func (*T) Get

func (p *T) Get(t time.Duration) (v interface{}, err error)

func (*T) Put

func (p *T) Put(v interface{}) (err error)