ircbot/SocketFramework/Classes/Connection/ConnectionHandler.php

<?php
namespace JPT\SocketFramework\Connection;

/**
 * This class is a decorator for the SocketHandler class.
 * It provides a buffer for the SocketHandler, so reading and writing
 * a full line won't be that much pain.
 * 
 * @author jpt
 * @package Connection
 * @depends Socket
 * @depends Misc
 */
class ConnectionHandler {

	/**
	 * Buffer that contains incoming data.
	 * Contents were received from the SocketHandler.
	 * This buffer does not use a linebreak, it's a temporary store for data.
	 * 
	 * @var \JPT\SocketFramework\Misc\Buffer
	 */
	protected $bufferIncoming;

	/**
	 * Buffer that contains outgoing data.
	 * Contents will be sent to the SocketHandler.
	 * This buffer does not use a linebreak, it's a temporary store for data.
	 * 
	 * @var \JPT\SocketFramework\Misc\Buffer
	 */
	protected $bufferOutgoing;

	/**
	 * Contains the instance of the SocketHandler class.
	 * According to the Liskov substitution principle, decoration pattern must be used in this case.
	 * 
	 * @var \JPT\SocketFramework\Socket\SocketHandler
	 */
	protected $socketHandler;

	/**
	 * @var \JPT\SocketFramework\Connection\ConnectionPool
	 */
	protected $connectionPool;

	/**
	 * A boolean that indicates whether this Connection is a listening server socket or a usual client socket.
	 * 
	 * @var boolean
	 */
	protected $isServer;

	/**
	 * Unique Connection ID.
	 * 
	 * @var int
	 */
	protected $id;

	/**
	 * Connection Group.
	 * 
	 * @var string
	 */
	protected $group;

	/**
	 * @var string
	 */
	protected $protocol;

	/**
	 * @var boolean
	 */
	protected $IPv6;

	/**
	 * @var string
	 */
	protected $host;

	/**
	 * @var int
	 */
	protected $port;

	/**
	 * @var boolean
	 */
	protected $reconnectOnDisconnect;

	/**
	 * Calls parent constructor.
	 * 
	 * @param $socket
	 * @param $linebreak
	 * @return void
	 */
	public function __construct($socket, $id, $group = "", $protocol = "") {
		$this->bufferIncoming = new \JPT\SocketFramework\Misc\Buffer();
		$this->bufferOutgoing = new \JPT\SocketFramework\Misc\Buffer();
		$this->socketHandler = new \JPT\SocketFramework\Socket\SocketHandler($socket);
		$this->id = $id;
		$this->group = $group;
		$this->protocol = $protocol;
		$this->isServer = FALSE;
		$this->host = "";
		$this->port = 0;
		$this->reconnectOnDisconnect = FALSE;
		$this->IPv6 = FALSE;
	}

	/**
	 * Calls parent destructor.
	 * 
	 * @return void
	 */
	public function __destruct() {
		unset($this->socketHandler);
	}

	/**
	 * Injector for the internal ConnectionPool access.
	 * 
	 * @param \JPT\SocketFramework\Connection\ConnectionPool $connectionPool
	 * @return void
	 */
	public function injectConnectionPool($connectionPool) {
		$this->connectionPool = $connectionPool;
	}

	/**
	 * @return string
	 */
	public function getProtocol() {
		return $this->protocol;
	}

	/**
	 * @return string Connection Group
	 */
	public function getGroup() {
		return $this->group;
	}

	/**
	 * @return int Connection ID
	 */
	public function getID() {
		return $this->id;
	}

	/**
	 * Returns whether this connection is a listening socket or a general client connection socket.
	 * 
	 * @return boolean
	 */
	public function isServer() {
		return $this->isServer;
	}

	/**
	 * Sets the IPv6-flag.
	 * 
	 * @param boolean $IPv6
	 * @return void
	 */
	public function setIPv6($IPv6) {
		$this->IPv6 = $IPv6;
	}

