arjunmann73 / tcpconnpool

Thread safe package for TCP Connection Pooling in Golang

TCPconnPool

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Thread safe TCP Connection Pooling package in golang. For a server, a pool of connections can be maintained so requests to that server can use an available connection in the pool rather than waiting on initiating a connection. Using existing connections delivers requests to that server faster, and decreases connection setup and tear-down overhead. Connection Pooling also reduces the server load, which frees resources to handle other important tasks.

Built With

• Golang

Prerequisites

• golang

1. Install Go
2. Download the Go installer and run it.
3. Verify your installation by running

$ go version

Installation

  $ go get -t github.com/arjunmann73/TCPconnPool

Usage

func main() {
...

    // Creating a pool with 5 initial connections and maximum connects possible = 30.
    if pool, err := TCPconnPool.CreateConnectionPool(5, 30); err != nil {
         log.Fatal("error in creation of connection pool")
    }
...
...

    // Retrieving a connection from the pool
    if conn, err := pool.GetOneConnection(); err != nil {
         log.Fatal("error in retriving a connection")
    }
...
...

    // Putting a connection back into the pool, does not close the underlying connection.
    if err := pool.PutOneConnection(conn); err != nil {
         log.Fatal("error in putting a connection back into the pool")
    }
}

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Arjun Singh Mann - [email protected]