RedisConnRef Class Reference

Helper class to handle automatically marking connections as reusable (via RAII pattern) More...

Inheritance diagram for RedisConnRef:

Collaboration diagram for RedisConnRef:

Public Member Functions
	__call ( $name, $arguments)
	Magic __call handler for most Redis functions.
	__construct (RedisConnectionPool $pool, $server, Redis $conn, LoggerInterface $logger)
	__destruct ()
	clearLastError ()
	getLastError ()
	getServer ()
	hScan ( $key, &$iterator, $pattern=null, $count=null)
	Hash Scan Handle this explicitly due to needing the iterator passed by reference.
	isConnIdentical (Redis $conn)
	luaEval ( $script, array $params, $numKeys)
	scan (&$iterator, $pattern=null, $count=null)
	Key Scan Handle this explicitly due to needing the iterator passed by reference.
	setLogger (LoggerInterface $logger)
	sScan ( $key, &$iterator, $pattern=null, $count=null)
	Set Scan Handle this explicitly due to needing the iterator passed by reference.
	zScan ( $key, &$iterator, $pattern=null, $count=null)
	Sorted Set Scan Handle this explicitly due to needing the iterator passed by reference.

Protected Attributes
Redis	$conn
string null	$lastError
LoggerInterface	$logger
RedisConnectionPool	$pool
string	$server

Detailed Description

Helper class to handle automatically marking connections as reusable (via RAII pattern)

This class simply wraps the Redis class and can be used the same way

Since

1.21

Definition at line 31 of file RedisConnRef.php.

Constructor & Destructor Documentation

__construct()

RedisConnRef::__construct	(	RedisConnectionPool	$pool,
			$server,
		Redis	$conn,
		LoggerInterface	$logger )

Parameters

RedisConnectionPool	$pool
string	$server
Redis	$conn
LoggerInterface	$logger

Definition at line 67 of file RedisConnRef.php.

References $conn, $logger, $pool, and $server.

__destruct()

RedisConnRef::__destruct

(

)

Definition at line 300 of file RedisConnRef.php.

Member Function Documentation

__call()

RedisConnRef::__call	(		$name,
			$arguments )

Magic __call handler for most Redis functions.

Parameters

string	$name
array	$arguments

Returns

mixed

Exceptions

RedisException

Definition at line 104 of file RedisConnRef.php.

clearLastError()

RedisConnRef::clearLastError

(

)

Definition at line 92 of file RedisConnRef.php.

getLastError()

RedisConnRef::getLastError

(

)

Definition at line 88 of file RedisConnRef.php.

References $lastError.

getServer()

RedisConnRef::getServer

(

)

Returns

string

Since

1.23

Definition at line 84 of file RedisConnRef.php.

References $server.

Referenced by RedisConnectionPool\handleError().

hScan()

RedisConnRef::hScan	(		$key,
		&	$iterator,
			$pattern = null,
			$count = null )

Hash Scan Handle this explicitly due to needing the iterator passed by reference.

See: https://github.com/phpredis/phpredis#hScan

Parameters

string	$key
int	&$iterator
string | null	$pattern
int | null	$count

Returns

array

Definition at line 185 of file RedisConnRef.php.

isConnIdentical()

RedisConnRef::isConnIdentical

(

Redis

$conn

)

Parameters

Redis

$conn

Returns

bool

Definition at line 296 of file RedisConnRef.php.

References $conn.

Referenced by RedisConnectionPool\handleError().

luaEval()

RedisConnRef::luaEval	(		$script,
		array	$params,
			$numKeys )

Parameters

string	$script
array	$params
int	$numKeys

Returns

mixed

Exceptions

RedisException

Definition at line 244 of file RedisConnRef.php.

References $conn, $lastError, $res, and $server.

Referenced by PoolCounterRedis\initAndPopPoolSlotList(), JobQueueRedis\popAndAcquireBlob(), JobQueueRedis\pushBlobs(), PoolCounterRedis\registerAcquisitionTime(), and PoolCounterRedis\release().

scan()

RedisConnRef::scan	(	&	$iterator,
			$pattern = null,
			$count = null )

Key Scan Handle this explicitly due to needing the iterator passed by reference.

See: https://github.com/phpredis/phpredis#scan

Parameters

int	&$iterator
string | null	$pattern
int | null	$count

Returns

array

Definition at line 155 of file RedisConnRef.php.

setLogger()

RedisConnRef::setLogger

(

LoggerInterface

$logger

)

Definition at line 76 of file RedisConnRef.php.

References $logger.

sScan()

RedisConnRef::sScan	(		$key,
		&	$iterator,
			$pattern = null,
			$count = null )

Set Scan Handle this explicitly due to needing the iterator passed by reference.

See: https://github.com/phpredis/phpredis#sScan

Parameters

string	$key
int	&$iterator
string | null	$pattern
int | null	$count

Returns

array

Definition at line 170 of file RedisConnRef.php.

zScan()

RedisConnRef::zScan	(		$key,
		&	$iterator,
			$pattern = null,
			$count = null )

Sorted Set Scan Handle this explicitly due to needing the iterator passed by reference.

See: https://github.com/phpredis/phpredis#hScan

Parameters

string	$key
int	&$iterator
string | null	$pattern
int | null	$count

Returns

array

Definition at line 200 of file RedisConnRef.php.

Member Data Documentation

$conn

Redis RedisConnRef::$conn

protected

Definition at line 35 of file RedisConnRef.php.

Referenced by __construct(), isConnIdentical(), and luaEval().

$lastError

string null RedisConnRef::$lastError

protected

Definition at line 39 of file RedisConnRef.php.

Referenced by getLastError(), and luaEval().

$logger

LoggerInterface RedisConnRef::$logger

protected

Definition at line 44 of file RedisConnRef.php.

Referenced by __construct(), and setLogger().

$pool

RedisConnectionPool RedisConnRef::$pool

protected

Definition at line 33 of file RedisConnRef.php.

Referenced by __construct().

$server

string RedisConnRef::$server

protected

Definition at line 37 of file RedisConnRef.php.

Referenced by __construct(), getServer(), and luaEval().

---

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

• includes/libs/redis/RedisConnRef.php