	/**
	 * Sets reconnectOnDisconnect flag.
	 * 
	 * @param boolean $reconnect
	 * @return void
	 */
	public function setReconnect($reconnect) {
		$this->reconnectOnDisconnect = $reconnect;
	}

	/**
	 * Gets reconnectOnDisconnect flag.
	 * 
	 * @return boolean
	 */
	public function getReconnect() {
		return $this->reconnectOnDisconnect;
	}

	/**
	 * This function is called when socket_read() or socket_write() fail.
	 * It creates a new ConnectionHandler that will reconnect.
	 * 
	 * @return void
	 */
	protected function shutdown() {
		$this->setConnected(FALSE);
		$this->close();
	}

	/**
	 * Reads from SocketHandler, writes into bufferIncoming.
	 * Returns a boolean that will indicate whether the socket is still okay.
	 * 
	 * @throws \JPT\SocketFramework\Exception\SocketException
	 * @return boolean
	 */
	public function readToBuffer() {
		$data = $this->socketHandler->read();
			//set connection status flag properly.
		if($data === "") {
			$this->shutdown();
			return FALSE;
		}
		$this->bufferIncoming->addData($data);
		return TRUE;
	}

	/**
	 * Writes the bufferOutgoing to the SocketHandler.
	 * Returns a boolean that will indicate whether the socket is still okay.
	 * 
	 * @throws \JPT\SocketFramework\Exception\SocketException
	 * @return boolean
	 */
	public function writeFromBuffer() {
		$bufferContent = $this->bufferOutgoing->getAllBufferContents();
			//this might not be cool, but it should do.
		if($bufferContent === "") return TRUE;
		$result = $this->socketHandler->write($bufferContent);
		if($result === FALSE) {
			$this->shutdown();
			return FALSE;
		}
		return TRUE;
	}

	/**
	 * Calls error() on \JPT\SocketFramework\Socket\SocketHandler.
	 * 
	 * @throws \JPT\SocketFramework\Exception\SocketException
	 * @return void
	 */
	public function handleSocketError() {
		$this->socketHandler->error();
	}

	/**
	 * Determines whether this ConnectionHandler has data to read.
	 * 
	 * @return boolean
	 */
	public function canRead() {
		return $this->bufferIncoming->hasData();
	}

	/**
	 * Determines whether this ConnectionHandler has data to write.
	 * 
	 * @return boolean
	 */
	public function canWrite() {
		return $this->bufferOutgoing->hasData();
	}

	/**
	 * Reads new data into bufferIncoming.
	 * Returns a full line from bufferIncoming.
	 * 
	 * @return string
	 */
	public function read() {
		return $this->bufferIncoming->getAllBufferContents();
	}

	/**
	 * Writes data into bufferOutgoing.
	 * Sends data from bufferOutgoing to the SocketHandler.
	 * 
	 * @param $data
	 * @return void
	 */
	public function write($data) {
		$this->bufferOutgoing->addData($data);
	}

	/**
	 * Calls SocketHandler.
	 * 
	 * @see \JPT\SocketFramework\Socket\SocketHandler
	 * @throws \JPT\SocketFramework\Exception\SocketException
	 * @return ressource
	 */
	public function accept() {
		return $this->socketHandler->accept();
	}

	/**
	 * Calls SocketHandler.
	 * 
	 * @see \JPT\SocketFramework\Socket\SocketHandler
	 * @throws \JPT\SocketFramework\Exception\SocketException
	 * @return string
	 */
	public function getRemoteName() {
		return $this->socketHandler->getRemoteName();
	}

	/**
	 * Calls SocketHandler.
	 * 
	 * @see \JPT\SocketFramework\Socket\SocketHandler
	 * @throws \JPT\SocketFramework\Exception\SocketException
	 * @return string
	 */
	public function getLocalName() {
		return $this->socketHandler->getLocalName();
	}

