MediaWiki  master
RedisConnectionPool Class Reference

Helper class to manage Redis connections. More...

Inheritance diagram for RedisConnectionPool:
Collaboration diagram for RedisConnectionPool:

Public Member Functions

 __destruct ()
 Make sure connections are closed for sanity. More...
 
 freeConnection ( $server, Redis $conn)
 Mark a connection to a server as free to return to the pool. More...
 
 getConnection ( $server, LoggerInterface $logger=null)
 Get a connection to a redis server. More...
 
 handleError (RedisConnRef $cref, RedisException $e)
 The redis extension throws an exception in response to various read, write and protocol errors. More...
 
 reauthenticateConnection ( $server, Redis $conn)
 Re-send an AUTH request to the redis server (useful after disconnects). More...
 
 resetTimeout (Redis $conn, $timeout=null)
 Adjust or reset the connection handle read timeout value. More...
 
 setLogger (LoggerInterface $logger)
 

Static Public Member Functions

static destroySingletons ()
 Destroy all singleton() instances. More...
 
static singleton (array $options)
 

Public Attributes

const SERVER_DOWN_TTL = 30
 integer; seconds to cache servers as "down". More...
 

Protected Member Functions

 __construct (array $options, $id)
 
 closeExcessIdleConections ()
 Close any extra idle connections if there are more than the limit. More...
 

Static Protected Member Functions

static applyDefaultConfig (array $options)
 

Protected Attributes

