Skip to content

Commit f89b19c

Browse files
committed
doc: cleanup
1 parent cf913db commit f89b19c

File tree

1 file changed

+1
-30
lines changed

1 file changed

+1
-30
lines changed

src/WQ/WorkServerAdapter/RedisWorkServer.php

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ class RedisWorkServer
4040

4141
/**
4242
* Constructor.
43-
* Takes an already-configured {@see Pheanstalk} instance to work with.
43+
* Takes an already-configured {@see Redis} instance to work with.
4444
* Does not attempt to establish a connection itself --
4545
* use the {@see connect()} factory method for that instead
4646
* or do it with {@see Redis::connect()} prior to using this constructor.
@@ -281,14 +281,6 @@ private static function queueKeys(array $workQueues)
281281
# return $workQueues;
282282
# }
283283

284-
/**
285-
* Stores a job in the work queue for later processing.
286-
*
287-
* @param string $workQueue The name of the Work Queue to store the job in.
288-
* @param Job $job The job to store.
289-
* @param int $delay The job delay in seconds after which it will become available to {@see getNextQueueEntry()}.
290-
* Set to zero (default) for jobs which should be processed as soon as possible.
291-
*/
292284
public function storeJob(string $workQueue, Job $job, int $delay = 0): void
293285
{
294286
$serializedData = serialize($job);
@@ -318,33 +310,12 @@ public function buryEntry(QueueEntry $entry): void
318310
$entry->getHandle());
319311
}
320312

321-
/**
322-
* Re-queues an existing job
323-
* so that it can be returned by {@see getNextQueueEntry()}
324-
* again at some later time.
325-
* A {@see $delay} is required
326-
* to prevent the job from being returned right after it was re-queued.
327-
*
328-
* This is what happens to failed jobs which can still be re-queued for a retry.
329-
*
330-
* @param QueueEntry $entry The job to re-queue. The instance should not be used anymore after this call.
331-
* @param int $delay The job delay in seconds. It will become available for {@see getNextQueueEntry()} after this delay.
332-
* @param string|null $workQueue By default, to job is re-queued into its original Work Queue ({@see QueueEntry::getWorkQueue}).
333-
* With this parameter, a different Work Queue can be chosen.
334-
*/
335313
public function requeueEntry(QueueEntry $entry, int $delay, string $workQueue = null): void
336314
{
337315
$queueName = $workQueue ?? $entry->getWorkQueue();
338316
$this->storeJob($queueName, $entry->getJob(), $delay);
339317
}
340318

341-
/**
342-
* Permanently deletes a job entry for its work queue.
343-
*
344-
* This is what happens to finished jobs.
345-
*
346-
* @param QueueEntry $entry The job to delete.
347-
*/
348319
public function deleteEntry(QueueEntry $entry): void
349320
{
350321
// nop, we already removed the entry from the queue with LPOP

0 commit comments

Comments
 (0)