Merge pull request #34 from dcormier/master

dcormier · web-flow · commit 2633f272f4f5 · 2018-06-21T11:05:37.000-04:00
Updated documentation so examples show up properly
diff --git a/example__simple_test.go b/example__simple_test.go
@@ -0,0 +1,43 @@
+package pool_test
+
+import (
+	"context"
+	"fmt"
+	"strconv"
+	"sync/atomic"
+
+	"github.com/jolestar/go-commons-pool"
+)
+
+func Example_simple() {
+	type myPoolObject struct {
+		s string
+	}
+
+	v := uint64(0)
+	factory := pool.NewPooledObjectFactorySimple(
+		func(context.Context) (interface{}, error) {
+			return &myPoolObject{
+					s: strconv.FormatUint(atomic.AddUint64(&v, 1), 10),
+				},
+				nil
+		})
+
+	ctx := context.Background()
+	p := pool.NewObjectPoolWithDefaultConfig(ctx, factory)
+
+	obj, err := p.BorrowObject(ctx)
+	if err != nil {
+		panic(err)
+	}
+
+	o := obj.(*myPoolObject)
+	fmt.Println(o.s)
+
+	err = p.ReturnObject(ctx, obj)
+	if err != nil {
+		panic(err)
+	}
+
+	// Output: 1
+}
diff --git a/example_customFactory_test.go b/example_customFactory_test.go
@@ -0,0 +1,66 @@
+package pool_test
+
+import (
+	"context"
+	"fmt"
+	"strconv"
+	"sync/atomic"
+
+	"github.com/jolestar/go-commons-pool"
+)
+
+type MyPoolObject struct {
+	s string
+}
+
+type MyCustomFactory struct {
+	v uint64
+}
+
+func (f *MyCustomFactory) MakeObject(ctx context.Context) (*pool.PooledObject, error) {
+	return pool.NewPooledObject(
+			&MyPoolObject{
+				s: strconv.FormatUint(atomic.AddUint64(&f.v, 1), 10),
+			}),
+		nil
+}
+
+func (f *MyCustomFactory) DestroyObject(ctx context.Context, object *pool.PooledObject) error {
+	// do destroy
+	return nil
+}
+
+func (f *MyCustomFactory) ValidateObject(ctx context.Context, object *pool.PooledObject) bool {
+	// do validate
+	return true
+}
+
+func (f *MyCustomFactory) ActivateObject(ctx context.Context, object *pool.PooledObject) error {
+	// do activate
+	return nil
+}
+
+func (f *MyCustomFactory) PassivateObject(ctx context.Context, object *pool.PooledObject) error {
+	// do passivate
+	return nil
+}
+
+func Example_customFactory() {
+	ctx := context.Background()
+	p := pool.NewObjectPoolWithDefaultConfig(ctx, &MyCustomFactory{})
+
+	obj1, err := p.BorrowObject(ctx)
+	if err != nil {
+		panic(err)
+	}
+
+	o := obj1.(*MyPoolObject)
+	fmt.Println(o.s)
+
+	err = p.ReturnObject(ctx, obj1)
+	if err != nil {
+		panic(err)
+	}
+
+	// Output: 1
+}
diff --git a/example_multipleBorrowers_test.go b/example_multipleBorrowers_test.go
@@ -0,0 +1,82 @@
+package pool_test
+
+import (
+	"context"
+	"fmt"
+	"strconv"
+	"sync/atomic"
+
+	"github.com/jolestar/go-commons-pool"
+)
+
+func Example_multipleBorrowers() {
+	type myPoolObject struct {
+		s string
+	}
+
+	var v uint64
+	factory := pool.NewPooledObjectFactorySimple(
+		func(context.Context) (interface{}, error) {
+			return &myPoolObject{
+					s: strconv.FormatUint(atomic.AddUint64(&v, 1), 10),
+				},
+				nil
+		})
+
+	ctx := context.Background()
+	p := pool.NewObjectPoolWithDefaultConfig(ctx, factory)
+
+	// Borrows #1
+	obj1, err := p.BorrowObject(ctx)
+	if err != nil {
+		panic(err)
+	}
+
+	o := obj1.(*myPoolObject)
+	fmt.Println(o.s)
+
+	// Borrowing again while the first object is borrowed will cause a new object to be made, if
+	// the pool configuration allows it. If the pull is full, this will block until the context
+	// is cancelled or an object is returned to the pool.
+	//
+	// Borrows #2
+	obj2, err := p.BorrowObject(ctx)
+	if err != nil {
+		panic(err)
+	}
+
+	// Returning the object to the pool makes it available to another borrower.
+	err = p.ReturnObject(ctx, obj1)
+	if err != nil {
+		panic(err)
+	}
+
+	// Since there's an object available in the pool, this gets that rather than creating a new one.
+	//
+	// Borrows #1 again (since it was returned earlier)
+	obj3, err := p.BorrowObject(ctx)
+	if err != nil {
+		panic(err)
+	}
+
+	o = obj2.(*myPoolObject)
+	fmt.Println(o.s)
+
+	err = p.ReturnObject(ctx, obj2)
+	if err != nil {
+		panic(err)
+	}
+
+	o = obj3.(*myPoolObject)
+	fmt.Println(o.s)
+
+	err = p.ReturnObject(ctx, obj3)
+	if err != nil {
+		panic(err)
+	}
+
+	// Output:
+	// 1
+	// 2
+	// 1
+}
diff --git a/example_test.go b/example_test.go
diff --git a/pool.go b/pool.go
@@ -133,7 +133,7 @@ func (pool *ObjectPool) addIdleObject(ctx context.Context, p *PooledObject) erro
 // PooledObjectFactory.ValidateObject.
 // If the pool is full (based on the number of objects in the pool and the
 // value of the MaxTotal configuration field), this method will block until
-// an object is returned to the pool or the context is cancelled.
+// an object is returned to the pool or the context is done.
 //
 // By contract, clients must return the borrowed instance
 // using ReturnObject, InvalidateObject