array $connections = []
 (server name => ((connection info array),...) More...
 
string $connectTimeout
 Connection timeout in seconds. More...
 
array $downServers = []
 (server name => UNIX timestamp) More...
 
string $id
 ID for persistent connections. More...
 
int $idlePoolSize = 0
 Current idle pool size. More...
 
LoggerInterface $logger
 
string $password
 Plaintext auth password. More...
 
bool $persistent
 Whether connections persist. More...
 
string $readTimeout
 Read timeout in seconds. More...
 
int $serializer
 Serializer to use (Redis::SERIALIZER_*) More...
 

Static Protected Attributes

static array $instances = []
 (pool ID => RedisConnectionPool) More...
 

Detailed Description

Helper class to manage Redis connections.

This can be used to get handle wrappers that free the handle when the wrapper leaves scope. The maximum number of free handles (connections) is configurable. This provides an easy way to cache connection handles that may also have state, such as a handle does between multi() and exec(), and without hoarding connections. The wrappers use PHP magic methods so that calling functions on them calls the function of the actual Redis object handle.

Since
1.21

Definition at line 41 of file RedisConnectionPool.php.

Constructor & Destructor Documentation

◆ __construct()

RedisConnectionPool::__construct ( array  $options,
  $id 
)
protected
Parameters
array$options
string$id
Exceptions
Exception

Definition at line 79 of file RedisConnectionPool.php.

References $id.

◆ __destruct()

RedisConnectionPool::__destruct ( )

Make sure connections are closed for sanity.

Definition at line 394 of file RedisConnectionPool.php.

Member Function Documentation

◆ applyDefaultConfig()

static RedisConnectionPool::applyDefaultConfig ( array  $options)
staticprotected
Parameters
array$options
Returns
array

Definition at line 114 of file RedisConnectionPool.php.

◆ closeExcessIdleConections()

RedisConnectionPool::closeExcessIdleConections ( )
protected

Close any extra idle connections if there are more than the limit.

Definition at line 308 of file RedisConnectionPool.php.

Referenced by freeConnection().

◆ destroySingletons()

static RedisConnectionPool::destroySingletons ( )
static

Destroy all singleton() instances.

Since
1.27

Definition at line 163 of file RedisConnectionPool.php.

Referenced by ForkController\prepareEnvironment().

◆ freeConnection()

RedisConnectionPool::freeConnection (   $server,
Redis  $conn 
)

Mark a connection to a server as free to return to the pool.

Parameters
string$server
Redis$conn
Returns
bool

Definition at line 289 of file RedisConnectionPool.php.

References $idlePoolSize, and closeExcessIdleConections().

◆ getConnection()

RedisConnectionPool::getConnection (   $server,
LoggerInterface  $logger = null 
)

Get a connection to a redis server.

Based on code in RedisBagOStuff.php.

Parameters
string$serverA hostname/port combination or the absolute path of a UNIX socket. If a hostname is specified but no port, port 6379 will be used.
LoggerInterface | null$loggerPSR-3 logger intance. [optional]
Returns
RedisConnRef|Redis|bool Returns false on failure
Exceptions
MWException

Definition at line 176 of file RedisConnectionPool.php.

References $idlePoolSize, and $logger.

◆ handleError()

RedisConnectionPool::handleError ( RedisConnRef  $cref,
RedisException  $e 
)

The redis extension throws an exception in response to various read, write and protocol errors.

Sometimes it also closes the connection, sometimes not. The safest response for us is to explicitly destroy the connection object and let it be reopened during the next request.

Parameters
RedisConnRef$cref
RedisException$e

Definition at line 334 of file RedisConnectionPool.php.

References RedisConnRef\getServer(), and RedisConnRef\isConnIdentical().

◆ reauthenticateConnection()

RedisConnectionPool::reauthenticateConnection (   $server,
Redis  $conn 
)

Re-send an AUTH request to the redis server (useful after disconnects).

This works around an upstream bug in phpredis. phpredis hides disconnects by transparently reconnecting, but it neglects to re-authenticate the new connection. To the user of the phpredis client API this manifests as a seemingly random tendency of connections to lose their authentication status.

This method is for internal use only.

See also
https://github.com/nicolasff/phpredis/issues/403
Parameters
string$server
Redis$conn
Returns
bool Success

Definition at line 368 of file RedisConnectionPool.php.

◆ resetTimeout()

RedisConnectionPool::resetTimeout ( Redis  $conn,
  $timeout = null 
)

Adjust or reset the connection handle read timeout value.

Parameters
Redis$conn
int | null$timeoutOptional

Definition at line 387 of file RedisConnectionPool.php.

◆ setLogger()

RedisConnectionPool::setLogger ( LoggerInterface  $logger)

Definition at line 106 of file RedisConnectionPool.php.

References $logger.

◆ singleton()

static RedisConnectionPool::singleton ( array  $options)
static
Parameters
array$options$options include:
  • connectTimeout : The timeout for new connections, in seconds. Optional, default is 1 second.
  • readTimeout : The timeout for operation reads, in seconds. Commands like BLPOP can fail if told to wait longer than this. Optional, default is 1 second.
  • persistent : Set this to true to allow connections to persist across multiple web requests. False by default.
  • password : The authentication password, will be sent to Redis in clear text. Optional, if it is unspecified, no AUTH command will be sent.
  • serializer : Set to "php", "igbinary", or "none". Default is "php".
Returns
RedisConnectionPool

Definition at line 146 of file RedisConnectionPool.php.

References $id, and serialize().

Referenced by RedisLockManager\__construct(), RedisBagOStuff\__construct(), PoolCounterRedis\__construct(), JobQueueRedis\__construct(), and RedisPubSubFeedEngine\send().

Member Data Documentation

◆ $connections

array RedisConnectionPool::$connections = []
protected

(server name => ((connection info array),...)

Definition at line 59 of file RedisConnectionPool.php.

◆ $connectTimeout

string RedisConnectionPool::$connectTimeout
protected

Connection timeout in seconds.

Definition at line 43 of file RedisConnectionPool.php.

◆ $downServers

array RedisConnectionPool::$downServers = []
protected

(server name => UNIX timestamp)

Definition at line 61 of file RedisConnectionPool.php.

◆ $id

string RedisConnectionPool::$id
protected

ID for persistent connections.

Definition at line 53 of file RedisConnectionPool.php.

Referenced by __construct(), and singleton().

◆ $idlePoolSize

int RedisConnectionPool::$idlePoolSize = 0
protected

Current idle pool size.

Definition at line 56 of file RedisConnectionPool.php.

Referenced by freeConnection(), and getConnection().

◆ $instances

array RedisConnectionPool::$instances = []
staticprotected

(pool ID => RedisConnectionPool)

Definition at line 64 of file RedisConnectionPool.php.

◆ $logger

LoggerInterface RedisConnectionPool::$logger
protected

Definition at line 72 of file RedisConnectionPool.php.

Referenced by getConnection(), and setLogger().

◆ $password

string RedisConnectionPool::$password
protected

Plaintext auth password.

Definition at line 47 of file RedisConnectionPool.php.

◆ $persistent

bool RedisConnectionPool::$persistent
protected

Whether connections persist.

Definition at line 49 of file RedisConnectionPool.php.

◆ $readTimeout

string RedisConnectionPool::$readTimeout
protected

Read timeout in seconds.

Definition at line 45 of file RedisConnectionPool.php.

◆ $serializer

int RedisConnectionPool::$serializer
protected

Serializer to use (Redis::SERIALIZER_*)

Definition at line 51 of file RedisConnectionPool.php.

◆ SERVER_DOWN_TTL

const RedisConnectionPool::SERVER_DOWN_TTL = 30

integer; seconds to cache servers as "down".

Definition at line 67 of file RedisConnectionPool.php.


The documentation for this class was generated from the following file: