class Pool extends Pool

A simple pool that creates connections via a callback.

Properties

protected Channel $channel from  Pool
protected PoolOptionInterface $option from  Pool
protected array<int, true> $managedConnections from  Pool
protected array<int, true> $borrowedConnections from  Pool
protected int $creating from  Pool
protected bool $closed from  Pool
protected FrequencyInterface|LowFrequencyInterface|null $frequency from  Pool
protected callable $callback

Methods

__construct(Container $container, string $name, callable $callback, array $option)

No description

string
getName()

Get the pool name.

from  Pool
get()

Get a connection from the pool.

from  Pool
void
release(ConnectionInterface $connection)

Release a connection back to the pool.

from  Pool
void
discard(ConnectionInterface $connection)

Discard a borrowed connection from the pool.

from  Pool
void
flush()

Close idle connections while the total managed count exceeds the configured minimum.

from  Pool
void
checkIdleConnection()

Check one idle connection and discard it when unhealthy.

from  Pool
void
close()

Close the pool and destroy every idle connection.

from  Pool
bool
isClosed()

Determine if the pool is closed.

from  Pool
int
getCurrentConnections()

Get the current number of connections managed by the pool.

from  Pool
getOption()

Get the pool configuration options.

from  Pool
int
getConnectionsInChannel()

Get the number of connections currently available in the pool.

from  Pool
void
initOption(array $options = [])

Initialize pool options from configuration.

from  Pool
createConnection()

Create a new connection for the pool.

popIdleConnection()

Pop and validate one idle connection.

from  Pool
void
requeueConnection(ConnectionInterface $connection)

Return an idle connection without changing its activity timestamps.

from  Pool
void
destroyConnection(ConnectionInterface $connection)

Destroy a managed connection and release its capacity.

from  Pool
void
report(Throwable|string $error)

Report a pool maintenance or cleanup failure without throwing.

from  Pool
getLogger()

Get the logger instance if available.

from  Pool
int
nanoseconds(float $seconds)

Convert seconds to nanoseconds without overflowing integer arithmetic.

from  Pool
int
deadline(float $seconds)

Build a monotonic deadline without overflowing at long durations or uptimes.

from  Pool

Details

at line 24
__construct(Container $container, string $name, callable $callback, array $option)

No description

Parameters

Container $container
string $name
callable $callback
array $option

in Pool at line 54
string getName()

Get the pool name.

Return Value

string

in Pool at line 62
ConnectionInterface get()

Get a connection from the pool.

Return Value

ConnectionInterface

in Pool at line 92
void release(ConnectionInterface $connection)

Release a connection back to the pool.

Parameters

ConnectionInterface $connection

Return Value

void

in Pool at line 109
void discard(ConnectionInterface $connection)

Discard a borrowed connection from the pool.

Parameters

ConnectionInterface $connection

Return Value

void

in Pool at line 118
void flush()

Close idle connections while the total managed count exceeds the configured minimum.

Return Value

void

in Pool at line 133
void checkIdleConnection()

Check one idle connection and discard it when unhealthy.

Return Value

void

in Pool at line 163
void close()

Close the pool and destroy every idle connection.

Idempotent. Connections borrowed when closure begins are destroyed on release, and factories completing after closure destroy their orphan.

Return Value

void

in Pool at line 189
bool isClosed()

Determine if the pool is closed.

Return Value

bool

in Pool at line 197
int getCurrentConnections()

Get the current number of connections managed by the pool.

Return Value

int

in Pool at line 205
PoolOptionInterface getOption()

Get the pool configuration options.

Return Value

PoolOptionInterface

in Pool at line 213
int getConnectionsInChannel()

Get the number of connections currently available in the pool.

Return Value

int

in Pool at line 221
protected void initOption(array $options = [])

Initialize pool options from configuration.

Parameters

array $options

Return Value

void

at line 35
protected ConnectionInterface createConnection()

Create a new connection for the pool.

Return Value

ConnectionInterface

in Pool at line 267
protected ConnectionInterface|false popIdleConnection()

Pop and validate one idle connection.

Return Value

ConnectionInterface|false

in Pool at line 291
protected void requeueConnection(ConnectionInterface $connection)

Return an idle connection without changing its activity timestamps.

Parameters

ConnectionInterface $connection

Return Value

void

in Pool at line 309
protected void destroyConnection(ConnectionInterface $connection)

Destroy a managed connection and release its capacity.

Parameters

ConnectionInterface $connection

Return Value

void

in Pool at line 333
protected void report(Throwable|string $error)

Report a pool maintenance or cleanup failure without throwing.

Parameters

Throwable|string $error

Return Value

void

in Pool at line 344
protected StdoutLoggerInterface|null getLogger()

Get the logger instance if available.

Return Value

StdoutLoggerInterface|null

in Pool at line 431
protected int nanoseconds(float $seconds)

Convert seconds to nanoseconds without overflowing integer arithmetic.

Parameters

float $seconds

Return Value

int

in Pool at line 441
protected int deadline(float $seconds)

Build a monotonic deadline without overflowing at long durations or uptimes.

Parameters

float $seconds

Return Value

int