<?php
// Own namespace
namespace CoreFramework\Listener\!!!;

// Import framework stuff
use CoreFramework\Listener\Listenable;

/**
 * A ??? listener
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core 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 ???Listener extends BaseListener implements Listenable {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);

		// Set the protocol to !!!
		$this->setProtocolName('!!!');
	}

	/**
	 * Creates an instance of this class
	 *
	 * @return	$listenerInstance	An instance a prepared listener class
	 */
	public final static function create???Listener () {
		// Get new instance
		$listenerInstance = new ???Listener();

		// Return the prepared instance
		return $listenerInstance;
	}

	/**
	 * Initializes the listener by setting up the required socket server
	 *
	 * @return	void
	 * @todo	0% done
	 */
	public function initListener() {
		$this->partialStub('Need to implement this method.');
	}

	/**
	 * "Listens" for incoming network packages
	 *
	 * @return	void
	 * @todo	0% done
	 */
	public function doListen() {
		$this->partialStub('Need to implement this method.');
	}

	/**
	 * Checks whether the listener would accept the given package data array
	 *
	 * @param	$packageData	Raw package data
	 * @return	$accepts		Whether this listener does accept
	 */
	public function ifListenerAcceptsPackageData (array $packageData) {
		$this->partialStub('Need to implement this method.') {
	}

	/**
	 * Monitors incoming raw data from the handler and transfers it to the
	 * given receiver instance.
	 *
	 * @return	void
	 */
	public function monitorIncomingRawData () {
		$this->partialStub('Need to implement this method.') {
	}

	/**
	 * Getter for connection type
	 *
	 * @return	$connectionType		Connection type for this listener
	 */
	public function getConnectionType () {
		$this->partialStub('Need to implement this method.') {
	}

}