| [ Index ] |
PHP Cross Reference of MediaWiki-1.24.0 |
[Source view] [Print] [Project Stats]
Redis-backed job queue code. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
| Author: | Aaron Schulz |
| File Size: | 865 lines (27 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
JobQueueRedis:: (34 methods):
__construct()
supportedOrders()
optimalOrder()
supportsDelayedJobs()
doIsEmpty()
doGetSize()
doGetAcquiredCount()
doGetDelayedCount()
doGetAbandonedCount()
doBatchPush()
pushBlobs()
doPop()
popAndDeleteBlob()
popAndAcquireBlob()
doAck()
doDeduplicateRootJob()
doIsRootJobOldDuplicate()
doDelete()
getAllQueuedJobs()
getAllDelayedJobs()
getCoalesceLocationInternal()
doGetSiblingQueuesWithJobs()
doGetSiblingQueueSizes()
getJobFromUidInternal()
recyclePruneAndUndelayJobs()
doGetPeriodicTasks()
getNewJobFields()
getJobFromFields()
serialize()
unserialize()
getConnection()
throwRedisException()
getQueueKey()
setTestingPrefix()
Class: JobQueueRedis - X-Ref
Class to handle job queues stored in Redis| __construct( array $params ) X-Ref |
param: array $params Possible keys: |
| supportedOrders() X-Ref |
| No description |
| optimalOrder() X-Ref |
| No description |
| supportsDelayedJobs() X-Ref |
| No description |
| doIsEmpty() X-Ref |
return: bool |
| doGetSize() X-Ref |
return: int |
| doGetAcquiredCount() X-Ref |
return: int |
| doGetDelayedCount() X-Ref |
return: int |
| doGetAbandonedCount() X-Ref |
return: int |
| doBatchPush( array $jobs, $flags ) X-Ref |
param: array $jobs param: int $flags return: void |
| pushBlobs( RedisConnRef $conn, array $items ) X-Ref |
param: RedisConnRef $conn param: array $items List of results from JobQueueRedis::getNewJobFields() return: int Number of jobs inserted (duplicates are ignored) |
| doPop() X-Ref |
return: Job|bool |
| popAndDeleteBlob( RedisConnRef $conn ) X-Ref |
param: RedisConnRef $conn return: array Serialized string or false |
| popAndAcquireBlob( RedisConnRef $conn ) X-Ref |
param: RedisConnRef $conn return: array Serialized string or false |
| doAck( Job $job ) X-Ref |
param: Job $job return: Job|bool |
| doDeduplicateRootJob( Job $job ) X-Ref |
param: Job $job return: bool |
| doIsRootJobOldDuplicate( Job $job ) X-Ref |
param: Job $job return: bool |
| doDelete() X-Ref |
return: bool |
| getAllQueuedJobs() X-Ref |
return: Iterator |
| getAllDelayedJobs() X-Ref |
| No description |
| getCoalesceLocationInternal() X-Ref |
| No description |
| doGetSiblingQueuesWithJobs( array $types ) X-Ref |
| No description |
| doGetSiblingQueueSizes( array $types ) X-Ref |
| No description |
| getJobFromUidInternal( $uid, RedisConnRef $conn ) X-Ref |
| This function should not be called outside JobQueueRedis param: string $uid param: RedisConnRef $conn return: Job|bool Returns false if the job does not exist |
| recyclePruneAndUndelayJobs() X-Ref |
| Recycle or destroy any jobs that have been claimed for too long and release any ready delayed jobs into the queue return: int Number of jobs recycled/deleted/undelayed |
| doGetPeriodicTasks() X-Ref |
return: array |
| getNewJobFields( IJobSpecification $job ) X-Ref |
param: IJobSpecification $job return: array |
| getJobFromFields( array $fields ) X-Ref |
param: array $fields return: Job|bool |
| serialize( array $fields ) X-Ref |
param: array $fields return: string Serialized and possibly compressed version of $fields |
| unserialize( $blob ) X-Ref |
param: string $blob return: array|bool Unserialized version of $blob or false |
| getConnection() X-Ref |
| Get a connection to the server that handles all sub-queues for this queue return: RedisConnRef |
| throwRedisException( RedisConnRef $conn, $e ) X-Ref |
param: RedisConnRef $conn param: RedisException $e |
| getQueueKey( $prop, $type = null ) X-Ref |
param: string $prop param: string|null $type return: string |
| setTestingPrefix( $key ) X-Ref |
param: string $key return: void |
| Generated: Fri Nov 28 14:03:12 2014 | Cross-referenced by PHPXref 0.7.1 |