diff --git a/ircbot/AutoLoader.php b/ircbot/AutoLoader.php new file mode 100644 index 0000000..487f531 --- /dev/null +++ b/ircbot/AutoLoader.php @@ -0,0 +1,17 @@ + \ No newline at end of file diff --git a/ircbot/Classes/Client/AbstractClient.php b/ircbot/Classes/Client/AbstractClient.php new file mode 100644 index 0000000..0d0d7b7 --- /dev/null +++ b/ircbot/Classes/Client/AbstractClient.php @@ -0,0 +1,62 @@ +ID = $id; + } + + /** + * @param string $group + */ + public function setGroup($group) { + $this->group = $group; + } + + + /** + * Injects ClientManager + * @param Client_ClientManager $clientManager + */ + public function injectClientManager($clientManager) { + $this->clientManager = $clientManager; + } +} +?> \ No newline at end of file diff --git a/ircbot/Classes/Client/BotClient.php b/ircbot/Classes/Client/BotClient.php new file mode 100644 index 0000000..59a7795 --- /dev/null +++ b/ircbot/Classes/Client/BotClient.php @@ -0,0 +1,48 @@ +clientManager->sendToID((int) $data[0], $data[1]."\r\n"); + $return = print_r($data, TRUE); + } + + if(strpos($data, "+") !== FALSE ) { + $data = explode("+", $data); + $this->clientManager->sendToGroup($data[0], $data[1]."\r\n"); + $return = print_r($data, TRUE); + } + + return $return; + } + + /** + * Loads the given configuration. + * @param array $config + * @return void + */ + public function loadConfig($config) { + + } + +} +?> \ No newline at end of file diff --git a/ircbot/Classes/Client/ClientManager.php b/ircbot/Classes/Client/ClientManager.php new file mode 100644 index 0000000..aa4d20b --- /dev/null +++ b/ircbot/Classes/Client/ClientManager.php @@ -0,0 +1,242 @@ +connectionPool = new Connection_ConnectionPool($linebreak); + $this->clientPool = array(); + $this->registeredProtocols = array(); + $this->rawRoutingRules = array(); + $this->configPool = array(); + } + + /** + * Default destructor. Closes connections before being killed. + * @return void + */ + function __destruct() { + unset($this->clientPool); + unset($this->connectionPool); + } + + /** + * @see Connection_ConnectionPool + * @return int + */ + public function countConnections() { + return $this->connectionPool->countConnections(); + } + + /** + * Main worker function. + * Processes incoming data, calls clients and much more. + * @return void + */ + public function work() { + $connectionHandlers = $this->connectionPool->select(); + if(isset($connectionHandlers["read"]) === FALSE || count($connectionHandlers["read"]) === 0) return; + foreach($connectionHandlers["read"] AS $connectionHandler) { + //handle disconnects + if($connectionHandler->isConnected() === FALSE && $connectionHandler->isListening() === FALSE) { + $this->removeClientForConnectionHandler($connectionHandler); + } + + //ne warte mal, das geht nicht...oder so + if($connectionHandler->isListening() === TRUE) { + $this->addClientForConnectionHandler($connectionHandler); + } + + //create a client for a connection without one. + if(!isset($this->clientPool[$connectionHandler->getID()])) { + $this->addClientForConnectionHandler($connectionHandler); + } + + + if(isset($this->clientPool[$connectionHandler->getID()])) { + //let the client process the data, send the results back. + while($data = $connectionHandler->read()) { + $result = $this->clientPool[$connectionHandler->getID()]->processData($data); + if($result !== "") { + $connectionHandler->write($result); + } + } + } + + } + } + + /** + * TODO: implement this! + * @param unknown_type $from + * @param unknown_type $to + */ + public function addRawRouting($from, $to) { + $this->rawRoutingRules[] = array(""); + } + + /** + * Calls ConnectionPool in order to create a simple connection. + * @see Connection_ConnectionPool + * @param string $group + * @param boolean $IPv6 + * @return Connection_ConnectionHandler + */ + public function createTcpConnection($group = "", $protocol = "RAW", $IPv6 = FALSE) { + return $this->connectionPool->createTcpConnection($group, $protocol, $IPv6); + } + + /** + * Closes and removes the connection. + * @param Connection_ConnectionHandler $connectionHandler + */ + public function removeConnection($connectionHandler) { + unset($this->configPool[$connectionHandler->getID()]); + unset($this->clientPool[$connectionHandler->getID()]); + $this->connectionPool->removeConnectionHandler($connectionHandler); + } + + /** + * Registers a protocol with a specific client. + * @param string $protocol + * @param string $className + * @return void + */ + public function registerProtocol($protocol, $className) { + $this->registeredProtocols[$protocol] = $className; + } + + /** + * Unregisters a protocol. + * @param string $protocol + * @return void + */ + public function unregisterProtocol($protocol) { + unset($this->registeredProtocols[$protocol]); + } + + /** + * Searches for the registered client for the given protocol. + * Returns a client instance or void. + * @param string $protocol + * @return mixed + * @throws Exception_GeneralException + */ + protected function createClientForProtocol($protocol) { + //look for the protocol + if(!isset($this->registeredProtocols[$protocol])) { + throw new Exception_GeneralException("No client registered for protocol: '" . $protocol . "'!", 1290271651); + } + $className = $this->registeredProtocols[$protocol]; + //look for the class + if(class_exists($className)) { + return new $className(); + } else { + throw new Exception_GeneralException("Registered class name '" . $className . "' does not exist for protocol: '" . $protocol . "'!", 1290271773); + } + } + + /** + * Adds a client to our client pool. + * @param Connection_ConnectionHandler $connectionHandler + * @return void + */ + protected function addClientForConnectionHandler($connectionHandler) { + $protocol = $connectionHandler->getProtocol(); + //do not try this for raw connections + if($protocol === "RAW") return; + $client = $this->createClientForProtocol($protocol); + if(isset($this->configPool[$connectionHandler->getID()])) { + $client->loadConfig($this->configPool[$connectionHandler->getID()]); + } + $client->injectClientManager($this); + $client->setID($connectionHandler->getID()); + $client->setGroup($connectionHandler->getGroup()); + $this->clientPool[$connectionHandler->getID()] = $client; + } + + /** + * Removes a client from our client pool. + * @param Connection_ConnectionHandler $connectionHandler + * @return void + */ + protected function removeClientForConnectionHandler($connectionHandler) { + unset($this->clientPool[$connectionHandler->getID()]); + $this->connectionPool->removeConnectionHandler($connectionHandler); + } + + /** + * Attaches a configuration to a connection. + * Will overwrite the existing configuration for the connection. + * @param array $config + * @param Connection_ConnectionHandler $connectionHandler + * @return void + */ + public function attachConfig($config, $connectionHandler) { + $this->configPool[$connectionHandler->getID()] = $config; + } + + /** + * Calls Connection_Pool + * @see Connection_ConnectionPool + * @param int $id + * @param string $data + * @return void + */ + public function sendToID($id, $data) { + return $this->connectionPool->writeToID($id, $data); + } + + /** + * Calls Connection_Pool + * @see Connection_ConnectionPool + * @param string $group + * @param string $data + * @return void + */ + public function sendToGroup($group, $data) { + return $this->connectionPool->writeToGroup($group, $data); + } + +} +?> \ No newline at end of file diff --git a/ircbot/Classes/Client/IrcClient.php b/ircbot/Classes/Client/IrcClient.php new file mode 100644 index 0000000..cf91bf3 --- /dev/null +++ b/ircbot/Classes/Client/IrcClient.php @@ -0,0 +1,77 @@ +nick = "Serena"; + $this->channels = array(); + $this->lines = 0; + $this->got_001 = FALSE; + $this->joined = FALSE; + $this->authed = FALSE; + } + + /** + * Does all the hard work. + * @param string $data + * @return string + */ + public function processData($data) { + //echo "[RECV] ".$data; + + $this->clientManager->sendToGroup("srv", "[#".$this->ID."] ".$data."\r\n\r\n"); + + $return = ""; + + if(strpos($data, "PING :") !== FALSE) $return .= str_replace("PING", "PONG", $data); + + if(preg_match("/001/", $data)) $this->got_001 = TRUE; + $this->lines++; + + if(!$this->authed && $this->lines > 1) { + $return .= "USER as as as :Asdfg\r\nNICK :" . $this->nick . "\r\n"; + $this->authed = TRUE; + } + + if($this->got_001 && !$this->joined) { + $this->joined = TRUE; + foreach($this->channels AS $channel) $return .= "JOIN " . $channel . "\r\n"; + } + + if(strpos($data, "hau ab") !== FALSE) { + $return .= "PRIVMSG ".$this->channels[0]." :roger that :D\r\n"; + $return .= "QUIT :lol\r\n"; + } + + //if($return !== "") echo "[SEND] ".$return; + return $return; + } + + /** + * Loads the given configuration. + * @param array $config + * @return void + */ + public function loadConfig($config) { + $this->nick = $config["nick"]; + $this->channels = $config["channels"]; + $this->userident = $config["userident"]; + } + +} +?> \ No newline at end of file diff --git a/ircbot/Classes/Connection/ConnectionHandler.php b/ircbot/Classes/Connection/ConnectionHandler.php new file mode 100644 index 0000000..12cb541 --- /dev/null +++ b/ircbot/Classes/Connection/ConnectionHandler.php @@ -0,0 +1,295 @@ +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(); + } + +} +?> \ No newline at end of file diff --git a/ircbot/Classes/Connection/ConnectionPool.php b/ircbot/Classes/Connection/ConnectionPool.php new file mode 100644 index 0000000..1160528 --- /dev/null +++ b/ircbot/Classes/Connection/ConnectionPool.php @@ -0,0 +1,181 @@ +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(); + } +} +?> \ No newline at end of file diff --git a/ircbot/Classes/Exception/GeneralException.php b/ircbot/Classes/Exception/GeneralException.php new file mode 100644 index 0000000..172fe80 --- /dev/null +++ b/ircbot/Classes/Exception/GeneralException.php @@ -0,0 +1,35 @@ +message; + $string .= " in " . $this->file . "(" . $this->line . ")"; + $string .= "\n" . $this->getTraceAsString(); + return $string; + } +} +?> \ No newline at end of file diff --git a/ircbot/Classes/Exception/SocketException.php b/ircbot/Classes/Exception/SocketException.php new file mode 100644 index 0000000..6d461ad --- /dev/null +++ b/ircbot/Classes/Exception/SocketException.php @@ -0,0 +1,9 @@ + \ No newline at end of file diff --git a/ircbot/Classes/Misc/Buffer.php b/ircbot/Classes/Misc/Buffer.php new file mode 100644 index 0000000..43c1f6c --- /dev/null +++ b/ircbot/Classes/Misc/Buffer.php @@ -0,0 +1,82 @@ +buffer = ""; + $this->linebreak = $linebreak; + } + + /** + * Prunes empty lines out of the buffer. + * @return void + */ + protected function pruneEmptyLines() { + if(strpos($this->buffer, $this->linebreak) === FALSE) return; + $has_linebreak_at_end = (substr($this->buffer, (-1) * strlen($this->linebreak)) === $this->linebreak) ? TRUE : FALSE; + $lines = explode($this->linebreak, $this->buffer); + foreach($lines AS $key=>$line) { + $line = str_replace($this->linebreak, "", $line); + $line = trim($line); + if($line === "") unset($lines[$key]); + } + $this->buffer = implode($this->linebreak, $lines); + if($has_linebreak_at_end) $this->buffer .= $this->linebreak; + } + + /** + * Appends data to the buffer. + * @param string $data + * @return void + */ + public function addData($data) { + $this->buffer .= $data; + $this->pruneEmptyLines(); + } + + /** + * Returns the next line in the buffer and removes it from the buffer. + * @return string + */ + public function getNextLine() { + if(!$this->hasLines()) return ""; + list($line) = explode($this->linebreak, $this->buffer); + $this->buffer = str_replace($line.$this->linebreak, "", $this->buffer); + $line = trim($line); + $result = ($line !== "") ? $line.$this->linebreak : ""; + return $result; + } + + /** + * Checks whether the buffer contains more lines to process. + * @return boolean + */ + public function hasLines() { + return (trim(strstr($this->buffer, $this->linebreak, TRUE)) !== "") ? TRUE : FALSE; + } + +} +?> \ No newline at end of file diff --git a/ircbot/Classes/Socket/SocketHandler.php b/ircbot/Classes/Socket/SocketHandler.php new file mode 100644 index 0000000..545dfe1 --- /dev/null +++ b/ircbot/Classes/Socket/SocketHandler.php @@ -0,0 +1,216 @@ +socket = $socket; + $this->is_bound = FALSE; + $this->is_connected = FALSE; + $this->is_listening = FALSE; + } + + /** + * Destructor. Closes socket. + * @return void + */ + function __destruct() { + $this->close(); + } + + /** + * Returns socket + * @return ressource + */ + public function getSocket() { + return $this->socket; + } + + /** + * @return boolean + */ + public function isConnected() { + return $this->is_connected; + } + + /** + * @return boolean + */ + public function isListening() { + return $this->is_listening; + } + + /** + * Connects to a specified address. + * @throws Exception_SocketException + * @param string $address + * @param int $port + * @return void + */ + public function connect($address, $port) { + if($this->is_connected === TRUE) throw new Exception_SocketException("Socket is already connected!", 1289663170); + $result = socket_connect($this->socket, $address, $port); + if($result === FALSE) $this->error(); + $this->is_connected = TRUE; + } + + /** + * Binds the socket to an address + port. + * @throws Exception_SocketException + * @param string $address + * @param int $port + * @return void + */ + public function bind($address, $port) { + if($this->is_bound === TRUE) throw new Exception_SocketException("Socket is already bound!", 1289663212); + $result = socket_set_option($this->socket, SOL_SOCKET, SO_REUSEADDR, 1); + if($result === FALSE) $this->error(); + $result = socket_bind($this->socket, $address, $port); + if($result === FALSE) $this->error(); + $this->is_bound = TRUE; + } + + /** + * Let's the socket listen for incoming connections. + * @throws Exception_SocketException + * @return void + */ + public function listen() { + if($this->is_bound === FALSE) throw new Exception_SocketException("Cannot listen on unbound socket!", 1289663220); + $result = socket_listen($this->socket); + if($result === FALSE) $this->error(); + $this->is_listening = TRUE; + } + + /** + * Tells the SocketHandler that he got accepted. + * @return void + */ + public function hasBeenAccepted() { + $this->is_connected = TRUE; + } + + /** + * Accepts a connection to a socket that is bound and listens + * The ressource has to be added to the SocketPool manually + * @throws Exception_SocketException + * @return ressource + */ + public function accept() { + if($this->is_bound === FALSE) throw new Exception_SocketException("Cannot accept connections from unbound socket!", 1289663239); + if($this->is_listening === FALSE) throw new Exception_SocketException("Cannot accept connections from socket that is not listening!", 1289663241); + $accept = socket_accept($this->socket); + if($accept === FALSE) $this->error(); + return $accept; + } + + /** + * Returns ip + port of the remote socket. + * @throws Exception_SocketException + * @return string + */ + public function getRemoteName() { + if($this->is_connected === FALSE) throw new Exception_SocketException("Socket not connected, cannot retrieve remote name!", 1289928192); + $result = socket_getpeername($this->socket, $address, $port); + if($result === FALSE) $this->error(); + return $address . ":" . $port; + } + + /** + * Returns ip + port of the local socket. + * @throws Exception_SocketException + * @return string + */ + public function getLocalName() { + if($this->is_bound === FALSE ^ $this->is_connected === FALSE) throw new Exception_SocketException("Socket is not bound or connected, no local name available!", 1289928256); + $result = socket_getsockname($this->socket, $address, $port); + if($result === FALSE) $this->error(); + return $address . ":" . $port; + } + + /** + * Writes data to the socket. + * @throws Exception_SocketException + * @param string $data + * @return void + */ + public function write($data) { + $result = socket_write($this->socket, $data); + if($result === FALSE) $this->error(); + } + + /** + * Reads data from the socket. + * @throws Exception_SocketException + * @param int $length + * @return string + */ + public function read($length = 16384) { + $result = socket_read($this->socket, $length, PHP_BINARY_READ); + if($result === FALSE) $this->error(); + return $result; + } + + /** + * Shuts the socket down after waiting a bit (waiting might be optional). + * @throws Exception_SocketException + * @return void + */ + public function close() { + usleep(100000); + if($this->is_connected === TRUE) { + $result = socket_shutdown($this->socket); + if($result === FALSE) $this->error(); + } + if(is_resource($this->socket)) { + $result = socket_close($this->socket); + if($result === FALSE) $this->error(); + } + $this->is_connected = FALSE; + } + + /** + * Gets last error from socket. + * @throws Exception_SocketException + */ + protected function error() { + $errno = socket_last_error($this->socket); + $error = socket_strerror($errno); + socket_clear_error(); + $errormsg = "[" . $errno . "] " . $error; + throw new Exception_SocketException("A socket error occured: " . $errormsg, 1289663360); + } +} +?> \ No newline at end of file diff --git a/ircbot/Classes/Socket/SocketPool.php b/ircbot/Classes/Socket/SocketPool.php new file mode 100644 index 0000000..8cc3cfe --- /dev/null +++ b/ircbot/Classes/Socket/SocketPool.php @@ -0,0 +1,100 @@ +sockets = array(); + } + + /** + * Closes all connections. + * @return void + */ + function __destruct() { + unset($this->sockets); + } + + /** + * Returns the amount of active sockets. + * @return int + */ + public function countSockets() { + return count($this->sockets); + } + + /** + * Adds a socket to the pool + * @param ressource $add_socket + * @return void + */ + public function addSocket($add_socket) { + array_push($this->sockets, $add_socket); + } + + /** + * Removes the given socket from the pool. + * The socket will be shutdown. + * @param ressource $remove_socket + * @return void + */ + public function removeSocket($remove_socket) { + foreach($this->sockets AS $key=>$socket) { + if($socket !== $remove_socket) { + continue; + } else { + unset($socket); + unset($this->sockets[$key]); + break; + } + } + } + + /** + * Creates a new TcpSocket and adds it to the pool. + * @throws Exception_SocketException + * @param boolean $IPv6 will determine whether the socket uses IPv4 or IPv6. + * @return ressource + */ + public function createTcpSocket($IPv6 = FALSE) { + $Domain = ($IPv6) ? AF_INET6 : AF_INET; + $socket = socket_create($Domain, SOCK_STREAM, SOL_TCP); + socket_set_block($socket); + if($socket === FALSE) throw new Exception_SocketException("socket_create() failed!", 1290273709); + $this->addSocket($socket); + return $socket; + } + + /** + * Returns an array of sockets one can read from. + * @param array $read + * @param array $write + * @param array $except + * @param int $timeout + * @throws Exception_SocketException + * @return array + */ + public function select($read, $write, $except, $timeout = NULL) { + $n = socket_select($read, $write, $except, $timeout); + if($n === FALSE) throw new Exception_SocketException("socket_select() failed!", 1290273693); + if($n === 0) return array("read" => array(), "write" => array(), "except" => array()); + return array("read" => $read, "write" => $write, "except" => $except); + } + + +} +?> \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/AbstractClient_8php_source.html b/ircbot/Documentation/Doxygen/html/AbstractClient_8php_source.html new file mode 100644 index 0000000..3d5e6dc --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/AbstractClient_8php_source.html @@ -0,0 +1,133 @@ + + + + +ircbot: Classes/Client/AbstractClient.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/AutoLoader_8php_source.html b/ircbot/Documentation/Doxygen/html/AutoLoader_8php_source.html new file mode 100644 index 0000000..32a53a0 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/AutoLoader_8php_source.html @@ -0,0 +1,88 @@ + + + + +ircbot: AutoLoader.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/BotClient_8php_source.html b/ircbot/Documentation/Doxygen/html/BotClient_8php_source.html new file mode 100644 index 0000000..9e60af4 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/BotClient_8php_source.html @@ -0,0 +1,119 @@ + + + + +ircbot: Classes/Client/BotClient.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/Buffer_8php_source.html b/ircbot/Documentation/Doxygen/html/Buffer_8php_source.html new file mode 100644 index 0000000..62bb7f2 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/Buffer_8php_source.html @@ -0,0 +1,153 @@ + + + + +ircbot: Classes/Misc/Buffer.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/ClientManagerTest_8php_source.html b/ircbot/Documentation/Doxygen/html/ClientManagerTest_8php_source.html new file mode 100644 index 0000000..7ca4ecc --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/ClientManagerTest_8php_source.html @@ -0,0 +1,111 @@ + + + + +ircbot: Testcode/Client/ClientManagerTest.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/ClientManager_8php_source.html b/ircbot/Documentation/Doxygen/html/ClientManager_8php_source.html new file mode 100644 index 0000000..9cf3987 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/ClientManager_8php_source.html @@ -0,0 +1,314 @@ + + + + +ircbot: Classes/Client/ClientManager.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/ConnectionHandler_8php_source.html b/ircbot/Documentation/Doxygen/html/ConnectionHandler_8php_source.html new file mode 100644 index 0000000..fbc8083 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/ConnectionHandler_8php_source.html @@ -0,0 +1,366 @@ + + + + +ircbot: Classes/Connection/ConnectionHandler.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/ConnectionPool_8php_source.html b/ircbot/Documentation/Doxygen/html/ConnectionPool_8php_source.html new file mode 100644 index 0000000..fbdbc65 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/ConnectionPool_8php_source.html @@ -0,0 +1,252 @@ + + + + +ircbot: Classes/Connection/ConnectionPool.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/Exceptions_8php_source.html b/ircbot/Documentation/Doxygen/html/Exceptions_8php_source.html new file mode 100644 index 0000000..7fb4408 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/Exceptions_8php_source.html @@ -0,0 +1,132 @@ + + + + +ircbot: Testcode/Misc/Exceptions.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/GeneralException_8php_source.html b/ircbot/Documentation/Doxygen/html/GeneralException_8php_source.html new file mode 100644 index 0000000..f704b81 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/GeneralException_8php_source.html @@ -0,0 +1,106 @@ + + + + +ircbot: Classes/Exception/GeneralException.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/IrcClientTest_8php_source.html b/ircbot/Documentation/Doxygen/html/IrcClientTest_8php_source.html new file mode 100644 index 0000000..fb1e023 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/IrcClientTest_8php_source.html @@ -0,0 +1,110 @@ + + + + +ircbot: Testcode/Connection/IrcClientTest.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/IrcClient_8php_source.html b/ircbot/Documentation/Doxygen/html/IrcClient_8php_source.html new file mode 100644 index 0000000..31cedb3 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/IrcClient_8php_source.html @@ -0,0 +1,148 @@ + + + + +ircbot: Classes/Client/IrcClient.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/Main_8php_source.html b/ircbot/Documentation/Doxygen/html/Main_8php_source.html new file mode 100644 index 0000000..9b615b2 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/Main_8php_source.html @@ -0,0 +1,83 @@ + + + + +ircbot: Main.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/ReferenceTest_8php_source.html b/ircbot/Documentation/Doxygen/html/ReferenceTest_8php_source.html new file mode 100644 index 0000000..adba8d0 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/ReferenceTest_8php_source.html @@ -0,0 +1,150 @@ + + + + +ircbot: Testcode/Misc/ReferenceTest.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/Reflection_8php_source.html b/ircbot/Documentation/Doxygen/html/Reflection_8php_source.html new file mode 100644 index 0000000..c40b436 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/Reflection_8php_source.html @@ -0,0 +1,138 @@ + + + + +ircbot: Testcode/Misc/Reflection.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/SocketException_8php_source.html b/ircbot/Documentation/Doxygen/html/SocketException_8php_source.html new file mode 100644 index 0000000..a5a70f5 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/SocketException_8php_source.html @@ -0,0 +1,80 @@ + + + + +ircbot: Classes/Exception/SocketException.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/SocketHandler_8php_source.html b/ircbot/Documentation/Doxygen/html/SocketHandler_8php_source.html new file mode 100644 index 0000000..a43e1ff --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/SocketHandler_8php_source.html @@ -0,0 +1,286 @@ + + + + +ircbot: Classes/Socket/SocketHandler.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/SocketPool_8php_source.html b/ircbot/Documentation/Doxygen/html/SocketPool_8php_source.html new file mode 100644 index 0000000..b54beea --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/SocketPool_8php_source.html @@ -0,0 +1,171 @@ + + + + +ircbot: Classes/Socket/SocketPool.php Quellcode + + + + + + + + + + +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/annotated.html b/ircbot/Documentation/Doxygen/html/annotated.html new file mode 100644 index 0000000..00e14f7 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/annotated.html @@ -0,0 +1,88 @@ + + + + +ircbot: Auflistung der Klassen + + + + + + + + + +
+
+

Auflistung der Klassen

+
+
+Hier folgt die Aufzählung aller Klassen, Strukturen, Varianten und Schnittstellen mit einer Kurzbeschreibung: + + + + + + + + + + + + +
Client_AbstractClient
Client_BotClient
Client_ClientManager
Client_IrcClient
Connection_ConnectionHandler
Connection_ConnectionPool
Exception
Exception_GeneralException
Exception_SocketException
Misc_Buffer
Socket_SocketHandler
Socket_SocketPool
+
+ +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/bc_s.png b/ircbot/Documentation/Doxygen/html/bc_s.png new file mode 100644 index 0000000..e401862 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/bc_s.png differ diff --git a/ircbot/Documentation/Doxygen/html/classBar-members.html b/ircbot/Documentation/Doxygen/html/classBar-members.html new file mode 100644 index 0000000..d164988 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classBar-members.html @@ -0,0 +1,77 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Bar Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Bar einschließlich aller geerbten Elemente. + + +
$test (Definiert in Bar)Bar
__construct()Bar
+ +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classBar.html b/ircbot/Documentation/Doxygen/html/classBar.html new file mode 100644 index 0000000..5114a41 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classBar.html @@ -0,0 +1,118 @@ + + + + +ircbot: Bar Klassenreferenz + + + + + + + + + +
+
+Öffentliche Methoden | +Öffentliche Attribute
+
+

Bar Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + +

+Öffentliche Methoden

 __construct ()

+Öffentliche Attribute

$test
+

Ausführliche Beschreibung

+

Testclass #2

+
Autor:
jpt
+ +

Definiert in Zeile 51 der Datei ReferenceTest.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + +
Bar.__construct ( ) 
+
+
+

Default constructor. Initializes test variable.

+
Rückgabe:
void
+ +

Definiert in Zeile 61 der Datei ReferenceTest.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classClient__AbstractClient-members.html b/ircbot/Documentation/Doxygen/html/classClient__AbstractClient-members.html new file mode 100644 index 0000000..02cf313 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classClient__AbstractClient-members.html @@ -0,0 +1,83 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Client_AbstractClient Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Client_AbstractClient einschließlich aller geerbten Elemente. + + + + + + + + +
$clientManager (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
$group (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
$ID (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
injectClientManager($clientManager)Client_AbstractClient
loadConfig($config)Client_AbstractClient
processData($data)Client_AbstractClient
setGroup($group)Client_AbstractClient
setID($id)Client_AbstractClient
+ +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classClient__AbstractClient.html b/ircbot/Documentation/Doxygen/html/classClient__AbstractClient.html new file mode 100644 index 0000000..9b9b8d1 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classClient__AbstractClient.html @@ -0,0 +1,247 @@ + + + + +ircbot: Client_AbstractClient Klassenreferenz + + + + + + + + + +
+
+Öffentliche Methoden | +Geschützte Attribute
+
+

Client_AbstractClient Klassenreferenz

+
+
+
+Klassendiagramm für Client_AbstractClient:
+
+
+ + +Client_BotClient +Client_IrcClient + +
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + +

+Öffentliche Methoden

 processData ($data)
 loadConfig ($config)
 setID ($id)
 setGroup ($group)
 injectClientManager ($clientManager)

+Geschützte Attribute

$ID
$group
$clientManager
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 8 der Datei AbstractClient.php.

+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Client_AbstractClient.injectClientManager ( clientManager ) 
+
+
+

Injects ClientManager

+
Parameter:
+ + +
Client_ClientManager $clientManager
+
+
+ +

Definiert in Zeile 58 der Datei AbstractClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.loadConfig ( config )  [abstract]
+
+
+

This function will load the given config.

+
Parameter:
+ + +
array $config
+
+
+ +

Erneute Implementation in Client_BotClient und Client_IrcClient.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.processData ( data )  [abstract]
+
+
+

This function will be the main entry point of any client.

+
Parameter:
+ + +
string $data
+
+
+
Rückgabe:
string
+ +

Erneute Implementation in Client_BotClient und Client_IrcClient.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.setGroup ( group ) 
+
+
+
Parameter:
+ + +
string $group
+
+
+ +

Definiert in Zeile 49 der Datei AbstractClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.setID ( id ) 
+
+
+
Parameter:
+ + +
int $id
+
+
+ +

Definiert in Zeile 42 der Datei AbstractClient.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classClient__AbstractClient.png b/ircbot/Documentation/Doxygen/html/classClient__AbstractClient.png new file mode 100644 index 0000000..44d7fea Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/classClient__AbstractClient.png differ diff --git a/ircbot/Documentation/Doxygen/html/classClient__BotClient-members.html b/ircbot/Documentation/Doxygen/html/classClient__BotClient-members.html new file mode 100644 index 0000000..8fe7cba --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classClient__BotClient-members.html @@ -0,0 +1,84 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Client_BotClient Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Client_BotClient einschließlich aller geerbten Elemente. + + + + + + + + + +
$clientManager (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
$group (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
$ID (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
__construct()Client_BotClient
injectClientManager($clientManager)Client_AbstractClient
loadConfig($config)Client_BotClient
processData($data)Client_BotClient
setGroup($group)Client_AbstractClient
setID($id)Client_AbstractClient
+ +
+ Alle Klassen Namensbereiche Funktionen
+ + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classClient__BotClient.html b/ircbot/Documentation/Doxygen/html/classClient__BotClient.html new file mode 100644 index 0000000..e313b01 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classClient__BotClient.html @@ -0,0 +1,273 @@ + + + + +ircbot: Client_BotClient Klassenreferenz + + + + + + + + + +
+ +
+

Client_BotClient Klassenreferenz

+
+
+
+Klassendiagramm für Client_BotClient:
+
+
+ + +Client_AbstractClient + +
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + + +

+Öffentliche Methoden

 __construct ()
 processData ($data)
 loadConfig ($config)
 setID ($id)
 setGroup ($group)
 injectClientManager ($clientManager)

+Geschützte Attribute

$ID
$group
$clientManager
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 8 der Datei BotClient.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + +
Client_BotClient.__construct ( ) 
+
+
+

Default constructor.

+ +

Definiert in Zeile 13 der Datei BotClient.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Client_AbstractClient.injectClientManager ( clientManager )  [inherited]
+
+
+

Injects ClientManager

+
Parameter:
+ + +
Client_ClientManager $clientManager
+
+
+ +

Definiert in Zeile 58 der Datei AbstractClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_BotClient.loadConfig ( config ) 
+
+
+

Loads the given configuration.

+
Parameter:
+ + +
array $config
+
+
+
Rückgabe:
void
+ +

Erneute Implementation von Client_AbstractClient.

+ +

Definiert in Zeile 43 der Datei BotClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_BotClient.processData ( data ) 
+
+
+

Does all the hard work.

+
Parameter:
+ + +
string $data
+
+
+
Rückgabe:
string
+ +

Erneute Implementation von Client_AbstractClient.

+ +

Definiert in Zeile 22 der Datei BotClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.setGroup ( group )  [inherited]
+
+
+
Parameter:
+ + +
string $group
+
+
+ +

Definiert in Zeile 49 der Datei AbstractClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.setID ( id )  [inherited]
+
+
+
Parameter:
+ + +
int $id
+
+
+ +

Definiert in Zeile 42 der Datei AbstractClient.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classClient__BotClient.png b/ircbot/Documentation/Doxygen/html/classClient__BotClient.png new file mode 100644 index 0000000..59128c5 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/classClient__BotClient.png differ diff --git a/ircbot/Documentation/Doxygen/html/classClient__ClientManager-members.html b/ircbot/Documentation/Doxygen/html/classClient__ClientManager-members.html new file mode 100644 index 0000000..ff71aee --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classClient__ClientManager-members.html @@ -0,0 +1,95 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Client_ClientManager Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Client_ClientManager einschließlich aller geerbten Elemente. + + + + + + + + + + + + + + + + + + + + +
$clientPool (Definiert in Client_ClientManager)Client_ClientManager [protected]
$configPool (Definiert in Client_ClientManager)Client_ClientManager [protected]
$connectionPool (Definiert in Client_ClientManager)Client_ClientManager [protected]
$rawRoutingRules (Definiert in Client_ClientManager)Client_ClientManager [protected]
$registeredProtocols (Definiert in Client_ClientManager)Client_ClientManager [protected]
__construct($linebreak="\r\n")Client_ClientManager
__destruct()Client_ClientManager
addClientForConnectionHandler($connectionHandler)Client_ClientManager [protected]
addRawRouting($from, $to)Client_ClientManager
attachConfig($config, $connectionHandler)Client_ClientManager
countConnections()Client_ClientManager
createClientForProtocol($protocol)Client_ClientManager [protected]
createTcpConnection($group="", $protocol="RAW", $IPv6=FALSE)Client_ClientManager
registerProtocol($protocol, $className)Client_ClientManager
removeClientForConnectionHandler($connectionHandler)Client_ClientManager [protected]
removeConnection($connectionHandler)Client_ClientManager
sendToGroup($group, $data)Client_ClientManager
sendToID($id, $data)Client_ClientManager
unregisterProtocol($protocol)Client_ClientManager
work()Client_ClientManager
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classClient__ClientManager.html b/ircbot/Documentation/Doxygen/html/classClient__ClientManager.html new file mode 100644 index 0000000..e2cbd3a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classClient__ClientManager.html @@ -0,0 +1,603 @@ + + + + +ircbot: Client_ClientManager Klassenreferenz + + + + + + + + + +
+ +
+

Client_ClientManager Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + + + + + + + + + + + + + + +

+Öffentliche Methoden

 __construct ($linebreak="\r\n")
 __destruct ()
 countConnections ()
 work ()
 addRawRouting ($from, $to)
 createTcpConnection ($group="", $protocol="RAW", $IPv6=FALSE)
 removeConnection ($connectionHandler)
 registerProtocol ($protocol, $className)
 unregisterProtocol ($protocol)
 attachConfig ($config, $connectionHandler)
 sendToID ($id, $data)
 sendToGroup ($group, $data)

+Geschützte Methoden

 createClientForProtocol ($protocol)
 addClientForConnectionHandler ($connectionHandler)
 removeClientForConnectionHandler ($connectionHandler)

+Geschützte Attribute

$connectionPool
$clientPool
$rawRoutingRules
$registeredProtocols
$configPool
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 11 der Datei ClientManager.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + + +
Client_ClientManager.__construct ( linebreak = "\r\n" ) 
+
+
+

Default constructor.

+
Parameter:
+ + +
string $linebreak
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 47 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + +
Client_ClientManager.__destruct ( ) 
+
+
+

Default destructor. Closes connections before being killed.

+
Rückgabe:
void
+ +

Definiert in Zeile 59 der Datei ClientManager.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Client_ClientManager.addClientForConnectionHandler ( connectionHandler )  [protected]
+
+
+

Adds a client to our client pool.

+
Parameter:
+ + +
Connection_ConnectionHandler $connectionHandler
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 185 der Datei ClientManager.php.

+ +

Benutzt createClientForProtocol().

+ +

Wird benutzt von work().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Client_ClientManager.addRawRouting ( from,
to 
)
+
+
+

TODO: implement this!

+
Parameter:
+ + + +
unknown_type $from
unknown_type $to
+
+
+ +

Definiert in Zeile 115 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Client_ClientManager.attachConfig ( config,
connectionHandler 
)
+
+
+

Attaches a configuration to a connection. Will overwrite the existing configuration for the connection.

+
Parameter:
+ + + +
array $config
Connection_ConnectionHandler $connectionHandler
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 216 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + +
Client_ClientManager.countConnections ( ) 
+
+
+
Siehe auch:
Connection_ConnectionPool
+
Rückgabe:
int
+ +

Definiert in Zeile 68 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_ClientManager.createClientForProtocol ( protocol )  [protected]
+
+
+

Searches for the registered client for the given protocol. Returns a client instance or void.

+
Parameter:
+ + +
string $protocol
+
+
+
Rückgabe:
mixed
+
Ausnahmebehandlung:
+ + +
Exception_GeneralException 
+
+
+ +

Definiert in Zeile 166 der Datei ClientManager.php.

+ +

Wird benutzt von addClientForConnectionHandler().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Client_ClientManager.createTcpConnection ( group = "",
protocol = "RAW",
IPv6 = FALSE 
)
+
+
+

Calls ConnectionPool in order to create a simple connection.

+
Siehe auch:
Connection_ConnectionPool
+
Parameter:
+ + + +
string $group
boolean $IPv6
+
+
+
Rückgabe:
Connection_ConnectionHandler
+ +

Definiert in Zeile 126 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Client_ClientManager.registerProtocol ( protocol,
className 
)
+
+
+

Registers a protocol with a specific client.

+
Parameter:
+ + + +
string $protocol
string $className
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 146 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_ClientManager.removeClientForConnectionHandler ( connectionHandler )  [protected]
+
+
+

Removes a client from our client pool.

+
Parameter:
+ + +
Connection_ConnectionHandler $connectionHandler
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 204 der Datei ClientManager.php.

+ +

Wird benutzt von work().

+ +
+
+ +
+
+ + + + + + + + + +
Client_ClientManager.removeConnection ( connectionHandler ) 
+
+
+

Closes and removes the connection.

+
Parameter:
+ + +
Connection_ConnectionHandler $connectionHandler
+
+
+ +

Definiert in Zeile 134 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Client_ClientManager.sendToGroup ( group,
data 
)
+
+
+

Calls Connection_Pool

+
Siehe auch:
Connection_ConnectionPool
+
Parameter:
+ + + +
string $group
string $data
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 238 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Client_ClientManager.sendToID ( id,
data 
)
+
+
+

Calls Connection_Pool

+
Siehe auch:
Connection_ConnectionPool
+
Parameter:
+ + + +
int $id
string $data
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 227 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_ClientManager.unregisterProtocol ( protocol ) 
+
+
+

Unregisters a protocol.

+
Parameter:
+ + +
string $protocol
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 155 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + +
Client_ClientManager.work ( ) 
+
+
+

Main worker function. Processes incoming data, calls clients and much more.

+
Rückgabe:
void
+ +

Definiert in Zeile 77 der Datei ClientManager.php.

+ +

Benutzt addClientForConnectionHandler() und removeClientForConnectionHandler().

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classClient__IrcClient-members.html b/ircbot/Documentation/Doxygen/html/classClient__IrcClient-members.html new file mode 100644 index 0000000..aa87568 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classClient__IrcClient-members.html @@ -0,0 +1,90 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Client_IrcClient Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Client_IrcClient einschließlich aller geerbten Elemente. + + + + + + + + + + + + + + + +
$authed (Definiert in Client_IrcClient)Client_IrcClient [protected]
$channels (Definiert in Client_IrcClient)Client_IrcClient [protected]
$clientManager (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
$got_001 (Definiert in Client_IrcClient)Client_IrcClient [protected]
$group (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
$ID (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
$joined (Definiert in Client_IrcClient)Client_IrcClient [protected]
$lines (Definiert in Client_IrcClient)Client_IrcClient [protected]
$nick (Definiert in Client_IrcClient)Client_IrcClient [protected]
__construct()Client_IrcClient
injectClientManager($clientManager)Client_AbstractClient
loadConfig($config)Client_IrcClient
processData($data)Client_IrcClient
setGroup($group)Client_AbstractClient
setID($id)Client_AbstractClient
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classClient__IrcClient.html b/ircbot/Documentation/Doxygen/html/classClient__IrcClient.html new file mode 100644 index 0000000..020534c --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classClient__IrcClient.html @@ -0,0 +1,285 @@ + + + + +ircbot: Client_IrcClient Klassenreferenz + + + + + + + + + +
+ +
+

Client_IrcClient Klassenreferenz

+
+
+
+Klassendiagramm für Client_IrcClient:
+
+
+ + +Client_AbstractClient + +
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + + + + + + + + +

+Öffentliche Methoden

 __construct ()
 processData ($data)
 loadConfig ($config)
 setID ($id)
 setGroup ($group)
 injectClientManager ($clientManager)

+Geschützte Attribute

$got_001
$joined
$authed
$nick
$channels
$lines
$ID
$group
$clientManager
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 8 der Datei IrcClient.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + +
Client_IrcClient.__construct ( ) 
+
+
+

Default constructor.

+ +

Definiert in Zeile 20 der Datei IrcClient.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Client_AbstractClient.injectClientManager ( clientManager )  [inherited]
+
+
+

Injects ClientManager

+
Parameter:
+ + +
Client_ClientManager $clientManager
+
+
+ +

Definiert in Zeile 58 der Datei AbstractClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_IrcClient.loadConfig ( config ) 
+
+
+

Loads the given configuration.

+
Parameter:
+ + +
array $config
+
+
+
Rückgabe:
void
+ +

Erneute Implementation von Client_AbstractClient.

+ +

Definiert in Zeile 70 der Datei IrcClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_IrcClient.processData ( data ) 
+
+
+

Does all the hard work.

+
Parameter:
+ + +
string $data
+
+
+
Rückgabe:
string
+ +

Erneute Implementation von Client_AbstractClient.

+ +

Definiert in Zeile 34 der Datei IrcClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.setGroup ( group )  [inherited]
+
+
+
Parameter:
+ + +
string $group
+
+
+ +

Definiert in Zeile 49 der Datei AbstractClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.setID ( id )  [inherited]
+
+
+
Parameter:
+ + +
int $id
+
+
+ +

Definiert in Zeile 42 der Datei AbstractClient.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classClient__IrcClient.png b/ircbot/Documentation/Doxygen/html/classClient__IrcClient.png new file mode 100644 index 0000000..2ae42b7 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/classClient__IrcClient.png differ diff --git a/ircbot/Documentation/Doxygen/html/classConnection__ConnectionHandler-members.html b/ircbot/Documentation/Doxygen/html/classConnection__ConnectionHandler-members.html new file mode 100644 index 0000000..fe67efe --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classConnection__ConnectionHandler-members.html @@ -0,0 +1,107 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Connection_ConnectionHandler Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Connection_ConnectionHandler einschließlich aller geerbten Elemente. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
$buffer_incoming (Definiert in Connection_ConnectionHandler)Connection_ConnectionHandler [protected]
$buffer_outgoing (Definiert in Connection_ConnectionHandler)Connection_ConnectionHandler [protected]
$group (Definiert in Connection_ConnectionHandler)Connection_ConnectionHandler [protected]
$id (Definiert in Connection_ConnectionHandler)Connection_ConnectionHandler [protected]
$is_server (Definiert in Connection_ConnectionHandler)Connection_ConnectionHandler [protected]
$protocol (Definiert in Connection_ConnectionHandler)Connection_ConnectionHandler [protected]
$socketHandler (Definiert in Connection_ConnectionHandler)Connection_ConnectionHandler [protected]
__construct($socket, $id, $group="", $protocol="", $linebreak="\r\n")Connection_ConnectionHandler
__destruct()Connection_ConnectionHandler
accept()Connection_ConnectionHandler
bind($address, $port)Connection_ConnectionHandler
canRead()Connection_ConnectionHandler
canWrite()Connection_ConnectionHandler
close()Connection_ConnectionHandler
connect($address, $port)Connection_ConnectionHandler
getGroup()Connection_ConnectionHandler
getID()Connection_ConnectionHandler
getLocalName()Connection_ConnectionHandler
getProtocol()Connection_ConnectionHandler
getRemoteName()Connection_ConnectionHandler
getSocket()Connection_ConnectionHandler
getSocketHandler()Connection_ConnectionHandler
handleSocketError()Connection_ConnectionHandler
hasBeenAccepted()Connection_ConnectionHandler
isConnected()Connection_ConnectionHandler
isListening()Connection_ConnectionHandler
isServer()Connection_ConnectionHandler
listen()Connection_ConnectionHandler
read()Connection_ConnectionHandler
readToBuffer()Connection_ConnectionHandler
write($data)Connection_ConnectionHandler
writeFromBuffer()Connection_ConnectionHandler
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classConnection__ConnectionHandler.html b/ircbot/Documentation/Doxygen/html/classConnection__ConnectionHandler.html new file mode 100644 index 0000000..2c4d46a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classConnection__ConnectionHandler.html @@ -0,0 +1,790 @@ + + + + +ircbot: Connection_ConnectionHandler Klassenreferenz + + + + + + + + + +
+ +
+

Connection_ConnectionHandler Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Öffentliche Methoden

 __construct ($socket, $id, $group="", $protocol="", $linebreak="\r\n")
 __destruct ()
 getProtocol ()
 getGroup ()
 getID ()
 isServer ()
 readToBuffer ()
 writeFromBuffer ()
 handleSocketError ()
 canRead ()
 canWrite ()
 read ()
 write ($data)
 accept ()
 getRemoteName ()
 getLocalName ()
 close ()
 connect ($address, $port)
 bind ($address, $port)
 listen ()
 isConnected ()
 isListening ()
 getSocket ()
 getSocketHandler ()
 hasBeenAccepted ()

+Geschützte Attribute

$buffer_incoming
$buffer_outgoing
$socketHandler
$is_server
$id
$group
$protocol
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 11 der Datei ConnectionHandler.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Connection_ConnectionHandler.__construct ( socket,
id,
group = "",
protocol = "",
linebreak = "\r\n" 
)
+
+
+

Calls parent constructor.

+
Parameter:
+ + + +
$socket 
$linebreak 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 63 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.__destruct ( ) 
+
+
+

Calls parent destructor.

+
Rückgabe:
void
+ +

Definiert in Zeile 77 der Datei ConnectionHandler.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.accept ( ) 
+
+
+

Calls SocketHandler

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
ressource
+ +

Definiert in Zeile 187 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Connection_ConnectionHandler.bind ( address,
port 
)
+
+
+

Calls SocketHandler

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 237 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.canRead ( ) 
+
+
+

Determines whether this ConnectionHandler has data to read.

+
Rückgabe:
boolean
+ +

Definiert in Zeile 150 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.canWrite ( ) 
+
+
+

Determines whether this ConnectionHandler has data to write.

+
Rückgabe:
boolean
+ +

Definiert in Zeile 158 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.close ( ) 
+
+
+

Calls SocketHandler

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 217 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Connection_ConnectionHandler.connect ( address,
port 
)
+
+
+

Calls SocketHandler

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 227 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.getGroup ( ) 
+
+
+
Rückgabe:
string Connection Group
+ +

Definiert in Zeile 91 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.getID ( ) 
+
+
+
Rückgabe:
int Connection ID
+ +

Definiert in Zeile 98 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.getLocalName ( ) 
+
+
+

Calls SocketHandler

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
string
+ +

Definiert in Zeile 207 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.getProtocol ( ) 
+
+
+
Rückgabe:
string
+ +

Definiert in Zeile 84 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.getRemoteName ( ) 
+
+
+

Calls SocketHandler

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
string
+ +

Definiert in Zeile 197 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.getSocket ( ) 
+
+
+

Calls SocketHandler

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
ressource
+ +

Definiert in Zeile 274 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.getSocketHandler ( ) 
+
+
+
Rückgabe:
Socket_SocketHandler
+ +

Definiert in Zeile 281 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.handleSocketError ( ) 
+
+
+

Calls error() on Socket_SocketHandler.

+
Ausnahmebehandlung:
+ + +
Socket_SocketExceptions 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 142 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.hasBeenAccepted ( ) 
+
+
+

Calls SocketHandler

+
Siehe auch:
Socket_SocketHandler
+
Rückgabe:
void
+ +

Definiert in Zeile 290 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.isConnected ( ) 
+
+
+
Siehe auch:
Socket_SocketHandler
+
Rückgabe:
boolean
+ +

Definiert in Zeile 256 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.isListening ( ) 
+
+
+
Siehe auch:
Socket_SocketHandler
+
Rückgabe:
boolean
+ +

Definiert in Zeile 264 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.isServer ( ) 
+
+
+

Returns whether this connection is a listening socket or a general client connection socket.

+
Rückgabe:
boolean
+ +

Definiert in Zeile 106 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.listen ( ) 
+
+
+

Calls SocketHandler

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 247 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.read ( ) 
+
+
+

Reads new data into buffer_incoming. Returns a full line from buffer_incoming.

+
Rückgabe:
string
+ +

Definiert in Zeile 167 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.readToBuffer ( ) 
+
+
+

Reads from SocketHandler, writes into buffer_incoming. Returns a boolean that will indicate whether the socket is still okay.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
boolean
+ +

Definiert in Zeile 116 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + + +
Connection_ConnectionHandler.write ( data ) 
+
+
+

Writes data into buffer_outgoing. Sends data from buffer_outgoing to the SocketHandler.

+
Parameter:
+ + +
$data 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 177 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.writeFromBuffer ( ) 
+
+
+

Writes the buffer_outgoing to the SocketHandler. Returns a boolean that will indicate whether the socket is still okay.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
boolean
+ +

Definiert in Zeile 129 der Datei ConnectionHandler.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classConnection__ConnectionPool-members.html b/ircbot/Documentation/Doxygen/html/classConnection__ConnectionPool-members.html new file mode 100644 index 0000000..cdac917 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classConnection__ConnectionPool-members.html @@ -0,0 +1,88 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Connection_ConnectionPool Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Connection_ConnectionPool einschließlich aller geerbten Elemente. + + + + + + + + + + + + + +
$connectionHandlers (Definiert in Connection_ConnectionPool)Connection_ConnectionPool [protected]
$nextID (Definiert in Connection_ConnectionPool)Connection_ConnectionPool [protected]
$socketPool (Definiert in Connection_ConnectionPool)Connection_ConnectionPool [protected]
__construct($linebreak="\r\n")Connection_ConnectionPool
__destruct()Connection_ConnectionPool
addConnectionHandler($add_connectionHandler)Connection_ConnectionPool
countConnections()Connection_ConnectionPool
createTcpConnection($group="", $protocol="RAW", $IPv6=FALSE)Connection_ConnectionPool
getConnectionHandlerForSocketRessource($socketRessource)Connection_ConnectionPool [protected]
removeConnectionHandler($remove_connectionHandler)Connection_ConnectionPool
select()Connection_ConnectionPool
writeToGroup($group, $data)Connection_ConnectionPool
writeToID($id, $data)Connection_ConnectionPool
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classConnection__ConnectionPool.html b/ircbot/Documentation/Doxygen/html/classConnection__ConnectionPool.html new file mode 100644 index 0000000..44e9fde --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classConnection__ConnectionPool.html @@ -0,0 +1,422 @@ + + + + +ircbot: Connection_ConnectionPool Klassenreferenz + + + + + + + + + +
+ +
+

Connection_ConnectionPool Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + + + + + + + +

+Öffentliche Methoden

 __construct ($linebreak="\r\n")
 __destruct ()
 createTcpConnection ($group="", $protocol="RAW", $IPv6=FALSE)
 addConnectionHandler ($add_connectionHandler)
 removeConnectionHandler ($remove_connectionHandler)
 select ()
 writeToGroup ($group, $data)
 writeToID ($id, $data)
 countConnections ()

+Geschützte Methoden

 getConnectionHandlerForSocketRessource ($socketRessource)

+Geschützte Attribute

$socketPool
$connectionHandlers
$nextID
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 8 der Datei ConnectionPool.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + + +
Connection_ConnectionPool.__construct ( linebreak = "\r\n" ) 
+
+
+

Creates an Instance of SocketPool

+
Rückgabe:
void
+ +

Definiert in Zeile 31 der Datei ConnectionPool.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionPool.__destruct ( ) 
+
+
+

Destroys the SocketPool

+
Rückgabe:
void
+ +

Definiert in Zeile 41 der Datei ConnectionPool.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Connection_ConnectionPool.addConnectionHandler ( add_connectionHandler ) 
+
+
+

Adds a ConnectionHandler to the pool.

+
Parameter:
+ + +
Connection_ConnectionHandler $add_connectionHandler
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 62 der Datei ConnectionPool.php.

+ +

Wird benutzt von createTcpConnection() und select().

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionPool.countConnections ( ) 
+
+
+
Siehe auch:
Socket_SocketPool
+
Rückgabe:
int
+ +

Definiert in Zeile 177 der Datei ConnectionPool.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Connection_ConnectionPool.createTcpConnection ( group = "",
protocol = "RAW",
IPv6 = FALSE 
)
+
+
+

Creates a new TcpConnection.

+
Parameter:
+ + +
boolean $IPv6 will determine whether the socket uses IPv4 or IPv6.
+
+
+
Rückgabe:
Connection_ConnectionHandler
+ +

Definiert in Zeile 50 der Datei ConnectionPool.php.

+ +

Benutzt addConnectionHandler().

+ +
+
+ +
+
+ + + + + + + + + +
Connection_ConnectionPool.getConnectionHandlerForSocketRessource ( socketRessource )  [protected]
+
+
+

Returns ConnectionHandler for the given socket ressource.

+
Parameter:
+ + +
ressource $socketRessource
+
+
+
Rückgabe:
Connection_ConnectionHandler
+ +

Definiert in Zeile 87 der Datei ConnectionPool.php.

+ +

Wird benutzt von select().

+ +
+
+ +
+
+ + + + + + + + + +
Connection_ConnectionPool.removeConnectionHandler ( remove_connectionHandler ) 
+
+
+

Removes a ConnectionHandler from the pool.

+
Parameter:
+ + +
Connection_ConnectionHandler $remove_connectionHandler
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 72 der Datei ConnectionPool.php.

+ +

Wird benutzt von select().

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionPool.select ( ) 
+
+
+

Calls select() on SocketPool and updates the ConnectionHandler. Will also accept incoming connections and add them to the pool.

+
Rückgabe:
array An array containing the Connection_ConnectionHandler for each Socket with new data.
+
Ausnahmebehandlung:
+ + + +
Exception_GeneralException 
Exception_SocketException 
+
+
+ +

Definiert in Zeile 102 der Datei ConnectionPool.php.

+ +

Benutzt addConnectionHandler(), getConnectionHandlerForSocketRessource() und removeConnectionHandler().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Connection_ConnectionPool.writeToGroup ( group,
data 
)
+
+
+

Writes the given data to all sockets in $group.

+
Parameter:
+ + + +
string $group
string $data
+
+
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 152 der Datei ConnectionPool.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Connection_ConnectionPool.writeToID ( id,
data 
)
+
+
+

Writes the given data to the socket with $id.

+
Parameter:
+ + + +
int $id
string $data
+
+
+ +

Definiert in Zeile 165 der Datei ConnectionPool.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classException.html b/ircbot/Documentation/Doxygen/html/classException.html new file mode 100644 index 0000000..187e896 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classException.html @@ -0,0 +1,92 @@ + + + + +ircbot: Exception Klassenreferenz + + + + + + + + + +
+
+

Exception Klassenreferenz

+
+
+
+Klassendiagramm für Exception:
+
+
+ + +Exception_GeneralException +TestException +TestFailException +Exception_SocketException + +
+ +
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classException.png b/ircbot/Documentation/Doxygen/html/classException.png new file mode 100644 index 0000000..69764d5 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/classException.png differ diff --git a/ircbot/Documentation/Doxygen/html/classException__GeneralException-members.html b/ircbot/Documentation/Doxygen/html/classException__GeneralException-members.html new file mode 100644 index 0000000..51ef2e4 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classException__GeneralException-members.html @@ -0,0 +1,77 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Exception_GeneralException Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Exception_GeneralException einschließlich aller geerbten Elemente. + + +
__construct($message="", $code=0)Exception_GeneralException
__toString()Exception_GeneralException
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classException__GeneralException.html b/ircbot/Documentation/Doxygen/html/classException__GeneralException.html new file mode 100644 index 0000000..f8c2d15 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classException__GeneralException.html @@ -0,0 +1,166 @@ + + + + +ircbot: Exception_GeneralException Klassenreferenz + + + + + + + + + +
+ +
+

Exception_GeneralException Klassenreferenz

+
+
+
+Klassendiagramm für Exception_GeneralException:
+
+
+ + +Exception +Exception_SocketException + +
+ +

Aufstellung aller Elemente

+ + + + +

+Öffentliche Methoden

 __construct ($message="", $code=0)
 __toString ()
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 8 der Datei GeneralException.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + + + + + + + + + + + +
Exception_GeneralException.__construct ( message = "",
code = 0 
)
+
+
+

Constructor. Throws a new exception in case the exception is unknown.

+
Ausnahmebehandlung:
+ + +
UnknownException 
+
+
+
Parameter:
+ + + +
string $message
int $code
+
+
+ +

Definiert in Zeile 16 der Datei GeneralException.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + +
Exception_GeneralException.__toString ( ) 
+
+
+

Puts all the important information into a string.

+
Rückgabe:
string
+ +

Definiert in Zeile 27 der Datei GeneralException.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classException__GeneralException.png b/ircbot/Documentation/Doxygen/html/classException__GeneralException.png new file mode 100644 index 0000000..4c88b2c Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/classException__GeneralException.png differ diff --git a/ircbot/Documentation/Doxygen/html/classException__SocketException-members.html b/ircbot/Documentation/Doxygen/html/classException__SocketException-members.html new file mode 100644 index 0000000..341b959 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classException__SocketException-members.html @@ -0,0 +1,77 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Exception_SocketException Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Exception_SocketException einschließlich aller geerbten Elemente. + + +
__construct($message="", $code=0)Exception_GeneralException
__toString()Exception_GeneralException
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classException__SocketException.html b/ircbot/Documentation/Doxygen/html/classException__SocketException.html new file mode 100644 index 0000000..fce105a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classException__SocketException.html @@ -0,0 +1,121 @@ + + + + +ircbot: Exception_SocketException Klassenreferenz + + + + + + + + + +
+ +
+

Exception_SocketException Klassenreferenz

+
+
+
+Klassendiagramm für Exception_SocketException:
+
+
+ + +Exception_GeneralException +Exception + +
+ +

Aufstellung aller Elemente

+ + + +

+Öffentliche Methoden

 __toString ()
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 8 der Datei SocketException.php.

+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + +
Exception_GeneralException.__toString ( )  [inherited]
+
+
+

Puts all the important information into a string.

+
Rückgabe:
string
+ +

Definiert in Zeile 27 der Datei GeneralException.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classException__SocketException.png b/ircbot/Documentation/Doxygen/html/classException__SocketException.png new file mode 100644 index 0000000..b4ec340 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/classException__SocketException.png differ diff --git a/ircbot/Documentation/Doxygen/html/classFoo-members.html b/ircbot/Documentation/Doxygen/html/classFoo-members.html new file mode 100644 index 0000000..517a6e9 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classFoo-members.html @@ -0,0 +1,80 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Foo Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Foo einschließlich aller geerbten Elemente. + + + + + +
$pool (Definiert in Foo)Foo [protected]
__construct() (Definiert in Foo)Foo
addBar($bar)Foo
getBar($id)Foo
getTestResult()Foo
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classFoo.html b/ircbot/Documentation/Doxygen/html/classFoo.html new file mode 100644 index 0000000..1bae10f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classFoo.html @@ -0,0 +1,176 @@ + + + + +ircbot: Foo Klassenreferenz + + + + + + + + + +
+ +
+

Foo Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + +

+Öffentliche Methoden

 addBar ($bar)
 getBar ($id)
 getTestResult ()

+Geschützte Attribute

$pool
+

Ausführliche Beschreibung

+

Testclass

+
Autor:
jpt
+ +

Definiert in Zeile 6 der Datei ReferenceTest.php.

+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Foo.addBar ( bar ) 
+
+
+

Adds an Instance of Bar to the Pool.

+
Parameter:
+ + +
Bar $bar
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 21 der Datei ReferenceTest.php.

+ +
+
+ +
+
+ + + + + + + + + +
Foo.getBar ( id ) 
+
+
+

Returns the internal instance of Bar for the specific ID.

+
Parameter:
+ + +
int $id
+
+
+
Rückgabe:
Bar
+ +

Definiert in Zeile 30 der Datei ReferenceTest.php.

+ +
+
+ +
+
+ + + + + + + + +
Foo.getTestResult ( ) 
+
+
+

Outputs the current state of the bars in the pool.

+
Rückgabe:
void
+ +

Definiert in Zeile 40 der Datei ReferenceTest.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classMisc__Buffer-members.html b/ircbot/Documentation/Doxygen/html/classMisc__Buffer-members.html new file mode 100644 index 0000000..ab02843 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classMisc__Buffer-members.html @@ -0,0 +1,82 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Misc_Buffer Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Misc_Buffer einschließlich aller geerbten Elemente. + + + + + + + +
$buffer (Definiert in Misc_Buffer)Misc_Buffer [protected]
$linebreak (Definiert in Misc_Buffer)Misc_Buffer [protected]
__construct($linebreak="\r\n")Misc_Buffer
addData($data)Misc_Buffer
getNextLine()Misc_Buffer
hasLines()Misc_Buffer
pruneEmptyLines()Misc_Buffer [protected]
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classMisc__Buffer.html b/ircbot/Documentation/Doxygen/html/classMisc__Buffer.html new file mode 100644 index 0000000..e1f66a5 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classMisc__Buffer.html @@ -0,0 +1,232 @@ + + + + +ircbot: Misc_Buffer Klassenreferenz + + + + + + + + + +
+ +
+

Misc_Buffer Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + +

+Öffentliche Methoden

 __construct ($linebreak="\r\n")
 addData ($data)
 getNextLine ()
 hasLines ()

+Geschützte Methoden

 pruneEmptyLines ()

+Geschützte Attribute

$buffer
$linebreak
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 9 der Datei Buffer.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + + +
Misc_Buffer.__construct ( linebreak = "\r\n" ) 
+
+
+

Default constructor. Sets a default linebreak and initializes the buffer.

+
Parameter:
+ + +
$linebreak 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 28 der Datei Buffer.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Misc_Buffer.addData ( data ) 
+
+
+

Appends data to the buffer.

+
Parameter:
+ + +
string $data
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 55 der Datei Buffer.php.

+ +

Benutzt pruneEmptyLines().

+ +
+
+ +
+
+ + + + + + + + +
Misc_Buffer.getNextLine ( ) 
+
+
+

Returns the next line in the buffer and removes it from the buffer.

+
Rückgabe:
string
+ +

Definiert in Zeile 64 der Datei Buffer.php.

+ +

Benutzt hasLines().

+ +
+
+ +
+
+ + + + + + + + +
Misc_Buffer.hasLines ( ) 
+
+
+

Checks whether the buffer contains more lines to process.

+
Rückgabe:
boolean
+ +

Definiert in Zeile 77 der Datei Buffer.php.

+ +

Wird benutzt von getNextLine().

+ +
+
+ +
+
+ + + + + + + + +
Misc_Buffer.pruneEmptyLines ( )  [protected]
+
+
+

Prunes empty lines out of the buffer.

+
Rückgabe:
void
+ +

Definiert in Zeile 37 der Datei Buffer.php.

+ +

Wird benutzt von addData().

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classService__ExceptionTest-members.html b/ircbot/Documentation/Doxygen/html/classService__ExceptionTest-members.html new file mode 100644 index 0000000..26d8fbb --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classService__ExceptionTest-members.html @@ -0,0 +1,80 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Service_ExceptionTest Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Service_ExceptionTest einschließlich aller geerbten Elemente. + + + + + +
__construct() (Definiert in Service_ExceptionTest)Service_ExceptionTest
CatchAndThrow() (Definiert in Service_ExceptionTest)Service_ExceptionTest
failAtThis() (Definiert in Service_ExceptionTest)Service_ExceptionTest
internalCatch() (Definiert in Service_ExceptionTest)Service_ExceptionTest
TestTheFail() (Definiert in Service_ExceptionTest)Service_ExceptionTest
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classService__ExceptionTest.html b/ircbot/Documentation/Doxygen/html/classService__ExceptionTest.html new file mode 100644 index 0000000..2eb344c --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classService__ExceptionTest.html @@ -0,0 +1,96 @@ + + + + +ircbot: Service_ExceptionTest Klassenreferenz + + + + + + + + + +
+ +
+

Service_ExceptionTest Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + +

+Öffentliche Methoden

TestTheFail ()
CatchAndThrow ()
internalCatch ()
failAtThis ()
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 19 der Datei Exceptions.php.

+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classSocket__SocketHandler-members.html b/ircbot/Documentation/Doxygen/html/classSocket__SocketHandler-members.html new file mode 100644 index 0000000..7ea2193 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classSocket__SocketHandler-members.html @@ -0,0 +1,95 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Socket_SocketHandler Elementverzeichnis

+
+ + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classSocket__SocketHandler.html b/ircbot/Documentation/Doxygen/html/classSocket__SocketHandler.html new file mode 100644 index 0000000..1fa6a5a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classSocket__SocketHandler.html @@ -0,0 +1,598 @@ + + + + +ircbot: Socket_SocketHandler Klassenreferenz + + + + + + + + + +
+ +
+

Socket_SocketHandler Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + + + + + + + + + + + + + + +

+Öffentliche Methoden

 __construct ($socket)
 __destruct ()
 getSocket ()
 isConnected ()
 isListening ()
 connect ($address, $port)
 bind ($address, $port)
 listen ()
 hasBeenAccepted ()
 accept ()
 getRemoteName ()
 getLocalName ()
 write ($data)
 read ($length=16384)
 close ()

+Geschützte Methoden

 error ()

+Geschützte Attribute

$socket
$is_connected
$is_bound
$is_listening
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 7 der Datei SocketHandler.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + + +
Socket_SocketHandler.__construct ( socket ) 
+
+
+

Default constructor. Sets the socket.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Parameter:
+ + +
ressource $socket
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 36 der Datei SocketHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.__destruct ( ) 
+
+
+

Destructor. Closes socket.

+
Rückgabe:
void
+ +

Definiert in Zeile 48 der Datei SocketHandler.php.

+ +

Benutzt close().

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + +
Socket_SocketHandler.accept ( ) 
+
+
+

Accepts a connection to a socket that is bound and listens The ressource has to be added to the SocketPool manually

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
ressource
+ +

Definiert in Zeile 130 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Socket_SocketHandler.bind ( address,
port 
)
+
+
+

Binds the socket to an address + port.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Parameter:
+ + + +
string $address
int $port
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 95 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.close ( ) 
+
+
+

Shuts the socket down after waiting a bit (waiting might be optional).

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 190 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +

Wird benutzt von __destruct().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Socket_SocketHandler.connect ( address,
port 
)
+
+
+

Connects to a specified address.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Parameter:
+ + + +
string $address
int $port
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 81 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.error ( )  [protected]
+
+
+

Gets last error from socket.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+ +

Definiert in Zeile 207 der Datei SocketHandler.php.

+ +

Wird benutzt von accept(), bind(), close(), connect(), getLocalName(), getRemoteName(), listen(), read() und write().

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.getLocalName ( ) 
+
+
+

Returns ip + port of the local socket.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
string
+ +

Definiert in Zeile 155 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.getRemoteName ( ) 
+
+
+

Returns ip + port of the remote socket.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
string
+ +

Definiert in Zeile 143 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.getSocket ( ) 
+
+
+

Returns socket

+
Rückgabe:
ressource
+ +

Definiert in Zeile 56 der Datei SocketHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.hasBeenAccepted ( ) 
+
+
+

Tells the SocketHandler that he got accepted.

+
Rückgabe:
void
+ +

Definiert in Zeile 120 der Datei SocketHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.isConnected ( ) 
+
+
+
Rückgabe:
boolean
+ +

Definiert in Zeile 63 der Datei SocketHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.isListening ( ) 
+
+
+
Rückgabe:
boolean
+ +

Definiert in Zeile 70 der Datei SocketHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.listen ( ) 
+
+
+

Let's the socket listen for incoming connections.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 109 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +
+
+ +
+
+ + + + + + + + + +
Socket_SocketHandler.read ( length = 16384 ) 
+
+
+

Reads data from the socket.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Parameter:
+ + +
int $length
+
+
+
Rückgabe:
string
+ +

Definiert in Zeile 179 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +
+
+ +
+
+ + + + + + + + + +
Socket_SocketHandler.write ( data ) 
+
+
+

Writes data to the socket.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Parameter:
+ + +
string $data
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 168 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classSocket__SocketPool-members.html b/ircbot/Documentation/Doxygen/html/classSocket__SocketPool-members.html new file mode 100644 index 0000000..350b945 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classSocket__SocketPool-members.html @@ -0,0 +1,83 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Socket_SocketPool Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Socket_SocketPool einschließlich aller geerbten Elemente. + + + + + + + + +
$sockets (Definiert in Socket_SocketPool)Socket_SocketPool [protected]
__construct()Socket_SocketPool
__destruct()Socket_SocketPool
addSocket($add_socket)Socket_SocketPool
countSockets()Socket_SocketPool
createTcpSocket($IPv6=FALSE)Socket_SocketPool
removeSocket($remove_socket)Socket_SocketPool
select($read, $write, $except, $timeout=NULL)Socket_SocketPool
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classSocket__SocketPool.html b/ircbot/Documentation/Doxygen/html/classSocket__SocketPool.html new file mode 100644 index 0000000..9f2f9ef --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classSocket__SocketPool.html @@ -0,0 +1,317 @@ + + + + +ircbot: Socket_SocketPool Klassenreferenz + + + + + + + + + +
+ +
+

Socket_SocketPool Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + +

+Öffentliche Methoden

 __construct ()
 __destruct ()
 countSockets ()
 addSocket ($add_socket)
 removeSocket ($remove_socket)
 createTcpSocket ($IPv6=FALSE)
 select ($read, $write, $except, $timeout=NULL)

+Geschützte Attribute

$sockets
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 8 der Datei SocketPool.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + +
Socket_SocketPool.__construct ( ) 
+
+
+

Creates sockets.

+
Rückgabe:
void
+ +

Definiert in Zeile 20 der Datei SocketPool.php.

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketPool.__destruct ( ) 
+
+
+

Closes all connections.

+
Rückgabe:
void
+ +

Definiert in Zeile 28 der Datei SocketPool.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Socket_SocketPool.addSocket ( add_socket ) 
+
+
+

Adds a socket to the pool

+
Parameter:
+ + +
ressource $add_socket
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 45 der Datei SocketPool.php.

+ +

Wird benutzt von createTcpSocket().

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketPool.countSockets ( ) 
+
+
+

Returns the amount of active sockets.

+
Rückgabe:
int
+ +

Definiert in Zeile 36 der Datei SocketPool.php.

+ +
+
+ +
+
+ + + + + + + + + +
Socket_SocketPool.createTcpSocket ( IPv6 = FALSE ) 
+
+
+

Creates a new TcpSocket and adds it to the pool.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Parameter:
+ + +
boolean $IPv6 will determine whether the socket uses IPv4 or IPv6.
+
+
+
Rückgabe:
ressource
+ +

Definiert in Zeile 73 der Datei SocketPool.php.

+ +

Benutzt addSocket().

+ +
+
+ +
+
+ + + + + + + + + +
Socket_SocketPool.removeSocket ( remove_socket ) 
+
+
+

Removes the given socket from the pool. The socket will be shutdown.

+
Parameter:
+ + +
ressource $remove_socket
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 55 der Datei SocketPool.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Socket_SocketPool.select ( read,
write,
except,
timeout = NULL 
)
+
+
+

Returns an array of sockets one can read from.

+
Parameter:
+ + + + + +
array $read
array $write
array $except
int $timeout
+
+
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
array
+ +

Definiert in Zeile 91 der Datei SocketPool.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classTestClassForTestsWithReflection-members.html b/ircbot/Documentation/Doxygen/html/classTestClassForTestsWithReflection-members.html new file mode 100644 index 0000000..e202efa --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classTestClassForTestsWithReflection-members.html @@ -0,0 +1,79 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

TestClassForTestsWithReflection Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für TestClassForTestsWithReflection einschließlich aller geerbten Elemente. + + + + +
$protected (Definiert in TestClassForTestsWithReflection)TestClassForTestsWithReflection [protected]
$public (Definiert in TestClassForTestsWithReflection)TestClassForTestsWithReflection
blablubblol(Klasse $objekt)TestClassForTestsWithReflection
testfunctionWithCamelCase(array $ray, $zero=0)TestClassForTestsWithReflection [protected]
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classTestClassForTestsWithReflection.html b/ircbot/Documentation/Doxygen/html/classTestClassForTestsWithReflection.html new file mode 100644 index 0000000..985642a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classTestClassForTestsWithReflection.html @@ -0,0 +1,172 @@ + + + + +ircbot: TestClassForTestsWithReflection Klassenreferenz + + + + + + + + + +
+ +
+

TestClassForTestsWithReflection Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + + + +

+Öffentliche Methoden

 blablubblol (Klasse $objekt)

+Öffentliche Attribute

$public

+Geschützte Methoden

 testfunctionWithCamelCase (array $ray, $zero=0)

+Geschützte Attribute

$protected
+

Ausführliche Beschreibung

+

Testclass in order to test phpdoc-stuff with the php reflection api Shall help in order to find out how this stuff works.

+
Autor:
jpt
+ +

Definiert in Zeile 7 der Datei Reflection.php.

+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
TestClassForTestsWithReflection.blablubblol (Klasse $  objekt ) 
+
+
+

Testfunction

+
Parameter:
+ + +
Klasse $objekt
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 29 der Datei Reflection.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
TestClassForTestsWithReflection.testfunctionWithCamelCase (array $  ray,
zero = 0 
) [protected]
+
+
+

Tests the getDocComment() method

+
Parameter:
+ + + +
array $ray
int $zero
+
+
+
Rückgabe:
string
+ +

Definiert in Zeile 42 der Datei Reflection.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classTestException-members.html b/ircbot/Documentation/Doxygen/html/classTestException-members.html new file mode 100644 index 0000000..2a42548 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classTestException-members.html @@ -0,0 +1,76 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

TestException Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für TestException einschließlich aller geerbten Elemente. + +
__construct($message) (Definiert in TestException)TestException
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classTestException.html b/ircbot/Documentation/Doxygen/html/classTestException.html new file mode 100644 index 0000000..d501ae7 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classTestException.html @@ -0,0 +1,99 @@ + + + + +ircbot: TestException Klassenreferenz + + + + + + + + + +
+ +
+

TestException Klassenreferenz

+
+
+
+Klassendiagramm für TestException:
+
+
+ + +Exception + +
+ +

Aufstellung aller Elemente

+ + + +

+Öffentliche Methoden

__construct ($message)
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 3 der Datei Exceptions.php.

+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classTestException.png b/ircbot/Documentation/Doxygen/html/classTestException.png new file mode 100644 index 0000000..df8be49 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/classTestException.png differ diff --git a/ircbot/Documentation/Doxygen/html/classTestFailException-members.html b/ircbot/Documentation/Doxygen/html/classTestFailException-members.html new file mode 100644 index 0000000..70e0a40 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classTestFailException-members.html @@ -0,0 +1,76 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

TestFailException Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für TestFailException einschließlich aller geerbten Elemente. + +
__construct($msg) (Definiert in TestFailException)TestFailException
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classTestFailException.html b/ircbot/Documentation/Doxygen/html/classTestFailException.html new file mode 100644 index 0000000..5cd8439 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classTestFailException.html @@ -0,0 +1,99 @@ + + + + +ircbot: TestFailException Klassenreferenz + + + + + + + + + +
+ +
+

TestFailException Klassenreferenz

+
+
+
+Klassendiagramm für TestFailException:
+
+
+ + +Exception + +
+ +

Aufstellung aller Elemente

+ + + +

+Öffentliche Methoden

__construct ($msg)
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 11 der Datei Exceptions.php.

+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/classTestFailException.png b/ircbot/Documentation/Doxygen/html/classTestFailException.png new file mode 100644 index 0000000..9e53cd4 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/classTestFailException.png differ diff --git a/ircbot/Documentation/Doxygen/html/classes.html b/ircbot/Documentation/Doxygen/html/classes.html new file mode 100644 index 0000000..f245817 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/classes.html @@ -0,0 +1,81 @@ + + + + +ircbot: Alphabetische Liste + + + + + + + + + +
+
+

Klassen-Verzeichnis

+
+ + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/closed.png b/ircbot/Documentation/Doxygen/html/closed.png new file mode 100644 index 0000000..b7d4bd9 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/closed.png differ diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool.html b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool.html new file mode 100644 index 0000000..0c0c4e7 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool.html @@ -0,0 +1,486 @@ + + + + +ircbot: Connection_ConnectionPool Klassenreferenz + + + + + + + + + +
+ +
+

Connection_ConnectionPool Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

+Öffentliche Methoden

 __construct ($linebreak="\r\n")
 Creates an Instance of SocketPool.
 __destruct ()
 Destroys the SocketPool.
 createTcpConnection ($group="", $protocol="RAW", $IPv6=FALSE)
 Creates a new TcpConnection.
 addConnectionHandler ($add_connectionHandler)
 Adds a ConnectionHandler to the pool.
 removeConnectionHandler ($remove_connectionHandler)
 Removes a ConnectionHandler from the pool.
 select ()
 Calls select() on SocketPool and updates the ConnectionHandler.
 writeToGroup ($group, $data)
 Writes the given data to all sockets in $group.
 writeToID ($id, $data)
 Writes the given data to the socket with $id.
 countConnections ()

+Geschützte Methoden

 getConnectionHandlerForSocketRessource ($socketRessource)
 Returns ConnectionHandler for the given socket ressource.

+Geschützte Attribute

$socketPool
$connectionHandlers
$nextID
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 8 der Datei ConnectionPool.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + + +
Connection_ConnectionPool.__construct ( linebreak = "\r\n" ) 
+
+
+ +

Creates an Instance of SocketPool.

+
Rückgabe:
void
+ +

Definiert in Zeile 31 der Datei ConnectionPool.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionPool.__destruct ( ) 
+
+
+ +

Destroys the SocketPool.

+
Rückgabe:
void
+ +

Definiert in Zeile 41 der Datei ConnectionPool.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Connection_ConnectionPool.addConnectionHandler ( add_connectionHandler ) 
+
+
+ +

Adds a ConnectionHandler to the pool.

+
Parameter:
+ + +
Connection_ConnectionHandler $add_connectionHandler
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 62 der Datei ConnectionPool.php.

+ +

Wird benutzt von createTcpConnection() und select().

+ +

+Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionPool.countConnections ( ) 
+
+
+
Siehe auch:
Socket_SocketPool
+
Rückgabe:
int
+ +

Definiert in Zeile 177 der Datei ConnectionPool.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Connection_ConnectionPool.createTcpConnection ( group = "",
protocol = "RAW",
IPv6 = FALSE 
)
+
+
+ +

Creates a new TcpConnection.

+
Parameter:
+ + +
boolean $IPv6 will determine whether the socket uses IPv4 or IPv6.
+
+
+
Rückgabe:
Connection_ConnectionHandler
+ +

Definiert in Zeile 50 der Datei ConnectionPool.php.

+ +

Benutzt addConnectionHandler().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + + +
Connection_ConnectionPool.getConnectionHandlerForSocketRessource ( socketRessource )  [protected]
+
+
+ +

Returns ConnectionHandler for the given socket ressource.

+
Parameter:
+ + +
ressource $socketRessource
+
+
+
Rückgabe:
Connection_ConnectionHandler
+ +

Definiert in Zeile 87 der Datei ConnectionPool.php.

+ +

Wird benutzt von select().

+ +

+Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + + +
Connection_ConnectionPool.removeConnectionHandler ( remove_connectionHandler ) 
+
+
+ +

Removes a ConnectionHandler from the pool.

+
Parameter:
+ + +
Connection_ConnectionHandler $remove_connectionHandler
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 72 der Datei ConnectionPool.php.

+ +

Wird benutzt von select().

+ +

+Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionPool.select ( ) 
+
+
+ +

Calls select() on SocketPool and updates the ConnectionHandler.

+

Will also accept incoming connections and add them to the pool.

+
Rückgabe:
array An array containing the Connection_ConnectionHandler for each Socket with new data.
+
Ausnahmebehandlung:
+ + + +
Exception_GeneralException 
Exception_SocketException 
+
+
+ +

Definiert in Zeile 102 der Datei ConnectionPool.php.

+ +

Benutzt addConnectionHandler(), getConnectionHandlerForSocketRessource() und removeConnectionHandler().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Connection_ConnectionPool.writeToGroup ( group,
data 
)
+
+
+ +

Writes the given data to all sockets in $group.

+
Parameter:
+ + + +
string $group
string $data
+
+
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 152 der Datei ConnectionPool.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Connection_ConnectionPool.writeToID ( id,
data 
)
+
+
+ +

Writes the given data to the socket with $id.

+
Parameter:
+ + + +
int $id
string $data
+
+
+ +

Definiert in Zeile 165 der Datei ConnectionPool.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a3088844988e22a033edf52edefe9f14d_cgraph.map b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a3088844988e22a033edf52edefe9f14d_cgraph.map new file mode 100644 index 0000000..ef5059f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a3088844988e22a033edf52edefe9f14d_cgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a3088844988e22a033edf52edefe9f14d_cgraph.md5 b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a3088844988e22a033edf52edefe9f14d_cgraph.md5 new file mode 100644 index 0000000..14ba963 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a3088844988e22a033edf52edefe9f14d_cgraph.md5 @@ -0,0 +1 @@ +78b757deb0ea176873f24731171f30f1 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a3088844988e22a033edf52edefe9f14d_cgraph.png b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a3088844988e22a033edf52edefe9f14d_cgraph.png new file mode 100644 index 0000000..2160a76 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a3088844988e22a033edf52edefe9f14d_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a65922149420aa8b7635235628a031ab5_cgraph.map b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a65922149420aa8b7635235628a031ab5_cgraph.map new file mode 100644 index 0000000..1affcdd --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a65922149420aa8b7635235628a031ab5_cgraph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a65922149420aa8b7635235628a031ab5_cgraph.md5 b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a65922149420aa8b7635235628a031ab5_cgraph.md5 new file mode 100644 index 0000000..7aed445 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a65922149420aa8b7635235628a031ab5_cgraph.md5 @@ -0,0 +1 @@ +dc43e7f5835a0333ad768b763f04f023 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a65922149420aa8b7635235628a031ab5_cgraph.png b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a65922149420aa8b7635235628a031ab5_cgraph.png new file mode 100644 index 0000000..39381e6 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a65922149420aa8b7635235628a031ab5_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a7b69c8594a0da112b7624a89b5f0069c_icgraph.map b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a7b69c8594a0da112b7624a89b5f0069c_icgraph.map new file mode 100644 index 0000000..f7c70c5 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a7b69c8594a0da112b7624a89b5f0069c_icgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a7b69c8594a0da112b7624a89b5f0069c_icgraph.md5 b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a7b69c8594a0da112b7624a89b5f0069c_icgraph.md5 new file mode 100644 index 0000000..22e12b3 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a7b69c8594a0da112b7624a89b5f0069c_icgraph.md5 @@ -0,0 +1 @@ +e400dd87790adbb3396c207d4ebbfd1d \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a7b69c8594a0da112b7624a89b5f0069c_icgraph.png b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a7b69c8594a0da112b7624a89b5f0069c_icgraph.png new file mode 100644 index 0000000..1781a74 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_a7b69c8594a0da112b7624a89b5f0069c_icgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_abc4695c339196fdddce0623dd357ecfc_icgraph.map b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_abc4695c339196fdddce0623dd357ecfc_icgraph.map new file mode 100644 index 0000000..fc11de1 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_abc4695c339196fdddce0623dd357ecfc_icgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_abc4695c339196fdddce0623dd357ecfc_icgraph.md5 b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_abc4695c339196fdddce0623dd357ecfc_icgraph.md5 new file mode 100644 index 0000000..4881f99 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_abc4695c339196fdddce0623dd357ecfc_icgraph.md5 @@ -0,0 +1 @@ +6fd1e259f4d745ea5a29218509d73cba \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_abc4695c339196fdddce0623dd357ecfc_icgraph.png b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_abc4695c339196fdddce0623dd357ecfc_icgraph.png new file mode 100644 index 0000000..b7e7e85 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_abc4695c339196fdddce0623dd357ecfc_icgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_ad1e391419908d336389c4158adc67b49_icgraph.map b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_ad1e391419908d336389c4158adc67b49_icgraph.map new file mode 100644 index 0000000..edfd38e --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_ad1e391419908d336389c4158adc67b49_icgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_ad1e391419908d336389c4158adc67b49_icgraph.md5 b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_ad1e391419908d336389c4158adc67b49_icgraph.md5 new file mode 100644 index 0000000..4a2f5ee --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_ad1e391419908d336389c4158adc67b49_icgraph.md5 @@ -0,0 +1 @@ +d7313fd7f0355c8953aee488c0920d62 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_ad1e391419908d336389c4158adc67b49_icgraph.png b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_ad1e391419908d336389c4158adc67b49_icgraph.png new file mode 100644 index 0000000..6980743 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d0/d25/classConnection__ConnectionPool_ad1e391419908d336389c4158adc67b49_icgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d0/d2a/classClient__IrcClient__coll__graph.map b/ircbot/Documentation/Doxygen/html/d0/d2a/classClient__IrcClient__coll__graph.map new file mode 100644 index 0000000..202fcfd --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/d2a/classClient__IrcClient__coll__graph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d0/d2a/classClient__IrcClient__coll__graph.md5 b/ircbot/Documentation/Doxygen/html/d0/d2a/classClient__IrcClient__coll__graph.md5 new file mode 100644 index 0000000..1c7f00a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/d2a/classClient__IrcClient__coll__graph.md5 @@ -0,0 +1 @@ +7c59a08fe398f3857e1833f3df49f992 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d0/d2a/classClient__IrcClient__coll__graph.png b/ircbot/Documentation/Doxygen/html/d0/d2a/classClient__IrcClient__coll__graph.png new file mode 100644 index 0000000..8bd6b26 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d0/d2a/classClient__IrcClient__coll__graph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d0/d34/classTestFailException__inherit__graph.map b/ircbot/Documentation/Doxygen/html/d0/d34/classTestFailException__inherit__graph.map new file mode 100644 index 0000000..d5d57dd --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/d34/classTestFailException__inherit__graph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d0/d34/classTestFailException__inherit__graph.md5 b/ircbot/Documentation/Doxygen/html/d0/d34/classTestFailException__inherit__graph.md5 new file mode 100644 index 0000000..2d0a4cc --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/d34/classTestFailException__inherit__graph.md5 @@ -0,0 +1 @@ +3a9c4d7b257c8870f9738ef825e68afd \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d0/d34/classTestFailException__inherit__graph.png b/ircbot/Documentation/Doxygen/html/d0/d34/classTestFailException__inherit__graph.png new file mode 100644 index 0000000..fa647ea Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d0/d34/classTestFailException__inherit__graph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d0/daa/inherit__graph__9.map b/ircbot/Documentation/Doxygen/html/d0/daa/inherit__graph__9.map new file mode 100644 index 0000000..a7e0bdb --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/daa/inherit__graph__9.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d0/daa/inherit__graph__9.md5 b/ircbot/Documentation/Doxygen/html/d0/daa/inherit__graph__9.md5 new file mode 100644 index 0000000..9b3b58f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/daa/inherit__graph__9.md5 @@ -0,0 +1 @@ +ed533d7ab9a6eb1038759719d48c8d23 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d0/daa/inherit__graph__9.png b/ircbot/Documentation/Doxygen/html/d0/daa/inherit__graph__9.png new file mode 100644 index 0000000..63be689 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d0/daa/inherit__graph__9.png differ diff --git a/ircbot/Documentation/Doxygen/html/d0/db4/classFoo-members.html b/ircbot/Documentation/Doxygen/html/d0/db4/classFoo-members.html new file mode 100644 index 0000000..460cd29 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/db4/classFoo-members.html @@ -0,0 +1,80 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Foo Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Foo einschließlich aller geerbten Elemente. + + + + + +
$pool (Definiert in Foo)Foo [protected]
__construct() (Definiert in Foo)Foo
addBar($bar)Foo
getBar($id)Foo
getTestResult()Foo
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d0/ddf/classConnection__ConnectionHandler.html b/ircbot/Documentation/Doxygen/html/d0/ddf/classConnection__ConnectionHandler.html new file mode 100644 index 0000000..2e4f1de --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d0/ddf/classConnection__ConnectionHandler.html @@ -0,0 +1,832 @@ + + + + +ircbot: Connection_ConnectionHandler Klassenreferenz + + + + + + + + + +
+ +
+

Connection_ConnectionHandler Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Öffentliche Methoden

 __construct ($socket, $id, $group="", $protocol="", $linebreak="\r\n")
 Calls parent constructor.
 __destruct ()
 Calls parent destructor.
 getProtocol ()
 getGroup ()
 getID ()
 isServer ()
 Returns whether this connection is a listening socket or a general client connection socket.
 readToBuffer ()
 Reads from SocketHandler, writes into buffer_incoming.
 writeFromBuffer ()
 Writes the buffer_outgoing to the SocketHandler.
 handleSocketError ()
 Calls error() on Socket_SocketHandler.
 canRead ()
 Determines whether this ConnectionHandler has data to read.
 canWrite ()
 Determines whether this ConnectionHandler has data to write.
 read ()
 Reads new data into buffer_incoming.
 write ($data)
 Writes data into buffer_outgoing.
 accept ()
 Calls SocketHandler.
 getRemoteName ()
 Calls SocketHandler.
 getLocalName ()
 Calls SocketHandler.
 close ()
 Calls SocketHandler.
 connect ($address, $port)
 Calls SocketHandler.
 bind ($address, $port)
 Calls SocketHandler.
 listen ()
 Calls SocketHandler.
 isConnected ()
 isListening ()
 getSocket ()
 Calls SocketHandler.
 getSocketHandler ()
 hasBeenAccepted ()
 Calls SocketHandler.

+Geschützte Attribute

$buffer_incoming
$buffer_outgoing
$socketHandler
$is_server
$id
$group
$protocol
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 11 der Datei ConnectionHandler.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Connection_ConnectionHandler.__construct ( socket,
id,
group = "",
protocol = "",
linebreak = "\r\n" 
)
+
+
+ +

Calls parent constructor.

+
Parameter:
+ + + +
$socket 
$linebreak 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 63 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.__destruct ( ) 
+
+
+ +

Calls parent destructor.

+
Rückgabe:
void
+ +

Definiert in Zeile 77 der Datei ConnectionHandler.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.accept ( ) 
+
+
+ +

Calls SocketHandler.

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
ressource
+ +

Definiert in Zeile 187 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Connection_ConnectionHandler.bind ( address,
port 
)
+
+
+ +

Calls SocketHandler.

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 237 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.canRead ( ) 
+
+
+ +

Determines whether this ConnectionHandler has data to read.

+
Rückgabe:
boolean
+ +

Definiert in Zeile 150 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.canWrite ( ) 
+
+
+ +

Determines whether this ConnectionHandler has data to write.

+
Rückgabe:
boolean
+ +

Definiert in Zeile 158 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.close ( ) 
+
+
+ +

Calls SocketHandler.

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 217 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Connection_ConnectionHandler.connect ( address,
port 
)
+
+
+ +

Calls SocketHandler.

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 227 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.getGroup ( ) 
+
+
+
Rückgabe:
string Connection Group
+ +

Definiert in Zeile 91 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.getID ( ) 
+
+
+
Rückgabe:
int Connection ID
+ +

Definiert in Zeile 98 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.getLocalName ( ) 
+
+
+ +

Calls SocketHandler.

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
string
+ +

Definiert in Zeile 207 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.getProtocol ( ) 
+
+
+
Rückgabe:
string
+ +

Definiert in Zeile 84 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.getRemoteName ( ) 
+
+
+ +

Calls SocketHandler.

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
string
+ +

Definiert in Zeile 197 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.getSocket ( ) 
+
+
+ +

Calls SocketHandler.

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
ressource
+ +

Definiert in Zeile 274 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.getSocketHandler ( ) 
+
+
+
Rückgabe:
Socket_SocketHandler
+ +

Definiert in Zeile 281 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.handleSocketError ( ) 
+
+
+ +

Calls error() on Socket_SocketHandler.

+
Ausnahmebehandlung:
+ + +
Socket_SocketExceptions 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 142 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.hasBeenAccepted ( ) 
+
+
+ +

Calls SocketHandler.

+
Siehe auch:
Socket_SocketHandler
+
Rückgabe:
void
+ +

Definiert in Zeile 290 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.isConnected ( ) 
+
+
+
Siehe auch:
Socket_SocketHandler
+
Rückgabe:
boolean
+ +

Definiert in Zeile 256 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.isListening ( ) 
+
+
+
Siehe auch:
Socket_SocketHandler
+
Rückgabe:
boolean
+ +

Definiert in Zeile 264 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.isServer ( ) 
+
+
+ +

Returns whether this connection is a listening socket or a general client connection socket.

+
Rückgabe:
boolean
+ +

Definiert in Zeile 106 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.listen ( ) 
+
+
+ +

Calls SocketHandler.

+
Siehe auch:
Socket_SocketHandler
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 247 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.read ( ) 
+
+
+ +

Reads new data into buffer_incoming.

+

Returns a full line from buffer_incoming.

+
Rückgabe:
string
+ +

Definiert in Zeile 167 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.readToBuffer ( ) 
+
+
+ +

Reads from SocketHandler, writes into buffer_incoming.

+

Returns a boolean that will indicate whether the socket is still okay.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
boolean
+ +

Definiert in Zeile 116 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + + +
Connection_ConnectionHandler.write ( data ) 
+
+
+ +

Writes data into buffer_outgoing.

+

Sends data from buffer_outgoing to the SocketHandler.

+
Parameter:
+ + +
$data 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 177 der Datei ConnectionHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Connection_ConnectionHandler.writeFromBuffer ( ) 
+
+
+ +

Writes the buffer_outgoing to the SocketHandler.

+

Returns a boolean that will indicate whether the socket is still okay.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
boolean
+ +

Definiert in Zeile 129 der Datei ConnectionHandler.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d1/d4f/inherit__graph__11.map b/ircbot/Documentation/Doxygen/html/d1/d4f/inherit__graph__11.map new file mode 100644 index 0000000..2963b2e --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d1/d4f/inherit__graph__11.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d1/d4f/inherit__graph__11.md5 b/ircbot/Documentation/Doxygen/html/d1/d4f/inherit__graph__11.md5 new file mode 100644 index 0000000..fae22ad --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d1/d4f/inherit__graph__11.md5 @@ -0,0 +1 @@ +79227ffdd9aec9c03c0ee17f32dbc383 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d1/d4f/inherit__graph__11.png b/ircbot/Documentation/Doxygen/html/d1/d4f/inherit__graph__11.png new file mode 100644 index 0000000..fb0b938 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d1/d4f/inherit__graph__11.png differ diff --git a/ircbot/Documentation/Doxygen/html/d1/dc6/classException__SocketException__inherit__graph.map b/ircbot/Documentation/Doxygen/html/d1/dc6/classException__SocketException__inherit__graph.map new file mode 100644 index 0000000..681de5d --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d1/dc6/classException__SocketException__inherit__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/ircbot/Documentation/Doxygen/html/d1/dc6/classException__SocketException__inherit__graph.md5 b/ircbot/Documentation/Doxygen/html/d1/dc6/classException__SocketException__inherit__graph.md5 new file mode 100644 index 0000000..af9fdad --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d1/dc6/classException__SocketException__inherit__graph.md5 @@ -0,0 +1 @@ +64f92f108e046ca30c27ffcad11b0307 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d1/dc6/classException__SocketException__inherit__graph.png b/ircbot/Documentation/Doxygen/html/d1/dc6/classException__SocketException__inherit__graph.png new file mode 100644 index 0000000..7be938e Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d1/dc6/classException__SocketException__inherit__graph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool.html b/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool.html new file mode 100644 index 0000000..6a2b049 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool.html @@ -0,0 +1,350 @@ + + + + +ircbot: Socket_SocketPool Klassenreferenz + + + + + + + + + +
+ +
+

Socket_SocketPool Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + + + + + + + + +

+Öffentliche Methoden

 __construct ()
 Creates sockets.
 __destruct ()
 Closes all connections.
 countSockets ()
 Returns the amount of active sockets.
 addSocket ($add_socket)
 Adds a socket to the pool.
 removeSocket ($remove_socket)
 Removes the given socket from the pool.
 createTcpSocket ($IPv6=FALSE)
 Creates a new TcpSocket and adds it to the pool.
 select ($read, $write, $except, $timeout=NULL)
 Returns an array of sockets one can read from.

+Geschützte Attribute

$sockets
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 8 der Datei SocketPool.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + +
Socket_SocketPool.__construct ( ) 
+
+
+ +

Creates sockets.

+
Rückgabe:
void
+ +

Definiert in Zeile 20 der Datei SocketPool.php.

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketPool.__destruct ( ) 
+
+
+ +

Closes all connections.

+
Rückgabe:
void
+ +

Definiert in Zeile 28 der Datei SocketPool.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Socket_SocketPool.addSocket ( add_socket ) 
+
+
+ +

Adds a socket to the pool.

+
Parameter:
+ + +
ressource $add_socket
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 45 der Datei SocketPool.php.

+ +

Wird benutzt von createTcpSocket().

+ +

+Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketPool.countSockets ( ) 
+
+
+ +

Returns the amount of active sockets.

+
Rückgabe:
int
+ +

Definiert in Zeile 36 der Datei SocketPool.php.

+ +
+
+ +
+
+ + + + + + + + + +
Socket_SocketPool.createTcpSocket ( IPv6 = FALSE ) 
+
+
+ +

Creates a new TcpSocket and adds it to the pool.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Parameter:
+ + +
boolean $IPv6 will determine whether the socket uses IPv4 or IPv6.
+
+
+
Rückgabe:
ressource
+ +

Definiert in Zeile 73 der Datei SocketPool.php.

+ +

Benutzt addSocket().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + + +
Socket_SocketPool.removeSocket ( remove_socket ) 
+
+
+ +

Removes the given socket from the pool.

+

The socket will be shutdown.

+
Parameter:
+ + +
ressource $remove_socket
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 55 der Datei SocketPool.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Socket_SocketPool.select ( read,
write,
except,
timeout = NULL 
)
+
+
+ +

Returns an array of sockets one can read from.

+
Parameter:
+ + + + + +
array $read
array $write
array $except
int $timeout
+
+
+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
array
+ +

Definiert in Zeile 91 der Datei SocketPool.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_a93576a5822f28d931a8b9644b80418a9_icgraph.map b/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_a93576a5822f28d931a8b9644b80418a9_icgraph.map new file mode 100644 index 0000000..a6b3c0c --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_a93576a5822f28d931a8b9644b80418a9_icgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_a93576a5822f28d931a8b9644b80418a9_icgraph.md5 b/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_a93576a5822f28d931a8b9644b80418a9_icgraph.md5 new file mode 100644 index 0000000..408df31 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_a93576a5822f28d931a8b9644b80418a9_icgraph.md5 @@ -0,0 +1 @@ +69c352c873a93ca34cc2beb7c2c57741 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_a93576a5822f28d931a8b9644b80418a9_icgraph.png b/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_a93576a5822f28d931a8b9644b80418a9_icgraph.png new file mode 100644 index 0000000..5677d83 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_a93576a5822f28d931a8b9644b80418a9_icgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_ac9dd05127f3aad43185cc971b101773f_cgraph.map b/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_ac9dd05127f3aad43185cc971b101773f_cgraph.map new file mode 100644 index 0000000..15dde61 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_ac9dd05127f3aad43185cc971b101773f_cgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_ac9dd05127f3aad43185cc971b101773f_cgraph.md5 b/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_ac9dd05127f3aad43185cc971b101773f_cgraph.md5 new file mode 100644 index 0000000..41e7129 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_ac9dd05127f3aad43185cc971b101773f_cgraph.md5 @@ -0,0 +1 @@ +499258d0aa4fc61d285c3303f730a39b \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_ac9dd05127f3aad43185cc971b101773f_cgraph.png b/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_ac9dd05127f3aad43185cc971b101773f_cgraph.png new file mode 100644 index 0000000..352da53 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d2/d2c/classSocket__SocketPool_ac9dd05127f3aad43185cc971b101773f_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d2/d46/classClient__BotClient-members.html b/ircbot/Documentation/Doxygen/html/d2/d46/classClient__BotClient-members.html new file mode 100644 index 0000000..6b21d41 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d2/d46/classClient__BotClient-members.html @@ -0,0 +1,84 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Client_BotClient Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Client_BotClient einschließlich aller geerbten Elemente. + + + + + + + + + +
$clientManager (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
$group (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
$ID (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
__construct()Client_BotClient
injectClientManager($clientManager)Client_AbstractClient
loadConfig($config)Client_BotClient
processData($data)Client_BotClient
setGroup($group)Client_AbstractClient
setID($id)Client_AbstractClient
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d2/d9d/classTestFailException-members.html b/ircbot/Documentation/Doxygen/html/d2/d9d/classTestFailException-members.html new file mode 100644 index 0000000..8c43157 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d2/d9d/classTestFailException-members.html @@ -0,0 +1,76 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

TestFailException Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für TestFailException einschließlich aller geerbten Elemente. + +
__construct($msg) (Definiert in TestFailException)TestFailException
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d2/dec/namespaceSocket.html b/ircbot/Documentation/Doxygen/html/d2/dec/namespaceSocket.html new file mode 100644 index 0000000..b5b57e8 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d2/dec/namespaceSocket.html @@ -0,0 +1,83 @@ + + + + +ircbot: Paket Socket + + + + + + + + + +
+
+

Paket Socket

+
+
+ +

The SocketHandler class will handle a single socket. +Mehr ...

+ +
+

Ausführliche Beschreibung

+

The SocketHandler class will handle a single socket.

+

The SocketPool class that will handle all the sockets.

+

It takes care of the very basic socket functions.

+
Autor:
jpt
+

Manages a pool of socket ressources with socket_select()

+
Autor:
jpt
+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d2/dfc/ReferenceTest_8php_source.html b/ircbot/Documentation/Doxygen/html/d2/dfc/ReferenceTest_8php_source.html new file mode 100644 index 0000000..73c37cf --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d2/dfc/ReferenceTest_8php_source.html @@ -0,0 +1,150 @@ + + + + +ircbot: Testcode/Misc/ReferenceTest.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d3/d13/classService__ExceptionTest.html b/ircbot/Documentation/Doxygen/html/d3/d13/classService__ExceptionTest.html new file mode 100644 index 0000000..6823ffa --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d3/d13/classService__ExceptionTest.html @@ -0,0 +1,96 @@ + + + + +ircbot: Service_ExceptionTest Klassenreferenz + + + + + + + + + +
+ +
+

Service_ExceptionTest Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + +

+Öffentliche Methoden

TestTheFail ()
CatchAndThrow ()
internalCatch ()
failAtThis ()
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 19 der Datei Exceptions.php.

+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d4/d22/classTestClassForTestsWithReflection-members.html b/ircbot/Documentation/Doxygen/html/d4/d22/classTestClassForTestsWithReflection-members.html new file mode 100644 index 0000000..3f31f94 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d4/d22/classTestClassForTestsWithReflection-members.html @@ -0,0 +1,79 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

TestClassForTestsWithReflection Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für TestClassForTestsWithReflection einschließlich aller geerbten Elemente. + + + + +
$protected (Definiert in TestClassForTestsWithReflection)TestClassForTestsWithReflection [protected]
$public (Definiert in TestClassForTestsWithReflection)TestClassForTestsWithReflection
blablubblol(Klasse $objekt)TestClassForTestsWithReflection
testfunctionWithCamelCase(array $ray, $zero=0)TestClassForTestsWithReflection [protected]
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d4/d24/classMisc__Buffer-members.html b/ircbot/Documentation/Doxygen/html/d4/d24/classMisc__Buffer-members.html new file mode 100644 index 0000000..0442e71 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d4/d24/classMisc__Buffer-members.html @@ -0,0 +1,82 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Misc_Buffer Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Misc_Buffer einschließlich aller geerbten Elemente. + + + + + + + +
$buffer (Definiert in Misc_Buffer)Misc_Buffer [protected]
$linebreak (Definiert in Misc_Buffer)Misc_Buffer [protected]
__construct($linebreak="\r\n")Misc_Buffer
addData($data)Misc_Buffer
getNextLine()Misc_Buffer
hasLines()Misc_Buffer
pruneEmptyLines()Misc_Buffer [protected]
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d4/d3d/Buffer_8php_source.html b/ircbot/Documentation/Doxygen/html/d4/d3d/Buffer_8php_source.html new file mode 100644 index 0000000..c497902 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d4/d3d/Buffer_8php_source.html @@ -0,0 +1,153 @@ + + + + +ircbot: Classes/Misc/Buffer.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d4/d67/Main_8php_source.html b/ircbot/Documentation/Doxygen/html/d4/d67/Main_8php_source.html new file mode 100644 index 0000000..5571d42 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d4/d67/Main_8php_source.html @@ -0,0 +1,83 @@ + + + + +ircbot: Main.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d4/d67/classException.html b/ircbot/Documentation/Doxygen/html/d4/d67/classException.html new file mode 100644 index 0000000..243038a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d4/d67/classException.html @@ -0,0 +1,79 @@ + + + + +ircbot: Exception Klassenreferenz + + + + + + + + + +
+
+

Exception Klassenreferenz

+
+
+ +
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d4/d67/classException.png b/ircbot/Documentation/Doxygen/html/d4/d67/classException.png new file mode 100644 index 0000000..69764d5 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d4/d67/classException.png differ diff --git a/ircbot/Documentation/Doxygen/html/d4/d8a/inherit__graph__6.map b/ircbot/Documentation/Doxygen/html/d4/d8a/inherit__graph__6.map new file mode 100644 index 0000000..a7e0bdb --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d4/d8a/inherit__graph__6.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d4/d8a/inherit__graph__6.md5 b/ircbot/Documentation/Doxygen/html/d4/d8a/inherit__graph__6.md5 new file mode 100644 index 0000000..9b3b58f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d4/d8a/inherit__graph__6.md5 @@ -0,0 +1 @@ +ed533d7ab9a6eb1038759719d48c8d23 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d4/d8a/inherit__graph__6.png b/ircbot/Documentation/Doxygen/html/d4/d8a/inherit__graph__6.png new file mode 100644 index 0000000..63be689 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d4/d8a/inherit__graph__6.png differ diff --git a/ircbot/Documentation/Doxygen/html/d4/da0/classTestFailException__coll__graph.map b/ircbot/Documentation/Doxygen/html/d4/da0/classTestFailException__coll__graph.map new file mode 100644 index 0000000..d5d57dd --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d4/da0/classTestFailException__coll__graph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d4/da0/classTestFailException__coll__graph.md5 b/ircbot/Documentation/Doxygen/html/d4/da0/classTestFailException__coll__graph.md5 new file mode 100644 index 0000000..2d0a4cc --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d4/da0/classTestFailException__coll__graph.md5 @@ -0,0 +1 @@ +3a9c4d7b257c8870f9738ef825e68afd \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d4/da0/classTestFailException__coll__graph.png b/ircbot/Documentation/Doxygen/html/d4/da0/classTestFailException__coll__graph.png new file mode 100644 index 0000000..fa647ea Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d4/da0/classTestFailException__coll__graph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d4/dc7/classClient__ClientManager-members.html b/ircbot/Documentation/Doxygen/html/d4/dc7/classClient__ClientManager-members.html new file mode 100644 index 0000000..ec0cac0 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d4/dc7/classClient__ClientManager-members.html @@ -0,0 +1,95 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Client_ClientManager Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Client_ClientManager einschließlich aller geerbten Elemente. + + + + + + + + + + + + + + + + + + + + +
$clientPool (Definiert in Client_ClientManager)Client_ClientManager [protected]
$configPool (Definiert in Client_ClientManager)Client_ClientManager [protected]
$connectionPool (Definiert in Client_ClientManager)Client_ClientManager [protected]
$rawRoutingRules (Definiert in Client_ClientManager)Client_ClientManager [protected]
$registeredProtocols (Definiert in Client_ClientManager)Client_ClientManager [protected]
__construct($linebreak="\r\n")Client_ClientManager
__destruct()Client_ClientManager
addClientForConnectionHandler($connectionHandler)Client_ClientManager [protected]
addRawRouting($from, $to)Client_ClientManager
attachConfig($config, $connectionHandler)Client_ClientManager
countConnections()Client_ClientManager
createClientForProtocol($protocol)Client_ClientManager [protected]
createTcpConnection($group="", $protocol="RAW", $IPv6=FALSE)Client_ClientManager
registerProtocol($protocol, $className)Client_ClientManager
removeClientForConnectionHandler($connectionHandler)Client_ClientManager [protected]
removeConnection($connectionHandler)Client_ClientManager
sendToGroup($group, $data)Client_ClientManager
sendToID($id, $data)Client_ClientManager
unregisterProtocol($protocol)Client_ClientManager
work()Client_ClientManager
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d5/d22/classException__GeneralException__inherit__graph.map b/ircbot/Documentation/Doxygen/html/d5/d22/classException__GeneralException__inherit__graph.map new file mode 100644 index 0000000..533c63a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d5/d22/classException__GeneralException__inherit__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/ircbot/Documentation/Doxygen/html/d5/d22/classException__GeneralException__inherit__graph.md5 b/ircbot/Documentation/Doxygen/html/d5/d22/classException__GeneralException__inherit__graph.md5 new file mode 100644 index 0000000..8ba0673 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d5/d22/classException__GeneralException__inherit__graph.md5 @@ -0,0 +1 @@ +58c6ff1f7224f862b08b229ca2972d44 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d5/d22/classException__GeneralException__inherit__graph.png b/ircbot/Documentation/Doxygen/html/d5/d22/classException__GeneralException__inherit__graph.png new file mode 100644 index 0000000..aa9586f Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d5/d22/classException__GeneralException__inherit__graph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d5/d4c/classException__inherit__graph.map b/ircbot/Documentation/Doxygen/html/d5/d4c/classException__inherit__graph.map new file mode 100644 index 0000000..81d5cc8 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d5/d4c/classException__inherit__graph.map @@ -0,0 +1,6 @@ + + + + + + diff --git a/ircbot/Documentation/Doxygen/html/d5/d4c/classException__inherit__graph.md5 b/ircbot/Documentation/Doxygen/html/d5/d4c/classException__inherit__graph.md5 new file mode 100644 index 0000000..5b9bb10 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d5/d4c/classException__inherit__graph.md5 @@ -0,0 +1 @@ +2eb22af7ffd0b98a5fd87cde95007620 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d5/d4c/classException__inherit__graph.png b/ircbot/Documentation/Doxygen/html/d5/d4c/classException__inherit__graph.png new file mode 100644 index 0000000..3775f03 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d5/d4c/classException__inherit__graph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d5/d51/ClientManagerTest_8php_source.html b/ircbot/Documentation/Doxygen/html/d5/d51/ClientManagerTest_8php_source.html new file mode 100644 index 0000000..8433201 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d5/d51/ClientManagerTest_8php_source.html @@ -0,0 +1,111 @@ + + + + +ircbot: Testcode/Client/ClientManagerTest.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d5/d95/classClient__BotClient__inherit__graph.map b/ircbot/Documentation/Doxygen/html/d5/d95/classClient__BotClient__inherit__graph.map new file mode 100644 index 0000000..202fcfd --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d5/d95/classClient__BotClient__inherit__graph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d5/d95/classClient__BotClient__inherit__graph.md5 b/ircbot/Documentation/Doxygen/html/d5/d95/classClient__BotClient__inherit__graph.md5 new file mode 100644 index 0000000..2d325d7 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d5/d95/classClient__BotClient__inherit__graph.md5 @@ -0,0 +1 @@ +97773074c14c44fd057a070bd2b2d966 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d5/d95/classClient__BotClient__inherit__graph.png b/ircbot/Documentation/Doxygen/html/d5/d95/classClient__BotClient__inherit__graph.png new file mode 100644 index 0000000..88442dd Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d5/d95/classClient__BotClient__inherit__graph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d6/d1a/classConnection__ConnectionPool-members.html b/ircbot/Documentation/Doxygen/html/d6/d1a/classConnection__ConnectionPool-members.html new file mode 100644 index 0000000..68c11ca --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d1a/classConnection__ConnectionPool-members.html @@ -0,0 +1,88 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Connection_ConnectionPool Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Connection_ConnectionPool einschließlich aller geerbten Elemente. + + + + + + + + + + + + + +
$connectionHandlers (Definiert in Connection_ConnectionPool)Connection_ConnectionPool [protected]
$nextID (Definiert in Connection_ConnectionPool)Connection_ConnectionPool [protected]
$socketPool (Definiert in Connection_ConnectionPool)Connection_ConnectionPool [protected]
__construct($linebreak="\r\n")Connection_ConnectionPool
__destruct()Connection_ConnectionPool
addConnectionHandler($add_connectionHandler)Connection_ConnectionPool
countConnections()Connection_ConnectionPool
createTcpConnection($group="", $protocol="RAW", $IPv6=FALSE)Connection_ConnectionPool
getConnectionHandlerForSocketRessource($socketRessource)Connection_ConnectionPool [protected]
removeConnectionHandler($remove_connectionHandler)Connection_ConnectionPool
select()Connection_ConnectionPool
writeToGroup($group, $data)Connection_ConnectionPool
writeToID($id, $data)Connection_ConnectionPool
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d25/Reflection_8php_source.html b/ircbot/Documentation/Doxygen/html/d6/d25/Reflection_8php_source.html new file mode 100644 index 0000000..2fb290f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d25/Reflection_8php_source.html @@ -0,0 +1,138 @@ + + + + +ircbot: Testcode/Misc/Reflection.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d2e/classException__GeneralException.html b/ircbot/Documentation/Doxygen/html/d6/d2e/classException__GeneralException.html new file mode 100644 index 0000000..50ce045 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d2e/classException__GeneralException.html @@ -0,0 +1,168 @@ + + + + +ircbot: Exception_GeneralException Klassenreferenz + + + + + + + + + +
+ +
+

Exception_GeneralException Klassenreferenz

+
+
+
+Zusammengehörigkeiten von Exception_GeneralException:
+
+
Collaboration graph
+ + +
[Legende]
+ +

Aufstellung aller Elemente

+ + + + + + +

+Öffentliche Methoden

 __construct ($message="", $code=0)
 Constructor.
 __toString ()
 Puts all the important information into a string.
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 8 der Datei GeneralException.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + + + + + + + + + + + +
Exception_GeneralException.__construct ( message = "",
code = 0 
)
+
+
+ +

Constructor.

+

Throws a new exception in case the exception is unknown.

+
Ausnahmebehandlung:
+ + +
UnknownException 
+
+
+
Parameter:
+ + + +
string $message
int $code
+
+
+ +

Definiert in Zeile 16 der Datei GeneralException.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + +
Exception_GeneralException.__toString ( ) 
+
+
+ +

Puts all the important information into a string.

+
Rückgabe:
string
+ +

Definiert in Zeile 27 der Datei GeneralException.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d2e/classException__GeneralException.png b/ircbot/Documentation/Doxygen/html/d6/d2e/classException__GeneralException.png new file mode 100644 index 0000000..4c88b2c Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d6/d2e/classException__GeneralException.png differ diff --git a/ircbot/Documentation/Doxygen/html/d6/d65/namespaceException.html b/ircbot/Documentation/Doxygen/html/d6/d65/namespaceException.html new file mode 100644 index 0000000..c28125a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d65/namespaceException.html @@ -0,0 +1,86 @@ + + + + +ircbot: Paket Exception + + + + + + + + + +
+
+

Paket Exception

+
+
+ +

General exception class. +Mehr ...

+ +
+

Ausführliche Beschreibung

+

General exception class.

+

SocketException.

+
Autor:
jpt
+
Ausnahmebehandlung:
+ + +
 
+
+
+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler.html b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler.html new file mode 100644 index 0000000..a2d505c --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler.html @@ -0,0 +1,736 @@ + + + + +ircbot: Socket_SocketHandler Klassenreferenz + + + + + + + + + +
+ +
+

Socket_SocketHandler Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Öffentliche Methoden

 __construct ($socket)
 Default constructor.
 __destruct ()
 Destructor.
 getSocket ()
 Returns socket.
 isConnected ()
 isListening ()
 connect ($address, $port)
 Connects to a specified address.
 bind ($address, $port)
 Binds the socket to an address + port.
 listen ()
 Let's the socket listen for incoming connections.
 hasBeenAccepted ()
 Tells the SocketHandler that he got accepted.
 accept ()
 Accepts a connection to a socket that is bound and listens The ressource has to be added to the SocketPool manually.
 getRemoteName ()
 Returns ip + port of the remote socket.
 getLocalName ()
 Returns ip + port of the local socket.
 write ($data)
 Writes data to the socket.
 read ($length=16384)
 Reads data from the socket.
 close ()
 Shuts the socket down after waiting a bit (waiting might be optional).

+Geschützte Methoden

 error ()
 Gets last error from socket.

+Geschützte Attribute

$socket
$is_connected
$is_bound
$is_listening
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 8 der Datei SocketHandler.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + + +
Socket_SocketHandler.__construct ( socket ) 
+
+
+ +

Default constructor.

+

Sets the socket.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Parameter:
+ + +
ressource $socket
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 37 der Datei SocketHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.__destruct ( ) 
+
+
+ +

Destructor.

+

Closes socket.

+
Rückgabe:
void
+ +

Definiert in Zeile 49 der Datei SocketHandler.php.

+ +

Benutzt close().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + +
Socket_SocketHandler.accept ( ) 
+
+
+ +

Accepts a connection to a socket that is bound and listens The ressource has to be added to the SocketPool manually.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
ressource
+ +

Definiert in Zeile 131 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Socket_SocketHandler.bind ( address,
port 
)
+
+
+ +

Binds the socket to an address + port.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Parameter:
+ + + +
string $address
int $port
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 96 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.close ( ) 
+
+
+ +

Shuts the socket down after waiting a bit (waiting might be optional).

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 191 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +

Wird benutzt von __destruct().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +

+Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Socket_SocketHandler.connect ( address,
port 
)
+
+
+ +

Connects to a specified address.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Parameter:
+ + + +
string $address
int $port
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 82 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.error ( )  [protected]
+
+
+ +

Gets last error from socket.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+ +

Definiert in Zeile 208 der Datei SocketHandler.php.

+ +

Wird benutzt von accept(), bind(), close(), connect(), getLocalName(), getRemoteName(), listen(), read() und write().

+ +

+Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.getLocalName ( ) 
+
+
+ +

Returns ip + port of the local socket.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
string
+ +

Definiert in Zeile 156 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.getRemoteName ( ) 
+
+
+ +

Returns ip + port of the remote socket.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
string
+ +

Definiert in Zeile 144 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.getSocket ( ) 
+
+
+ +

Returns socket.

+
Rückgabe:
ressource
+ +

Definiert in Zeile 57 der Datei SocketHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.hasBeenAccepted ( ) 
+
+
+ +

Tells the SocketHandler that he got accepted.

+
Rückgabe:
void
+ +

Definiert in Zeile 121 der Datei SocketHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.isConnected ( ) 
+
+
+
Rückgabe:
boolean
+ +

Definiert in Zeile 64 der Datei SocketHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.isListening ( ) 
+
+
+
Rückgabe:
boolean
+ +

Definiert in Zeile 71 der Datei SocketHandler.php.

+ +
+
+ +
+
+ + + + + + + + +
Socket_SocketHandler.listen ( ) 
+
+
+ +

Let's the socket listen for incoming connections.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 110 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + + +
Socket_SocketHandler.read ( length = 16384 ) 
+
+
+ +

Reads data from the socket.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Parameter:
+ + +
int $length
+
+
+
Rückgabe:
string
+ +

Definiert in Zeile 180 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + + +
Socket_SocketHandler.write ( data ) 
+
+
+ +

Writes data to the socket.

+
Ausnahmebehandlung:
+ + +
Exception_SocketException 
+
+
+
Parameter:
+ + +
string $data
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 169 der Datei SocketHandler.php.

+ +

Benutzt error().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_cgraph.map b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_cgraph.map new file mode 100644 index 0000000..202ae83 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_cgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_cgraph.md5 b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_cgraph.md5 new file mode 100644 index 0000000..1f58d1a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_cgraph.md5 @@ -0,0 +1 @@ +59d1248aa38b9082176421c731e2a77e \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_cgraph.png b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_cgraph.png new file mode 100644 index 0000000..aec6bc9 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_icgraph.map b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_icgraph.map new file mode 100644 index 0000000..8b9287b --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_icgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_icgraph.md5 b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_icgraph.md5 new file mode 100644 index 0000000..eaa5f0b --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_icgraph.md5 @@ -0,0 +1 @@ +3ad185f31e0fd930d06e4878f0cd25ae \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_icgraph.png b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_icgraph.png new file mode 100644 index 0000000..41568be Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a0c7dd9154f3c33585e0bf59a29e9d1ad_icgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a2ec66b5858cfaa03dc3165fc23fdc529_cgraph.map b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a2ec66b5858cfaa03dc3165fc23fdc529_cgraph.map new file mode 100644 index 0000000..69652d8 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a2ec66b5858cfaa03dc3165fc23fdc529_cgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a2ec66b5858cfaa03dc3165fc23fdc529_cgraph.md5 b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a2ec66b5858cfaa03dc3165fc23fdc529_cgraph.md5 new file mode 100644 index 0000000..e7a24ba --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a2ec66b5858cfaa03dc3165fc23fdc529_cgraph.md5 @@ -0,0 +1 @@ +a1fd5e6aa7d6b03fe27bae79f2600ca1 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a2ec66b5858cfaa03dc3165fc23fdc529_cgraph.png b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a2ec66b5858cfaa03dc3165fc23fdc529_cgraph.png new file mode 100644 index 0000000..cfe4cc2 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a2ec66b5858cfaa03dc3165fc23fdc529_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a48316d6231bf2944355a95a46deea433_cgraph.map b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a48316d6231bf2944355a95a46deea433_cgraph.map new file mode 100644 index 0000000..38dd47f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a48316d6231bf2944355a95a46deea433_cgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a48316d6231bf2944355a95a46deea433_cgraph.md5 b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a48316d6231bf2944355a95a46deea433_cgraph.md5 new file mode 100644 index 0000000..919e537 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a48316d6231bf2944355a95a46deea433_cgraph.md5 @@ -0,0 +1 @@ +2b75872f14218be0bbd5e001352bd651 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a48316d6231bf2944355a95a46deea433_cgraph.png b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a48316d6231bf2944355a95a46deea433_cgraph.png new file mode 100644 index 0000000..72555ab Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a48316d6231bf2944355a95a46deea433_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89b5c5db71cf10b556c54027ad5750aa_cgraph.map b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89b5c5db71cf10b556c54027ad5750aa_cgraph.map new file mode 100644 index 0000000..38dd47f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89b5c5db71cf10b556c54027ad5750aa_cgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89b5c5db71cf10b556c54027ad5750aa_cgraph.md5 b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89b5c5db71cf10b556c54027ad5750aa_cgraph.md5 new file mode 100644 index 0000000..87cee7a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89b5c5db71cf10b556c54027ad5750aa_cgraph.md5 @@ -0,0 +1 @@ +88cec1e843b41433ce2d2dc5fdaebc01 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89b5c5db71cf10b556c54027ad5750aa_cgraph.png b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89b5c5db71cf10b556c54027ad5750aa_cgraph.png new file mode 100644 index 0000000..dc053fa Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89b5c5db71cf10b556c54027ad5750aa_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89f663620590f7a9a80310f282d14d51_cgraph.map b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89f663620590f7a9a80310f282d14d51_cgraph.map new file mode 100644 index 0000000..51ad9e5 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89f663620590f7a9a80310f282d14d51_cgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89f663620590f7a9a80310f282d14d51_cgraph.md5 b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89f663620590f7a9a80310f282d14d51_cgraph.md5 new file mode 100644 index 0000000..269ffb9 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89f663620590f7a9a80310f282d14d51_cgraph.md5 @@ -0,0 +1 @@ +6e711b075eabb93c9769628abf3f737c \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89f663620590f7a9a80310f282d14d51_cgraph.png b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89f663620590f7a9a80310f282d14d51_cgraph.png new file mode 100644 index 0000000..9424a68 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a89f663620590f7a9a80310f282d14d51_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c33134ed5fd74984b7df5d95cdb18c5_cgraph.map b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c33134ed5fd74984b7df5d95cdb18c5_cgraph.map new file mode 100644 index 0000000..d7981b8 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c33134ed5fd74984b7df5d95cdb18c5_cgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c33134ed5fd74984b7df5d95cdb18c5_cgraph.md5 b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c33134ed5fd74984b7df5d95cdb18c5_cgraph.md5 new file mode 100644 index 0000000..795113a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c33134ed5fd74984b7df5d95cdb18c5_cgraph.md5 @@ -0,0 +1 @@ +13e037f59bcf6d922f3e7fc3bf8378f3 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c33134ed5fd74984b7df5d95cdb18c5_cgraph.png b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c33134ed5fd74984b7df5d95cdb18c5_cgraph.png new file mode 100644 index 0000000..a129f58 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c33134ed5fd74984b7df5d95cdb18c5_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c8771a7e74afae5d35cd885e1a6c5e5_cgraph.map b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c8771a7e74afae5d35cd885e1a6c5e5_cgraph.map new file mode 100644 index 0000000..cde2629 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c8771a7e74afae5d35cd885e1a6c5e5_cgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c8771a7e74afae5d35cd885e1a6c5e5_cgraph.md5 b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c8771a7e74afae5d35cd885e1a6c5e5_cgraph.md5 new file mode 100644 index 0000000..813a8d5 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c8771a7e74afae5d35cd885e1a6c5e5_cgraph.md5 @@ -0,0 +1 @@ +a03405d081525a43da89d265812dd253 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c8771a7e74afae5d35cd885e1a6c5e5_cgraph.png b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c8771a7e74afae5d35cd885e1a6c5e5_cgraph.png new file mode 100644 index 0000000..e3c0f52 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8c8771a7e74afae5d35cd885e1a6c5e5_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8f27e3dc0b4bda53563612e3dce9d26b_cgraph.map b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8f27e3dc0b4bda53563612e3dce9d26b_cgraph.map new file mode 100644 index 0000000..68e1902 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8f27e3dc0b4bda53563612e3dce9d26b_cgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8f27e3dc0b4bda53563612e3dce9d26b_cgraph.md5 b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8f27e3dc0b4bda53563612e3dce9d26b_cgraph.md5 new file mode 100644 index 0000000..b4bad81 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8f27e3dc0b4bda53563612e3dce9d26b_cgraph.md5 @@ -0,0 +1 @@ +9486ed9d2428ee5b92d4b45927d2d587 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8f27e3dc0b4bda53563612e3dce9d26b_cgraph.png b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8f27e3dc0b4bda53563612e3dce9d26b_cgraph.png new file mode 100644 index 0000000..64013f5 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a8f27e3dc0b4bda53563612e3dce9d26b_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a93d9d2dddba7a1b03b14599492f9a160_cgraph.map b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a93d9d2dddba7a1b03b14599492f9a160_cgraph.map new file mode 100644 index 0000000..d8c5b78 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a93d9d2dddba7a1b03b14599492f9a160_cgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a93d9d2dddba7a1b03b14599492f9a160_cgraph.md5 b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a93d9d2dddba7a1b03b14599492f9a160_cgraph.md5 new file mode 100644 index 0000000..642b288 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a93d9d2dddba7a1b03b14599492f9a160_cgraph.md5 @@ -0,0 +1 @@ +32842a41a9f6e680e3d7ccc98677f883 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a93d9d2dddba7a1b03b14599492f9a160_cgraph.png b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a93d9d2dddba7a1b03b14599492f9a160_cgraph.png new file mode 100644 index 0000000..c04f5ae Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_a93d9d2dddba7a1b03b14599492f9a160_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aa89717d6278f6138ed19e0033b3b0273_cgraph.map b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aa89717d6278f6138ed19e0033b3b0273_cgraph.map new file mode 100644 index 0000000..e6f67fe --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aa89717d6278f6138ed19e0033b3b0273_cgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aa89717d6278f6138ed19e0033b3b0273_cgraph.md5 b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aa89717d6278f6138ed19e0033b3b0273_cgraph.md5 new file mode 100644 index 0000000..0a0c382 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aa89717d6278f6138ed19e0033b3b0273_cgraph.md5 @@ -0,0 +1 @@ +8be844e87efb083e4b5562da3ddc7a4b \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aa89717d6278f6138ed19e0033b3b0273_cgraph.png b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aa89717d6278f6138ed19e0033b3b0273_cgraph.png new file mode 100644 index 0000000..4209e8a Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aa89717d6278f6138ed19e0033b3b0273_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aac6f4bae57724b01e72dead2f1875f45_icgraph.map b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aac6f4bae57724b01e72dead2f1875f45_icgraph.map new file mode 100644 index 0000000..66e0899 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aac6f4bae57724b01e72dead2f1875f45_icgraph.map @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aac6f4bae57724b01e72dead2f1875f45_icgraph.md5 b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aac6f4bae57724b01e72dead2f1875f45_icgraph.md5 new file mode 100644 index 0000000..0491c7b --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aac6f4bae57724b01e72dead2f1875f45_icgraph.md5 @@ -0,0 +1 @@ +9ace5899e82b9c49c7d908070116ba3c \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aac6f4bae57724b01e72dead2f1875f45_icgraph.png b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aac6f4bae57724b01e72dead2f1875f45_icgraph.png new file mode 100644 index 0000000..9f7ae68 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d6/d8c/classSocket__SocketHandler_aac6f4bae57724b01e72dead2f1875f45_icgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d6/d92/classClient__AbstractClient__inherit__graph.map b/ircbot/Documentation/Doxygen/html/d6/d92/classClient__AbstractClient__inherit__graph.map new file mode 100644 index 0000000..fcf2b53 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d92/classClient__AbstractClient__inherit__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/ircbot/Documentation/Doxygen/html/d6/d92/classClient__AbstractClient__inherit__graph.md5 b/ircbot/Documentation/Doxygen/html/d6/d92/classClient__AbstractClient__inherit__graph.md5 new file mode 100644 index 0000000..540ebbf --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/d92/classClient__AbstractClient__inherit__graph.md5 @@ -0,0 +1 @@ +82f7687c4e2627576038d420aa94dbbc \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d6/d92/classClient__AbstractClient__inherit__graph.png b/ircbot/Documentation/Doxygen/html/d6/d92/classClient__AbstractClient__inherit__graph.png new file mode 100644 index 0000000..c3e7fc9 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d6/d92/classClient__AbstractClient__inherit__graph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d6/df1/ConnectionHandler_8php_source.html b/ircbot/Documentation/Doxygen/html/d6/df1/ConnectionHandler_8php_source.html new file mode 100644 index 0000000..096469d --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d6/df1/ConnectionHandler_8php_source.html @@ -0,0 +1,366 @@ + + + + +ircbot: Classes/Connection/ConnectionHandler.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d7/d0f/classTestException-members.html b/ircbot/Documentation/Doxygen/html/d7/d0f/classTestException-members.html new file mode 100644 index 0000000..e3dff1d --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/d0f/classTestException-members.html @@ -0,0 +1,76 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

TestException Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für TestException einschließlich aller geerbten Elemente. + +
__construct($message) (Definiert in TestException)TestException
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d7/d13/classClient__IrcClient.html b/ircbot/Documentation/Doxygen/html/d7/d13/classClient__IrcClient.html new file mode 100644 index 0000000..1e8ea55 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/d13/classClient__IrcClient.html @@ -0,0 +1,291 @@ + + + + +ircbot: Client_IrcClient Klassenreferenz + + + + + + + + + +
+ +
+

Client_IrcClient Klassenreferenz

+
+
+
+Zusammengehörigkeiten von Client_IrcClient:
+
+
Collaboration graph
+ + +
[Legende]
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + + + + + + + + + + + + +

+Öffentliche Methoden

 __construct ()
 Default constructor.
 processData ($data)
 Does all the hard work.
 loadConfig ($config)
 Loads the given configuration.
 setID ($id)
 setGroup ($group)
 injectClientManager ($clientManager)
 Injects ClientManager.

+Geschützte Attribute

$got_001
$joined
$authed
$nick
$channels
$lines
$ID
$group
$clientManager
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 8 der Datei IrcClient.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + +
Client_IrcClient.__construct ( ) 
+
+
+ +

Default constructor.

+ +

Definiert in Zeile 20 der Datei IrcClient.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Client_AbstractClient.injectClientManager ( clientManager )  [inherited]
+
+
+ +

Injects ClientManager.

+
Parameter:
+ + +
Client_ClientManager $clientManager
+
+
+ +

Definiert in Zeile 58 der Datei AbstractClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_IrcClient.loadConfig ( config ) 
+
+
+ +

Loads the given configuration.

+
Parameter:
+ + +
array $config
+
+
+
Rückgabe:
void
+ +

Erneute Implementation von Client_AbstractClient.

+ +

Definiert in Zeile 70 der Datei IrcClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_IrcClient.processData ( data ) 
+
+
+ +

Does all the hard work.

+
Parameter:
+ + +
string $data
+
+
+
Rückgabe:
string
+ +

Erneute Implementation von Client_AbstractClient.

+ +

Definiert in Zeile 34 der Datei IrcClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.setGroup ( group )  [inherited]
+
+
+
Parameter:
+ + +
string $group
+
+
+ +

Definiert in Zeile 49 der Datei AbstractClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.setID ( id )  [inherited]
+
+
+
Parameter:
+ + +
int $id
+
+
+ +

Definiert in Zeile 42 der Datei AbstractClient.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d7/d13/classClient__IrcClient.png b/ircbot/Documentation/Doxygen/html/d7/d13/classClient__IrcClient.png new file mode 100644 index 0000000..2ae42b7 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d7/d13/classClient__IrcClient.png differ diff --git a/ircbot/Documentation/Doxygen/html/d7/d63/GeneralException_8php_source.html b/ircbot/Documentation/Doxygen/html/d7/d63/GeneralException_8php_source.html new file mode 100644 index 0000000..2b37292 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/d63/GeneralException_8php_source.html @@ -0,0 +1,106 @@ + + + + +ircbot: Classes/Exception/GeneralException.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d7/d9a/classBar.html b/ircbot/Documentation/Doxygen/html/d7/d9a/classBar.html new file mode 100644 index 0000000..06ffcf7 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/d9a/classBar.html @@ -0,0 +1,118 @@ + + + + +ircbot: Bar Klassenreferenz + + + + + + + + + +
+ +
+

Bar Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + +

+Öffentliche Methoden

 __construct ()

+Öffentliche Attribute

$test
+

Ausführliche Beschreibung

+

Testclass #2

+
Autor:
jpt
+ +

Definiert in Zeile 51 der Datei ReferenceTest.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + +
Bar.__construct ( ) 
+
+
+

Default constructor. Initializes test variable.

+
Rückgabe:
void
+ +

Definiert in Zeile 61 der Datei ReferenceTest.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d7/da0/ConnectionPool_8php_source.html b/ircbot/Documentation/Doxygen/html/d7/da0/ConnectionPool_8php_source.html new file mode 100644 index 0000000..54fd923 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/da0/ConnectionPool_8php_source.html @@ -0,0 +1,252 @@ + + + + +ircbot: Classes/Connection/ConnectionPool.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d7/dbd/classTestException__coll__graph.map b/ircbot/Documentation/Doxygen/html/d7/dbd/classTestException__coll__graph.map new file mode 100644 index 0000000..37b3c31 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/dbd/classTestException__coll__graph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d7/dbd/classTestException__coll__graph.md5 b/ircbot/Documentation/Doxygen/html/d7/dbd/classTestException__coll__graph.md5 new file mode 100644 index 0000000..dd59a6f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/dbd/classTestException__coll__graph.md5 @@ -0,0 +1 @@ +53a1fbe25a9649319c5562f6f7964da8 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d7/dbd/classTestException__coll__graph.png b/ircbot/Documentation/Doxygen/html/d7/dbd/classTestException__coll__graph.png new file mode 100644 index 0000000..d151bd9 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d7/dbd/classTestException__coll__graph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager.html b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager.html new file mode 100644 index 0000000..f72ff84 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager.html @@ -0,0 +1,680 @@ + + + + +ircbot: Client_ClientManager Klassenreferenz + + + + + + + + + +
+ +
+

Client_ClientManager Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Öffentliche Methoden

 __construct ($linebreak="\r\n")
 Default constructor.
 __destruct ()
 Default destructor.
 countConnections ()
 work ()
 Main worker function.
 addRawRouting ($from, $to)
 TODO: implement this!
 createTcpConnection ($group="", $protocol="RAW", $IPv6=FALSE)
 Calls ConnectionPool in order to create a simple connection.
 removeConnection ($connectionHandler)
 Closes and removes the connection.
 registerProtocol ($protocol, $className)
 Registers a protocol with a specific client.
 unregisterProtocol ($protocol)
 Unregisters a protocol.
 attachConfig ($config, $connectionHandler)
 Attaches a configuration to a connection.
 sendToID ($id, $data)
 Calls Connection_Pool.
 sendToGroup ($group, $data)
 Calls Connection_Pool.

+Geschützte Methoden

 createClientForProtocol ($protocol)
 Searches for the registered client for the given protocol.
 addClientForConnectionHandler ($connectionHandler)
 Adds a client to our client pool.
 removeClientForConnectionHandler ($connectionHandler)
 Removes a client from our client pool.

+Geschützte Attribute

$connectionPool
$clientPool
$rawRoutingRules
$registeredProtocols
$configPool
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 10 der Datei ClientManager.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + + +
Client_ClientManager.__construct ( linebreak = "\r\n" ) 
+
+
+ +

Default constructor.

+
Parameter:
+ + +
string $linebreak
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 46 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + +
Client_ClientManager.__destruct ( ) 
+
+
+ +

Default destructor.

+

Closes connections before being killed.

+
Rückgabe:
void
+ +

Definiert in Zeile 58 der Datei ClientManager.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Client_ClientManager.addClientForConnectionHandler ( connectionHandler )  [protected]
+
+
+ +

Adds a client to our client pool.

+
Parameter:
+ + +
Connection_ConnectionHandler $connectionHandler
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 184 der Datei ClientManager.php.

+ +

Benutzt createClientForProtocol().

+ +

Wird benutzt von work().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +

+Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Client_ClientManager.addRawRouting ( from,
to 
)
+
+
+ +

TODO: implement this!

+
Parameter:
+ + + +
unknown_type $from
unknown_type $to
+
+
+ +

Definiert in Zeile 114 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Client_ClientManager.attachConfig ( config,
connectionHandler 
)
+
+
+ +

Attaches a configuration to a connection.

+

Will overwrite the existing configuration for the connection.

+
Parameter:
+ + + +
array $config
Connection_ConnectionHandler $connectionHandler
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 215 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + +
Client_ClientManager.countConnections ( ) 
+
+
+
Siehe auch:
Connection_ConnectionPool
+
Rückgabe:
int
+ +

Definiert in Zeile 67 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_ClientManager.createClientForProtocol ( protocol )  [protected]
+
+
+ +

Searches for the registered client for the given protocol.

+

Returns a client instance or void.

+
Parameter:
+ + +
string $protocol
+
+
+
Rückgabe:
mixed
+
Ausnahmebehandlung:
+ + +
Exception_GeneralException 
+
+
+ +

Definiert in Zeile 165 der Datei ClientManager.php.

+ +

Wird benutzt von addClientForConnectionHandler().

+ +

+Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Client_ClientManager.createTcpConnection ( group = "",
protocol = "RAW",
IPv6 = FALSE 
)
+
+
+ +

Calls ConnectionPool in order to create a simple connection.

+
Siehe auch:
Connection_ConnectionPool
+
Parameter:
+ + + +
string $group
boolean $IPv6
+
+
+
Rückgabe:
Connection_ConnectionHandler
+ +

Definiert in Zeile 125 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Client_ClientManager.registerProtocol ( protocol,
className 
)
+
+
+ +

Registers a protocol with a specific client.

+
Parameter:
+ + + +
string $protocol
string $className
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 145 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_ClientManager.removeClientForConnectionHandler ( connectionHandler )  [protected]
+
+
+ +

Removes a client from our client pool.

+
Parameter:
+ + +
Connection_ConnectionHandler $connectionHandler
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 203 der Datei ClientManager.php.

+ +

Wird benutzt von work().

+ +

+Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + + +
Client_ClientManager.removeConnection ( connectionHandler ) 
+
+
+ +

Closes and removes the connection.

+
Parameter:
+ + +
Connection_ConnectionHandler $connectionHandler
+
+
+ +

Definiert in Zeile 133 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Client_ClientManager.sendToGroup ( group,
data 
)
+
+
+ +

Calls Connection_Pool.

+
Siehe auch:
Connection_ConnectionPool
+
Parameter:
+ + + +
string $group
string $data
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 237 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Client_ClientManager.sendToID ( id,
data 
)
+
+
+ +

Calls Connection_Pool.

+
Siehe auch:
Connection_ConnectionPool
+
Parameter:
+ + + +
int $id
string $data
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 226 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_ClientManager.unregisterProtocol ( protocol ) 
+
+
+ +

Unregisters a protocol.

+
Parameter:
+ + +
string $protocol
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 154 der Datei ClientManager.php.

+ +
+
+ +
+
+ + + + + + + + +
Client_ClientManager.work ( ) 
+
+
+ +

Main worker function.

+

Processes incoming data, calls clients and much more.

+
Rückgabe:
void
+ +

Definiert in Zeile 76 der Datei ClientManager.php.

+ +

Benutzt addClientForConnectionHandler() und removeClientForConnectionHandler().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a03e7565392b6e8504b0918ce89557251_icgraph.map b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a03e7565392b6e8504b0918ce89557251_icgraph.map new file mode 100644 index 0000000..84a3eff --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a03e7565392b6e8504b0918ce89557251_icgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a03e7565392b6e8504b0918ce89557251_icgraph.md5 b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a03e7565392b6e8504b0918ce89557251_icgraph.md5 new file mode 100644 index 0000000..5a67cf8 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a03e7565392b6e8504b0918ce89557251_icgraph.md5 @@ -0,0 +1 @@ +63c1f17337a3517fd6426344275c3dc2 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a03e7565392b6e8504b0918ce89557251_icgraph.png b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a03e7565392b6e8504b0918ce89557251_icgraph.png new file mode 100644 index 0000000..63fc8c6 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a03e7565392b6e8504b0918ce89557251_icgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a2aee25ef0e6ab25afbbf7ab7b6a12725_icgraph.map b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a2aee25ef0e6ab25afbbf7ab7b6a12725_icgraph.map new file mode 100644 index 0000000..e5ec828 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a2aee25ef0e6ab25afbbf7ab7b6a12725_icgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a2aee25ef0e6ab25afbbf7ab7b6a12725_icgraph.md5 b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a2aee25ef0e6ab25afbbf7ab7b6a12725_icgraph.md5 new file mode 100644 index 0000000..19ee7a0 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a2aee25ef0e6ab25afbbf7ab7b6a12725_icgraph.md5 @@ -0,0 +1 @@ +08b5e4d464c3a288ff959171a8f23fe0 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a2aee25ef0e6ab25afbbf7ab7b6a12725_icgraph.png b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a2aee25ef0e6ab25afbbf7ab7b6a12725_icgraph.png new file mode 100644 index 0000000..25acdc2 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a2aee25ef0e6ab25afbbf7ab7b6a12725_icgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a4a1a387ccf7170719002f6b14b7eda7b_cgraph.map b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a4a1a387ccf7170719002f6b14b7eda7b_cgraph.map new file mode 100644 index 0000000..2d0e18a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a4a1a387ccf7170719002f6b14b7eda7b_cgraph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a4a1a387ccf7170719002f6b14b7eda7b_cgraph.md5 b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a4a1a387ccf7170719002f6b14b7eda7b_cgraph.md5 new file mode 100644 index 0000000..fac0093 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a4a1a387ccf7170719002f6b14b7eda7b_cgraph.md5 @@ -0,0 +1 @@ +3925bbab504deee6f69b60c0ce45978a \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a4a1a387ccf7170719002f6b14b7eda7b_cgraph.png b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a4a1a387ccf7170719002f6b14b7eda7b_cgraph.png new file mode 100644 index 0000000..14f37e7 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_a4a1a387ccf7170719002f6b14b7eda7b_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_cgraph.map b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_cgraph.map new file mode 100644 index 0000000..61eedb9 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_cgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_cgraph.md5 b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_cgraph.md5 new file mode 100644 index 0000000..2555969 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_cgraph.md5 @@ -0,0 +1 @@ +018987da473dead4cccfd6fda28594a9 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_cgraph.png b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_cgraph.png new file mode 100644 index 0000000..501e393 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_icgraph.map b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_icgraph.map new file mode 100644 index 0000000..10a786d --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_icgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_icgraph.md5 b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_icgraph.md5 new file mode 100644 index 0000000..b715e75 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_icgraph.md5 @@ -0,0 +1 @@ +87efaa5da391bb01b2ad9a55e70c8854 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_icgraph.png b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_icgraph.png new file mode 100644 index 0000000..4519a09 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d7/dc1/classClient__ClientManager_aba2b55abbe025be6a46d6959bee7cfce_icgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d7/dc4/ClientManager_8php_source.html b/ircbot/Documentation/Doxygen/html/d7/dc4/ClientManager_8php_source.html new file mode 100644 index 0000000..83ef561 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d7/dc4/ClientManager_8php_source.html @@ -0,0 +1,313 @@ + + + + +ircbot: Classes/Client/ClientManager.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d8/d0f/classException__GeneralException__coll__graph.map b/ircbot/Documentation/Doxygen/html/d8/d0f/classException__GeneralException__coll__graph.map new file mode 100644 index 0000000..94327dc --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d8/d0f/classException__GeneralException__coll__graph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d8/d0f/classException__GeneralException__coll__graph.md5 b/ircbot/Documentation/Doxygen/html/d8/d0f/classException__GeneralException__coll__graph.md5 new file mode 100644 index 0000000..3e60e91 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d8/d0f/classException__GeneralException__coll__graph.md5 @@ -0,0 +1 @@ +228eda2f4b2cd3341f2053f4ce4c7ecd \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d8/d0f/classException__GeneralException__coll__graph.png b/ircbot/Documentation/Doxygen/html/d8/d0f/classException__GeneralException__coll__graph.png new file mode 100644 index 0000000..76ff879 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d8/d0f/classException__GeneralException__coll__graph.png differ diff --git a/ircbot/Documentation/Doxygen/html/d8/d2a/inherit__graph__4.map b/ircbot/Documentation/Doxygen/html/d8/d2a/inherit__graph__4.map new file mode 100644 index 0000000..587fd55 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d8/d2a/inherit__graph__4.map @@ -0,0 +1,5 @@ + + + + + diff --git a/ircbot/Documentation/Doxygen/html/d8/d2a/inherit__graph__4.md5 b/ircbot/Documentation/Doxygen/html/d8/d2a/inherit__graph__4.md5 new file mode 100644 index 0000000..87545f4 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d8/d2a/inherit__graph__4.md5 @@ -0,0 +1 @@ +ba10dd8f25d4761310b94e5d4e261d0d \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d8/d2a/inherit__graph__4.png b/ircbot/Documentation/Doxygen/html/d8/d2a/inherit__graph__4.png new file mode 100644 index 0000000..3867dbe Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d8/d2a/inherit__graph__4.png differ diff --git a/ircbot/Documentation/Doxygen/html/d8/d4a/inherit__graph__10.map b/ircbot/Documentation/Doxygen/html/d8/d4a/inherit__graph__10.map new file mode 100644 index 0000000..2dc470b --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d8/d4a/inherit__graph__10.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/d8/d4a/inherit__graph__10.md5 b/ircbot/Documentation/Doxygen/html/d8/d4a/inherit__graph__10.md5 new file mode 100644 index 0000000..4b0083e --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d8/d4a/inherit__graph__10.md5 @@ -0,0 +1 @@ +ad4ef93ecd4a3f7bb87e69df155a47b6 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/d8/d4a/inherit__graph__10.png b/ircbot/Documentation/Doxygen/html/d8/d4a/inherit__graph__10.png new file mode 100644 index 0000000..d085c68 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/d8/d4a/inherit__graph__10.png differ diff --git a/ircbot/Documentation/Doxygen/html/d8/d5a/SocketPool_8php_source.html b/ircbot/Documentation/Doxygen/html/d8/d5a/SocketPool_8php_source.html new file mode 100644 index 0000000..4e9866e --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d8/d5a/SocketPool_8php_source.html @@ -0,0 +1,171 @@ + + + + +ircbot: Classes/Socket/SocketPool.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d8/d5d/classFoo.html b/ircbot/Documentation/Doxygen/html/d8/d5d/classFoo.html new file mode 100644 index 0000000..e445327 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d8/d5d/classFoo.html @@ -0,0 +1,176 @@ + + + + +ircbot: Foo Klassenreferenz + + + + + + + + + +
+ +
+

Foo Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + +

+Öffentliche Methoden

 addBar ($bar)
 getBar ($id)
 getTestResult ()

+Geschützte Attribute

$pool
+

Ausführliche Beschreibung

+

Testclass

+
Autor:
jpt
+ +

Definiert in Zeile 6 der Datei ReferenceTest.php.

+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Foo.addBar ( bar ) 
+
+
+

Adds an Instance of Bar to the Pool.

+
Parameter:
+ + +
Bar $bar
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 21 der Datei ReferenceTest.php.

+ +
+
+ +
+
+ + + + + + + + + +
Foo.getBar ( id ) 
+
+
+

Returns the internal instance of Bar for the specific ID.

+
Parameter:
+ + +
int $id
+
+
+
Rückgabe:
Bar
+ +

Definiert in Zeile 30 der Datei ReferenceTest.php.

+ +
+
+ +
+
+ + + + + + + + +
Foo.getTestResult ( ) 
+
+
+

Outputs the current state of the bars in the pool.

+
Rückgabe:
void
+ +

Definiert in Zeile 40 der Datei ReferenceTest.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d8/db6/classService__ExceptionTest-members.html b/ircbot/Documentation/Doxygen/html/d8/db6/classService__ExceptionTest-members.html new file mode 100644 index 0000000..7456c0a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d8/db6/classService__ExceptionTest-members.html @@ -0,0 +1,80 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Service_ExceptionTest Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Service_ExceptionTest einschließlich aller geerbten Elemente. + + + + + +
__construct() (Definiert in Service_ExceptionTest)Service_ExceptionTest
CatchAndThrow() (Definiert in Service_ExceptionTest)Service_ExceptionTest
failAtThis() (Definiert in Service_ExceptionTest)Service_ExceptionTest
internalCatch() (Definiert in Service_ExceptionTest)Service_ExceptionTest
TestTheFail() (Definiert in Service_ExceptionTest)Service_ExceptionTest
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d8/dd7/IrcClientTest_8php_source.html b/ircbot/Documentation/Doxygen/html/d8/dd7/IrcClientTest_8php_source.html new file mode 100644 index 0000000..0e95fe4 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d8/dd7/IrcClientTest_8php_source.html @@ -0,0 +1,110 @@ + + + + +ircbot: Testcode/Connection/IrcClientTest.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/d8/de0/classSocket__SocketHandler-members.html b/ircbot/Documentation/Doxygen/html/d8/de0/classSocket__SocketHandler-members.html new file mode 100644 index 0000000..d9f6cd8 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/d8/de0/classSocket__SocketHandler-members.html @@ -0,0 +1,95 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Socket_SocketHandler Elementverzeichnis

+
+ + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/da/d64/classClient__BotClient.html b/ircbot/Documentation/Doxygen/html/da/d64/classClient__BotClient.html new file mode 100644 index 0000000..f14bccf --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/da/d64/classClient__BotClient.html @@ -0,0 +1,279 @@ + + + + +ircbot: Client_BotClient Klassenreferenz + + + + + + + + + +
+ +
+

Client_BotClient Klassenreferenz

+
+
+
+Zusammengehörigkeiten von Client_BotClient:
+
+
Collaboration graph
+ + +
[Legende]
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + + + + + + +

+Öffentliche Methoden

 __construct ()
 Default constructor.
 processData ($data)
 Does all the hard work.
 loadConfig ($config)
 Loads the given configuration.
 setID ($id)
 setGroup ($group)
 injectClientManager ($clientManager)
 Injects ClientManager.

+Geschützte Attribute

$ID
$group
$clientManager
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 8 der Datei BotClient.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + +
Client_BotClient.__construct ( ) 
+
+
+ +

Default constructor.

+ +

Definiert in Zeile 13 der Datei BotClient.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Client_AbstractClient.injectClientManager ( clientManager )  [inherited]
+
+
+ +

Injects ClientManager.

+
Parameter:
+ + +
Client_ClientManager $clientManager
+
+
+ +

Definiert in Zeile 58 der Datei AbstractClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_BotClient.loadConfig ( config ) 
+
+
+ +

Loads the given configuration.

+
Parameter:
+ + +
array $config
+
+
+
Rückgabe:
void
+ +

Erneute Implementation von Client_AbstractClient.

+ +

Definiert in Zeile 43 der Datei BotClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_BotClient.processData ( data ) 
+
+
+ +

Does all the hard work.

+
Parameter:
+ + +
string $data
+
+
+
Rückgabe:
string
+ +

Erneute Implementation von Client_AbstractClient.

+ +

Definiert in Zeile 22 der Datei BotClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.setGroup ( group )  [inherited]
+
+
+
Parameter:
+ + +
string $group
+
+
+ +

Definiert in Zeile 49 der Datei AbstractClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.setID ( id )  [inherited]
+
+
+
Parameter:
+ + +
int $id
+
+
+ +

Definiert in Zeile 42 der Datei AbstractClient.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/da/d64/classClient__BotClient.png b/ircbot/Documentation/Doxygen/html/da/d64/classClient__BotClient.png new file mode 100644 index 0000000..59128c5 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/da/d64/classClient__BotClient.png differ diff --git a/ircbot/Documentation/Doxygen/html/da/d73/classClient__IrcClient__inherit__graph.map b/ircbot/Documentation/Doxygen/html/da/d73/classClient__IrcClient__inherit__graph.map new file mode 100644 index 0000000..202fcfd --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/da/d73/classClient__IrcClient__inherit__graph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/da/d73/classClient__IrcClient__inherit__graph.md5 b/ircbot/Documentation/Doxygen/html/da/d73/classClient__IrcClient__inherit__graph.md5 new file mode 100644 index 0000000..1c7f00a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/da/d73/classClient__IrcClient__inherit__graph.md5 @@ -0,0 +1 @@ +7c59a08fe398f3857e1833f3df49f992 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/da/d73/classClient__IrcClient__inherit__graph.png b/ircbot/Documentation/Doxygen/html/da/d73/classClient__IrcClient__inherit__graph.png new file mode 100644 index 0000000..8bd6b26 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/da/d73/classClient__IrcClient__inherit__graph.png differ diff --git a/ircbot/Documentation/Doxygen/html/da/d7d/classTestClassForTestsWithReflection.html b/ircbot/Documentation/Doxygen/html/da/d7d/classTestClassForTestsWithReflection.html new file mode 100644 index 0000000..5c173f5 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/da/d7d/classTestClassForTestsWithReflection.html @@ -0,0 +1,172 @@ + + + + +ircbot: TestClassForTestsWithReflection Klassenreferenz + + + + + + + + + +
+ +
+

TestClassForTestsWithReflection Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + + + +

+Öffentliche Methoden

 blablubblol (Klasse $objekt)

+Öffentliche Attribute

$public

+Geschützte Methoden

 testfunctionWithCamelCase (array $ray, $zero=0)

+Geschützte Attribute

$protected
+

Ausführliche Beschreibung

+

Testclass in order to test phpdoc-stuff with the php reflection api Shall help in order to find out how this stuff works.

+
Autor:
jpt
+ +

Definiert in Zeile 7 der Datei Reflection.php.

+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
TestClassForTestsWithReflection.blablubblol (Klasse $  objekt ) 
+
+
+

Testfunction

+
Parameter:
+ + +
Klasse $objekt
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 29 der Datei Reflection.php.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
TestClassForTestsWithReflection.testfunctionWithCamelCase (array $  ray,
zero = 0 
) [protected]
+
+
+

Tests the getDocComment() method

+
Parameter:
+ + + +
array $ray
int $zero
+
+
+
Rückgabe:
string
+ +

Definiert in Zeile 42 der Datei Reflection.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/da/d82/classException__SocketException.html b/ircbot/Documentation/Doxygen/html/da/d82/classException__SocketException.html new file mode 100644 index 0000000..38429a2 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/da/d82/classException__SocketException.html @@ -0,0 +1,120 @@ + + + + +ircbot: Exception_SocketException Klassenreferenz + + + + + + + + + +
+ +
+

Exception_SocketException Klassenreferenz

+
+
+
+Zusammengehörigkeiten von Exception_SocketException:
+
+
Collaboration graph
+ + +
[Legende]
+ +

Aufstellung aller Elemente

+ + + + +

+Öffentliche Methoden

 __toString ()
 Puts all the important information into a string.
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 8 der Datei SocketException.php.

+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + +
Exception_GeneralException.__toString ( )  [inherited]
+
+
+ +

Puts all the important information into a string.

+
Rückgabe:
string
+ +

Definiert in Zeile 27 der Datei GeneralException.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/da/d82/classException__SocketException.png b/ircbot/Documentation/Doxygen/html/da/d82/classException__SocketException.png new file mode 100644 index 0000000..b4ec340 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/da/d82/classException__SocketException.png differ diff --git a/ircbot/Documentation/Doxygen/html/da/d83/classClient__IrcClient-members.html b/ircbot/Documentation/Doxygen/html/da/d83/classClient__IrcClient-members.html new file mode 100644 index 0000000..e5c4291 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/da/d83/classClient__IrcClient-members.html @@ -0,0 +1,90 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Client_IrcClient Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Client_IrcClient einschließlich aller geerbten Elemente. + + + + + + + + + + + + + + + +
$authed (Definiert in Client_IrcClient)Client_IrcClient [protected]
$channels (Definiert in Client_IrcClient)Client_IrcClient [protected]
$clientManager (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
$got_001 (Definiert in Client_IrcClient)Client_IrcClient [protected]
$group (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
$ID (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
$joined (Definiert in Client_IrcClient)Client_IrcClient [protected]
$lines (Definiert in Client_IrcClient)Client_IrcClient [protected]
$nick (Definiert in Client_IrcClient)Client_IrcClient [protected]
__construct()Client_IrcClient
injectClientManager($clientManager)Client_AbstractClient
loadConfig($config)Client_IrcClient
processData($data)Client_IrcClient
setGroup($group)Client_AbstractClient
setID($id)Client_AbstractClient
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/da/da0/classBar-members.html b/ircbot/Documentation/Doxygen/html/da/da0/classBar-members.html new file mode 100644 index 0000000..3de3b42 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/da/da0/classBar-members.html @@ -0,0 +1,77 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Bar Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Bar einschließlich aller geerbten Elemente. + + +
$test (Definiert in Bar)Bar
__construct()Bar
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/da/df5/classClient__AbstractClient-members.html b/ircbot/Documentation/Doxygen/html/da/df5/classClient__AbstractClient-members.html new file mode 100644 index 0000000..40c825d --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/da/df5/classClient__AbstractClient-members.html @@ -0,0 +1,83 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Client_AbstractClient Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Client_AbstractClient einschließlich aller geerbten Elemente. + + + + + + + + +
$clientManager (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
$group (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
$ID (Definiert in Client_AbstractClient)Client_AbstractClient [protected]
injectClientManager($clientManager)Client_AbstractClient
loadConfig($config)Client_AbstractClient
processData($data)Client_AbstractClient
setGroup($group)Client_AbstractClient
setID($id)Client_AbstractClient
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/db/d3c/classClient__AbstractClient.html b/ircbot/Documentation/Doxygen/html/db/d3c/classClient__AbstractClient.html new file mode 100644 index 0000000..962576c --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/db/d3c/classClient__AbstractClient.html @@ -0,0 +1,243 @@ + + + + +ircbot: Client_AbstractClient Klassenreferenz + + + + + + + + + +
+ +
+

Client_AbstractClient Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + + + + +

+Öffentliche Methoden

 processData ($data)
 This function will be the main entry point of any client.
 loadConfig ($config)
 This function will load the given config.
 setID ($id)
 setGroup ($group)
 injectClientManager ($clientManager)
 Injects ClientManager.

+Geschützte Attribute

$ID
$group
$clientManager
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 8 der Datei AbstractClient.php.

+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Client_AbstractClient.injectClientManager ( clientManager ) 
+
+
+ +

Injects ClientManager.

+
Parameter:
+ + +
Client_ClientManager $clientManager
+
+
+ +

Definiert in Zeile 58 der Datei AbstractClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.loadConfig ( config )  [abstract]
+
+
+ +

This function will load the given config.

+
Parameter:
+ + +
array $config
+
+
+ +

Erneute Implementation in Client_BotClient und Client_IrcClient.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.processData ( data )  [abstract]
+
+
+ +

This function will be the main entry point of any client.

+
Parameter:
+ + +
string $data
+
+
+
Rückgabe:
string
+ +

Erneute Implementation in Client_BotClient und Client_IrcClient.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.setGroup ( group ) 
+
+
+
Parameter:
+ + +
string $group
+
+
+ +

Definiert in Zeile 49 der Datei AbstractClient.php.

+ +
+
+ +
+
+ + + + + + + + + +
Client_AbstractClient.setID ( id ) 
+
+
+
Parameter:
+ + +
int $id
+
+
+ +

Definiert in Zeile 42 der Datei AbstractClient.php.

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/db/d3c/classClient__AbstractClient.png b/ircbot/Documentation/Doxygen/html/db/d3c/classClient__AbstractClient.png new file mode 100644 index 0000000..44d7fea Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/db/d3c/classClient__AbstractClient.png differ diff --git a/ircbot/Documentation/Doxygen/html/db/d70/namespaceConnection.html b/ircbot/Documentation/Doxygen/html/db/d70/namespaceConnection.html new file mode 100644 index 0000000..4e075b7 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/db/d70/namespaceConnection.html @@ -0,0 +1,85 @@ + + + + +ircbot: Paket Connection + + + + + + + + + +
+
+

Paket Connection

+
+
+ +

This class is a decorator for the class SocketHandler. +Mehr ...

+ +
+

Ausführliche Beschreibung

+

This class is a decorator for the class SocketHandler.

+

Connection pool class.

+

It provides a buffer for the SocketHandler, so reading and writing a full line won't be that much pain.

+
Autor:
jpt
+

Socket Misc

+

Contains the SocketPool.

+
Autor:
jpt
+

Socket

+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/db/d73/classTestException__inherit__graph.map b/ircbot/Documentation/Doxygen/html/db/d73/classTestException__inherit__graph.map new file mode 100644 index 0000000..37b3c31 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/db/d73/classTestException__inherit__graph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/db/d73/classTestException__inherit__graph.md5 b/ircbot/Documentation/Doxygen/html/db/d73/classTestException__inherit__graph.md5 new file mode 100644 index 0000000..dd59a6f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/db/d73/classTestException__inherit__graph.md5 @@ -0,0 +1 @@ +53a1fbe25a9649319c5562f6f7964da8 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/db/d73/classTestException__inherit__graph.png b/ircbot/Documentation/Doxygen/html/db/d73/classTestException__inherit__graph.png new file mode 100644 index 0000000..d151bd9 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/db/d73/classTestException__inherit__graph.png differ diff --git a/ircbot/Documentation/Doxygen/html/db/ddc/AutoLoader_8php_source.html b/ircbot/Documentation/Doxygen/html/db/ddc/AutoLoader_8php_source.html new file mode 100644 index 0000000..58f5c81 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/db/ddc/AutoLoader_8php_source.html @@ -0,0 +1,88 @@ + + + + +ircbot: AutoLoader.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/db/df5/classException__GeneralException-members.html b/ircbot/Documentation/Doxygen/html/db/df5/classException__GeneralException-members.html new file mode 100644 index 0000000..5ebe085 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/db/df5/classException__GeneralException-members.html @@ -0,0 +1,77 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Exception_GeneralException Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Exception_GeneralException einschließlich aller geerbten Elemente. + + +
__construct($message="", $code=0)Exception_GeneralException
__toString()Exception_GeneralException
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/dc/d0b/classConnection__ConnectionHandler-members.html b/ircbot/Documentation/Doxygen/html/dc/d0b/classConnection__ConnectionHandler-members.html new file mode 100644 index 0000000..5f1fb1d --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/d0b/classConnection__ConnectionHandler-members.html @@ -0,0 +1,107 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Connection_ConnectionHandler Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Connection_ConnectionHandler einschließlich aller geerbten Elemente. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
$buffer_incoming (Definiert in Connection_ConnectionHandler)Connection_ConnectionHandler [protected]
$buffer_outgoing (Definiert in Connection_ConnectionHandler)Connection_ConnectionHandler [protected]
$group (Definiert in Connection_ConnectionHandler)Connection_ConnectionHandler [protected]
$id (Definiert in Connection_ConnectionHandler)Connection_ConnectionHandler [protected]
$is_server (Definiert in Connection_ConnectionHandler)Connection_ConnectionHandler [protected]
$protocol (Definiert in Connection_ConnectionHandler)Connection_ConnectionHandler [protected]
$socketHandler (Definiert in Connection_ConnectionHandler)Connection_ConnectionHandler [protected]
__construct($socket, $id, $group="", $protocol="", $linebreak="\r\n")Connection_ConnectionHandler
__destruct()Connection_ConnectionHandler
accept()Connection_ConnectionHandler
bind($address, $port)Connection_ConnectionHandler
canRead()Connection_ConnectionHandler
canWrite()Connection_ConnectionHandler
close()Connection_ConnectionHandler
connect($address, $port)Connection_ConnectionHandler
getGroup()Connection_ConnectionHandler
getID()Connection_ConnectionHandler
getLocalName()Connection_ConnectionHandler
getProtocol()Connection_ConnectionHandler
getRemoteName()Connection_ConnectionHandler
getSocket()Connection_ConnectionHandler
getSocketHandler()Connection_ConnectionHandler
handleSocketError()Connection_ConnectionHandler
hasBeenAccepted()Connection_ConnectionHandler
isConnected()Connection_ConnectionHandler
isListening()Connection_ConnectionHandler
isServer()Connection_ConnectionHandler
listen()Connection_ConnectionHandler
read()Connection_ConnectionHandler
readToBuffer()Connection_ConnectionHandler
write($data)Connection_ConnectionHandler
writeFromBuffer()Connection_ConnectionHandler
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/dc/d0e/AbstractClient_8php_source.html b/ircbot/Documentation/Doxygen/html/dc/d0e/AbstractClient_8php_source.html new file mode 100644 index 0000000..19738de --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/d0e/AbstractClient_8php_source.html @@ -0,0 +1,133 @@ + + + + +ircbot: Classes/Client/AbstractClient.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/dc/d67/IrcClient_8php_source.html b/ircbot/Documentation/Doxygen/html/dc/d67/IrcClient_8php_source.html new file mode 100644 index 0000000..52a9a35 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/d67/IrcClient_8php_source.html @@ -0,0 +1,148 @@ + + + + +ircbot: Classes/Client/IrcClient.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer.html b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer.html new file mode 100644 index 0000000..c14a028 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer.html @@ -0,0 +1,279 @@ + + + + +ircbot: Misc_Buffer Klassenreferenz + + + + + + + + + +
+ +
+

Misc_Buffer Klassenreferenz

+
+
+ +

Aufstellung aller Elemente

+ + + + + + + + + + + + + + + + +

+Öffentliche Methoden

 __construct ($linebreak="\r\n")
 Default constructor.
 addData ($data)
 Appends data to the buffer.
 getNextLine ()
 Returns the next line in the buffer and removes it from the buffer.
 hasLines ()
 Checks whether the buffer contains more lines to process.

+Geschützte Methoden

 pruneEmptyLines ()
 Prunes empty lines out of the buffer.

+Geschützte Attribute

$buffer
$linebreak
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 9 der Datei Buffer.php.

+

Beschreibung der Konstruktoren und Destruktoren

+ +
+
+ + + + + + + + + +
Misc_Buffer.__construct ( linebreak = "\r\n" ) 
+
+
+ +

Default constructor.

+

Sets a default linebreak and initializes the buffer.

+
Parameter:
+ + +
$linebreak 
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 28 der Datei Buffer.php.

+ +
+
+

Dokumentation der Elementfunktionen

+ +
+
+ + + + + + + + + +
Misc_Buffer.addData ( data ) 
+
+
+ +

Appends data to the buffer.

+
Parameter:
+ + +
string $data
+
+
+
Rückgabe:
void
+ +

Definiert in Zeile 55 der Datei Buffer.php.

+ +

Benutzt pruneEmptyLines().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + +
Misc_Buffer.getNextLine ( ) 
+
+
+ +

Returns the next line in the buffer and removes it from the buffer.

+
Rückgabe:
string
+ +

Definiert in Zeile 64 der Datei Buffer.php.

+ +

Benutzt hasLines().

+ +

+Hier ist ein Graph der zeigt, was diese Funktion aufruft:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + +
Misc_Buffer.hasLines ( ) 
+
+
+ +

Checks whether the buffer contains more lines to process.

+
Rückgabe:
boolean
+ +

Definiert in Zeile 77 der Datei Buffer.php.

+ +

Wird benutzt von getNextLine().

+ +

+Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:
+
+
+ + +
+

+ +
+
+ +
+
+ + + + + + + + +
Misc_Buffer.pruneEmptyLines ( )  [protected]
+
+
+ +

Prunes empty lines out of the buffer.

+
Rückgabe:
void
+ +

Definiert in Zeile 37 der Datei Buffer.php.

+ +

Wird benutzt von addData().

+ +

+Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:
+
+
+ + +
+

+ +
+
+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a4f896c1c2310de58bc4a3aeecc1dd557_cgraph.map b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a4f896c1c2310de58bc4a3aeecc1dd557_cgraph.map new file mode 100644 index 0000000..36b6709 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a4f896c1c2310de58bc4a3aeecc1dd557_cgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a4f896c1c2310de58bc4a3aeecc1dd557_cgraph.md5 b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a4f896c1c2310de58bc4a3aeecc1dd557_cgraph.md5 new file mode 100644 index 0000000..f14139f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a4f896c1c2310de58bc4a3aeecc1dd557_cgraph.md5 @@ -0,0 +1 @@ +0df678a347f86324259aa85dddf9c599 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a4f896c1c2310de58bc4a3aeecc1dd557_cgraph.png b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a4f896c1c2310de58bc4a3aeecc1dd557_cgraph.png new file mode 100644 index 0000000..38edaf6 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a4f896c1c2310de58bc4a3aeecc1dd557_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a6b2165a557efecf7080039614c64ad49_cgraph.map b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a6b2165a557efecf7080039614c64ad49_cgraph.map new file mode 100644 index 0000000..42ab248 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a6b2165a557efecf7080039614c64ad49_cgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a6b2165a557efecf7080039614c64ad49_cgraph.md5 b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a6b2165a557efecf7080039614c64ad49_cgraph.md5 new file mode 100644 index 0000000..79ed5de --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a6b2165a557efecf7080039614c64ad49_cgraph.md5 @@ -0,0 +1 @@ +37fe2fb046130a298326fef43dbb0dde \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a6b2165a557efecf7080039614c64ad49_cgraph.png b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a6b2165a557efecf7080039614c64ad49_cgraph.png new file mode 100644 index 0000000..f09ca40 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a6b2165a557efecf7080039614c64ad49_cgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a8756bff58487a261ae706f4fe1717623_icgraph.map b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a8756bff58487a261ae706f4fe1717623_icgraph.map new file mode 100644 index 0000000..a4922f9 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a8756bff58487a261ae706f4fe1717623_icgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a8756bff58487a261ae706f4fe1717623_icgraph.md5 b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a8756bff58487a261ae706f4fe1717623_icgraph.md5 new file mode 100644 index 0000000..47ae178 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a8756bff58487a261ae706f4fe1717623_icgraph.md5 @@ -0,0 +1 @@ +0f19da39e3ae41d14aab99baeeb44006 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a8756bff58487a261ae706f4fe1717623_icgraph.png b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a8756bff58487a261ae706f4fe1717623_icgraph.png new file mode 100644 index 0000000..a1f63a3 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_a8756bff58487a261ae706f4fe1717623_icgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_ab972b47b0d986625d7989d1c1915996a_icgraph.map b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_ab972b47b0d986625d7989d1c1915996a_icgraph.map new file mode 100644 index 0000000..5be459c --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_ab972b47b0d986625d7989d1c1915996a_icgraph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_ab972b47b0d986625d7989d1c1915996a_icgraph.md5 b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_ab972b47b0d986625d7989d1c1915996a_icgraph.md5 new file mode 100644 index 0000000..71ae64a --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_ab972b47b0d986625d7989d1c1915996a_icgraph.md5 @@ -0,0 +1 @@ +9269354da2cb7406425e996feca5be44 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_ab972b47b0d986625d7989d1c1915996a_icgraph.png b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_ab972b47b0d986625d7989d1c1915996a_icgraph.png new file mode 100644 index 0000000..c2e211d Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/dc/d78/classMisc__Buffer_ab972b47b0d986625d7989d1c1915996a_icgraph.png differ diff --git a/ircbot/Documentation/Doxygen/html/dc/ddd/inherit__graph__0.map b/ircbot/Documentation/Doxygen/html/dc/ddd/inherit__graph__0.map new file mode 100644 index 0000000..3bbf077 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/ddd/inherit__graph__0.map @@ -0,0 +1,5 @@ + + + + + diff --git a/ircbot/Documentation/Doxygen/html/dc/ddd/inherit__graph__0.md5 b/ircbot/Documentation/Doxygen/html/dc/ddd/inherit__graph__0.md5 new file mode 100644 index 0000000..bc49b00 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/ddd/inherit__graph__0.md5 @@ -0,0 +1 @@ +e25dddac50f2684016dc488a8a995af1 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/dc/ddd/inherit__graph__0.png b/ircbot/Documentation/Doxygen/html/dc/ddd/inherit__graph__0.png new file mode 100644 index 0000000..4118186 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/dc/ddd/inherit__graph__0.png differ diff --git a/ircbot/Documentation/Doxygen/html/dc/dfe/classClient__BotClient__coll__graph.map b/ircbot/Documentation/Doxygen/html/dc/dfe/classClient__BotClient__coll__graph.map new file mode 100644 index 0000000..202fcfd --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/dfe/classClient__BotClient__coll__graph.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/dc/dfe/classClient__BotClient__coll__graph.md5 b/ircbot/Documentation/Doxygen/html/dc/dfe/classClient__BotClient__coll__graph.md5 new file mode 100644 index 0000000..2d325d7 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dc/dfe/classClient__BotClient__coll__graph.md5 @@ -0,0 +1 @@ +97773074c14c44fd057a070bd2b2d966 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/dc/dfe/classClient__BotClient__coll__graph.png b/ircbot/Documentation/Doxygen/html/dc/dfe/classClient__BotClient__coll__graph.png new file mode 100644 index 0000000..88442dd Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/dc/dfe/classClient__BotClient__coll__graph.png differ diff --git a/ircbot/Documentation/Doxygen/html/dd/d3c/SocketException_8php_source.html b/ircbot/Documentation/Doxygen/html/dd/d3c/SocketException_8php_source.html new file mode 100644 index 0000000..30d2713 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dd/d3c/SocketException_8php_source.html @@ -0,0 +1,80 @@ + + + + +ircbot: Classes/Exception/SocketException.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/dd/d75/classException__SocketException-members.html b/ircbot/Documentation/Doxygen/html/dd/d75/classException__SocketException-members.html new file mode 100644 index 0000000..2ac17ac --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dd/d75/classException__SocketException-members.html @@ -0,0 +1,77 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Exception_SocketException Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Exception_SocketException einschließlich aller geerbten Elemente. + + +
__construct($message="", $code=0)Exception_GeneralException
__toString()Exception_GeneralException
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/dd/dd0/inherit__graph__8.map b/ircbot/Documentation/Doxygen/html/dd/dd0/inherit__graph__8.map new file mode 100644 index 0000000..b8f15f6 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dd/dd0/inherit__graph__8.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/dd/dd0/inherit__graph__8.md5 b/ircbot/Documentation/Doxygen/html/dd/dd0/inherit__graph__8.md5 new file mode 100644 index 0000000..edcc2fc --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dd/dd0/inherit__graph__8.md5 @@ -0,0 +1 @@ +a7a19ebc53ad54222b42b8de41f8c847 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/dd/dd0/inherit__graph__8.png b/ircbot/Documentation/Doxygen/html/dd/dd0/inherit__graph__8.png new file mode 100644 index 0000000..37911e1 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/dd/dd0/inherit__graph__8.png differ diff --git a/ircbot/Documentation/Doxygen/html/dd/dec/classTestFailException.html b/ircbot/Documentation/Doxygen/html/dd/dec/classTestFailException.html new file mode 100644 index 0000000..c659ab8 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dd/dec/classTestFailException.html @@ -0,0 +1,97 @@ + + + + +ircbot: TestFailException Klassenreferenz + + + + + + + + + +
+ +
+

TestFailException Klassenreferenz

+
+
+
+Zusammengehörigkeiten von TestFailException:
+
+
Collaboration graph
+ + +
[Legende]
+ +

Aufstellung aller Elemente

+ + + +

+Öffentliche Methoden

__construct ($msg)
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 11 der Datei Exceptions.php.

+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/dd/dec/classTestFailException.png b/ircbot/Documentation/Doxygen/html/dd/dec/classTestFailException.png new file mode 100644 index 0000000..9e53cd4 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/dd/dec/classTestFailException.png differ diff --git a/ircbot/Documentation/Doxygen/html/dd/df4/classTestException.html b/ircbot/Documentation/Doxygen/html/dd/df4/classTestException.html new file mode 100644 index 0000000..0207ba7 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/dd/df4/classTestException.html @@ -0,0 +1,97 @@ + + + + +ircbot: TestException Klassenreferenz + + + + + + + + + +
+ +
+

TestException Klassenreferenz

+
+
+
+Zusammengehörigkeiten von TestException:
+
+
Collaboration graph
+ + +
[Legende]
+ +

Aufstellung aller Elemente

+ + + +

+Öffentliche Methoden

__construct ($message)
+

Ausführliche Beschreibung

+ +

Definiert in Zeile 3 der Datei Exceptions.php.

+
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: +
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/dd/df4/classTestException.png b/ircbot/Documentation/Doxygen/html/dd/df4/classTestException.png new file mode 100644 index 0000000..df8be49 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/dd/df4/classTestException.png differ diff --git a/ircbot/Documentation/Doxygen/html/de/d07/SocketHandler_8php_source.html b/ircbot/Documentation/Doxygen/html/de/d07/SocketHandler_8php_source.html new file mode 100644 index 0000000..d56bd5d --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/de/d07/SocketHandler_8php_source.html @@ -0,0 +1,287 @@ + + + + +ircbot: Classes/Socket/SocketHandler.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/de/d11/BotClient_8php_source.html b/ircbot/Documentation/Doxygen/html/de/d11/BotClient_8php_source.html new file mode 100644 index 0000000..085ad8f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/de/d11/BotClient_8php_source.html @@ -0,0 +1,119 @@ + + + + +ircbot: Classes/Client/BotClient.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/de/d46/namespaceClient.html b/ircbot/Documentation/Doxygen/html/de/d46/namespaceClient.html new file mode 100644 index 0000000..24bcc01 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/de/d46/namespaceClient.html @@ -0,0 +1,87 @@ + + + + +ircbot: Paket Client + + + + + + + + + +
+
+

Paket Client

+
+
+ +

Abstract class that implements the basic api for any client. +Mehr ...

+ +
+

Ausführliche Beschreibung

+

Abstract class that implements the basic api for any client.

+

This class contains the connection handler.

+

IrcClient class that contains all the Plugins.

+
Autor:
jpt
+
+jpt
+

Client_AbstractClient

+

It handles all the incoming and outgoing data by forwarding it to the clients for the specific connection.

+
Autor:
jpt
+

Connection

+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/de/d7a/classException__SocketException__coll__graph.map b/ircbot/Documentation/Doxygen/html/de/d7a/classException__SocketException__coll__graph.map new file mode 100644 index 0000000..681de5d --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/de/d7a/classException__SocketException__coll__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/ircbot/Documentation/Doxygen/html/de/d7a/classException__SocketException__coll__graph.md5 b/ircbot/Documentation/Doxygen/html/de/d7a/classException__SocketException__coll__graph.md5 new file mode 100644 index 0000000..af9fdad --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/de/d7a/classException__SocketException__coll__graph.md5 @@ -0,0 +1 @@ +64f92f108e046ca30c27ffcad11b0307 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/de/d7a/classException__SocketException__coll__graph.png b/ircbot/Documentation/Doxygen/html/de/d7a/classException__SocketException__coll__graph.png new file mode 100644 index 0000000..7be938e Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/de/d7a/classException__SocketException__coll__graph.png differ diff --git a/ircbot/Documentation/Doxygen/html/de/d7d/namespaceMisc.html b/ircbot/Documentation/Doxygen/html/de/d7d/namespaceMisc.html new file mode 100644 index 0000000..9708c73 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/de/d7d/namespaceMisc.html @@ -0,0 +1,80 @@ + + + + +ircbot: Paket Misc + + + + + + + + + +
+
+

Paket Misc

+
+
+ +

Buffer class for a string. +Mehr ...

+ +
+

Ausführliche Beschreibung

+

Buffer class for a string.

+

Will fix issues with sockets that don't care about linebreaks. Can also be used for all kinds of purpose.

+
Autor:
jpt
+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/de/db8/classSocket__SocketPool-members.html b/ircbot/Documentation/Doxygen/html/de/db8/classSocket__SocketPool-members.html new file mode 100644 index 0000000..6419915 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/de/db8/classSocket__SocketPool-members.html @@ -0,0 +1,83 @@ + + + + +ircbot: Elementverzeichnis + + + + + + + + + +
+
+

Socket_SocketPool Elementverzeichnis

+
+
+Vollständige Aufstellung aller Elemente für Socket_SocketPool einschließlich aller geerbten Elemente. + + + + + + + + +
$sockets (Definiert in Socket_SocketPool)Socket_SocketPool [protected]
__construct()Socket_SocketPool
__destruct()Socket_SocketPool
addSocket($add_socket)Socket_SocketPool
countSockets()Socket_SocketPool
createTcpSocket($IPv6=FALSE)Socket_SocketPool
removeSocket($remove_socket)Socket_SocketPool
select($read, $write, $except, $timeout=NULL)Socket_SocketPool
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/de/dbf/inherit__graph__7.map b/ircbot/Documentation/Doxygen/html/de/dbf/inherit__graph__7.map new file mode 100644 index 0000000..2dc470b --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/de/dbf/inherit__graph__7.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/de/dbf/inherit__graph__7.md5 b/ircbot/Documentation/Doxygen/html/de/dbf/inherit__graph__7.md5 new file mode 100644 index 0000000..4b0083e --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/de/dbf/inherit__graph__7.md5 @@ -0,0 +1 @@ +ad4ef93ecd4a3f7bb87e69df155a47b6 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/de/dbf/inherit__graph__7.png b/ircbot/Documentation/Doxygen/html/de/dbf/inherit__graph__7.png new file mode 100644 index 0000000..d085c68 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/de/dbf/inherit__graph__7.png differ diff --git a/ircbot/Documentation/Doxygen/html/de/dc8/inherit__graph__2.map b/ircbot/Documentation/Doxygen/html/de/dc8/inherit__graph__2.map new file mode 100644 index 0000000..a1b3460 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/de/dc8/inherit__graph__2.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/de/dc8/inherit__graph__2.md5 b/ircbot/Documentation/Doxygen/html/de/dc8/inherit__graph__2.md5 new file mode 100644 index 0000000..84052f2 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/de/dc8/inherit__graph__2.md5 @@ -0,0 +1 @@ +4ef6314f3c88766ef9165a6245674292 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/de/dc8/inherit__graph__2.png b/ircbot/Documentation/Doxygen/html/de/dc8/inherit__graph__2.png new file mode 100644 index 0000000..bccf2f8 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/de/dc8/inherit__graph__2.png differ diff --git a/ircbot/Documentation/Doxygen/html/df/d4e/inherit__graph__3.map b/ircbot/Documentation/Doxygen/html/df/d4e/inherit__graph__3.map new file mode 100644 index 0000000..30c6791 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/df/d4e/inherit__graph__3.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/df/d4e/inherit__graph__3.md5 b/ircbot/Documentation/Doxygen/html/df/d4e/inherit__graph__3.md5 new file mode 100644 index 0000000..c4eaf93 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/df/d4e/inherit__graph__3.md5 @@ -0,0 +1 @@ +2ef7df4ebbf5aed21b7a840adad04b0c \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/df/d4e/inherit__graph__3.png b/ircbot/Documentation/Doxygen/html/df/d4e/inherit__graph__3.png new file mode 100644 index 0000000..2b384ad Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/df/d4e/inherit__graph__3.png differ diff --git a/ircbot/Documentation/Doxygen/html/df/d8a/inherit__graph__5.map b/ircbot/Documentation/Doxygen/html/df/d8a/inherit__graph__5.map new file mode 100644 index 0000000..45490ff --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/df/d8a/inherit__graph__5.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/df/d8a/inherit__graph__5.md5 b/ircbot/Documentation/Doxygen/html/df/d8a/inherit__graph__5.md5 new file mode 100644 index 0000000..64893c3 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/df/d8a/inherit__graph__5.md5 @@ -0,0 +1 @@ +6a58e9aa2b83fdb1254b35f30c4805b1 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/df/d8a/inherit__graph__5.png b/ircbot/Documentation/Doxygen/html/df/d8a/inherit__graph__5.png new file mode 100644 index 0000000..07008db Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/df/d8a/inherit__graph__5.png differ diff --git a/ircbot/Documentation/Doxygen/html/df/da9/inherit__graph__1.map b/ircbot/Documentation/Doxygen/html/df/da9/inherit__graph__1.map new file mode 100644 index 0000000..9179d4d --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/df/da9/inherit__graph__1.map @@ -0,0 +1,3 @@ + + + diff --git a/ircbot/Documentation/Doxygen/html/df/da9/inherit__graph__1.md5 b/ircbot/Documentation/Doxygen/html/df/da9/inherit__graph__1.md5 new file mode 100644 index 0000000..4d27f4f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/df/da9/inherit__graph__1.md5 @@ -0,0 +1 @@ +5c55a02890cc161dc17ff9bc0d02b466 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/df/da9/inherit__graph__1.png b/ircbot/Documentation/Doxygen/html/df/da9/inherit__graph__1.png new file mode 100644 index 0000000..a4ab407 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/df/da9/inherit__graph__1.png differ diff --git a/ircbot/Documentation/Doxygen/html/df/dc6/Exceptions_8php_source.html b/ircbot/Documentation/Doxygen/html/df/dc6/Exceptions_8php_source.html new file mode 100644 index 0000000..f97af2f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/df/dc6/Exceptions_8php_source.html @@ -0,0 +1,132 @@ + + + + +ircbot: Testcode/Misc/Exceptions.php Quellcode + + + + + + + + + + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/doxygen.css b/ircbot/Documentation/Doxygen/html/doxygen.css new file mode 100644 index 0000000..658686f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/doxygen.css @@ -0,0 +1,656 @@ +/* The standard CSS for doxygen */ + +body, table, div, p, dl { + font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; + font-size: 12px; +} + +/* @group Heading Levels */ + +h1 { + font-size: 150%; +} + +h2 { + font-size: 120%; +} + +h3 { + font-size: 100%; +} + +dt { + font-weight: bold; +} + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p.startli, p.startdd, p.starttd { + margin-top: 2px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.qindex, div.navtab{ + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + padding: 2px; +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + +a { + color: #3D578C; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #4665A2; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #9CAFD4; + color: #ffffff; + border: 1px double #869DCA; +} + +.contents a.qindexHL:visited { + color: #ffffff; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code { + color: #4665A2; +} + +a.codeRef { + color: #4665A2; +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +.fragment { + font-family: monospace, fixed; + font-size: 105%; +} + +pre.fragment { + border: 1px solid #C4CFE5; + background-color: #FBFCFD; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; +} + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); + background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000); +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background: white; + color: black; + margin: 0; +} + +div.contents { + margin-top: 10px; + margin-left: 10px; + margin-right: 10px; +} + +td.indexkey { + background-color: #EBEFF6; + font-weight: bold; + border: 1px solid #C4CFE5; + margin: 2px 0px 2px 0; + padding: 2px 10px; +} + +td.indexvalue { + background-color: #EBEFF6; + border: 1px solid #C4CFE5; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #EEF1F7; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +address.footer { + text-align: right; + padding-right: 12px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +/* @end */ + +/* +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +*/ + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #A3B4D7; +} + +th.dirtab { + background: #EBEFF6; + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid #4A6AAA; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +table.memberdecls { + border-spacing: 0px; + padding: 0px; +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #F9FAFC; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memItemLeft, .memItemRight, .memTemplParams { + border-top: 1px solid #C4CFE5; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memTemplParams { + color: #4665A2; + white-space: nowrap; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { + font-size: 80%; + color: #4665A2; + font-weight: normal; + margin-left: 3px; +} + +.memnav { + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.memitem { + padding: 0; + margin-bottom: 10px; +} + +.memname { + white-space: nowrap; + font-weight: bold; + margin-left: 6px; +} + +.memproto { + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 0px 6px 0px; + color: #253555; + font-weight: bold; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + /* firefox specific markup */ + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 8px; + -moz-border-radius-topleft: 8px; + /* webkit specific markup */ + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 8px; + -webkit-border-top-left-radius: 8px; + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + +} + +.memdoc { + border-bottom: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 2px 5px; + background-color: #FBFCFD; + border-top-width: 0; + /* firefox specific markup */ + -moz-border-radius-bottomleft: 8px; + -moz-border-radius-bottomright: 8px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + background-image: -moz-linear-gradient(center top, #FFFFFF 0%, #FFFFFF 60%, #F7F8FB 95%, #EEF1F7); + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 8px; + -webkit-border-bottom-right-radius: 8px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + background-image: -webkit-gradient(linear,center top,center bottom,from(#FFFFFF), color-stop(0.6,#FFFFFF), color-stop(0.60,#FFFFFF), color-stop(0.95,#F7F8FB), to(#EEF1F7)); +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} + +/* @end */ + +/* @group Directory (tree) */ + +/* for the tree view */ + +.ftvtree { + font-family: sans-serif; + margin: 0px; +} + +/* these are for tree view when used as main index */ + +.directory { + font-size: 9pt; + font-weight: bold; + margin: 5px; +} + +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* +The following two styles can be used to replace the root node title +with an image of your choice. Simply uncomment the next two styles, +specify the name of your image and be sure to set 'height' to the +proper pixel height of your image. +*/ + +/* +.directory h3.swap { + height: 61px; + background-repeat: no-repeat; + background-image: url("yourimage.gif"); +} +.directory h3.swap span { + display: none; +} +*/ + +.directory > h3 { + margin-top: 0; +} + +.directory p { + margin: 0px; + white-space: nowrap; +} + +.directory div { + display: none; + margin: 0px; +} + +.directory img { + vertical-align: -30%; +} + +/* these are for tree view when not used as main index */ + +.directory-alt { + font-size: 100%; + font-weight: bold; +} + +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +.directory-alt > h3 { + margin-top: 0; +} + +.directory-alt p { + margin: 0px; + white-space: nowrap; +} + +.directory-alt div { + display: none; + margin: 0px; +} + +.directory-alt img { + vertical-align: -30%; +} + +/* @end */ + +div.dynheader { + margin-top: 8px; +} + +address { + font-style: normal; + color: #2A3D61; +} + +table.doxtable { + border-collapse:collapse; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; +} + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-image:url('tab_b.png'); + background-repeat:repeat-x; + height:30px; + line-height:30px; + color:#8AA0CC; + border:solid 1px #C2CDE4; + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right: 15px; + background-image:url('bc_s.png'); + background-repeat:no-repeat; + background-position:right; + color:#364D7C; +} + +.navpath a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; +} + +.navpath a:hover +{ + color:#6884BD; +} + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +div.header +{ + background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: #F9FAFC; + margin: 0px; + border-bottom: 1px solid #C4CFE5; +} + +div.headertitle +{ + padding: 5px 5px 5px 10px; +} + diff --git a/ircbot/Documentation/Doxygen/html/doxygen.png b/ircbot/Documentation/Doxygen/html/doxygen.png new file mode 100644 index 0000000..635ed52 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/doxygen.png differ diff --git a/ircbot/Documentation/Doxygen/html/files.html b/ircbot/Documentation/Doxygen/html/files.html new file mode 100644 index 0000000..c440b8f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/files.html @@ -0,0 +1,86 @@ + + + + +ircbot: Datei-Verzeichnis + + + + + + + + + +
+
+

Auflistung der Dateien

+
+
+Hier folgt die Aufzählung aller dokumentierten Dateien mit einer Kurzbeschreibung: + + + + + + + + + + + + + +
AutoLoader.php [code]
Main.php [code]
Classes/Client/AbstractClient.php [code]
Classes/Client/BotClient.php [code]
Classes/Client/ClientManager.php [code]
Classes/Client/IrcClient.php [code]
Classes/Connection/ConnectionHandler.php [code]
Classes/Connection/ConnectionPool.php [code]
Classes/Exception/GeneralException.php [code]
Classes/Exception/SocketException.php [code]
Classes/Misc/Buffer.php [code]
Classes/Socket/SocketHandler.php [code]
Classes/Socket/SocketPool.php [code]
+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/functions.html b/ircbot/Documentation/Doxygen/html/functions.html new file mode 100644 index 0000000..35714d3 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/functions.html @@ -0,0 +1,359 @@ + + + + +ircbot: Klassen-Elemente + + + + + + + + + +
+Hier folgt die Aufzählung aller dokumentierten Klassenelemente mit Verweisen auf die Klassendokumentation zu jedem Element: + +

- _ -

+ + +

- a -

+ + +

- b -

+ + +

- c -

+ + +

- e -

+ + +

- g -

+ + +

- h -

+ + +

- i -

+ + +

- l -

+ + +

- p -

+ + +

- r -

+ + +

- s -

+ + +

- u -

+ + +

- w -

+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/functions_func.html b/ircbot/Documentation/Doxygen/html/functions_func.html new file mode 100644 index 0000000..cf11459 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/functions_func.html @@ -0,0 +1,359 @@ + + + + +ircbot: Klassen-Elemente - Funktionen + + + + + + + + + +
+  + +

- _ -

+ + +

- a -

+ + +

- b -

+ + +

- c -

+ + +

- e -

+ + +

- g -

+ + +

- h -

+ + +

- i -

+ + +

- l -

+ + +

- p -

+ + +

- r -

+ + +

- s -

+ + +

- u -

+ + +

- w -

+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/graph_legend.html b/ircbot/Documentation/Doxygen/html/graph_legend.html new file mode 100644 index 0000000..634cc06 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/graph_legend.html @@ -0,0 +1,130 @@ + + + + +ircbot: Erklärung des Graphen + + + + + + + + + +
+
+

Erklärung des Graphen

+
+
+

Diese Seite erklärt die Interpretation der von doxygen erzeugten Graphen.

+

Beispiel:

+
/*! Wegen Verkürzung unsichtbare Klasse */
+class Invisible { };
+
+/*! Klasse verkürzt dargestellt, Vererbungsbeziehung ist versteckt */
+class Truncated : public Invisible { };
+
+/* Nicht mit doxygen-Kommentaren dokumentierte Klasse */
+class Undocumented { };
+
+/*! Mithilfe öffentlicher Vererbung vererbte Klasse */
+class PublicBase : public Truncated { };
+
+/*! Eine Template-Klasse */
+template<class T> class Templ { };
+
+/*! Mithilfe geschützter Vererbung vererbte Klasse */
+class ProtectedBase { };
+
+/*! Mithilfe privater Vererbung vererbte Klasse */
+class PrivateBase { };
+
+/*! Von der Klasse Inherited benutzte Klasse */
+class Used { };
+
+/*! Superklasse, die von mehreren anderen Klassen erbt */
+class Inherited : public PublicBase,
+                  protected ProtectedBase,
+                  private PrivateBase,
+                  public Undocumented,
+                  public Templ<int>
+{
+  private:
+    Used *m_usedClass;
+};
+

Dies liefert den folgenden Graphen:

+
+graph_legend.png +
+

Die Rechtecke in obigem Graphen bedeuten:

+
    +
  • +Ein grau gefülltes Rechteck stellt die Struktur oder Klasse dar, für die der Graph erzeugt wurde.
  • +
  • +Ein Rechteck mit schwarzem Rahmen kennzeichnet eine dokumentierte Struktur oder Klasse.
  • +
  • +Ein Rechteck mit grauem Rahmen kennzeichnet eine undokumentierte Struktur oder Klasse.
  • +
  • +Ein Rechteck mit rotem Rahmen kennzeichnet eine dokumentierte Struktur oder Klasse, für die nicht alle Vererbungs-/Enthaltenseinsbeziehungen dargestellt werden. Ein Graph wird gekürzt, wenn er nicht in die angegebenen Schranken passt.
  • +
+

Die Pfeile bedeuten:

+
    +
  • +Ein dunkelblauer Pfeil stellt eine öffentliche Vererbungsbeziehung zwischen zwei Klassen dar.
  • +
  • +Ein dunkelgrüner Pfeil stellt geschützte Vererbung dar.
  • +
  • +Ein dunkelroter Pfeil stellt private Vererbung dar.
  • +
  • +Ein gestrichelter violetter Pfeil bedeutet, dass eine Klasse in einer anderen enthalten ist oder von einer anderen benutzt wird. Am Pfeil stehen die Variable(n), mit deren Hilfe auf die Struktur oder Klasse an der Pfeilspitze zugegriffen werden kann.
  • +
  • +Ein gestrichelter gelber Pfeil kennzeichnet eine Verknüpfung zwischen einer Template Instanz und der Template Klasse von welcher es abstammt. Neben dem Pfeil sind die Template Parameter aufgeführt.
  • +
+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/graph_legend.md5 b/ircbot/Documentation/Doxygen/html/graph_legend.md5 new file mode 100644 index 0000000..3b3ad51 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/graph_legend.md5 @@ -0,0 +1 @@ +4705be6b54053b6cc0680f86fd287f13 \ No newline at end of file diff --git a/ircbot/Documentation/Doxygen/html/graph_legend.png b/ircbot/Documentation/Doxygen/html/graph_legend.png new file mode 100644 index 0000000..0fc17f8 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/graph_legend.png differ diff --git a/ircbot/Documentation/Doxygen/html/hierarchy.html b/ircbot/Documentation/Doxygen/html/hierarchy.html new file mode 100644 index 0000000..c0d5963 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/hierarchy.html @@ -0,0 +1,96 @@ + + + + +ircbot: Hierarchie-Verzeichnis + + + + + + + + + +
+
+

Klassenhierarchie

+
+ + + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/index.html b/ircbot/Documentation/Doxygen/html/index.html new file mode 100644 index 0000000..cc894f3 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/index.html @@ -0,0 +1,66 @@ + + + + +ircbot: Hauptseite + + + + + + + + + +
+
+

ircbot Dokumentation

+
+
+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/inherits.html b/ircbot/Documentation/Doxygen/html/inherits.html new file mode 100644 index 0000000..01ae589 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/inherits.html @@ -0,0 +1,110 @@ + + + + +ircbot: Grafische Darstellung der Klassenhierarchie + + + + + + + + + +
+
+

Grafische Darstellung der Klassenhierarchie

+
+
+ +

gehe zur textbasierten Darstellung der Klassenhierarchie

+ + + + + + + + + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/installdox b/ircbot/Documentation/Doxygen/html/installdox new file mode 100755 index 0000000..2697a81 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/installdox @@ -0,0 +1,117 @@ +#!/usr/bin/perl + +%subst = ( ); +$quiet = 0; + +if (open(F,"search.cfg")) +{ + $_= ; s/[ \t\n]*$//g ; $subst{"_doc"} = $_; + $_= ; s/[ \t\n]*$//g ; $subst{"_cgi"} = $_; +} + +while ( @ARGV ) { + $_ = shift @ARGV; + if ( s/^-// ) { + if ( /^l(.*)/ ) { + $v = ($1 eq "") ? shift @ARGV : $1; + ($v =~ /\/$/) || ($v .= "/"); + $_ = $v; + if ( /(.+)\@(.+)/ ) { + if ( exists $subst{$1} ) { + $subst{$1} = $2; + } else { + print STDERR "Unknown tag file $1 given with option -l\n"; + &usage(); + } + } else { + print STDERR "Argument $_ is invalid for option -l\n"; + &usage(); + } + } + elsif ( /^q/ ) { + $quiet = 1; + } + elsif ( /^\?|^h/ ) { + &usage(); + } + else { + print STDERR "Illegal option -$_\n"; + &usage(); + } + } + else { + push (@files, $_ ); + } +} + +foreach $sub (keys %subst) +{ + if ( $subst{$sub} eq "" ) + { + print STDERR "No substitute given for tag file `$sub'\n"; + &usage(); + } + elsif ( ! $quiet && $sub ne "_doc" && $sub ne "_cgi" ) + { + print "Substituting $subst{$sub} for each occurrence of tag file $sub\n"; + } +} + +if ( ! @files ) { + if (opendir(D,".")) { + foreach $file ( readdir(D) ) { + $match = ".html"; + next if ( $file =~ /^\.\.?$/ ); + ($file =~ /$match/) && (push @files, $file); + ($file =~ "tree.js") && (push @files, $file); + } + closedir(D); + } +} + +if ( ! @files ) { + print STDERR "Warning: No input files given and none found!\n"; +} + +foreach $f (@files) +{ + if ( ! $quiet ) { + print "Editing: $f...\n"; + } + $oldf = $f; + $f .= ".bak"; + unless (rename $oldf,$f) { + print STDERR "Error: cannot rename file $oldf\n"; + exit 1; + } + if (open(F,"<$f")) { + unless (open(G,">$oldf")) { + print STDERR "Error: opening file $oldf for writing\n"; + exit 1; + } + if ($oldf ne "tree.js") { + while () { + s/doxygen\=\"([^ \"\:\t\>\<]*)\:([^ \"\t\>\<]*)\" (href|src)=\"\2/doxygen\=\"$1:$subst{$1}\" \3=\"$subst{$1}/g; + print G "$_"; + } + } + else { + while () { + s/\"([^ \"\:\t\>\<]*)\:([^ \"\t\>\<]*)\", \"\2/\"$1:$subst{$1}\" ,\"$subst{$1}/g; + print G "$_"; + } + } + } + else { + print STDERR "Warning file $f does not exist\n"; + } + unlink $f; +} + +sub usage { + print STDERR "Usage: installdox [options] [html-file [html-file ...]]\n"; + print STDERR "Options:\n"; + print STDERR " -l tagfile\@linkName tag file + URL or directory \n"; + print STDERR " -q Quiet mode\n\n"; + exit 1; +} diff --git a/ircbot/Documentation/Doxygen/html/namespaceClient.html b/ircbot/Documentation/Doxygen/html/namespaceClient.html new file mode 100644 index 0000000..388f099 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/namespaceClient.html @@ -0,0 +1,82 @@ + + + + +ircbot: Paket Client + + + + + + + + + +
+
+

Paket Client

+
+
+ +
+

Ausführliche Beschreibung

+

Abstract class that implements the basic api for any client.

+
Autor:
jpt
+

IrcClient class that contains all the Plugins

+
Autor:
jpt
+

Client_AbstractClient

+

This class contains the connection handler. It handles all the incoming and outgoing data by forwarding it to the clients for the specific connection.

+
Autor:
jpt
+

Connection

+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/namespaceConnection.html b/ircbot/Documentation/Doxygen/html/namespaceConnection.html new file mode 100644 index 0000000..f608f87 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/namespaceConnection.html @@ -0,0 +1,80 @@ + + + + +ircbot: Paket Connection + + + + + + + + + +
+
+

Paket Connection

+
+
+ +
+

Ausführliche Beschreibung

+

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.

+
Autor:
jpt
+

Socket Misc

+

Connection pool class. Contains the SocketPool.

+
Autor:
jpt
+

Socket

+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/namespaceException.html b/ircbot/Documentation/Doxygen/html/namespaceException.html new file mode 100644 index 0000000..978cca6 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/namespaceException.html @@ -0,0 +1,89 @@ + + + + +ircbot: Paket Exception + + + + + + + + + +
+
+

Paket Exception

+
+
+ +
+

Ausführliche Beschreibung

+

General exception class.

+
Autor:
jpt
+
Ausnahmebehandlung:
+ + +
 SocketException
+
+
+
Autor:
jpt
+
Ausnahmebehandlung:
+ + +
 
+
+
+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/namespaceMisc.html b/ircbot/Documentation/Doxygen/html/namespaceMisc.html new file mode 100644 index 0000000..92a539e --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/namespaceMisc.html @@ -0,0 +1,76 @@ + + + + +ircbot: Paket Misc + + + + + + + + + +
+
+

Paket Misc

+
+
+ +
+

Ausführliche Beschreibung

+

Buffer class for a string. Will fix issues with sockets that don't care about linebreaks. Can also be used for all kinds of purpose.

+
Autor:
jpt
+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/namespaceSocket.html b/ircbot/Documentation/Doxygen/html/namespaceSocket.html new file mode 100644 index 0000000..dca44b9 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/namespaceSocket.html @@ -0,0 +1,78 @@ + + + + +ircbot: Paket Socket + + + + + + + + + +
+
+

Paket Socket

+
+
+ +
+

Ausführliche Beschreibung

+

Socket handler class

+
Autor:
jpt
+

Socket pool class Manages a pool of socket ressources with socket_select()

+
Autor:
jpt
+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/namespaces.html b/ircbot/Documentation/Doxygen/html/namespaces.html new file mode 100644 index 0000000..34de053 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/namespaces.html @@ -0,0 +1,78 @@ + + + + +ircbot: Paketliste + + + + + + + + + +
+
+

Paketliste

+
+
+Hier folgen die Pakete mit einer Kurzbeschreibung (wenn verfügbar): + + + + + +
ClientAbstract class that implements the basic api for any client
ConnectionThis class is a decorator for the class SocketHandler
ExceptionGeneral exception class
MiscBuffer class for a string
SocketThe SocketHandler class will handle a single socket
+
+ + + + +
+ +
+ + + + diff --git a/ircbot/Documentation/Doxygen/html/nav_f.png b/ircbot/Documentation/Doxygen/html/nav_f.png new file mode 100644 index 0000000..1b07a16 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/nav_f.png differ diff --git a/ircbot/Documentation/Doxygen/html/nav_h.png b/ircbot/Documentation/Doxygen/html/nav_h.png new file mode 100644 index 0000000..01f5fa6 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/nav_h.png differ diff --git a/ircbot/Documentation/Doxygen/html/open.png b/ircbot/Documentation/Doxygen/html/open.png new file mode 100644 index 0000000..7b35d2c Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/open.png differ diff --git a/ircbot/Documentation/Doxygen/html/search/all_5f.html b/ircbot/Documentation/Doxygen/html/search/all_5f.html new file mode 100644 index 0000000..303d895 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_5f.html @@ -0,0 +1,54 @@ + + + + + + + +
+
Lade ...
+ + +
+
+ __toString + Exception_GeneralException +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_61.html b/ircbot/Documentation/Doxygen/html/search/all_61.html new file mode 100644 index 0000000..1a2fe8c --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_61.html @@ -0,0 +1,65 @@ + + + + + + + +
+
Lade ...
+ +
+
+ addClientForConnectionHandler + Client_ClientManager +
+
+
+
+ addConnectionHandler + Connection_ConnectionPool +
+
+
+
+ addData + Misc_Buffer +
+
+
+
+ addRawRouting + Client_ClientManager +
+
+
+
+ addSocket + Socket_SocketPool +
+
+
+
+ attachConfig + Client_ClientManager +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_62.html b/ircbot/Documentation/Doxygen/html/search/all_62.html new file mode 100644 index 0000000..675bf85 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_62.html @@ -0,0 +1,29 @@ + + + + + + + +
+
Lade ...
+ +
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_63.html b/ircbot/Documentation/Doxygen/html/search/all_63.html new file mode 100644 index 0000000..9719dea --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_63.html @@ -0,0 +1,126 @@ + + + + + + + +
+
Lade ...
+
+
+ canRead + Connection_ConnectionHandler +
+
+
+
+ canWrite + Connection_ConnectionHandler +
+
+
+
+ Client +
+
+ + + + + + +
+ +
+ + + +
+
+ countSockets + Socket_SocketPool +
+
+
+
+ createClientForProtocol + Client_ClientManager +
+
+ +
+
+ createTcpSocket + Socket_SocketPool +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_65.html b/ircbot/Documentation/Doxygen/html/search/all_65.html new file mode 100644 index 0000000..f44cb00 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_65.html @@ -0,0 +1,45 @@ + + + + + + + +
+
Lade ...
+
+
+ error + Socket_SocketHandler +
+
+
+ +
+ + +
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_66.html b/ircbot/Documentation/Doxygen/html/search/all_66.html new file mode 100644 index 0000000..6a4813b --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_66.html @@ -0,0 +1,25 @@ + + + + + + + +
+
Lade ...
+
+
+ Foo +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_67.html b/ircbot/Documentation/Doxygen/html/search/all_67.html new file mode 100644 index 0000000..1dba1a4 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_67.html @@ -0,0 +1,83 @@ + + + + + + + +
+
Lade ...
+
+
+ getConnectionHandlerForSocketRessource + Connection_ConnectionPool +
+
+
+
+ getGroup + Connection_ConnectionHandler +
+
+
+
+ getID + Connection_ConnectionHandler +
+
+ +
+
+ getNextLine + Misc_Buffer +
+
+
+
+ getProtocol + Connection_ConnectionHandler +
+
+ + +
+
+ getSocketHandler + Connection_ConnectionHandler +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_68.html b/ircbot/Documentation/Doxygen/html/search/all_68.html new file mode 100644 index 0000000..b35cf87 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_68.html @@ -0,0 +1,41 @@ + + + + + + + +
+
Lade ...
+
+
+ handleSocketError + Connection_ConnectionHandler +
+
+ +
+
+ hasLines + Misc_Buffer +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_69.html b/ircbot/Documentation/Doxygen/html/search/all_69.html new file mode 100644 index 0000000..882f485 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_69.html @@ -0,0 +1,50 @@ + + + + + + + +
+
Lade ...
+
+
+ injectClientManager + Client_AbstractClient +
+
+ + +
+
+ isServer + Connection_ConnectionHandler +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_6c.html b/ircbot/Documentation/Doxygen/html/search/all_6c.html new file mode 100644 index 0000000..082ab8f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_6c.html @@ -0,0 +1,39 @@ + + + + + + + +
+
Lade ...
+ + +
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_6d.html b/ircbot/Documentation/Doxygen/html/search/all_6d.html new file mode 100644 index 0000000..506f4fe --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_6d.html @@ -0,0 +1,30 @@ + + + + + + + +
+
Lade ...
+
+
+ Misc +
+
+
+ +
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_70.html b/ircbot/Documentation/Doxygen/html/search/all_70.html new file mode 100644 index 0000000..111cc50 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_70.html @@ -0,0 +1,36 @@ + + + + + + + +
+
Lade ...
+ +
+
+ pruneEmptyLines + Misc_Buffer +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_72.html b/ircbot/Documentation/Doxygen/html/search/all_72.html new file mode 100644 index 0000000..cb948c6 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_72.html @@ -0,0 +1,65 @@ + + + + + + + +
+
Lade ...
+ +
+
+ readToBuffer + Connection_ConnectionHandler +
+
+
+
+ registerProtocol + Client_ClientManager +
+
+
+
+ removeClientForConnectionHandler + Client_ClientManager +
+
+
+
+ removeConnection + Client_ClientManager +
+
+
+
+ removeConnectionHandler + Connection_ConnectionPool +
+
+
+
+ removeSocket + Socket_SocketPool +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_73.html b/ircbot/Documentation/Doxygen/html/search/all_73.html new file mode 100644 index 0000000..3b9fdaa --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_73.html @@ -0,0 +1,68 @@ + + + + + + + +
+
Lade ...
+ +
+
+ sendToGroup + Client_ClientManager +
+
+
+
+ sendToID + Client_ClientManager +
+
+
+
+ setGroup + Client_AbstractClient +
+
+
+
+ setID + Client_AbstractClient +
+
+
+
+ Socket +
+
+ + +
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_74.html b/ircbot/Documentation/Doxygen/html/search/all_74.html new file mode 100644 index 0000000..21c1a57 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_74.html @@ -0,0 +1,41 @@ + + + + + + + +
+
Lade ...
+ +
+ +
+ +
+
+ testfunctionWithCamelCase + TestClassForTestsWithReflection +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_75.html b/ircbot/Documentation/Doxygen/html/search/all_75.html new file mode 100644 index 0000000..5bffed5 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_75.html @@ -0,0 +1,26 @@ + + + + + + + +
+
Lade ...
+
+
+ unregisterProtocol + Client_ClientManager +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/all_77.html b/ircbot/Documentation/Doxygen/html/search/all_77.html new file mode 100644 index 0000000..a4ab7d0 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/all_77.html @@ -0,0 +1,53 @@ + + + + + + + +
+
Lade ...
+
+
+ work + Client_ClientManager +
+
+ +
+
+ writeFromBuffer + Connection_ConnectionHandler +
+
+
+
+ writeToGroup + Connection_ConnectionPool +
+
+
+
+ writeToID + Connection_ConnectionPool +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/classes_62.html b/ircbot/Documentation/Doxygen/html/search/classes_62.html new file mode 100644 index 0000000..dd8ae01 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/classes_62.html @@ -0,0 +1,25 @@ + + + + + + + +
+
Lade ...
+
+
+ Bar +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/classes_63.html b/ircbot/Documentation/Doxygen/html/search/classes_63.html new file mode 100644 index 0000000..c5d6a57 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/classes_63.html @@ -0,0 +1,50 @@ + + + + + + + +
+
Lade ...
+ + + + + + +
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/classes_65.html b/ircbot/Documentation/Doxygen/html/search/classes_65.html new file mode 100644 index 0000000..5353068 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/classes_65.html @@ -0,0 +1,35 @@ + + + + + + + +
+
Lade ...
+
+
+ Exception +
+
+ + +
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/classes_66.html b/ircbot/Documentation/Doxygen/html/search/classes_66.html new file mode 100644 index 0000000..6a4813b --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/classes_66.html @@ -0,0 +1,25 @@ + + + + + + + +
+
Lade ...
+
+
+ Foo +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/classes_6d.html b/ircbot/Documentation/Doxygen/html/search/classes_6d.html new file mode 100644 index 0000000..ff7f9d1 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/classes_6d.html @@ -0,0 +1,25 @@ + + + + + + + +
+
Lade ...
+
+ +
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/classes_73.html b/ircbot/Documentation/Doxygen/html/search/classes_73.html new file mode 100644 index 0000000..9d920ec --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/classes_73.html @@ -0,0 +1,30 @@ + + + + + + + +
+
Lade ...
+ + +
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/classes_74.html b/ircbot/Documentation/Doxygen/html/search/classes_74.html new file mode 100644 index 0000000..c82939d --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/classes_74.html @@ -0,0 +1,35 @@ + + + + + + + +
+
Lade ...
+ +
+ +
+ +
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/close.png b/ircbot/Documentation/Doxygen/html/search/close.png new file mode 100644 index 0000000..9342d3d Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/search/close.png differ diff --git a/ircbot/Documentation/Doxygen/html/search/functions_5f.html b/ircbot/Documentation/Doxygen/html/search/functions_5f.html new file mode 100644 index 0000000..303d895 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/functions_5f.html @@ -0,0 +1,54 @@ + + + + + + + +
+
Lade ...
+ + +
+
+ __toString + Exception_GeneralException +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/functions_61.html b/ircbot/Documentation/Doxygen/html/search/functions_61.html new file mode 100644 index 0000000..1a2fe8c --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/functions_61.html @@ -0,0 +1,65 @@ + + + + + + + +
+
Lade ...
+ +
+
+ addClientForConnectionHandler + Client_ClientManager +
+
+
+
+ addConnectionHandler + Connection_ConnectionPool +
+
+
+
+ addData + Misc_Buffer +
+
+
+
+ addRawRouting + Client_ClientManager +
+
+
+
+ addSocket + Socket_SocketPool +
+
+
+
+ attachConfig + Client_ClientManager +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/functions_62.html b/ircbot/Documentation/Doxygen/html/search/functions_62.html new file mode 100644 index 0000000..675bf85 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/functions_62.html @@ -0,0 +1,29 @@ + + + + + + + +
+
Lade ...
+ +
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/functions_63.html b/ircbot/Documentation/Doxygen/html/search/functions_63.html new file mode 100644 index 0000000..0bb4ac2 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/functions_63.html @@ -0,0 +1,86 @@ + + + + + + + +
+
Lade ...
+
+
+ canRead + Connection_ConnectionHandler +
+
+
+
+ canWrite + Connection_ConnectionHandler +
+
+ + + +
+
+ countSockets + Socket_SocketPool +
+
+
+
+ createClientForProtocol + Client_ClientManager +
+
+ +
+
+ createTcpSocket + Socket_SocketPool +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/functions_65.html b/ircbot/Documentation/Doxygen/html/search/functions_65.html new file mode 100644 index 0000000..2c54f44 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/functions_65.html @@ -0,0 +1,26 @@ + + + + + + + +
+
Lade ...
+
+
+ error + Socket_SocketHandler +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/functions_67.html b/ircbot/Documentation/Doxygen/html/search/functions_67.html new file mode 100644 index 0000000..1dba1a4 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/functions_67.html @@ -0,0 +1,83 @@ + + + + + + + +
+
Lade ...
+
+
+ getConnectionHandlerForSocketRessource + Connection_ConnectionPool +
+
+
+
+ getGroup + Connection_ConnectionHandler +
+
+
+
+ getID + Connection_ConnectionHandler +
+
+ +
+
+ getNextLine + Misc_Buffer +
+
+
+
+ getProtocol + Connection_ConnectionHandler +
+
+ + +
+
+ getSocketHandler + Connection_ConnectionHandler +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/functions_68.html b/ircbot/Documentation/Doxygen/html/search/functions_68.html new file mode 100644 index 0000000..b35cf87 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/functions_68.html @@ -0,0 +1,41 @@ + + + + + + + +
+
Lade ...
+
+
+ handleSocketError + Connection_ConnectionHandler +
+
+ +
+
+ hasLines + Misc_Buffer +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/functions_69.html b/ircbot/Documentation/Doxygen/html/search/functions_69.html new file mode 100644 index 0000000..882f485 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/functions_69.html @@ -0,0 +1,50 @@ + + + + + + + +
+
Lade ...
+
+
+ injectClientManager + Client_AbstractClient +
+
+ + +
+
+ isServer + Connection_ConnectionHandler +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/functions_6c.html b/ircbot/Documentation/Doxygen/html/search/functions_6c.html new file mode 100644 index 0000000..082ab8f --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/functions_6c.html @@ -0,0 +1,39 @@ + + + + + + + +
+
Lade ...
+ + +
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/functions_70.html b/ircbot/Documentation/Doxygen/html/search/functions_70.html new file mode 100644 index 0000000..111cc50 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/functions_70.html @@ -0,0 +1,36 @@ + + + + + + + +
+
Lade ...
+ +
+
+ pruneEmptyLines + Misc_Buffer +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/functions_72.html b/ircbot/Documentation/Doxygen/html/search/functions_72.html new file mode 100644 index 0000000..cb948c6 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/functions_72.html @@ -0,0 +1,65 @@ + + + + + + + +
+
Lade ...
+ +
+
+ readToBuffer + Connection_ConnectionHandler +
+
+
+
+ registerProtocol + Client_ClientManager +
+
+
+
+ removeClientForConnectionHandler + Client_ClientManager +
+
+
+
+ removeConnection + Client_ClientManager +
+
+
+
+ removeConnectionHandler + Connection_ConnectionPool +
+
+
+
+ removeSocket + Socket_SocketPool +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/functions_73.html b/ircbot/Documentation/Doxygen/html/search/functions_73.html new file mode 100644 index 0000000..60bfb59 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/functions_73.html @@ -0,0 +1,53 @@ + + + + + + + +
+
Lade ...
+ +
+
+ sendToGroup + Client_ClientManager +
+
+
+
+ sendToID + Client_ClientManager +
+
+
+
+ setGroup + Client_AbstractClient +
+
+
+
+ setID + Client_AbstractClient +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/functions_74.html b/ircbot/Documentation/Doxygen/html/search/functions_74.html new file mode 100644 index 0000000..94a4832 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/functions_74.html @@ -0,0 +1,26 @@ + + + + + + + +
+
Lade ...
+
+
+ testfunctionWithCamelCase + TestClassForTestsWithReflection +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/functions_75.html b/ircbot/Documentation/Doxygen/html/search/functions_75.html new file mode 100644 index 0000000..5bffed5 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/functions_75.html @@ -0,0 +1,26 @@ + + + + + + + +
+
Lade ...
+
+
+ unregisterProtocol + Client_ClientManager +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/functions_77.html b/ircbot/Documentation/Doxygen/html/search/functions_77.html new file mode 100644 index 0000000..a4ab7d0 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/functions_77.html @@ -0,0 +1,53 @@ + + + + + + + +
+
Lade ...
+
+
+ work + Client_ClientManager +
+
+ +
+
+ writeFromBuffer + Connection_ConnectionHandler +
+
+
+
+ writeToGroup + Connection_ConnectionPool +
+
+
+
+ writeToID + Connection_ConnectionPool +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/mag_sel.png b/ircbot/Documentation/Doxygen/html/search/mag_sel.png new file mode 100644 index 0000000..81f6040 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/search/mag_sel.png differ diff --git a/ircbot/Documentation/Doxygen/html/search/namespaces_63.html b/ircbot/Documentation/Doxygen/html/search/namespaces_63.html new file mode 100644 index 0000000..b2c6bd5 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/namespaces_63.html @@ -0,0 +1,30 @@ + + + + + + + +
+
Lade ...
+
+
+ Client +
+
+
+ +
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/namespaces_65.html b/ircbot/Documentation/Doxygen/html/search/namespaces_65.html new file mode 100644 index 0000000..f5004d8 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/namespaces_65.html @@ -0,0 +1,25 @@ + + + + + + + +
+
Lade ...
+
+
+ Exception +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/namespaces_6d.html b/ircbot/Documentation/Doxygen/html/search/namespaces_6d.html new file mode 100644 index 0000000..84630a8 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/namespaces_6d.html @@ -0,0 +1,25 @@ + + + + + + + +
+
Lade ...
+
+
+ Misc +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/namespaces_73.html b/ircbot/Documentation/Doxygen/html/search/namespaces_73.html new file mode 100644 index 0000000..bcea1fb --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/namespaces_73.html @@ -0,0 +1,25 @@ + + + + + + + +
+
Lade ...
+
+
+ Socket +
+
+
Suche ...
+
Keine Treffer
+ +
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/nomatches.html b/ircbot/Documentation/Doxygen/html/search/nomatches.html new file mode 100644 index 0000000..91f177d --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/nomatches.html @@ -0,0 +1,12 @@ + + + + + + + +
+
Keine Treffer
+
+ + diff --git a/ircbot/Documentation/Doxygen/html/search/search.css b/ircbot/Documentation/Doxygen/html/search/search.css new file mode 100644 index 0000000..50249e5 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/search.css @@ -0,0 +1,240 @@ +/*---------------- Search Box */ + +#FSearchBox { + float: left; +} + +#searchli { + float: right; + display: block; + width: 170px; + height: 36px; +} + +#MSearchBox { + white-space : nowrap; + position: absolute; + float: none; + display: inline; + margin-top: 8px; + right: 0px; + width: 170px; + z-index: 102; +} + +#MSearchBox .left +{ + display:block; + position:absolute; + left:10px; + width:20px; + height:19px; + background:url('search_l.png') no-repeat; + background-position:right; +} + +#MSearchSelect { + display:block; + position:absolute; + width:20px; + height:19px; +} + +.left #MSearchSelect { + left:4px; +} + +.right #MSearchSelect { + right:5px; +} + +#MSearchField { + display:block; + position:absolute; + height:19px; + background:url('search_m.png') repeat-x; + border:none; + width:116px; + margin-left:20px; + padding-left:4px; + color: #909090; + outline: none; + font: 9pt Arial, Verdana, sans-serif; +} + +#FSearchBox #MSearchField { + margin-left:15px; +} + +#MSearchBox .right { + display:block; + position:absolute; + right:10px; + top:0px; + width:20px; + height:19px; + background:url('search_r.png') no-repeat; + background-position:left; +} + +#MSearchClose { + display: none; + position: absolute; + top: 4px; + background : none; + border: none; + margin: 0px 4px 0px 0px; + padding: 0px 0px; + outline: none; +} + +.left #MSearchClose { + left: 6px; +} + +.right #MSearchClose { + right: 2px; +} + +.MSearchBoxActive #MSearchField { + color: #000000; +} + +/*---------------- Search filter selection */ + +#MSearchSelectWindow { + display: none; + position: absolute; + left: 0; top: 0; + border: 1px solid #90A5CE; + background-color: #F9FAFC; + z-index: 1; + padding-top: 4px; + padding-bottom: 4px; + -moz-border-radius: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +.SelectItem { + font: 8pt Arial, Verdana, sans-serif; + padding-left: 2px; + padding-right: 12px; + border: 0px; +} + +span.SelectionMark { + margin-right: 4px; + font-family: monospace; + outline-style: none; + text-decoration: none; +} + +a.SelectItem { + display: block; + outline-style: none; + color: #000000; + text-decoration: none; + padding-left: 6px; + padding-right: 12px; +} + +a.SelectItem:focus, +a.SelectItem:active { + color: #000000; + outline-style: none; + text-decoration: none; +} + +a.SelectItem:hover { + color: #FFFFFF; + background-color: #3D578C; + outline-style: none; + text-decoration: none; + cursor: pointer; + display: block; +} + +/*---------------- Search results window */ + +iframe#MSearchResults { + width: 60ex; + height: 15em; +} + +#MSearchResultsWindow { + display: none; + position: absolute; + left: 0; top: 0; + border: 1px solid #000; + background-color: #EEF1F7; +} + +/* ----------------------------------- */ + + +#SRIndex { + clear:both; + padding-bottom: 15px; +} + +.SREntry { + font-size: 10pt; + padding-left: 1ex; +} + +.SRPage .SREntry { + font-size: 8pt; + padding: 1px 5px; +} + +body.SRPage { + margin: 5px 2px; +} + +.SRChildren { + padding-left: 3ex; padding-bottom: .5em +} + +.SRPage .SRChildren { + display: none; +} + +.SRSymbol { + font-weight: bold; + color: #425E97; + font-family: Arial, Verdana, sans-serif; + text-decoration: none; + outline: none; +} + +a.SRScope { + display: block; + color: #425E97; + font-family: Arial, Verdana, sans-serif; + text-decoration: none; + outline: none; +} + +a.SRSymbol:focus, a.SRSymbol:active, +a.SRScope:focus, a.SRScope:active { + text-decoration: underline; +} + +.SRPage .SRStatus { + padding: 2px 5px; + font-size: 8pt; + font-style: italic; +} + +.SRResult { + display: none; +} + +DIV.searchresults { + margin-left: 10px; + margin-right: 10px; +} diff --git a/ircbot/Documentation/Doxygen/html/search/search.js b/ircbot/Documentation/Doxygen/html/search/search.js new file mode 100644 index 0000000..f6ffb5b --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/search/search.js @@ -0,0 +1,732 @@ +// Search script generated by doxygen +// Copyright (C) 2009 by Dimitri van Heesch. + +// The code in this file is loosly based on main.js, part of Natural Docs, +// which is Copyright (C) 2003-2008 Greg Valure +// Natural Docs is licensed under the GPL. + +var indexSectionsWithContent = +{ + 0: "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010111010111001100101101010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + 1: "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001010000000100000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + 2: "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001010000000100000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + 3: "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010111010111001000101101010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" +}; + +var indexSectionNames = +{ + 0: "all", + 1: "classes", + 2: "namespaces", + 3: "functions" +}; + +function convertToId(search) +{ + var result = ''; + for (i=0;i do a search + { + this.Search(); + } + } + + this.OnSearchSelectKey = function(evt) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==40 && this.searchIndex0) // Up + { + this.searchIndex--; + this.OnSelectItem(this.searchIndex); + } + else if (e.keyCode==13 || e.keyCode==27) + { + this.OnSelectItem(this.searchIndex); + this.CloseSelectionWindow(); + this.DOMSearchField().focus(); + } + return false; + } + + // --------- Actions + + // Closes the results window. + this.CloseResultsWindow = function() + { + this.DOMPopupSearchResultsWindow().style.display = 'none'; + this.DOMSearchClose().style.display = 'none'; + this.Activate(false); + } + + this.CloseSelectionWindow = function() + { + this.DOMSearchSelectWindow().style.display = 'none'; + } + + // Performs a search. + this.Search = function() + { + this.keyTimeout = 0; + + // strip leading whitespace + var searchValue = this.DOMSearchField().value.replace(/^ +/, ""); + + var code = searchValue.toLowerCase().charCodeAt(0); + var hexCode; + if (code<16) + { + hexCode="0"+code.toString(16); + } + else + { + hexCode=code.toString(16); + } + + var resultsPage; + var resultsPageWithSearch; + var hasResultsPage; + + if (indexSectionsWithContent[this.searchIndex].charAt(code) == '1') + { + resultsPage = this.resultsPath + '/' + indexSectionNames[this.searchIndex] + '_' + hexCode + '.html'; + resultsPageWithSearch = resultsPage+'?'+escape(searchValue); + hasResultsPage = true; + } + else // nothing available for this search term + { + resultsPage = this.resultsPath + '/nomatches.html'; + resultsPageWithSearch = resultsPage; + hasResultsPage = false; + } + + window.frames.MSearchResults.location.href = resultsPageWithSearch; + var domPopupSearchResultsWindow = this.DOMPopupSearchResultsWindow(); + + if (domPopupSearchResultsWindow.style.display!='block') + { + var domSearchBox = this.DOMSearchBox(); + this.DOMSearchClose().style.display = 'inline'; + if (this.insideFrame) + { + var domPopupSearchResults = this.DOMPopupSearchResults(); + domPopupSearchResultsWindow.style.position = 'relative'; + domPopupSearchResultsWindow.style.display = 'block'; + var width = document.body.clientWidth - 8; // the -8 is for IE :-( + domPopupSearchResultsWindow.style.width = width + 'px'; + domPopupSearchResults.style.width = width + 'px'; + } + else + { + var domPopupSearchResults = this.DOMPopupSearchResults(); + var left = getXPos(domSearchBox) + 150; // domSearchBox.offsetWidth; + var top = getYPos(domSearchBox) + 20; // domSearchBox.offsetHeight + 1; + domPopupSearchResultsWindow.style.display = 'block'; + left -= domPopupSearchResults.offsetWidth; + domPopupSearchResultsWindow.style.top = top + 'px'; + domPopupSearchResultsWindow.style.left = left + 'px'; + } + } + + this.lastSearchValue = searchValue; + this.lastResultsPage = resultsPage; + } + + // -------- Activation Functions + + // Activates or deactivates the search panel, resetting things to + // their default values if necessary. + this.Activate = function(isActive) + { + if (isActive || // open it + this.DOMPopupSearchResultsWindow().style.display == 'block' + ) + { + this.DOMSearchBox().className = 'MSearchBoxActive'; + + var searchField = this.DOMSearchField(); + + if (searchField.value == this.searchLabel) // clear "Search" term upon entry + { + searchField.value = ''; + this.searchActive = true; + } + } + else if (!isActive) // directly remove the panel + { + this.DOMSearchBox().className = 'MSearchBoxInactive'; + this.DOMSearchField().value = this.searchLabel; + this.searchActive = false; + this.lastSearchValue = '' + this.lastResultsPage = ''; + } + } +} + +// ----------------------------------------------------------------------- + +// The class that handles everything on the search results page. +function SearchResults(name) +{ + // The number of matches from the last run of . + this.lastMatchCount = 0; + this.lastKey = 0; + this.repeatOn = false; + + // Toggles the visibility of the passed element ID. + this.FindChildElement = function(id) + { + var parentElement = document.getElementById(id); + var element = parentElement.firstChild; + + while (element && element!=parentElement) + { + if (element.nodeName == 'DIV' && element.className == 'SRChildren') + { + return element; + } + + if (element.nodeName == 'DIV' && element.hasChildNodes()) + { + element = element.firstChild; + } + else if (element.nextSibling) + { + element = element.nextSibling; + } + else + { + do + { + element = element.parentNode; + } + while (element && element!=parentElement && !element.nextSibling); + + if (element && element!=parentElement) + { + element = element.nextSibling; + } + } + } + } + + this.Toggle = function(id) + { + var element = this.FindChildElement(id); + if (element) + { + if (element.style.display == 'block') + { + element.style.display = 'none'; + } + else + { + element.style.display = 'block'; + } + } + } + + // Searches for the passed string. If there is no parameter, + // it takes it from the URL query. + // + // Always returns true, since other documents may try to call it + // and that may or may not be possible. + this.Search = function(search) + { + if (!search) // get search word from URL + { + search = window.location.search; + search = search.substring(1); // Remove the leading '?' + search = unescape(search); + } + + search = search.replace(/^ +/, ""); // strip leading spaces + search = search.replace(/ +$/, ""); // strip trailing spaces + search = search.toLowerCase(); + search = convertToId(search); + + var resultRows = document.getElementsByTagName("div"); + var matches = 0; + + var i = 0; + while (i < resultRows.length) + { + var row = resultRows.item(i); + if (row.className == "SRResult") + { + var rowMatchName = row.id.toLowerCase(); + rowMatchName = rowMatchName.replace(/^sr\d*_/, ''); // strip 'sr123_' + + if (search.length<=rowMatchName.length && + rowMatchName.substr(0, search.length)==search) + { + row.style.display = 'block'; + matches++; + } + else + { + row.style.display = 'none'; + } + } + i++; + } + document.getElementById("Searching").style.display='none'; + if (matches == 0) // no results + { + document.getElementById("NoMatches").style.display='block'; + } + else // at least one result + { + document.getElementById("NoMatches").style.display='none'; + } + this.lastMatchCount = matches; + return true; + } + + // return the first item with index index or higher that is visible + this.NavNext = function(index) + { + var focusItem; + while (1) + { + var focusName = 'Item'+index; + focusItem = document.getElementById(focusName); + if (focusItem && focusItem.parentNode.parentNode.style.display=='block') + { + break; + } + else if (!focusItem) // last element + { + break; + } + focusItem=null; + index++; + } + return focusItem; + } + + this.NavPrev = function(index) + { + var focusItem; + while (1) + { + var focusName = 'Item'+index; + focusItem = document.getElementById(focusName); + if (focusItem && focusItem.parentNode.parentNode.style.display=='block') + { + break; + } + else if (!focusItem) // last element + { + break; + } + focusItem=null; + index--; + } + return focusItem; + } + + this.ProcessKeys = function(e) + { + if (e.type == "keydown") + { + this.repeatOn = false; + this.lastKey = e.keyCode; + } + else if (e.type == "keypress") + { + if (!this.repeatOn) + { + if (this.lastKey) this.repeatOn = true; + return false; // ignore first keypress after keydown + } + } + else if (e.type == "keyup") + { + this.lastKey = 0; + this.repeatOn = false; + } + return this.lastKey!=0; + } + + this.Nav = function(evt,itemIndex) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==13) return true; + if (!this.ProcessKeys(e)) return false; + + if (this.lastKey==38) // Up + { + var newIndex = itemIndex-1; + var focusItem = this.NavPrev(newIndex); + if (focusItem) + { + var child = this.FindChildElement(focusItem.parentNode.parentNode.id); + if (child && child.style.display == 'block') // children visible + { + var n=0; + var tmpElem; + while (1) // search for last child + { + tmpElem = document.getElementById('Item'+newIndex+'_c'+n); + if (tmpElem) + { + focusItem = tmpElem; + } + else // found it! + { + break; + } + n++; + } + } + } + if (focusItem) + { + focusItem.focus(); + } + else // return focus to search field + { + parent.document.getElementById("MSearchField").focus(); + } + } + else if (this.lastKey==40) // Down + { + var newIndex = itemIndex+1; + var focusItem; + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem && elem.style.display == 'block') // children visible + { + focusItem = document.getElementById('Item'+itemIndex+'_c0'); + } + if (!focusItem) focusItem = this.NavNext(newIndex); + if (focusItem) focusItem.focus(); + } + else if (this.lastKey==39) // Right + { + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem) elem.style.display = 'block'; + } + else if (this.lastKey==37) // Left + { + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem) elem.style.display = 'none'; + } + else if (this.lastKey==27) // Escape + { + parent.searchBox.CloseResultsWindow(); + parent.document.getElementById("MSearchField").focus(); + } + else if (this.lastKey==13) // Enter + { + return true; + } + return false; + } + + this.NavChild = function(evt,itemIndex,childIndex) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==13) return true; + if (!this.ProcessKeys(e)) return false; + + if (this.lastKey==38) // Up + { + if (childIndex>0) + { + var newIndex = childIndex-1; + document.getElementById('Item'+itemIndex+'_c'+newIndex).focus(); + } + else // already at first child, jump to parent + { + document.getElementById('Item'+itemIndex).focus(); + } + } + else if (this.lastKey==40) // Down + { + var newIndex = childIndex+1; + var elem = document.getElementById('Item'+itemIndex+'_c'+newIndex); + if (!elem) // last child, jump to parent next parent + { + elem = this.NavNext(itemIndex+1); + } + if (elem) + { + elem.focus(); + } + } + else if (this.lastKey==27) // Escape + { + parent.searchBox.CloseResultsWindow(); + parent.document.getElementById("MSearchField").focus(); + } + else if (this.lastKey==13) // Enter + { + return true; + } + return false; + } +} diff --git a/ircbot/Documentation/Doxygen/html/search/search_l.png b/ircbot/Documentation/Doxygen/html/search/search_l.png new file mode 100644 index 0000000..c872f4d Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/search/search_l.png differ diff --git a/ircbot/Documentation/Doxygen/html/search/search_m.png b/ircbot/Documentation/Doxygen/html/search/search_m.png new file mode 100644 index 0000000..b429a16 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/search/search_m.png differ diff --git a/ircbot/Documentation/Doxygen/html/search/search_r.png b/ircbot/Documentation/Doxygen/html/search/search_r.png new file mode 100644 index 0000000..97ee8b4 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/search/search_r.png differ diff --git a/ircbot/Documentation/Doxygen/html/tab_a.png b/ircbot/Documentation/Doxygen/html/tab_a.png new file mode 100644 index 0000000..2d99ef2 Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/tab_a.png differ diff --git a/ircbot/Documentation/Doxygen/html/tab_b.png b/ircbot/Documentation/Doxygen/html/tab_b.png new file mode 100644 index 0000000..b2c3d2b Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/tab_b.png differ diff --git a/ircbot/Documentation/Doxygen/html/tab_h.png b/ircbot/Documentation/Doxygen/html/tab_h.png new file mode 100644 index 0000000..c11f48f Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/tab_h.png differ diff --git a/ircbot/Documentation/Doxygen/html/tab_s.png b/ircbot/Documentation/Doxygen/html/tab_s.png new file mode 100644 index 0000000..978943a Binary files /dev/null and b/ircbot/Documentation/Doxygen/html/tab_s.png differ diff --git a/ircbot/Documentation/Doxygen/html/tabs.css b/ircbot/Documentation/Doxygen/html/tabs.css new file mode 100644 index 0000000..2192056 --- /dev/null +++ b/ircbot/Documentation/Doxygen/html/tabs.css @@ -0,0 +1,59 @@ +.tabs, .tabs2, .tabs3 { + background-image: url('tab_b.png'); + width: 100%; + z-index: 101; + font-size: 13px; +} + +.tabs2 { + font-size: 10px; +} +.tabs3 { + font-size: 9px; +} + +.tablist { + margin: 0; + padding: 0; + display: table; +} + +.tablist li { + float: left; + display: table-cell; + background-image: url('tab_b.png'); + line-height: 36px; + list-style: none; +} + +.tablist a { + display: block; + padding: 0 20px; + font-weight: bold; + background-image:url('tab_s.png'); + background-repeat:no-repeat; + background-position:right; + color: #283A5D; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + text-decoration: none; + outline: none; +} + +.tabs3 .tablist a { + padding: 0 10px; +} + +.tablist a:hover { + background-image: url('tab_h.png'); + background-repeat:repeat-x; + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); + text-decoration: none; +} + +.tablist li.current a { + background-image: url('tab_a.png'); + background-repeat:repeat-x; + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +} diff --git a/ircbot/Doxyfile b/ircbot/Doxyfile new file mode 100644 index 0000000..db660a3 --- /dev/null +++ b/ircbot/Doxyfile @@ -0,0 +1,1630 @@ +# Doxyfile 1.7.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = ircbot + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = Documentation/Doxygen/ + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = YES + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = German + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = YES + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = YES + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = YES + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this +# tag. The format is ext=language, where ext is a file extension, and language +# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penality. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will rougly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. The create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = */Testcode/* + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = NO + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. +# Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the stylesheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = YES + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list. + +USE_INLINE_TREES = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvances is that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = NO + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = YES + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans.ttf + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = NO + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = YES + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = YES + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = YES + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = YES + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = YES + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES diff --git a/ircbot/Main.php b/ircbot/Main.php new file mode 100644 index 0000000..8f3723d --- /dev/null +++ b/ircbot/Main.php @@ -0,0 +1,12 @@ + \ No newline at end of file diff --git a/ircbot/TODO b/ircbot/TODO new file mode 100644 index 0000000..e92d6a7 --- /dev/null +++ b/ircbot/TODO @@ -0,0 +1,18 @@ +################################### +# Geplant sind folgende Konzepte: # +################################### +- eval("class foobar {}") in einem funktions-kontext +- Plugins via foreach($plugins AS $plugin) { $plugin->work(); } laufen lassen +- +- Logging auf Verbindungs/Channel und Verbindung/Query-Basis für IRC. +- RAW-Logging für den Rest? + +- Settings?! + +" I'll ask Lucene about that ;-)" + + +- Logging mit Timestamp für: +- Sollte das Teil mal abkacken, so will ich zumindest über Verbindungsabbrüche, + Disconnects und Protokollseitige Quits, X-Lines und Errors einen Nachweis haben. +- Auch php-errors sollten in einem logfile landen. \ No newline at end of file diff --git a/ircbot/Testcode/Client/ClientManagerTest.php b/ircbot/Testcode/Client/ClientManagerTest.php new file mode 100644 index 0000000..44dde73 --- /dev/null +++ b/ircbot/Testcode/Client/ClientManagerTest.php @@ -0,0 +1,40 @@ +registerProtocol("irc", "Client_IrcClient"); +$clientManager->registerProtocol("jpt", "Client_BotClient"); + +$freenode = $clientManager->createTcpConnection("freenode", "irc"); +$clientManager->attachConfig(array( + "nick" => "Testinstanz", + "userident" => "uzuguck", + "channels" => array("#mstasty") +), $freenode); +$freenode->connect("irc.freenode.net", 6667); + +$freenode = $clientManager->createTcpConnection("freenode", "irc"); +$clientManager->attachConfig(array( + "nick" => "Testinstanz2", + "userident" => "uzuguck", + "channels" => array("#mstasty") +), $freenode); +$freenode->connect("irc.freenode.net", 6667); + + +/*$config_eloxoph = array( + "nick" => "Frischmilch", + "userident" => "olefolol", + "channels" => array("#eloxoph") +); + +$eloxoph = $clientManager->createTcpConnection("eloxoph", "irc"); +$clientManager->attachConfig($config_eloxoph, $eloxoph); +$eloxoph->connect("irc.eloxoph.com", 6667);*/ + +$srv = $clientManager->createTcpConnection("srv", "jpt"); +$srv->bind("localhost", 7777); +$srv->listen(); + +while($clientManager->countConnections() > 0) { + $clientManager->work(); +} +?> \ No newline at end of file diff --git a/ircbot/Testcode/Connection/IrcClientTest.php b/ircbot/Testcode/Connection/IrcClientTest.php new file mode 100644 index 0000000..9c640da --- /dev/null +++ b/ircbot/Testcode/Connection/IrcClientTest.php @@ -0,0 +1,39 @@ +createTcpConnection("raw_input"); +$srv->bind("localhost", 7777); +$srv->listen(); + +$sock = $pool->createTcpConnection("freenode"); +$sock->bind("192.168.0.101", 5456); +$sock->connect("irc.freenode.net", 6667); +$got_001 = FALSE; +$lines = 0; +$i = 0; +$authed = FALSE; +$joined = FALSE; +while(TRUE) { + $select = $pool->select(); + + while($read = $sock->read()) { + $pool->writeToGroup("raw_input", $read); + if(preg_match("/001/", $read)) $got_001 = TRUE; + $lines++; + } + + if(!$authed && $lines > 1) { + $sock->write("USER as as as :Asdfg\r\n"); + $sock->write("NICK :phptbt42\r\n"); + $authed = TRUE; + } + if($got_001 && !$joined) { + $joined = TRUE; + $sock->write("JOIN #mstasty\r\n"); + //$sock->write("PRIVMSG #mstasty :SocketTest abgeschlossen!\r\n"); + } + + echo $i++ . " ---\n"; +} + +?> \ No newline at end of file diff --git a/ircbot/Testcode/Misc/Exceptions.php b/ircbot/Testcode/Misc/Exceptions.php new file mode 100644 index 0000000..30c4f9c --- /dev/null +++ b/ircbot/Testcode/Misc/Exceptions.php @@ -0,0 +1,61 @@ +message = $message; + } + +} + +class TestFailException extends Exception { + + function __construct($msg) { + $this->message = "Error: ".$msg; + } + +} + +class Service_ExceptionTest { + + function __construct() { + + } + + public function TestTheFail() { + $this->failAtThis(); + } + + public function CatchAndThrow() { + try { + $this->failAtThis(); + } + catch (Exception $e) { + throw new TestFailException("moep:D"); + } + } + + + public function internalCatch() { + try { + $this->failAtThis(); + } + catch (Exception $e) { + var_dump($e); + } + } + + function failAtThis() { + throw new TestException("I had to do this. Please forgive me :/"); + } + +} + + +try { + $ExceptionTest = new Service_ExceptionTest; + $ExceptionTest->CatchAndThrow(); +} catch (Exception $e){ + var_dump($e); +} +?> \ No newline at end of file diff --git a/ircbot/Testcode/Misc/ReferenceTest.php b/ircbot/Testcode/Misc/ReferenceTest.php new file mode 100644 index 0000000..bcd4be4 --- /dev/null +++ b/ircbot/Testcode/Misc/ReferenceTest.php @@ -0,0 +1,79 @@ +pool = array(); + } + + /** + * Adds an Instance of Bar to the Pool. + * @param Bar $bar + * @return void + */ + public function addBar($bar) { + array_push($this->pool, $bar); + } + + /** + * Returns the internal instance of Bar for the specific ID. + * @param int $id + * @return Bar + */ + public function getBar($id) { + return $this->pool[$id]; + } + + + + /** + * Outputs the current state of the bars in the pool. + * @return void + */ + public function getTestResult() { + foreach($this->pool AS $id=>$bar) { + echo "ID: " . $id . ", Test: " . $bar->test . "\n"; + } + } +} + +/** + * Testclass #2 + * @author jpt + */ +class Bar { + /** + * @var string Teststring. + */ + public $test; + + /** + * Default constructor. Initializes test variable. + * @return void + */ + function __construct() { + $this->test = "failed"; + } +} + + +$f = new Foo(); + +$f->addBar(new Bar()); +$f->addBar(new Bar()); +$f->addBar(new Bar()); +$f->addBar(new Bar()); + +$f->getBar(1)->test = "success"; + +$f->getTestResult(); + + +?> \ No newline at end of file diff --git a/ircbot/Testcode/Misc/Reflection.php b/ircbot/Testcode/Misc/Reflection.php new file mode 100644 index 0000000..9fb1d9f --- /dev/null +++ b/ircbot/Testcode/Misc/Reflection.php @@ -0,0 +1,67 @@ +getName(); + } + + /** + * Tests the getDocComment() method + * + * @param array $ray + * @param int $zero + * @return string + * @specialtag + */ + protected function testfunctionWithCamelCase(array $ray, $zero = 0) { + return "bla"; + } +} + +//TestClassForTestsWithReflection ends here. + + //create ReflectionClass +$class = new ReflectionClass("TestClassForTestsWithReflection"); + + //print class name +echo "Information about: " . $class->name . "\n"; + + //getDocs for all methods +foreach($class->getMethods() as $key=>$method) { + var_dump($method->name, $method->getDocComment()); + echo "\n"; +} + + //getDocs for all properties +foreach($class->getProperties() as $key=>$property) { + var_dump($property->name, $property->getDocComment()); + echo "\n"; +} + +?> \ No newline at end of file diff --git a/ircbot/Testcode/WHATS_THIS b/ircbot/Testcode/WHATS_THIS new file mode 100644 index 0000000..066a917 --- /dev/null +++ b/ircbot/Testcode/WHATS_THIS @@ -0,0 +1,2 @@ +All the code in this directory is for testing only. +Just to make that clear ;-) \ No newline at end of file diff --git a/ircbot/start.sh b/ircbot/start.sh new file mode 100755 index 0000000..396eb9e --- /dev/null +++ b/ircbot/start.sh @@ -0,0 +1 @@ +clear && php Main.php \ No newline at end of file diff --git a/ircbot/update-docs.sh b/ircbot/update-docs.sh new file mode 100755 index 0000000..a761032 --- /dev/null +++ b/ircbot/update-docs.sh @@ -0,0 +1 @@ +doxygen \ No newline at end of file