3 * A general Producer class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 abstract class BaseProducer extends BaseFrameworkSystem {
28 private $outgoingQueueInstance = NULL;
31 * Incoming raw data/items queue
33 private $incomingQueueInstance = NULL;
36 * Protected constructor
38 * @param $className Name of the class
41 protected function __construct ($className) {
42 // Call parent constructor
43 parent::__construct($className);
45 // Initialize all producers
46 $this->initProducer();
48 // Initialize work queue (out-going, produced items)
49 $this->initWorkQueue();
53 * Getter for outgoing work queue
55 * @param $outgoingQueueInstance The outgoing work queue instance
57 protected final function getOutgoingQueueInstance () {
58 return $this->outgoingQueueInstance;
62 * Setter for outgoing work queue
64 * @param $outgoingQueueInstance The outgoing work queue instance
67 private final function setOutgoingQueueInstance (Stackable $outgoingQueueInstance) {
68 $this->outgoingQueueInstance = $outgoingQueueInstance;
72 * Getter for incoming raw data/items queue
74 * @param $incomingQueueInstance The incoming raw data/items queue instance
76 protected final function getIncomingQueueInstance () {
77 return $this->incomingQueueInstance;
81 * Setter for incoming raw data/items queue
83 * @param $incomingQueueInstance The incoming raw data/items queue instance
86 private final function setIncomingQueueInstance (Stackable $incomingQueueInstance) {
87 $this->incomingQueueInstance = $incomingQueueInstance;
91 * Initializes this producer, this method must be overwritten.
95 abstract protected function initProducer();
98 * Initializes the work queue which is being used for outgoing, produced
103 protected function initWorkQueue () {
104 // Get an instance and set it in this producer
105 $this->setOutgoingQueueInstance(ObjectFactory::createObjectByConfiguredName('producer_outgoing_queue'));
108 $this->initOutgoingQueue();
110 // Get an instance and set it in this producer
111 $this->setIncomingQueueInstance(ObjectFactory::createObjectByConfiguredName('producer_incoming_queue'));
114 $this->initIncomingQueue();
117 self::createDebugInstance(__CLASS__)->debugOutput('PRODUCER: All queues have been initialized.');
121 * Inits the out-going queue stack
125 protected function initOutgoingQueue () {
126 $this->getOutgoingQueueInstance()->initStacker('outgoing_queue', true);
130 * Adds an entry to the out-going work queue
132 * @param $value The value to be added to the out-going work queue
135 protected function addValueToOutgoingQueue ($value) {
136 $this->getOutgoingQueueInstance()->pushNamed('outgoing_queue', $value);
140 * Checks whether a configurable out-going queue limit has been reached
142 * @param $configEntry Configuration entry where the limit is stored
143 * @return $isReached Whether the limit is reached
145 protected function isOutgoingQueueLimitReached($configEntry) {
146 return ($this->getConfigInstance()->getConfigEntry($configEntry) <= $this->getOutgoingQueueInstance()->getStackCount('outgoing_queue'));
150 * Inits the incoming queue stack
154 protected function initIncomingQueue () {
155 $this->getIncomingQueueInstance()->initStacker('incoming_queue', true);
159 * Adds an entry to the incoming work queue
161 * @param $value The value to be added to the incoming work queue
164 protected function addValueToIncomingQueue ($value) {
165 $this->getIncomingQueueInstance()->pushNamed('incoming_queue', $value);
169 * Checks whether a configurable incoming queue limit has been reached
171 * @param $configEntry Configuration entry where the limit is stored
172 * @return $isReached Whether the limit is reached
174 protected function isIncomingQueueLimitReached($configEntry) {
175 return ($this->getConfigInstance()->getConfigEntry($configEntry) <= $this->getIncomingQueueInstance()->getStackCount('incoming_queue'));