Settings View Source Poolex

Poolex is a library for managing pools of workers. Inspired by poolboy.

features

Features

With poolex you can:

• Launch multiple pools of workers and then access the free ones from anywhere in the application.
• Configure the pool to run additional temporary workers if the load increases.
• Use your implementations to define worker and caller processes access logic.

Why `poolex` instead of `poolboy`?

- `poolex` is written in Elixir. This library is much more convenient to use in Elixir projects. - `poolboy` is a great library, but not actively maintained at the moment :crying_cat_face:

requirements

Requirements

Requirement	Version
Erlang/OTP	>= 22
Elixir	>= 1.7

table-of-contents

Table of Contents

• Installation
• Getting Started
  • Starting pool of workers
  • Poolex configuration options
  • Working with the pool
• Migration from :poolboy
• Example of use
  • Defining the worker
  • Configuring Poolex
  • Using Poolex
• Workers and callers implementations
  • Callers
  • Workers
  • Writing custom implementations
• Contributions

installation

Installation

Add :poolex to your list of dependencies in mix.exs:

def deps do
  [
    {:poolex, "~> 0.7.0"}
  ]
end

usage

Usage

In the most typical use of Poolex, you only need to start a pool of workers as a child of your application.

children = [
  {Poolex, 
    pool_id: :worker_pool,
    worker_module: SomeWorker,
    workers_count: 5}
]

Supervisor.start_link(children, strategy: :one_for_one)

Then you can execute any code on the workers with run/3:

iex> Poolex.run(:worker_pool, &(is_pid?(&1)), timeout: 1_000)
{:ok, true}

A detailed description of the available configuration or examples of use can be found in documentation.

contributions

Contributions

If you feel something can be improved, or have any questions about certain behaviors or pieces of implementation, please feel free to file an issue. Proposed changes should be taken to issues before any PRs to avoid wasting time on code that might not be merged upstream.

If you are ready to make changes to the project, then please read the Contributing guide first.