	/**
	 * Calls SocketHandler.
	 * 
	 * @see \JPT\SocketFramework\Socket\SocketHandler
	 * @throws \JPT\SocketFramework\Exception\SocketException
	 * @return void
	 */
	public function close() {
		return $this->socketHandler->close();
	}

	/**
	 * Calls SocketHandler, stores connection data.
	 * 
	 * @see \JPT\SocketFramework\Socket\SocketHandler
	 * @throws \JPT\SocketFramework\Exception\SocketException
	 * @param string $address
	 * @param int $port
	 * @return void
	 */
	public function connect($address, $port) {
		$this->host = $address;
		$this->port = $port;
		return $this->socketHandler->connect($address, $port);
	}

	/**
	 * Calls SocketHandler, uses stored connection data to fork a new instance of itself.
	 * 
	 * @see \JPT\SocketFramework\Socket\SocketHandler
	 * @throws \JPT\SocketFramework\Exception\SocketException
	 * @throws \JPT\SocketFramework\Exception\GeneralException
	 * @return \JPT\SocketFramework\Connection\ConnectionHandler
	 */
	public function reconnect() {
		if($this->reconnectOnDisconnect === FALSE) throw new \JPT\SocketFramework\Exception\GeneralException("Cannot reconnect: Reconnect-Flag not set!", 1290951385);
		if(empty($this->host) === TRUE) throw new \JPT\SocketFramework\Exception\GeneralException("Cannot reconnect: No host specified.", 1290950818);
		if(empty($this->port) === TRUE) throw new \JPT\SocketFramework\Exception\GeneralException("Cannot reconnect: No port specified.", 1290950844);
		$newConnectionHandler = $this->connectionPool->createTcpConnection($this->group, $this->protocol, $this->IPv6);
		$newConnectionHandler->setReconnect($this->getReconnect());
		$newConnectionHandler->connect($this->host, $this->port);
		return $newConnectionHandler;
	}

	/**
	 * Calls SocketHandler.
	 * 
	 * @see \JPT\SocketFramework\Socket\SocketHandler
	 * @throws \JPT\SocketFramework\Exception\SocketException
	 * @return void
	 */
	public function bind($address, $port) {
		$this->host = $address;
		$this->port = $port;
		return $this->socketHandler->bind($address, $port);
	}

	/**
	 * Calls SocketHandler.
	 * 
	 * @see \JPT\SocketFramework\Socket\SocketHandler
	 * @throws \JPT\SocketFramework\Exception\SocketException
	 * @return void
	 */
	public function listen() {
		$this->isServer = TRUE;
		return $this->socketHandler->listen();
	}

	/**
	 * @see \JPT\SocketFramework\Socket\SocketHandler
	 * @return boolean
	 */
	public function isConnected() {
		return $this->socketHandler->isConnected();
	}

	/**
	 * Sets the is_connected-flag in the socket handler.
	 * 
	 * @see \JPT\SocketFramework\Socket\SocketHandler
	 * @param boolean $connected
	 * @return void
	 */
	protected function setConnected($connected) {
		return $this->socketHandler->setConnected($connected);
	}

	/**
	 * @see \JPT\SocketFramework\Socket\SocketHandler
	 * @return boolean
	 */
	public function isListening() {
		return $this->socketHandler->isListening();
	}

	/**
	 * Calls SocketHandler.
	 * 
	 * @see \JPT\SocketFramework\Socket\SocketHandler
	 * @throws \JPT\SocketFramework\Exception\SocketException
	 * @return ressource
	 */
	public function getSocket() {
		return $this->socketHandler->getSocket();
	}

	/**
	 * @return \JPT\SocketFramework\Socket\SocketHandler
	 */
	public function getSocketHandler() {
		return $this->socketHandler;
	}

	/**
	 * Calls SocketHandler.
	 * 
	 * @see \JPT\SocketFramework\Socket\SocketHandler
	 * @return void
	 */
	public function hasBeenAccepted() {
		return $this->socketHandler->hasBeenAccepted();
	}

}
?>