class RedisPool extends ConnectionPool

Properties

protected Connection> $channel from  ConnectionPool
protected PoolOptions $options from  ConnectionPool
protected array<int, true> $managedConnections from  ConnectionPool
protected array<int, true> $borrowedConnections from  ConnectionPool
protected int $creatingCount from  ConnectionPool
protected bool $closed from  ConnectionPool
protected UsageTracker|null $usageTracker from  ConnectionPool
protected bool $usageTrackerInitialized from  ConnectionPool
protected IdleConnectionMonitor|null $idleMonitor from  ConnectionPool
protected array $config
protected Timer|null $heartbeatTimer
protected int|null $heartbeatTimerId
protected bool $heartbeatStarted

Methods

__construct(Container $container, string $name)

Create a new Redis pool instance.

string
getName()

Get the pool name.

void
start()

Enable background maintenance after pool initialization succeeds.

borrow()

Borrow a connection from the pool.

void
release(Connection $connection)

Release a connection back to the pool.

void
discard(Connection $connection)

Discard a borrowed connection from the pool.

void
trimExcessIdle()

Close excess idle connections without checking their age.

void
checkIdleConnection()

Check one idle connection and discard it when unhealthy.

void
close()

Close the Redis pool and clear its shared resources.

bool
isClosed()

Determine if the pool is closed.

int
getManagedCount()

Get the current number of connections managed by the pool.

int
getBorrowedCount()

Return the number of connections borrowed by callers.

getOptions()

Get the pool configuration options.

int
getIdleCount()

Get the number of connections currently available in the pool.

int
getWaitingCount()

Get the number of coroutines waiting for a connection.

array
getStats()

Return the pool's current resource counts and closed state.

createUsageTracker()

Create a usage policy for this Redis pool.

createConnection()

Create a new pooled Redis connection.

Connection|false
popIdleConnection()

Pop and validate one idle connection.

void
requeueConnection(Connection $connection)

Return an idle connection without changing its activity timestamps.

void
destroyConnection(Connection $connection)

Destroy a managed connection and release its capacity.

void
report(Throwable|string $error)

Report a pool maintenance or cleanup failure without throwing.

getLogger()

Get the logger instance if available.

int
nanoseconds(float $seconds)

Convert seconds to nanoseconds without overflowing integer arithmetic.

int
deadline(float $seconds)

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

int
ensureManaged(Connection $connection)

Ensure that a connection belongs to this pool before destroying it.

array
getConfig()

Get the Redis connection configuration.

void
startHeartbeat()

Start the heartbeat timer if configured.

void
clearHeartbeat()

Clear the heartbeat timer.

void
heartbeat()

Run one heartbeat sweep over currently idle connections.

void
heartbeatConnection(RedisConnection $connection)

Heartbeat one idle connection.

void
discardHeartbeatConnection(RedisConnection $connection)

Discard an idle connection from the pool.

Details

at line 33
__construct(Container $container, string $name)

Create a new Redis pool instance.

Parameters

Container $container
string $name

in ConnectionPool at line 60
string getName()

Get the pool name.

Return Value

string

at line 51
void start()

Enable background maintenance after pool initialization succeeds.

Return Value

void

in ConnectionPool at line 84
Connection borrow()

Borrow a connection from the pool.

Return Value

Connection

in ConnectionPool at line 126
void release(Connection $connection)

Release a connection back to the pool.

Parameters

Connection $connection

Return Value

void

in ConnectionPool at line 143
void discard(Connection $connection)

Discard a borrowed connection from the pool.

Parameters

Connection $connection

Return Value

void

in ConnectionPool at line 154
void trimExcessIdle()

Close excess idle connections without checking their age.

Stop when the managed count reaches the retained minimum or no idle connections remain.

Return Value

void

in ConnectionPool at line 169
void checkIdleConnection()

Check one idle connection and discard it when unhealthy.

Return Value

void

at line 88
void close()

Close the Redis pool and clear its shared resources.

Return Value

void

in ConnectionPool at line 243
bool isClosed()

Determine if the pool is closed.

Return Value

bool

in ConnectionPool at line 251
int getManagedCount()

Get the current number of connections managed by the pool.

Return Value

int

in ConnectionPool at line 259
int getBorrowedCount()

Return the number of connections borrowed by callers.

Return Value

int

in ConnectionPool at line 267
PoolOptions getOptions()

Get the pool configuration options.

Return Value

PoolOptions

in ConnectionPool at line 275
int getIdleCount()

Get the number of connections currently available in the pool.

Return Value

int

in ConnectionPool at line 283
int getWaitingCount()

Get the number of coroutines waiting for a connection.

Return Value

int

in ConnectionPool at line 293
array getStats()

Return the pool's current resource counts and closed state.

Return Value

array

at line 68
protected UsageTracker|null createUsageTracker()

Create a usage policy for this Redis pool.

Return Value

UsageTracker|null

at line 76
protected Connection createConnection()

Create a new pooled Redis connection.

Return Value

Connection

in ConnectionPool at line 323
protected Connection|false popIdleConnection()

Pop and validate one idle connection.

Return Value

Connection|false

in ConnectionPool at line 347
protected void requeueConnection(Connection $connection)

Return an idle connection without changing its activity timestamps.

Parameters

Connection $connection

Return Value

void

in ConnectionPool at line 365
protected void destroyConnection(Connection $connection)

Destroy a managed connection and release its capacity.

Parameters

Connection $connection

Return Value

void

in ConnectionPool at line 387
protected void report(Throwable|string $error)

Report a pool maintenance or cleanup failure without throwing.

Parameters

Throwable|string $error

Return Value

void

in ConnectionPool at line 398
protected StdoutLoggerInterface|null getLogger()

Get the logger instance if available.

Return Value

StdoutLoggerInterface|null

in ConnectionPool at line 485
protected int nanoseconds(float $seconds)

Convert seconds to nanoseconds without overflowing integer arithmetic.

Parameters

float $seconds

Return Value

int

in ConnectionPool at line 495
protected int deadline(float $seconds)

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

Parameters

float $seconds

Return Value

int

in ConnectionPool at line 508
protected int ensureManaged(Connection $connection)

Ensure that a connection belongs to this pool before destroying it.

Parameters

Connection $connection

Return Value

int

at line 60
array getConfig()

Get the Redis connection configuration.

Return Value

array

at line 102
protected void startHeartbeat()

Start the heartbeat timer if configured.

Return Value

void

at line 145
protected void clearHeartbeat()

Clear the heartbeat timer.

Return Value

void

at line 159
protected void heartbeat()

Run one heartbeat sweep over currently idle connections.

Return Value

void

at line 178
protected void heartbeatConnection(RedisConnection $connection)

Heartbeat one idle connection.

Parameters

RedisConnection $connection

Return Value

void

at line 211
protected void discardHeartbeatConnection(RedisConnection $connection)

Discard an idle connection from the pool.

Parameters

RedisConnection $connection

Return Value

void