Snakepit.Pool (Snakepit v0.6.10)

View Source

Pool manager for external workers with concurrent initialization.

Features:

  • Concurrent worker startup (all workers start in parallel)
  • Simple queue-based request distribution
  • Non-blocking async execution
  • Automatic request queueing when workers are busy
  • Adapter-based support for any external process

Summary

Functions

await_ready(pool \\ __MODULE__, timeout \\ 15000)

Waits for the pool to be fully initialized.

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

execute(command, args, opts \\ [])

Executes a command on any available worker.

execute_stream(command, args, callback_fn, opts \\ [])

Execute a streaming command with callback.

get_stats(pool \\ __MODULE__)

Gets pool statistics.

list_workers(pool \\ __MODULE__)

Lists all worker IDs in the pool.

list_workers(pool, pool_name)
start_link(opts \\ [])

Starts the pool manager.

Functions

await_ready(pool \\ __MODULE__, timeout \\ 15000)

@spec await_ready(atom() | pid(), timeout()) :: :ok | {:error, Snakepit.Error.t()}

Waits for the pool to be fully initialized.

Returns :ok when all workers are ready, or {:error, %Snakepit.Error{}} if the pool doesn't initialize within the given timeout.

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

execute(command, args, opts \\ [])

Executes a command on any available worker.

execute_stream(command, args, callback_fn, opts \\ [])

Execute a streaming command with callback.

get_stats(pool \\ __MODULE__)

Gets pool statistics.

list_workers(pool \\ __MODULE__)

Lists all worker IDs in the pool.

Can be called with pool process or pool name:

  • list_workers() - all workers from all pools
  • list_workers(Snakepit.Pool) - all workers from all pools
  • list_workers(Snakepit.Pool, :pool_name) - workers from specific pool

list_workers(pool, pool_name)

start_link(opts \\ [])

Starts the pool manager.