1	<?php
2
3	/**
4	* This program is free software; you can redistribute it and/or
5	* modify it under the terms of the GNU General Public License
6	* as published by the Free Software Foundation; under version 2
7	* of the License (non-upgradable).
8	*
9	* This program is distributed in the hope that it will be useful,
10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12	* GNU General Public License for more details.
13	*
14	* You should have received a copy of the GNU General Public License
15	* along with this program; if not, write to the Free Software
16	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17	*
18	* Copyright (c) 2017-2021 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
19	*
20	*/
21
22	namespace oat\tao\model\taskQueue\Queue\Broker;
23
24	use oat\tao\model\taskQueue\Task\TaskInterface;
25	use Psr\Log\LoggerAwareInterface;
26
27	/**
28	* @author Gyula Szucs <gyula@taotesting.com>
29	*/
30	interface QueueBrokerInterface extends \Countable, LoggerAwareInterface
31	{
32	/**
33	* Set queue name
34	*
35	* @param string $name
36	* @return QueueBrokerInterface
37	*/
38	public function setQueueName($name);
39
40	public function getBrokerId(): string;
41
42	/**
43	* Creates the queue.
44	*
45	* @return mixed
46	*/
47	public function createQueue();
48
49	/**
50	* Pushes a task into the queue.
51	*
52	* @param TaskInterface $task
53	* @return bool
54	*/
55	public function push(TaskInterface $task);
56
57	/**
58	* Pops a task from the queue. Returns null if there is no more task.
59	*
60	* @return null|TaskInterface
61	*/
62	public function pop();
63
64	/**
65	* If the driver supports it, this will be called when a task has been consumed.
66	*
67	* @param TaskInterface $task
68	*/
69	public function delete(TaskInterface $task);
70
71	/**
72	* The amount of tasks that can be received in one pop.
73	*
74	* @return int
75	*/
76	public function getNumberOfTasksToReceive();
77
78	/**
79	* Check if the internal queue contains any tasks.
80	*/
81	public function hasPreFetchedMessages(): bool;
82	}