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 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
19	*
20	*/
21
22	namespace oat\tao\model\taskQueue;
23
24	use oat\tao\model\taskQueue\Task\TaskInterface;
25
26	/**
27	* Describes an object consumable by a worker.
28	*
29	* @author Gyula Szucs <gyula@taotesting.com>
30	*/
31	interface QueuerInterface extends \Countable
32	{
33	/**
34	* Publish a task to a queue.
35	*
36	* @param TaskInterface $task
37	* @param null|string   $label Label for the task
38	* @return bool Is the task successfully enqueued?
39	*/
40	public function enqueue(TaskInterface $task, $label = null);
41
42	/**
43	* Receive a task from the queue.
44	*
45	* @return null|TaskInterface
46	*/
47	public function dequeue();
48
49	/**
50	* Acknowledge that the task has been received and consumed.
51	*
52	* @param TaskInterface $task
53	*/
54	public function acknowledge(TaskInterface $task);
55
56	/**
57	* Check if the internal queue contains any tasks.
58	*/
59	public function hasPreFetchedMessages(): bool;
60	}