Files
ircbot/ircbot/Documentation/Doxygen/html/ConnectionPool_8php_source.html
T
2010-11-21 22:37:10 +00:00

253 lines
23 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ircbot: Classes/Connection/ConnectionPool.php Quellcode</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Erzeugt von Doxygen 1.7.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Suchen');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Hauptseite</span></a></li>
<li><a href="namespaces.html"><span>Pakete</span></a></li>
<li><a href="annotated.html"><span>Klassen</span></a></li>
<li class="current"><a href="files.html"><span>Dateien</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Suchen" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>Auflistung&nbsp;der&nbsp;Dateien</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>Classes/Connection/ConnectionPool.php</h1> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 &lt;?php<span class="comment"></span>
<a name="l00002"></a>00002 <span class="comment">/**</span>
<a name="l00003"></a>00003 <span class="comment"> * Connection pool class. Contains the SocketPool.</span>
<a name="l00004"></a>00004 <span class="comment"> * @author jpt</span>
<a name="l00005"></a>00005 <span class="comment"> * @package Connection</span>
<a name="l00006"></a>00006 <span class="comment"> * @depends Socket</span>
<a name="l00007"></a>00007 <span class="comment"> */</span>
<a name="l00008"></a><a class="code" href="classConnection__ConnectionPool.html">00008</a> <span class="keyword">class </span><a class="code" href="classConnection__ConnectionPool.html">Connection_ConnectionPool</a> {
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> /**</span>
<a name="l00011"></a>00011 <span class="comment"> * SocketPool instance.</span>
<a name="l00012"></a>00012 <span class="comment"> * @var Socket_SocketPool</span>
<a name="l00013"></a>00013 <span class="comment"> */</span>
<a name="l00014"></a>00014 <span class="keyword">protected</span> $socketPool;
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment"> /**</span>
<a name="l00017"></a>00017 <span class="comment"> * Contains all ConnectionHandler instances.</span>
<a name="l00018"></a>00018 <span class="comment"> * @var array</span>
<a name="l00019"></a>00019 <span class="comment"> */</span>
<a name="l00020"></a>00020 <span class="keyword">protected</span> $connectionHandlers;
<a name="l00021"></a>00021 <span class="comment"></span>
<a name="l00022"></a>00022 <span class="comment"> /**</span>
<a name="l00023"></a>00023 <span class="comment"> * @var int Next ID for a new ConnectionHandler</span>
<a name="l00024"></a>00024 <span class="comment"> */</span>
<a name="l00025"></a>00025 <span class="keyword">protected</span> $nextID;
<a name="l00026"></a>00026 <span class="comment"></span>
<a name="l00027"></a>00027 <span class="comment"> /**</span>
<a name="l00028"></a>00028 <span class="comment"> * Creates an Instance of SocketPool</span>
<a name="l00029"></a>00029 <span class="comment"> * @return void</span>
<a name="l00030"></a>00030 <span class="comment"> */</span>
<a name="l00031"></a><a class="code" href="classConnection__ConnectionPool.html#a20d464a86c35bc4eade65b92c97cb857">00031</a> function <a class="code" href="classConnection__ConnectionPool.html#a20d464a86c35bc4eade65b92c97cb857">__construct</a>($linebreak = <span class="stringliteral">&quot;\r\n&quot;</span>) {
<a name="l00032"></a>00032 $this-&gt;connectionHandlers = array();
<a name="l00033"></a>00033 $this-&gt;socketPool = <span class="keyword">new</span> <a class="code" href="classSocket__SocketPool.html">Socket_SocketPool</a>($linebreak);
<a name="l00034"></a>00034 $this-&gt;nextID = 1;
<a name="l00035"></a>00035 }
<a name="l00036"></a>00036 <span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment"> /**</span>
<a name="l00038"></a>00038 <span class="comment"> * Destroys the SocketPool</span>
<a name="l00039"></a>00039 <span class="comment"> * @return void</span>
<a name="l00040"></a>00040 <span class="comment"> */</span>
<a name="l00041"></a><a class="code" href="classConnection__ConnectionPool.html#a6b84ab619a94dde92c963c2800cad8d7">00041</a> function <a class="code" href="classConnection__ConnectionPool.html#a6b84ab619a94dde92c963c2800cad8d7">__destruct</a>() {
<a name="l00042"></a>00042 unset($this-&gt;socketPool);
<a name="l00043"></a>00043 }
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment"> /**</span>
<a name="l00046"></a>00046 <span class="comment"> * Creates a new TcpConnection.</span>
<a name="l00047"></a>00047 <span class="comment"> * @param boolean $IPv6 will determine whether the socket uses IPv4 or IPv6.</span>
<a name="l00048"></a>00048 <span class="comment"> * @return Connection_ConnectionHandler</span>
<a name="l00049"></a>00049 <span class="comment"> */</span>
<a name="l00050"></a><a class="code" href="classConnection__ConnectionPool.html#a3088844988e22a033edf52edefe9f14d">00050</a> <span class="keyword">public</span> function <a class="code" href="classConnection__ConnectionPool.html#a3088844988e22a033edf52edefe9f14d">createTcpConnection</a>($group = <span class="stringliteral">&quot;&quot;</span>, $protocol = <span class="stringliteral">&quot;RAW&quot;</span>, $IPv6 = FALSE) {
<a name="l00051"></a>00051 $socket = $this-&gt;socketPool-&gt;createTcpSocket($IPv6);
<a name="l00052"></a>00052 $connectionHandler = <span class="keyword">new</span> <a class="code" href="classConnection__ConnectionHandler.html">Connection_ConnectionHandler</a>($socket, $this-&gt;nextID, $group, $protocol);
<a name="l00053"></a>00053 $this-&gt;<a class="code" href="classConnection__ConnectionPool.html#abc4695c339196fdddce0623dd357ecfc">addConnectionHandler</a>($connectionHandler);
<a name="l00054"></a>00054 <span class="keywordflow">return</span> $connectionHandler;
<a name="l00055"></a>00055 }
<a name="l00056"></a>00056 <span class="comment"></span>
<a name="l00057"></a>00057 <span class="comment"> /**</span>
<a name="l00058"></a>00058 <span class="comment"> * Adds a ConnectionHandler to the pool.</span>
<a name="l00059"></a>00059 <span class="comment"> * @param Connection_ConnectionHandler $add_connectionHandler</span>
<a name="l00060"></a>00060 <span class="comment"> * @return void</span>
<a name="l00061"></a>00061 <span class="comment"> */</span>
<a name="l00062"></a><a class="code" href="classConnection__ConnectionPool.html#abc4695c339196fdddce0623dd357ecfc">00062</a> <span class="keyword">public</span> function <a class="code" href="classConnection__ConnectionPool.html#abc4695c339196fdddce0623dd357ecfc">addConnectionHandler</a>($add_connectionHandler) {
<a name="l00063"></a>00063 array_push($this-&gt;connectionHandlers, $add_connectionHandler);
<a name="l00064"></a>00064 $this-&gt;nextID++;
<a name="l00065"></a>00065 }
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment"> /**</span>
<a name="l00068"></a>00068 <span class="comment"> * Removes a ConnectionHandler from the pool.</span>
<a name="l00069"></a>00069 <span class="comment"> * @param Connection_ConnectionHandler $remove_connectionHandler</span>
<a name="l00070"></a>00070 <span class="comment"> * @return void</span>
<a name="l00071"></a>00071 <span class="comment"> */</span>
<a name="l00072"></a><a class="code" href="classConnection__ConnectionPool.html#ad1e391419908d336389c4158adc67b49">00072</a> <span class="keyword">public</span> function <a class="code" href="classConnection__ConnectionPool.html#ad1e391419908d336389c4158adc67b49">removeConnectionHandler</a>($remove_connectionHandler) {
<a name="l00073"></a>00073 <span class="keywordflow">foreach</span>($this-&gt;connectionHandlers AS $key=&gt;$connectionHandler) {
<a name="l00074"></a>00074 <span class="keywordflow">if</span>($connectionHandler === $remove_connectionHandler) {
<a name="l00075"></a>00075 $this-&gt;socketPool-&gt;removeSocket($remove_connectionHandler-&gt;getSocket());
<a name="l00076"></a>00076 $remove_connectionHandler-&gt;close();
<a name="l00077"></a>00077 unset($this-&gt;connectionHandlers[$key]);
<a name="l00078"></a>00078 }
<a name="l00079"></a>00079 }
<a name="l00080"></a>00080 }
<a name="l00081"></a>00081 <span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment"> /**</span>
<a name="l00083"></a>00083 <span class="comment"> * Returns ConnectionHandler for the given socket ressource.</span>
<a name="l00084"></a>00084 <span class="comment"> * @param ressource $socketRessource</span>
<a name="l00085"></a>00085 <span class="comment"> * @return Connection_ConnectionHandler</span>
<a name="l00086"></a>00086 <span class="comment"> */</span>
<a name="l00087"></a><a class="code" href="classConnection__ConnectionPool.html#a7b69c8594a0da112b7624a89b5f0069c">00087</a> <span class="keyword">protected</span> function <a class="code" href="classConnection__ConnectionPool.html#a7b69c8594a0da112b7624a89b5f0069c">getConnectionHandlerForSocketRessource</a>($socketRessource) {
<a name="l00088"></a>00088 <span class="keywordflow">foreach</span>($this-&gt;connectionHandlers AS $connectionHandler) {
<a name="l00089"></a>00089 <span class="keywordflow">if</span>($connectionHandler-&gt;getSocket() === $socketRessource) {
<a name="l00090"></a>00090 <span class="keywordflow">return</span> $connectionHandler;
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092 }
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094 <span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment"> /**</span>
<a name="l00096"></a>00096 <span class="comment"> * Calls select() on SocketPool and updates the ConnectionHandler.</span>
<a name="l00097"></a>00097 <span class="comment"> * Will also accept incoming connections and add them to the pool.</span>
<a name="l00098"></a>00098 <span class="comment"> * @return array An array containing the Connection_ConnectionHandler for each Socket with new data.</span>
<a name="l00099"></a>00099 <span class="comment"> * @throws Exception_GeneralException</span>
<a name="l00100"></a>00100 <span class="comment"> * @throws Exception_SocketException</span>
<a name="l00101"></a>00101 <span class="comment"> */</span>
<a name="l00102"></a><a class="code" href="classConnection__ConnectionPool.html#a65922149420aa8b7635235628a031ab5">00102</a> <span class="keyword">public</span> function <a class="code" href="classConnection__ConnectionPool.html#a65922149420aa8b7635235628a031ab5">select</a>() {
<a name="l00103"></a>00103 $read = array();
<a name="l00104"></a>00104 $write = array();
<a name="l00105"></a>00105 $except = array();
<a name="l00106"></a>00106 <span class="keywordflow">foreach</span>($this-&gt;connectionHandlers AS $connectionHandler) {
<a name="l00107"></a>00107 $connectionSocket = $connectionHandler-&gt;getSocket();
<a name="l00108"></a>00108 $read[] = $connectionSocket;
<a name="l00109"></a>00109 <span class="keywordflow">if</span>($connectionHandler-&gt;canWrite() &amp;&amp; $connectionHandler-&gt;isServer() === FALSE) $write[] = $connectionSocket;
<a name="l00110"></a>00110 }
<a name="l00111"></a>00111 $except = $read;
<a name="l00112"></a>00112
<a name="l00113"></a>00113 $tempArray = array();
<a name="l00114"></a>00114 $selectedSockets = $this-&gt;socketPool-&gt;select($read, $write, $except);
<a name="l00115"></a>00115 <span class="keywordflow">foreach</span>($selectedSockets AS $selectedType=&gt;$selectedArray) { <span class="comment">//read, write, except, this loop won&#39;t kill performance</span>
<a name="l00116"></a>00116 <span class="keywordflow">foreach</span>($selectedArray AS $socket) {
<a name="l00117"></a>00117 $connectionHandler = $this-&gt;<a class="code" href="classConnection__ConnectionPool.html#a7b69c8594a0da112b7624a89b5f0069c">getConnectionHandlerForSocketRessource</a>($socket);
<a name="l00118"></a>00118 <span class="keywordflow">switch</span>($selectedType) {
<a name="l00119"></a>00119 <span class="keywordflow">case</span> <span class="stringliteral">&quot;read&quot;</span>:
<a name="l00120"></a>00120 <span class="keywordflow">if</span>($connectionHandler-&gt;isServer() === FALSE) {
<a name="l00121"></a>00121 <span class="keywordflow">if</span>($connectionHandler-&gt;readToBuffer() === FALSE) $this-&gt;<a class="code" href="classConnection__ConnectionPool.html#ad1e391419908d336389c4158adc67b49">removeConnectionHandler</a>($connectionHandler);
<a name="l00122"></a>00122 } <span class="keywordflow">else</span> {
<a name="l00123"></a>00123 $acceptedSocket = $connectionHandler-&gt;accept();
<a name="l00124"></a>00124 $acceptedSocketHandler = <span class="keyword">new</span> <a class="code" href="classConnection__ConnectionHandler.html">Connection_ConnectionHandler</a>($acceptedSocket, $this-&gt;nextID, $connectionHandler-&gt;getGroup(), $connectionHandler-&gt;getProtocol());
<a name="l00125"></a>00125 $acceptedSocketHandler-&gt;hasBeenAccepted();
<a name="l00126"></a>00126 $this-&gt;<a class="code" href="classConnection__ConnectionPool.html#abc4695c339196fdddce0623dd357ecfc">addConnectionHandler</a>($acceptedSocketHandler);
<a name="l00127"></a>00127 }
<a name="l00128"></a>00128 <span class="keywordflow">break</span>;
<a name="l00129"></a>00129 <span class="keywordflow">case</span> <span class="stringliteral">&quot;write&quot;</span>:
<a name="l00130"></a>00130 <span class="keywordflow">if</span>($connectionHandler-&gt;writeFromBuffer() === FALSE) $this-&gt;<a class="code" href="classConnection__ConnectionPool.html#ad1e391419908d336389c4158adc67b49">removeConnectionHandler</a>($connectionHandler);
<a name="l00131"></a>00131 <span class="keywordflow">break</span>;
<a name="l00132"></a>00132 <span class="keywordflow">case</span> <span class="stringliteral">&quot;except&quot;</span>:
<a name="l00133"></a>00133 $connectionHandler-&gt;handleSocketError();
<a name="l00134"></a>00134 <span class="keywordflow">break</span>;
<a name="l00135"></a>00135 <span class="keywordflow">default</span>:
<a name="l00136"></a>00136 <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="classException__GeneralException.html">Exception_GeneralException</a>(<span class="stringliteral">&quot;Unknown select type: &#39;&quot;</span> . $selectedType . <span class="stringliteral">&quot;&#39;&quot;</span>, 1289737080);
<a name="l00137"></a>00137 <span class="keywordflow">break</span>;
<a name="l00138"></a>00138 }
<a name="l00139"></a>00139 $tempArray[$selectedType][] = $connectionHandler;
<a name="l00140"></a>00140 }
<a name="l00141"></a>00141 }
<a name="l00142"></a>00142 <span class="keywordflow">return</span> $tempArray;
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144 <span class="comment"></span>
<a name="l00145"></a>00145 <span class="comment"> /**</span>
<a name="l00146"></a>00146 <span class="comment"> * Writes the given data to all sockets in $group.</span>
<a name="l00147"></a>00147 <span class="comment"> * @param string $group</span>
<a name="l00148"></a>00148 <span class="comment"> * @param string $data</span>
<a name="l00149"></a>00149 <span class="comment"> * @throws Exception_SocketException</span>
<a name="l00150"></a>00150 <span class="comment"> * @return void</span>
<a name="l00151"></a>00151 <span class="comment"> */</span>
<a name="l00152"></a><a class="code" href="classConnection__ConnectionPool.html#aa8303c1c9288391e8c250c7c8dbf45d0">00152</a> <span class="keyword">public</span> function <a class="code" href="classConnection__ConnectionPool.html#aa8303c1c9288391e8c250c7c8dbf45d0">writeToGroup</a>($group, $data) {
<a name="l00153"></a>00153 <span class="keywordflow">foreach</span>($this-&gt;connectionHandlers AS $connectionHandler) {
<a name="l00154"></a>00154 <span class="keywordflow">if</span>($connectionHandler-&gt;getGroup() === $group &amp;&amp; $connectionHandler-&gt;isServer() === FALSE) {
<a name="l00155"></a>00155 $connectionHandler-&gt;write($data);
<a name="l00156"></a>00156 }
<a name="l00157"></a>00157 }
<a name="l00158"></a>00158 }
<a name="l00159"></a>00159 <span class="comment"></span>
<a name="l00160"></a>00160 <span class="comment"> /**</span>
<a name="l00161"></a>00161 <span class="comment"> * Writes the given data to the socket with $id.</span>
<a name="l00162"></a>00162 <span class="comment"> * @param int $id</span>
<a name="l00163"></a>00163 <span class="comment"> * @param string $data</span>
<a name="l00164"></a>00164 <span class="comment"> */</span>
<a name="l00165"></a><a class="code" href="classConnection__ConnectionPool.html#ab50212f42531a6ae9e9275087ea267dc">00165</a> <span class="keyword">public</span> function <a class="code" href="classConnection__ConnectionPool.html#ab50212f42531a6ae9e9275087ea267dc">writeToID</a>($id, $data) {
<a name="l00166"></a>00166 <span class="keywordflow">foreach</span>($this-&gt;connectionHandlers AS $connectionHandler) {
<a name="l00167"></a>00167 <span class="keywordflow">if</span>($connectionHandler-&gt;getID() === $id &amp;&amp; $connectionHandler-&gt;isServer() === FALSE) {
<a name="l00168"></a>00168 $connectionHandler-&gt;write($data);
<a name="l00169"></a>00169 }
<a name="l00170"></a>00170 }
<a name="l00171"></a>00171 }
<a name="l00172"></a>00172 <span class="comment"></span>
<a name="l00173"></a>00173 <span class="comment"> /**</span>
<a name="l00174"></a>00174 <span class="comment"> * @see Socket_SocketPool</span>
<a name="l00175"></a>00175 <span class="comment"> * @return int</span>
<a name="l00176"></a>00176 <span class="comment"> */</span>
<a name="l00177"></a><a class="code" href="classConnection__ConnectionPool.html#acc0ce7db50e7a4ca85eb3613c73bf60d">00177</a> <span class="keyword">public</span> function <a class="code" href="classConnection__ConnectionPool.html#acc0ce7db50e7a4ca85eb3613c73bf60d">countConnections</a>() {
<a name="l00178"></a>00178 <span class="keywordflow">return</span> $this-&gt;socketPool-&gt;countSockets();
<a name="l00179"></a>00179 }
<a name="l00180"></a>00180 }
<a name="l00181"></a>00181 ?&gt;
</pre></div></div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>Alle</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Klassen</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Namensbereiche</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Funktionen</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Erzeugt am Sun Nov 21 2010 15:11:52 für ircbot von&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>