https://github.com/fatih/pool

Connection pool for Go's net.Conn interface
https://github.com/fatih/pool

go golang pool

Last synced: about 1 month ago
JSON representation

Connection pool for Go's net.Conn interface

• Host: GitHub
• URL: https://github.com/fatih/pool
• Owner: fatih
• License: mit
• Archived: true
• Created: 2013-11-28T14:02:50.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2018-07-22T10:02:14.000Z (over 6 years ago)
• Last Synced: 2024-09-21T23:31:41.434Z (about 2 months ago)
• Topics: go, golang, pool
• Language: Go
• Homepage: https://godoc.org/gopkg.in/fatih/pool.v2
• Size: 39.1 KB
• Stars: 1,360
• Watchers: 46
• Forks: 292
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - pool - Connection pool for Go's net.Conn interface (Go)

README

        
# Archived project. No maintenance. 

This project is not maintained anymore and is archived. Feel free to fork and

use make your own changes if needed.

Thanks all for their work on this project. 

# Pool [![GoDoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](https://godoc.org/github.com/fatih/pool) [![Build Status](http://img.shields.io/travis/fatih/pool.svg?style=flat-square)](https://travis-ci.org/fatih/pool)

Pool is a thread safe connection pool for net.Conn interface. It can be used to

manage and reuse connections.

## Install and Usage

Install the package with:

```bash

go get github.com/fatih/pool

```

Please vendor the package with one of the releases: https://github.com/fatih/pool/releases.

`master` branch is **development** branch and will contain always the latest changes.

## Example

```go

// create a factory() to be used with channel based pool

factory    := func() (net.Conn, error) { return net.Dial("tcp", "127.0.0.1:4000") }

// create a new channel based pool with an initial capacity of 5 and maximum

// capacity of 30. The factory will create 5 initial connections and put it

// into the pool.

p, err := pool.NewChannelPool(5, 30, factory)

// now you can get a connection from the pool, if there is no connection

// available it will create a new one via the factory function.

conn, err := p.Get()

// do something with conn and put it back to the pool by closing the connection

// (this doesn't close the underlying connection instead it's putting it back

// to the pool).

conn.Close()

// close the underlying connection instead of returning it to pool

// it is useful when acceptor has already closed connection and conn.Write() returns error

if pc, ok := conn.(*pool.PoolConn); ok {

  pc.MarkUnusable()

  pc.Close()

}

// close pool any time you want, this closes all the connections inside a pool

p.Close()

// currently available connections in the pool

current := p.Len()

```

## Credits

 * [Fatih Arslan](https://github.com/fatih)

 * [sougou](https://github.com/sougou)

## License

The MIT License (MIT) - see LICENSE for more details