131 lines
3.0 KiB
PHP
131 lines
3.0 KiB
PHP
<?php
|
|
|
|
namespace Illuminate\Contracts\Queue;
|
|
|
|
interface Queue
|
|
{
|
|
/**
|
|
* Get the size of the queue.
|
|
*
|
|
* @param string|null $queue
|
|
* @return int
|
|
*/
|
|
public function size($queue = null);
|
|
|
|
/**
|
|
* Get the number of pending jobs.
|
|
*
|
|
* @param string|null $queue
|
|
* @return int
|
|
*/
|
|
public function pendingSize($queue = null);
|
|
|
|
/**
|
|
* Get the number of delayed jobs.
|
|
*
|
|
* @param string|null $queue
|
|
* @return int
|
|
*/
|
|
public function delayedSize($queue = null);
|
|
|
|
/**
|
|
* Get the number of reserved jobs.
|
|
*
|
|
* @param string|null $queue
|
|
* @return int
|
|
*/
|
|
public function reservedSize($queue = null);
|
|
|
|
/**
|
|
* Get the creation timestamp of the oldest pending job, excluding delayed jobs.
|
|
*
|
|
* @param string|null $queue
|
|
* @return int|null
|
|
*/
|
|
public function creationTimeOfOldestPendingJob($queue = null);
|
|
|
|
/**
|
|
* Push a new job onto the queue.
|
|
*
|
|
* @param string|object $job
|
|
* @param mixed $data
|
|
* @param string|null $queue
|
|
* @return mixed
|
|
*/
|
|
public function push($job, $data = '', $queue = null);
|
|
|
|
/**
|
|
* Push a new job onto the queue.
|
|
*
|
|
* @param string $queue
|
|
* @param string|object $job
|
|
* @param mixed $data
|
|
* @return mixed
|
|
*/
|
|
public function pushOn($queue, $job, $data = '');
|
|
|
|
/**
|
|
* Push a raw payload onto the queue.
|
|
*
|
|
* @param string $payload
|
|
* @param string|null $queue
|
|
* @return mixed
|
|
*/
|
|
public function pushRaw($payload, $queue = null, array $options = []);
|
|
|
|
/**
|
|
* Push a new job onto the queue after (n) seconds.
|
|
*
|
|
* @param \DateTimeInterface|\DateInterval|int $delay
|
|
* @param string|object $job
|
|
* @param mixed $data
|
|
* @param string|null $queue
|
|
* @return mixed
|
|
*/
|
|
public function later($delay, $job, $data = '', $queue = null);
|
|
|
|
/**
|
|
* Push a new job onto a specific queue after (n) seconds.
|
|
*
|
|
* @param string $queue
|
|
* @param \DateTimeInterface|\DateInterval|int $delay
|
|
* @param string|object $job
|
|
* @param mixed $data
|
|
* @return mixed
|
|
*/
|
|
public function laterOn($queue, $delay, $job, $data = '');
|
|
|
|
/**
|
|
* Push an array of jobs onto the queue.
|
|
*
|
|
* @param array $jobs
|
|
* @param mixed $data
|
|
* @param string|null $queue
|
|
* @return mixed
|
|
*/
|
|
public function bulk($jobs, $data = '', $queue = null);
|
|
|
|
/**
|
|
* Pop the next job off of the queue.
|
|
*
|
|
* @param string|null $queue
|
|
* @return \Illuminate\Contracts\Queue\Job|null
|
|
*/
|
|
public function pop($queue = null);
|
|
|
|
/**
|
|
* Get the connection name for the queue.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getConnectionName();
|
|
|
|
/**
|
|
* Set the connection name for the queue.
|
|
*
|
|
* @param string $name
|
|
* @return $this
|
|
*/
|
|
public function setConnectionName($name);
|
|
}
|