<?php
/**
 * A NetworkPackageReader task
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.ship-simu.org
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
class NetworkPackageReaderTask extends BaseTask implements Taskable, Visitable {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Creates an instance of this class
	 *
	 * @param	$poolInstance	An instance of a PoolableListener class
	 * @return	$taskInstance	An instance of a Taskable/Visitable class
	 */
	public static final function createNetworkPackageReaderTask (PoolableListener $poolInstance) {
		// Get new instance
		$taskInstance = new NetworkPackageReaderTask();

		// Set the listener instance here
		$taskInstance->setListenerPoolInstance($poolInstance);

		// Get a singleton network package instance
		$packageInstance = NetworkPackageFactory::createNetworkPackageInstance();

		// And set it in this task
		$taskInstance->setPackageInstance($packageInstance);

		// Return the prepared instance
		return $taskInstance;
	}

	/**
	 * Accepts the visitor to process the visit "request"
	 *
	 * @param	$visitorInstance	An instance of a Visitor class
	 * @return	void
	 * @todo	Also visit some sub-objects?
	 */
	public function accept (Visitor $visitorInstance) {
		// Visit this task
		$visitorInstance->visitTask($this);
	}

	/**
	 * Executes the task
	 *
	 * @return	void
	 */
	public function executeTask () {
		// Do we have something to handle?
		if ($this->getPackageInstance()->isProcessedMessagePending()) {
			/*
			 * A previously proccessed message is waiting for being
			 * "interpreted". This is done by trying to find a configuration
			 * entry based on 'message_type' element.
			 */
			$this->getPackageInstance()->handleProcessedMessage();
		} elseif ($this->getPackageInstance()->isNewMessageArrived()) {
			/*
			 * A fully "decoded" message has been received and added for being
			 * processed. Processing a message should not take long, so mostly
			 * this step involves reading all data through a XML template engine
			 * as "XML variables" from the content (which must be a well-formed
			 * XML) and then pushing it on the next stack "processed messages".
			 */
			$this->getPackageInstance()->handleNewlyArrivedMessage();
		} elseif ($this->getPackageInstance()->isIncomingRawDataHandled()) {
			/*
			 * Incoming decoded data has been handled (see below) so it needs to
			 * be assembled back to a "package array". Please see NetworkPackage
			 * for further details (what array elements are required et cetera).
			 */
			$this->getPackageInstance()->assembleDecodedDataToPackage();
		} elseif ($this->getPackageInstance()->isNewRawDataPending($this->getListenerPoolInstance())) {
			// Raw, decoded data has been received
			$this->getPackageInstance()->handleIncomingDecodedData();
		} elseif ($this->getPackageInstance()->ifAssemblerHasPendingDataLeft()) {
			// Handle any pending data from the package assembler
			$this->getPackageInstance()->handleAssemblerPendingData();
		} // END - if
	}
}

// [EOF]
?>