Jack Christensen
b1aadee38e
This allows for backwards compatible additions. No features are planned but this would make it easier if they are added.
63 lines
1.7 KiB
Markdown
63 lines
1.7 KiB
Markdown
[](https://godoc.org/github.com/jackc/puddle)
|
|
|
|
|
|
# Puddle
|
|
|
|
Puddle is a tiny generic resource pool library for Go that uses the standard
|
|
context library to signal cancellation of acquires. It is designed to contain
|
|
the minimum functionality required for a resource pool. It can be used directly
|
|
or it can be used as the base for a domain specific resource pool. For example,
|
|
a database connection pool may use puddle internally and implement health checks
|
|
and keep-alive behavior without needing to implement any concurrent code of its
|
|
own.
|
|
|
|
## Features
|
|
|
|
* Acquire cancellation via context standard library
|
|
* Statistics API for monitoring pool pressure
|
|
* No dependencies outside of standard library
|
|
* High performance
|
|
* 100% test coverage
|
|
|
|
## Example Usage
|
|
|
|
```go
|
|
constructor := func(context.Context) (net.Conn, error) {
|
|
return net.Dial("tcp", "127.0.0.1:8080")
|
|
}
|
|
destructor := func(value net.Conn) {
|
|
value.Close()
|
|
}
|
|
maxPoolSize := 10
|
|
|
|
pool := puddle.NewPool[net.Conn](&puddle.Config[int]{Constructor: constructor, Destructor: destructor, MaxSize: maxPoolSize})
|
|
|
|
// Acquire resource from the pool.
|
|
res, err := pool.Acquire(context.Background())
|
|
if err != nil {
|
|
// ...
|
|
}
|
|
|
|
// Use resource.
|
|
_, err = res.Value().Write([]byte{1})
|
|
if err != nil {
|
|
// ...
|
|
}
|
|
|
|
// Release when done.
|
|
res.Release()
|
|
|
|
```
|
|
|
|
## Status
|
|
|
|
Puddle is stable and feature complete.
|
|
|
|
* Bug reports and fixes are welcome.
|
|
* New features will not be accepted if they can be feasibly implemented in a wrapper.
|
|
* Performance optimizations will not be accepted unless the performance issue rises to the level of a bug.
|
|
|
|
## License
|
|
|
|
MIT
|