This commit is contained in:
Jan Philipp Timme
@@ -0,0 +1,295 @@
|
||||
<?php
|
||||
/**
|
||||
* This class is a decorator for the class SocketHandler.
|
||||
* 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 Connection_ConnectionHandler {
|
||||
|
||||
/**
|
||||
* Buffer that contains incoming data.
|
||||
* Contents were received from the SocketHandler.
|
||||
* @var Misc_Buffer
|
||||
*/
|
||||
protected $buffer_incoming;
|
||||
|
||||
/**
|
||||
* Buffer that contains outgoing data.
|
||||
* Contents will be sent to the SocketHandler.
|
||||
* @var Misc_Buffer
|
||||
*/
|
||||
protected $buffer_outgoing;
|
||||
|
||||
/**
|
||||
* Contains the instance of the SocketHandler class.
|
||||
* According to the Liskov substitution principle, decoration pattern must be used in this case.
|
||||
* @var Socket_SocketHandler
|
||||
*/
|
||||
protected $socketHandler;
|
||||
|
||||
/**
|
||||
* A boolean that indicates whether this Connection is a listening server socket or a usual client socket.
|
||||
* @var boolean
|
||||
*/
|
||||
protected $is_server;
|
||||
|
||||
/**
|
||||
* Unique Connection ID.
|
||||
* @var int
|
||||
*/
|
||||
protected $id;
|
||||
|
||||
/**
|
||||
* Connection Group.
|
||||
* @var string
|
||||
*/
|
||||
protected $group;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected $protocol;
|
||||
|
||||
/**
|
||||
* Calls parent constructor.
|
||||
* @param $socket
|
||||
* @param $linebreak
|
||||
* @return void
|
||||
*/
|
||||
function __construct($socket, $id, $group = "", $protocol = "", $linebreak = "\r\n") {
|
||||
$this->buffer_incoming = new Misc_Buffer($linebreak);
|
||||
$this->buffer_outgoing = new Misc_Buffer($linebreak);
|
||||
$this->socketHandler = new Socket_SocketHandler($socket);
|
||||
$this->id = $id;
|
||||
$this->group = $group;
|
||||
$this->protocol = $protocol;
|
||||
$this->is_server = FALSE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Calls parent destructor.
|
||||
* @return void
|
||||
*/
|
||||
function __destruct() {
|
||||
unset($this->socketHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* @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->is_server;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads from SocketHandler, writes into buffer_incoming.
|
||||
* Returns a boolean that will indicate whether the socket is still okay.
|
||||
* @throws Exception_SocketException
|
||||
* @return boolean
|
||||
*/
|
||||
public function readToBuffer() {
|
||||
$data = $this->socketHandler->read();
|
||||
if($data === "") return FALSE;
|
||||
$this->buffer_incoming->addData($data);
|
||||
return TRUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes the buffer_outgoing to the SocketHandler.
|
||||
* Returns a boolean that will indicate whether the socket is still okay.
|
||||
* @throws Exception_SocketException
|
||||
* @return boolean
|
||||
*/
|
||||
public function writeFromBuffer() {
|
||||
while($this->buffer_outgoing->hasLines()) {
|
||||
$result = $this->socketHandler->write($this->buffer_outgoing->getNextLine());
|
||||
if($result === FALSE) return FALSE;
|
||||
}
|
||||
return TRUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Calls error() on Socket_SocketHandler.
|
||||
* @throws Socket_SocketExceptions
|
||||
* @return void
|
||||
*/
|
||||
public function handleSocketError() {
|
||||
$this->socketHandler->error();
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines whether this ConnectionHandler has data to read.
|
||||
* @return boolean
|
||||
*/
|
||||
public function canRead() {
|
||||
return $this->buffer_incoming->hasLines();
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines whether this ConnectionHandler has data to write.
|
||||
* @return boolean
|
||||
*/
|
||||
public function canWrite() {
|
||||
return $this->buffer_outgoing->hasLines();
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads new data into buffer_incoming.
|
||||
* Returns a full line from buffer_incoming.
|
||||
* @return string
|
||||
*/
|
||||
public function read() {
|
||||
return $this->buffer_incoming->getNextLine();
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes data into buffer_outgoing.
|
||||
* Sends data from buffer_outgoing to the SocketHandler.
|
||||
* @param $data
|
||||
* @return void
|
||||
*/
|
||||
public function write($data) {
|
||||
$this->buffer_outgoing->addData($data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Calls SocketHandler
|
||||
* @see Socket_SocketHandler
|
||||
* @throws Exception_SocketException
|
||||
* @return ressource
|
||||
*/
|
||||
public function accept() {
|
||||
return $this->socketHandler->accept();
|
||||
}
|
||||
|
||||
/**
|
||||
* Calls SocketHandler
|
||||
* @see Socket_SocketHandler
|
||||
* @throws Exception_SocketException
|
||||
* @return string
|
||||
*/
|
||||
public function getRemoteName() {
|
||||
return $this->socketHandler->getRemoteName();
|
||||
}
|
||||
|
||||
/**
|
||||
* Calls SocketHandler
|
||||
* @see Socket_SocketHandler
|
||||
* @throws Exception_SocketException
|
||||
* @return string
|
||||
*/
|
||||
public function getLocalName() {
|
||||
return $this->socketHandler->getLocalName();
|
||||
}
|
||||
|
||||
/**
|
||||
* Calls SocketHandler
|
||||
* @see Socket_SocketHandler
|
||||
* @throws Exception_SocketException
|
||||
* @return void
|
||||
*/
|
||||
public function close() {
|
||||
return $this->socketHandler->close();
|
||||
}
|
||||
|
||||
/**
|
||||
* Calls SocketHandler
|
||||
* @see Socket_SocketHandler
|
||||
* @throws Exception_SocketException
|
||||
* @return void
|
||||
*/
|
||||
public function connect($address, $port) {
|
||||
return $this->socketHandler->connect($address, $port);
|
||||
}
|
||||
|
||||
/**
|
||||
* Calls SocketHandler
|
||||
* @see Socket_SocketHandler
|
||||
* @throws Exception_SocketException
|
||||
* @return void
|
||||
*/
|
||||
public function bind($address, $port) {
|
||||
return $this->socketHandler->bind($address, $port);
|
||||
}
|
||||
|
||||
/**
|
||||
* Calls SocketHandler
|
||||
* @see Socket_SocketHandler
|
||||
* @throws Exception_SocketException
|
||||
* @return void
|
||||
*/
|
||||
public function listen() {
|
||||
$this->is_server = TRUE;
|
||||
return $this->socketHandler->listen();
|
||||
}
|
||||
|
||||
/**
|
||||
* @see Socket_SocketHandler
|
||||
* @return boolean
|
||||
*/
|
||||
public function isConnected() {
|
||||
return $this->socketHandler->isConnected();
|
||||
}
|
||||
|
||||
/**
|
||||
* @see Socket_SocketHandler
|
||||
* @return boolean
|
||||
*/
|
||||
public function isListening() {
|
||||
return $this->socketHandler->isListening();
|
||||
}
|
||||
|
||||
/**
|
||||
* Calls SocketHandler
|
||||
* @see Socket_SocketHandler
|
||||
* @throws Exception_SocketException
|
||||
* @return ressource
|
||||
*/
|
||||
public function getSocket() {
|
||||
return $this->socketHandler->getSocket();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Socket_SocketHandler
|
||||
*/
|
||||
public function getSocketHandler() {
|
||||
return $this->socketHandler;
|
||||
}
|
||||
|
||||
/**
|
||||
* Calls SocketHandler
|
||||
* @see Socket_SocketHandler
|
||||
* @return void
|
||||
*/
|
||||
public function hasBeenAccepted() {
|
||||
return $this->socketHandler->hasBeenAccepted();
|
||||
}
|
||||
|
||||
}
|
||||
?>
|
||||
@@ -0,0 +1,181 @@
|
||||
<?php
|
||||
/**
|
||||
* Connection pool class. Contains the SocketPool.
|
||||
* @author jpt
|
||||
* @package Connection
|
||||
* @depends Socket
|
||||
*/
|
||||
class Connection_ConnectionPool {
|
||||
|
||||
/**
|
||||
* SocketPool instance.
|
||||
* @var Socket_SocketPool
|
||||
*/
|
||||
protected $socketPool;
|
||||
|
||||
/**
|
||||
* Contains all ConnectionHandler instances.
|
||||
* @var array
|
||||
*/
|
||||
protected $connectionHandlers;
|
||||
|
||||
/**
|
||||
* @var int Next ID for a new ConnectionHandler
|
||||
*/
|
||||
protected $nextID;
|
||||
|
||||
/**
|
||||
* Creates an Instance of SocketPool
|
||||
* @return void
|
||||
*/
|
||||
function __construct($linebreak = "\r\n") {
|
||||
$this->connectionHandlers = array();
|
||||
$this->socketPool = new Socket_SocketPool($linebreak);
|
||||
$this->nextID = 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Destroys the SocketPool
|
||||
* @return void
|
||||
*/
|
||||
function __destruct() {
|
||||
unset($this->socketPool);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new TcpConnection.
|
||||
* @param boolean $IPv6 will determine whether the socket uses IPv4 or IPv6.
|
||||
* @return Connection_ConnectionHandler
|
||||
*/
|
||||
public function createTcpConnection($group = "", $protocol = "RAW", $IPv6 = FALSE) {
|
||||
$socket = $this->socketPool->createTcpSocket($IPv6);
|
||||
$connectionHandler = new Connection_ConnectionHandler($socket, $this->nextID, $group, $protocol);
|
||||
$this->addConnectionHandler($connectionHandler);
|
||||
return $connectionHandler;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a ConnectionHandler to the pool.
|
||||
* @param Connection_ConnectionHandler $add_connectionHandler
|
||||
* @return void
|
||||
*/
|
||||
public function addConnectionHandler($add_connectionHandler) {
|
||||
array_push($this->connectionHandlers, $add_connectionHandler);
|
||||
$this->nextID++;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a ConnectionHandler from the pool.
|
||||
* @param Connection_ConnectionHandler $remove_connectionHandler
|
||||
* @return void
|
||||
*/
|
||||
public function removeConnectionHandler($remove_connectionHandler) {
|
||||
foreach($this->connectionHandlers AS $key=>$connectionHandler) {
|
||||
if($connectionHandler === $remove_connectionHandler) {
|
||||
$this->socketPool->removeSocket($remove_connectionHandler->getSocket());
|
||||
$remove_connectionHandler->close();
|
||||
unset($this->connectionHandlers[$key]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns ConnectionHandler for the given socket ressource.
|
||||
* @param ressource $socketRessource
|
||||
* @return Connection_ConnectionHandler
|
||||
*/
|
||||
protected function getConnectionHandlerForSocketRessource($socketRessource) {
|
||||
foreach($this->connectionHandlers AS $connectionHandler) {
|
||||
if($connectionHandler->getSocket() === $socketRessource) {
|
||||
return $connectionHandler;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Calls select() on SocketPool and updates the ConnectionHandler.
|
||||
* Will also accept incoming connections and add them to the pool.
|
||||
* @return array An array containing the Connection_ConnectionHandler for each Socket with new data.
|
||||
* @throws Exception_GeneralException
|
||||
* @throws Exception_SocketException
|
||||
*/
|
||||
public function select() {
|
||||
$read = array();
|
||||
$write = array();
|
||||
$except = array();
|
||||
foreach($this->connectionHandlers AS $connectionHandler) {
|
||||
$connectionSocket = $connectionHandler->getSocket();
|
||||
$read[] = $connectionSocket;
|
||||
if($connectionHandler->canWrite() && $connectionHandler->isServer() === FALSE) $write[] = $connectionSocket;
|
||||
}
|
||||
$except = $read;
|
||||
|
||||
$tempArray = array();
|
||||
$selectedSockets = $this->socketPool->select($read, $write, $except);
|
||||
foreach($selectedSockets AS $selectedType=>$selectedArray) { //read, write, except, this loop won't kill performance
|
||||
foreach($selectedArray AS $socket) {
|
||||
$connectionHandler = $this->getConnectionHandlerForSocketRessource($socket);
|
||||
switch($selectedType) {
|
||||
case "read":
|
||||
if($connectionHandler->isServer() === FALSE) {
|
||||
if($connectionHandler->readToBuffer() === FALSE) $this->removeConnectionHandler($connectionHandler);
|
||||
} else {
|
||||
$acceptedSocket = $connectionHandler->accept();
|
||||
$acceptedSocketHandler = new Connection_ConnectionHandler($acceptedSocket, $this->nextID, $connectionHandler->getGroup(), $connectionHandler->getProtocol());
|
||||
$acceptedSocketHandler->hasBeenAccepted();
|
||||
$this->addConnectionHandler($acceptedSocketHandler);
|
||||
}
|
||||
break;
|
||||
case "write":
|
||||
if($connectionHandler->writeFromBuffer() === FALSE) $this->removeConnectionHandler($connectionHandler);
|
||||
break;
|
||||
case "except":
|
||||
$connectionHandler->handleSocketError();
|
||||
break;
|
||||
default:
|
||||
throw new Exception_GeneralException("Unknown select type: '" . $selectedType . "'", 1289737080);
|
||||
break;
|
||||
}
|
||||
$tempArray[$selectedType][] = $connectionHandler;
|
||||
}
|
||||
}
|
||||
return $tempArray;
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes the given data to all sockets in $group.
|
||||
* @param string $group
|
||||
* @param string $data
|
||||
* @throws Exception_SocketException
|
||||
* @return void
|
||||
*/
|
||||
public function writeToGroup($group, $data) {
|
||||
foreach($this->connectionHandlers AS $connectionHandler) {
|
||||
if($connectionHandler->getGroup() === $group && $connectionHandler->isServer() === FALSE) {
|
||||
$connectionHandler->write($data);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes the given data to the socket with $id.
|
||||
* @param int $id
|
||||
* @param string $data
|
||||
*/
|
||||
public function writeToID($id, $data) {
|
||||
foreach($this->connectionHandlers AS $connectionHandler) {
|
||||
if($connectionHandler->getID() === $id && $connectionHandler->isServer() === FALSE) {
|
||||
$connectionHandler->write($data);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @see Socket_SocketPool
|
||||
* @return int
|
||||
*/
|
||||
public function countConnections() {
|
||||
return $this->socketPool->countSockets();
|
||||
}
|
||||
}
|
||||
?>
|
||||
Reference in New Issue
Block a user