https://github.com/alekras/rsrc_pool

Resource pool project is written in Erlang as a tiny library. The goal of the tool is reduce the overhead of creating new resources by reusing of the same resources among multiple processes. Database connection is most popular example for pooling resource.
https://github.com/alekras/rsrc_pool

connection-pool erlang pool pooling pooling-utility resource-pool

Last synced: 19 days ago
JSON representation

Resource pool project is written in Erlang as a tiny library. The goal of the tool is reduce the overhead of creating new resources by reusing of the same resources among multiple processes. Database connection is most popular example for pooling resource.

• Host: GitHub
• URL: https://github.com/alekras/rsrc_pool
• Owner: alekras
• License: apache-2.0
• Created: 2016-02-09T02:03:36.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2020-06-26T17:36:36.000Z (over 4 years ago)
• Last Synced: 2024-12-22T22:47:17.286Z (about 2 months ago)
• Topics: connection-pool, erlang, pool, pooling, pooling-utility, resource-pool
• Language: Erlang
• Homepage:
• Size: 69.3 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Resource Pool (rsrc_pool)

Resource pool project is written in Erlang as a tiny library. The goal of the tool is reduce the overhead of creating new resources by reusing of the same resources among multiple processes. Achieving result is better performance and throughput. The resource pool was inspired by Java Apache's commons pool and adopts API and main principals from this project. Database connection is most popular example for pooling resource.

## Introduction

Resource pool project was inspired by Apache Commons Pool library and API was borrowed from there. But internal 

implementation is completely different and is using Erlang OTP design principles and Erlang concurrent model. Resource Pool

is Erlang application library.

## Structure



  


resource_pool_srv.erl is a main module of Resource Pool. It is generic server and implements

almost all Pool functionality.

  


resource_pool.erl is a facade for gen_server and exposes all API functions.

  


resource_factory.erl defines resource_factory behaviour and acts as a template and 

simple implementation resource factory for testing purpose.



## Getting started



  
Create instance of Resource Pool
 

    
{ok, Pid} = resource_pool:new(test_pool, resource_factory, [])

    where: 

    


      


test_pool - registered name of the new pool;

      


resource_factory - name of a module that implements resource_factory behaviour.

    

    New resource pool is usually shared between few processes.  

  

  
Borrow resource from pool


    
Resource = resource_pool:borrow(test_pool)

    The process can use the borrowed resource and has to return to pool after finish. 

  

  
Return resource to pool


      
ok = resource_pool:return(test_pool, Resource)

      The process cannot use the Resource anymore.

  

  
Pool can be created with options:


    
Options = [{max_active, 10}, {when_exhausted_action, fail}]

    
{ok, Pid} = resource_pool:new(test_pool, resource_factory, Options)

    See resource_pool for more details about options. 

  



See [Resource Pool](article.md) article for details and [http://erlpool.sourceforge.net/](http://erlpool.sourceforge.net/).