RedisJobService Class Reference

Base class for job services with main() implemented by subclasses. More...

Inheritance diagram for RedisJobService:

Public Member Functions
	main ()
	Entry point method that starts the service in earnest and keeps running.
	getReadyQueueKey ()
	encQueueName ( $type, $domain)
	dencQueueName ( $name)
	getRedisConn ( $server)
	handleRedisError (RedisException $e, $server)
	redisCmd (Redis $conn, $cmd, array $args=[])
	redisCmdHA (array $servers, $cmd, array $args=[])
	Execute a command on the current working server in $servers.
	redisCmdBroadcast (array $servers, $cmd, array $args=[])
	Execute a command on all servers in $servers.
	incrStats ( $event, $delta=1)
	debug ( $s)
	notice ( $s)
	error ( $s)

Static Public Member Functions
static	init (array $args)
static	checkEnvironment ()
	Terminate this script if the OS/PHP environment is incompatible.

Public Attributes
	$loopMap = []
	$maxRealMap = []
	$maxMemMap = []
	$dispatcher
	$hpMaxDelay = 120
	$lpMaxTime = 60
	$lpMaxDelay = 600
	$hpMaxTime = 30

Protected Member Functions
	__construct (array $config)
	sendStats ()
	Actually send the stats that have been saved in $this->statsdPackets.

Protected Attributes
	$queueSrvs = []
	$aggrSrvs = []
	$password
	$wrapper
	$statsdHost
	$statsdPort
	$verbose
	$claimTTLMap = []
	$attemptsMap = []
	$conns = []
	$downSrvs = []

Detailed Description

Base class for job services with main() implemented by subclasses.

Constructor & Destructor Documentation

__construct()

RedisJobService::__construct ( array $config )

protected

Parameters

array

$config

Member Function Documentation

debug()

RedisJobService::debug

(

$s

)

Parameters

string

$s

dencQueueName()

RedisJobService::dencQueueName

(

$name

)

Parameters

string

$name

Returns

array (per JobQueueAggregatorRedis.php)

encQueueName()

RedisJobService::encQueueName	(		$type,
			$domain )

Parameters

string	$type
string	$domain

Returns

string (per JobQueueAggregatorRedis.php)

error()

RedisJobService::error

(

$s

)

Parameters

string

$s

getReadyQueueKey()

RedisJobService::getReadyQueueKey

(

)

Returns

string (per JobQueueAggregatorRedis.php)

getRedisConn()

RedisJobService::getRedisConn

(

$server

)

Parameters

string

$server

Returns

Redis|bool

handleRedisError()

RedisJobService::handleRedisError	(	RedisException	$e,
			$server )

Parameters

RedisException	$e
string	$server

incrStats()

RedisJobService::incrStats	(		$event,
			$delta = 1 )

Parameters

string	$event
int	$delta

Returns

void

init()

static RedisJobService::init ( array $args )

static

Parameters

array

$args

Returns

RedisJobService

Exceptions

Exception

main()

RedisJobService::main ( )

abstract

Entry point method that starts the service in earnest and keeps running.

Reimplemented in RedisJobChronService, and RedisJobRunnerService.

notice()

RedisJobService::notice

(

$s

)

Parameters

string

$s

redisCmd()

RedisJobService::redisCmd	(	Redis	$conn,
			$cmd,
		array	$args = [] )

Parameters

Redis	$conn
string	$cmd
array	$args

Returns

mixed

Exceptions

RedisException

redisCmdBroadcast()

RedisJobService::redisCmdBroadcast	(	array	$servers,
			$cmd,
		array	$args = [] )

Execute a command on all servers in $servers.

Parameters

array	$servers	List of servers to attempt
string	$cmd
array	$args

Returns

int Number of servers updated

Exceptions

RedisExceptionHA

redisCmdHA()

RedisJobService::redisCmdHA	(	array	$servers,
			$cmd,
		array	$args = [] )

Execute a command on the current working server in $servers.

Parameters

array	$servers	Ordered list of servers to attempt
string	$cmd
array	$args

Returns

mixed

Exceptions

RedisExceptionHA

---

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

• src/RedisJobService.php