Commit 722efcab by Maiyannah Bishop

Big documentation dump for moved classes

1 parent b6a0536f
Showing 84 changed files with 1042 additions and 93 deletions
<html><head><title>D:\Software\postActiv\classes\queue\DelUserQueueHandler.php - postActiv</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.4 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="DelUserQueueHandler.php"></a>DelUserQueueHandler.php</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#DelUserQueueHandler.php" >DelUserQueueHandler.php</a></td><td class=SDescription></td></tr><tr class="SSection"><td class=SEntry><a href="#DelUserQueueHandler" >DelUserQueueHandler</a></td><td class=SDescription>Background job to delete prolific users without disrupting front-end too much.</td></tr><tr class="SClass"><td class=SEntry><a href="#DelUserQueueHandler" >DelUserQueueHandler</a></td><td class=SDescription>Class abstraction for the queue job of deleting a prolific user</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#DelUserQueueHandler.transport" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">transport</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#DelUserQueueHandler.handle" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#DelUserQueueHandler.getNextBatch" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">getNextBatch</a></td><td class=SDescription>Fetch the next self::DELETION_WINDOW messages for this user.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="DelUserQueueHandler"></a>DelUserQueueHandler</h2><div class=CBody><p>Background job to delete prolific users without disrupting front-end too much.</p><h4 class=CHeading>postActiv</h4><p>the micro-blogging software</p><h4 class=CHeading>Copyright</h4><p>Copyright &copy; 2016, Maiyannah Bishop</p><h4 class=CHeading>Derived from code copyright various sources</h4><ul><li>GNU Social &copy; 2013-2016, Free Software Foundation, Inc</li><li>StatusNet &copy; 2008-2012, StatusNet, Inc</li></ul><h4 class=CHeading>License</h4><p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.&nbsp; See the GNU Affero General Public License for more details.</p><p>You should have received a copy of the GNU Affero General Public License along with this program.&nbsp; If not, see <a href="http://www.gnu.org/licenses/" class=LURL target=_top>http://www.gnu.org/licenses/</a>.</p><h4 class=CHeading>About</h4><p>Background job to delete prolific users without disrupting front-end too much.</p><p>Up to 50 messages are deleted on each run through; when all messages are gone, the actual account is deleted.</p><h4 class=CHeading>PHP version</h4><p>Tested with PHP 5.6</p><h4 class=CHeading>File Authors</h4><ul><li>Brion Vibber <a href="#" onClick="location.href='mai' + 'lto:' + 'br' + 'ion' + '@' + 'pobo' + 'x.com'; return false;" class=LEMail>br<span style="display: none">.nosp@m.</span>ion<span>@</span>pobo<span style="display: none">.nosp@m.</span>x.com</a></li><li>Evan Prodromou</li><li>Mikael Nordfeldth <a href="#" onClick="location.href='mai' + 'lto:' + 'm' + 'mn' + '@' + 'hetha' + 'ne.se'; return false;" class=LEMail>m<span style="display: none">.nosp@m.</span>mn<span>@</span>hetha<span style="display: none">.nosp@m.</span>ne.se</a></li><li>Maiyannah Bishop <a href="#" onClick="location.href='mai' + 'lto:' + 'maiyanna' + 'h.bishop' + '@' + 'postac' + 'tiv.com'; return false;" class=LEMail>maiyanna<span style="display: none">.nosp@m.</span>h.bishop<span>@</span>postac<span style="display: none">.nosp@m.</span>tiv.com</a></li></ul><h4 class=CHeading>Web</h4><ul><li>postActiv <a href="http://www.postactiv.com" class=LURL target=_top>http://www.postactiv.com</a></li><li>GNU social <a href="https://www.gnu.org/s/social/" class=LURL target=_top>https://www.gnu.org/s/social/</a></li></ul></div></div></div>
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="DelUserQueueHandler"></a>DelUserQueueHandler</h2><div class=CBody><p>Class abstraction for the queue job of deleting a prolific user</p><h4 class=CHeading>Defines</h4><ul><li>DELETION_WINDOW - 50</li></ul><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SFunction"><td class=SEntry><a href="#DelUserQueueHandler.transport" id=link4 onMouseOver="ShowTip(event, 'tt1', 'link4')" onMouseOut="HideTip('tt1')">transport</a></td><td class=SDescription></td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#DelUserQueueHandler.handle" id=link5 onMouseOver="ShowTip(event, 'tt2', 'link5')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription></td></tr><tr class="SFunction"><td class=SEntry><a href="#DelUserQueueHandler.getNextBatch" id=link6 onMouseOver="ShowTip(event, 'tt3', 'link6')" onMouseOut="HideTip('tt3')">getNextBatch</a></td><td class=SDescription>Fetch the next self::DELETION_WINDOW messages for this user.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="DelUserQueueHandler.transport"></a>transport</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>public function transport()</td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="DelUserQueueHandler.handle"></a>handle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function handle(</td><td class=PParameter nowrap>$user</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><ul><li>User $user</li></ul></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="DelUserQueueHandler.getNextBatch"></a>getNextBatch</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>protected function getNextBatch(</td><td class=PType nowrap>User&nbsp;</td><td class=PParameter nowrap>$user</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Fetch the next self::DELETION_WINDOW messages for this user.</p><h4 class=CHeading>Parameters</h4><ul><li>User $user</li></ul><h4 class=CHeading>Returns</h4><ul><li>Notice</li></ul></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>public function transport()</td></tr></table></blockquote></div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function handle(</td><td class=PParameter nowrap>$user</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>protected function getNextBatch(</td><td class=PType nowrap>User&nbsp;</td><td class=PParameter nowrap>$user</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Fetch the next self::DELETION_WINDOW messages for this user.</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
\ No newline at end of file
<html><head><title>D:\Software\postActiv\classes\queue\DistribQueueHandler.php - postActiv</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.4 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="DistribQueueHandler.php"></a>DistribQueueHandler.php</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#DistribQueueHandler.php" >DistribQueueHandler.php</a></td><td class=SDescription></td></tr><tr class="SSection"><td class=SEntry><a href="#DistribQueueHandler" >DistribQueueHandler</a></td><td class=SDescription>Transport that handles federation of notices.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#transport" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">transport</a></td><td class=SDescription>Return transport keyword which identifies items this queue handler services; must be defined for all subclasses.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#handle" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#logit" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">logit</a></td><td class=SDescription>Log an exception we come across in handling federation</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="DistribQueueHandler"></a>DistribQueueHandler</h2><div class=CBody><p>Transport that handles federation of notices.</p><h4 class=CHeading>postActiv</h4><p>the micro-blogging software</p><h4 class=CHeading>Copyright</h4><p>Copyright &copy; 2016, Maiyannah Bishop</p><h4 class=CHeading>Derived from code copyright various sources</h4><ul><li>GNU Social &copy; 2013-2016, Free Software Foundation, Inc</li><li>StatusNet &copy; 2008-2012, StatusNet, Inc</li></ul><h4 class=CHeading>License</h4><p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.&nbsp; See the GNU Affero General Public License for more details.</p><p>You should have received a copy of the GNU Affero General Public License along with this program.&nbsp; If not, see <a href="http://www.gnu.org/licenses/" class=LURL target=_top>http://www.gnu.org/licenses/</a>.</p><p><a href="https://www.gnu.org/licenses/agpl.html" class=LURL target=_top>https://www.gnu.org/licenses/agpl.html</a></p><h4 class=CHeading>About</h4><p>As extensions of the Daemon class, each queue handler has the ability to launch itself in the background, at which point it&rsquo;ll pass control to the configured QueueManager class to poll for updates.</p><h4 class=CHeading>Subclasses must override at least the following methods</h4><ul><li>transport</li><li>handle_notice</li></ul><h4 class=CHeading>PHP version</h4><p>Tested with PHP 5.6</p><h4 class=CHeading>File Authors</h4><ul><li>Evan Prodromou</li><li>Brion Vibber <a href="#" onClick="location.href='mai' + 'lto:' + 'br' + 'ion' + '@' + 'pobo' + 'x.com'; return false;" class=LEMail>br<span style="display: none">.nosp@m.</span>ion<span>@</span>pobo<span style="display: none">.nosp@m.</span>x.com</a></li><li>Mikael Nordfeldth <a href="#" onClick="location.href='mai' + 'lto:' + 'm' + 'mn' + '@' + 'hetha' + 'ne.se'; return false;" class=LEMail>m<span style="display: none">.nosp@m.</span>mn<span>@</span>hetha<span style="display: none">.nosp@m.</span>ne.se</a></li><li>Maiyannah Bishop <a href="#" onClick="location.href='mai' + 'lto:' + 'maiyanna' + 'h.bishop' + '@' + 'postac' + 'tiv.com'; return false;" class=LEMail>maiyanna<span style="display: none">.nosp@m.</span>h.bishop<span>@</span>postac<span style="display: none">.nosp@m.</span>tiv.com</a></li></ul><h4 class=CHeading>Web</h4><ul><li>postActiv <a href="http://www.postactiv.com" class=LURL target=_top>http://www.postactiv.com</a></li><li>GNU social <a href="https://www.gnu.org/s/social/" class=LURL target=_top>https://www.gnu.org/s/social/</a></li></ul><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SFunction"><td class=SEntry><a href="#transport" id=link4 onMouseOver="ShowTip(event, 'tt1', 'link4')" onMouseOut="HideTip('tt1')">transport</a></td><td class=SDescription>Return transport keyword which identifies items this queue handler services; must be defined for all subclasses.</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#handle" id=link5 onMouseOver="ShowTip(event, 'tt2', 'link5')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription></td></tr><tr class="SFunction"><td class=SEntry><a href="#logit" id=link6 onMouseOver="ShowTip(event, 'tt3', 'link6')" onMouseOut="HideTip('tt3')">logit</a></td><td class=SDescription>Log an exception we come across in handling federation</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="transport"></a>transport</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>public function transport()</td></tr></table></blockquote><p>Return transport keyword which identifies items this queue handler services; must be defined for all subclasses.</p><p>Must be 8 characters or less to fit in the queue_item database. ex &ldquo;email&rdquo;, &ldquo;jabber&rdquo;, &ldquo;sms&rdquo;, &ldquo;irc&rdquo;, ...</p><p>@return string</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="handle"></a>handle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function handle(</td><td class=PType nowrap>Notice&nbsp;</td><td class=PParameter nowrap>$notice</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Handle distribution of a notice after we&rsquo;ve saved it</h4><ul><li>add to local recipient inboxes</li><li>send email notifications to local @-reply targets</li><li>run final EndNoticeSave plugin events</li><li>put any remaining post-processing into the queues</li></ul><p>If this function indicates failure, a warning will be logged and the item is placed back in the queue to be re-run.</p><h4 class=CHeading>Parameters</h4><ul><li>Notice $notice</li></ul><h4 class=CHeading>Returns</h4><ul><li>boolean - true on success, false on failure</li></ul></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="logit"></a>logit</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>protected function logit(</td><td class=PParameter nowrap>$notice,</td></tr><tr><td></td><td class=PParameter nowrap>$e</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Log an exception we come across in handling federation</p></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>public function transport()</td></tr></table></blockquote>Return transport keyword which identifies items this queue handler services; must be defined for all subclasses.</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>public function handle(</td><td class=PType nowrap>Notice&nbsp;</td><td class=PParameter nowrap>$notice</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>protected function logit(</td><td class=PParameter nowrap>$notice,</td></tr><tr><td></td><td class=PParameter nowrap>$e</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Log an exception we come across in handling federation</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
\ No newline at end of file
<html><head><title>D:\Software\postActiv\classes\queue\ImManager.php - postActiv</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.4 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="ImManager.php"></a>ImManager.php</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#ImManager.php" >ImManager.php</a></td><td class=SDescription></td></tr><tr class="SSection"><td class=SEntry><a href="#IM_Queue_Manager" >IM Queue Manager</a></td><td class=SDescription>Simple-minded queue manager for storing items from IMs</td></tr><tr class="SClass"><td class=SEntry><a href="#ImManager" >ImManager</a></td><td class=SDescription>IKM background connection manager for IM-using queue handlers, allowing them to send outgoing messages on the right connection.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#ImManager.send_raw_message" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">send_raw_message</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#ImManager.__construct" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">__construct</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#ImManager.get" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">get</a></td><td class=SDescription>Fetch the singleton manager for the current site. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="IM_Queue_Manager"></a>IM Queue Manager</h2><div class=CBody><p>Simple-minded queue manager for storing items from IMs</p><h4 class=CHeading>postActiv</h4><p>the micro-blogging software</p><h4 class=CHeading>Copyright</h4><p>Copyright &copy; 2016, Maiyannah Bishop</p><h4 class=CHeading>Derived from code copyright various sources</h4><ul><li>GNU Social &copy; 2013-2016, Free Software Foundation, Inc</li><li>StatusNet &copy; 2008-2012, StatusNet, Inc</li></ul><h4 class=CHeading>License</h4><p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.&nbsp; See the GNU Affero General Public License for more details.</p><p>You should have received a copy of the GNU Affero General Public License along with this program.&nbsp; If not, see <a href="http://www.gnu.org/licenses/" class=LURL target=_top>http://www.gnu.org/licenses/</a>.</p><p><a href="https://www.gnu.org/licenses/agpl.html" class=LURL target=_top>https://www.gnu.org/licenses/agpl.html</a></p><h4 class=CHeading>About</h4><p>IKM background connection manager for IM-using queue handlers, allowing them to send outgoing messages on the right connection.</p><p>In a multi-site queuedaemon.php run, one connection will be instantiated for each site being handled by the current process that has IM enabled.</p><h4 class=CHeading>Implementations that extend this class will likely want to</h4><p>1) override start() with their connection process.&nbsp; 2) override handleInput() with what to do when data is waiting on one of the sockets 3) override idle($timeout) to do keepalives (if necessary) 4) implement send_raw_message() to send raw data that ImPlugin::enqueueOutgoingRaw enqueued</p><h4 class=CHeading>PHP version</h4><p>Tested with PHP 5.6</p><h4 class=CHeading>File Authors</h4><ul><li>Craig Andrews <a href="#" onClick="location.href='mai' + 'lto:' + 'cand' + 'rews' + '@' + 'integral' + 'blue.com'; return false;" class=LEMail>cand<span style="display: none">.nosp@m.</span>rews<span>@</span>integral<span style="display: none">.nosp@m.</span>blue.com</a></li><li>Maiyannah Bishop <a href="#" onClick="location.href='mai' + 'lto:' + 'maiyanna' + 'h.bishop' + '@' + 'postac' + 'tiv.com'; return false;" class=LEMail>maiyanna<span style="display: none">.nosp@m.</span>h.bishop<span>@</span>postac<span style="display: none">.nosp@m.</span>tiv.com</a></li></ul><h4 class=CHeading>Web</h4><ul><li>postActiv <a href="http://www.postactiv.com" class=LURL target=_top>http://www.postactiv.com</a></li><li>GNU social <a href="https://www.gnu.org/s/social/" class=LURL target=_top>https://www.gnu.org/s/social/</a></li></ul></div></div></div>
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="ImManager"></a>ImManager</h2><div class=CBody><p>IKM background connection manager for IM-using queue handlers, allowing them to send outgoing messages on the right connection.</p><p>In a multi-site queuedaemon.php run, one connection will be instantiated for each site being handled by the current process that has IM enabled.</p><h4 class=CHeading>Implementations that extend this class will likely want to</h4><p>1) override start() with their connection process.&nbsp; 2) override handleInput() with what to do when data is waiting on one of the sockets 3) override idle($timeout) to do keepalives (if necessary) 4) implement send_raw_message() to send raw data that ImPlugin::enqueueOutgoingRaw enqueued</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SFunction"><td class=SEntry><a href="#ImManager.send_raw_message" id=link4 onMouseOver="ShowTip(event, 'tt1', 'link4')" onMouseOut="HideTip('tt1')">send_raw_message</a></td><td class=SDescription></td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#ImManager.__construct" id=link5 onMouseOver="ShowTip(event, 'tt2', 'link5')" onMouseOut="HideTip('tt2')">__construct</a></td><td class=SDescription></td></tr><tr class="SFunction"><td class=SEntry><a href="#ImManager.get" id=link6 onMouseOver="ShowTip(event, 'tt3', 'link6')" onMouseOut="HideTip('tt3')">get</a></td><td class=SDescription>Fetch the singleton manager for the current site. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="ImManager.send_raw_message"></a>send_raw_message</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>abstract function send_raw_message(</td><td class=PParameter nowrap>$data</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="ImManager.__construct"></a>__construct</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function __construct(</td><td class=PParameter nowrap>$imPlugin</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="ImManager.get"></a>get</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>public static function get()</td></tr></table></blockquote><p>Fetch the singleton manager for the current site.&nbsp; @return mixed ImManager, or false if unneeded</p></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>abstract function send_raw_message(</td><td class=PParameter nowrap>$data</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function __construct(</td><td class=PParameter nowrap>$imPlugin</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>public static function get()</td></tr></table></blockquote>Fetch the singleton manager for the current site. </div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
\ No newline at end of file
<html><head><title>D:\Software\postActiv\classes\queue\ImQueueHandler.php - postActiv</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.4 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="ImQueueHandler.php"></a>ImQueueHandler.php</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#ImQueueHandler.php" >ImQueueHandler.php</a></td><td class=SDescription></td></tr><tr class="SSection"><td class=SEntry><a href="#ImQueueHandles" >ImQueueHandles</a></td><td class=SDescription>Common superclass for all IM sending queue handlers.</td></tr><tr class="SClass"><td class=SEntry><a href="#ImQueueHandler" >ImQueueHandler</a></td><td class=SDescription>Common superclass for all IM sending queue handlers.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#ImQueueHandler.__construct" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">__construct</a></td><td class=SDescription>Class constructor</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#ImQueueHandler.handle" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription>Handle a notice</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="ImQueueHandles"></a>ImQueueHandles</h2><div class=CBody><p>Common superclass for all IM sending queue handlers.</p><h4 class=CHeading>postActiv</h4><p>the micro-blogging software</p><h4 class=CHeading>Copyright</h4><p>Copyright &copy; 2016, Maiyannah Bishop</p><h4 class=CHeading>Derived from code copyright various sources</h4><ul><li>GNU Social &copy; 2013-2016, Free Software Foundation, Inc</li><li>StatusNet &copy; 2008-2012, StatusNet, Inc</li></ul><h4 class=CHeading>License</h4><p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.&nbsp; See the GNU Affero General Public License for more details.</p><p>You should have received a copy of the GNU Affero General Public License along with this program.&nbsp; If not, see <a href="http://www.gnu.org/licenses/" class=LURL target=_top>http://www.gnu.org/licenses/</a>.</p><p><a href="https://www.gnu.org/licenses/agpl.html" class=LURL target=_top>https://www.gnu.org/licenses/agpl.html</a></p><h4 class=CHeading>About</h4><p>Common superclass for all IM sending queue handlers.</p><h4 class=CHeading>PHP version</h4><p>Tested with PHP 5.6</p><h4 class=CHeading>File Authors</h4><ul><li>Craig Andrews <a href="#" onClick="location.href='mai' + 'lto:' + 'cand' + 'rews' + '@' + 'integral' + 'blue.com'; return false;" class=LEMail>cand<span style="display: none">.nosp@m.</span>rews<span>@</span>integral<span style="display: none">.nosp@m.</span>blue.com</a></li><li>Mikael Nordfeldth <a href="#" onClick="location.href='mai' + 'lto:' + 'm' + 'mn' + '@' + 'hetha' + 'ne.se'; return false;" class=LEMail>m<span style="display: none">.nosp@m.</span>mn<span>@</span>hetha<span style="display: none">.nosp@m.</span>ne.se</a></li><li>Maiyannah Bishop <a href="#" onClick="location.href='mai' + 'lto:' + 'maiyanna' + 'h.bishop' + '@' + 'postac' + 'tiv.com'; return false;" class=LEMail>maiyanna<span style="display: none">.nosp@m.</span>h.bishop<span>@</span>postac<span style="display: none">.nosp@m.</span>tiv.com</a></li></ul><h4 class=CHeading>Web</h4><ul><li>postActiv <a href="http://www.postactiv.com" class=LURL target=_top>http://www.postactiv.com</a></li><li>GNU social <a href="https://www.gnu.org/s/social/" class=LURL target=_top>https://www.gnu.org/s/social/</a></li></ul></div></div></div>
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="ImQueueHandler"></a>ImQueueHandler</h2><div class=CBody><p>Common superclass for all IM sending queue handlers.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SFunction"><td class=SEntry><a href="#ImQueueHandler.__construct" id=link3 onMouseOver="ShowTip(event, 'tt1', 'link3')" onMouseOut="HideTip('tt1')">__construct</a></td><td class=SDescription>Class constructor</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#ImQueueHandler.handle" id=link4 onMouseOver="ShowTip(event, 'tt2', 'link4')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription>Handle a notice</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="ImQueueHandler.__construct"></a>__construct</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function __construct(</td><td class=PParameter nowrap>$plugin</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Class constructor</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="ImQueueHandler.handle"></a>handle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function handle(</td><td class=PParameter nowrap>$notice</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handle a notice</p><h4 class=CHeading>Parameters</h4><ul><li>Notice $notice</li></ul><h4 class=CHeading>Returns</h4><ul><li>boolean success</li></ul></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function __construct(</td><td class=PParameter nowrap>$plugin</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Class constructor</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function handle(</td><td class=PParameter nowrap>$notice</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Handle a notice</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
\ No newline at end of file
<html><head><title>D:\Software\postActiv\classes\queue\ImReceiverQueueHandler.php - postActiv</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.4 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="ImReceiverQueueHandler.php"></a>ImReceiverQueueHandler.php</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#ImReceiverQueueHandler.php" >ImReceiverQueueHandler.php</a></td><td class=SDescription></td></tr><tr class="SSection"><td class=SEntry><a href="#ImReceiverQueueHandler" >ImReceiverQueueHandler</a></td><td class=SDescription>Common superclass for all IM receiving queue handlers.</td></tr><tr class="SClass"><td class=SEntry><a href="#ImReceiverQueueHandler" >ImReceiverQueueHandler</a></td><td class=SDescription>Common superclass for all IM receiving queue handlers.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#ImReceiverQueueHandler.__construct" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">__construct</a></td><td class=SDescription>Class constructor</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#ImReceiverQueueHandler.handle" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription>Handle incoming IM data sent by a user to the IM bot</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="ImReceiverQueueHandler"></a>ImReceiverQueueHandler</h2><div class=CBody><p>Common superclass for all IM receiving queue handlers.</p><h4 class=CHeading>postActiv</h4><p>the micro-blogging software</p><h4 class=CHeading>Copyright</h4><p>Copyright &copy; 2016, Maiyannah Bishop</p><h4 class=CHeading>Derived from code copyright various sources</h4><ul><li>GNU Social &copy; 2013-2016, Free Software Foundation, Inc</li><li>StatusNet &copy; 2008-2012, StatusNet, Inc</li></ul><h4 class=CHeading>License</h4><p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.&nbsp; See the GNU Affero General Public License for more details.</p><p>You should have received a copy of the GNU Affero General Public License along with this program.&nbsp; If not, see <a href="http://www.gnu.org/licenses/" class=LURL target=_top>http://www.gnu.org/licenses/</a>.</p><p><a href="https://www.gnu.org/licenses/agpl.html" class=LURL target=_top>https://www.gnu.org/licenses/agpl.html</a></p><h4 class=CHeading>About</h4><p>Common superclass for all IM receiving queue handlers.</p><h4 class=CHeading>PHP version</h4><p>Tested with PHP 5.6</p><h4 class=CHeading>File Authors</h4><ul><li>Craig Andrews <a href="#" onClick="location.href='mai' + 'lto:' + 'cand' + 'rews' + '@' + 'integral' + 'blue.com'; return false;" class=LEMail>cand<span style="display: none">.nosp@m.</span>rews<span>@</span>integral<span style="display: none">.nosp@m.</span>blue.com</a></li><li>Maiyannah Bishop <a href="#" onClick="location.href='mai' + 'lto:' + 'maiyanna' + 'h.bishop' + '@' + 'postac' + 'tiv.com'; return false;" class=LEMail>maiyanna<span style="display: none">.nosp@m.</span>h.bishop<span>@</span>postac<span style="display: none">.nosp@m.</span>tiv.com</a></li></ul><h4 class=CHeading>Web</h4><ul><li>postActiv <a href="http://www.postactiv.com" class=LURL target=_top>http://www.postactiv.com</a></li><li>GNU social <a href="https://www.gnu.org/s/social/" class=LURL target=_top>https://www.gnu.org/s/social/</a></li></ul></div></div></div>
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="ImReceiverQueueHandler"></a>ImReceiverQueueHandler</h2><div class=CBody><p>Common superclass for all IM receiving queue handlers.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SFunction"><td class=SEntry><a href="#ImReceiverQueueHandler.__construct" id=link3 onMouseOver="ShowTip(event, 'tt1', 'link3')" onMouseOut="HideTip('tt1')">__construct</a></td><td class=SDescription>Class constructor</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#ImReceiverQueueHandler.handle" id=link4 onMouseOver="ShowTip(event, 'tt2', 'link4')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription>Handle incoming IM data sent by a user to the IM bot</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="ImReceiverQueueHandler.__construct"></a>__construct</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function __construct(</td><td class=PParameter nowrap>$plugin</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Class constructor</p><h4 class=CHeading>Parameters</h4><ul><li>Plugin $plugin - the IM plugin this handler is operating for</li></ul></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="ImReceiverQueueHandler.handle"></a>handle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function handle(</td><td class=PParameter nowrap>$data</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handle incoming IM data sent by a user to the IM bot</p><h4 class=CHeading>Parameters</h4><ul><li>object $data</li></ul><h4 class=CHeading>Returns</h4><ul><li>boolean success</li></ul></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function __construct(</td><td class=PParameter nowrap>$plugin</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Class constructor</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function handle(</td><td class=PParameter nowrap>$data</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Handle incoming IM data sent by a user to the IM bot</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
\ No newline at end of file
<html><head><title>D:\Software\postActiv\classes\queue\ImSenderQueueHandler.php - postActiv</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.4 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="ImSenderQueueHandler.php"></a>ImSenderQueueHandler.php</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#ImSenderQueueHandler.php" >ImSenderQueueHandler.php</a></td><td class=SDescription></td></tr><tr class="SSection"><td class=SEntry><a href="#ImSenderQueueHandler" >ImSenderQueueHandler</a></td><td class=SDescription>Common superclass for all IM sending queue handlers.</td></tr><tr class="SClass"><td class=SEntry><a href="#ImSenderQueueHandler" >ImSenderQueueHandler</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#ImSenderQueueHandler.__construct" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">__construct</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#ImSenderQueueHandler.handle" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription>Handle outgoing IM data to be sent from the bot to a user</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="ImSenderQueueHandler"></a>ImSenderQueueHandler</h2><div class=CBody><p>Common superclass for all IM sending queue handlers.</p><h4 class=CHeading>postActiv</h4><p>the micro-blogging software</p><h4 class=CHeading>Copyright</h4><p>Copyright &copy; 2016, Maiyannah Bishop</p><h4 class=CHeading>Derived from code copyright various sources</h4><ul><li>GNU Social &copy; 2013-2016, Free Software Foundation, Inc</li><li>StatusNet &copy; 2008-2012, StatusNet, Inc</li></ul><h4 class=CHeading>License</h4><p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.&nbsp; See the GNU Affero General Public License for more details.</p><p>You should have received a copy of the GNU Affero General Public License along with this program.&nbsp; If not, see <a href="http://www.gnu.org/licenses/" class=LURL target=_top>http://www.gnu.org/licenses/</a>.</p><p><a href="https://www.gnu.org/licenses/agpl.html" class=LURL target=_top>https://www.gnu.org/licenses/agpl.html</a></p><h4 class=CHeading>About</h4><p>Common superclass for all IM sending queue handlers.</p><h4 class=CHeading>PHP version</h4><p>Tested with PHP 5.6</p><h4 class=CHeading>File Authors</h4><ul><li>Craig Andrews <a href="#" onClick="location.href='mai' + 'lto:' + 'cand' + 'rews' + '@' + 'integral' + 'blue.com'; return false;" class=LEMail>cand<span style="display: none">.nosp@m.</span>rews<span>@</span>integral<span style="display: none">.nosp@m.</span>blue.com</a></li><li>Maiyannah Bishop <a href="#" onClick="location.href='mai' + 'lto:' + 'maiyanna' + 'h.bishop' + '@' + 'postac' + 'tiv.com'; return false;" class=LEMail>maiyanna<span style="display: none">.nosp@m.</span>h.bishop<span>@</span>postac<span style="display: none">.nosp@m.</span>tiv.com</a></li></ul><h4 class=CHeading>Web</h4><ul><li>postActiv <a href="http://www.postactiv.com" class=LURL target=_top>http://www.postactiv.com</a></li><li>GNU social <a href="https://www.gnu.org/s/social/" class=LURL target=_top>https://www.gnu.org/s/social/</a></li></ul></div></div></div>
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="ImSenderQueueHandler"></a>ImSenderQueueHandler</h2><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SFunction"><td class=SEntry><a href="#ImSenderQueueHandler.__construct" id=link3 onMouseOver="ShowTip(event, 'tt1', 'link3')" onMouseOut="HideTip('tt1')">__construct</a></td><td class=SDescription></td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#ImSenderQueueHandler.handle" id=link4 onMouseOver="ShowTip(event, 'tt2', 'link4')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription>Handle outgoing IM data to be sent from the bot to a user</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="ImSenderQueueHandler.__construct"></a>__construct</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function __construct(</td><td class=PParameter nowrap>$plugin</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="ImSenderQueueHandler.handle"></a>handle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function handle(</td><td class=PParameter nowrap>$data</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handle outgoing IM data to be sent from the bot to a user</p><h4 class=CHeading>Parameters</h4><ul><li>object $data</li></ul><h4 class=CHeading>Returns</h4><ul><li>boolean success</li></ul></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function __construct(</td><td class=PParameter nowrap>$plugin</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function handle(</td><td class=PParameter nowrap>$data</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Handle outgoing IM data to be sent from the bot to a user</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
\ No newline at end of file
<html><head><title>D:\Software\postActiv\classes\queue\PingQueueHandler.php - postActiv</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.4 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="PingQueueHandler.php"></a>PingQueueHandler.php</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#PingQueueHandler.php" >PingQueueHandler.php</a></td><td class=SDescription></td></tr><tr class="SSection"><td class=SEntry><a href="#PingQueueManager" >PingQueueManager</a></td><td class=SDescription>Queue handler for pushing new notices to ping servers.</td></tr><tr class="SClass"><td class=SEntry><a href="#PingQueueHandler" >PingQueueHandler</a></td><td class=SDescription>Queue handler for pushing new notices to ping servers.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#PingQueueHandler.transport" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">transport</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#PingQueueHandler.handle" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="PingQueueManager"></a>PingQueueManager</h2><div class=CBody><p>Queue handler for pushing new notices to ping servers.</p><h4 class=CHeading>postActiv</h4><p>the micro-blogging software</p><h4 class=CHeading>Copyright</h4><p>Copyright &copy; 2016, Maiyannah Bishop</p><h4 class=CHeading>Derived from code copyright various sources</h4><ul><li>GNU Social &copy; 2013-2016, Free Software Foundation, Inc</li><li>StatusNet &copy; 2008-2012, StatusNet, Inc</li></ul><h4 class=CHeading>License</h4><p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.&nbsp; See the GNU Affero General Public License for more details.</p><p>You should have received a copy of the GNU Affero General Public License along with this program.&nbsp; If not, see <a href="http://www.gnu.org/licenses/" class=LURL target=_top>http://www.gnu.org/licenses/</a>.</p><p><a href="https://www.gnu.org/licenses/agpl.html" class=LURL target=_top>https://www.gnu.org/licenses/agpl.html</a></p><h4 class=CHeading>About</h4><p>Queue handler for pushing new notices to ping servers.</p><h4 class=CHeading>PHP version</h4><p>Tested with PHP 5.6</p><h4 class=CHeading>File Authors</h4><ul><li>Brion Vibber <a href="#" onClick="location.href='mai' + 'lto:' + 'br' + 'ion' + '@' + 'pobo' + 'x.com'; return false;" class=LEMail>br<span style="display: none">.nosp@m.</span>ion<span>@</span>pobo<span style="display: none">.nosp@m.</span>x.com</a></li><li>Maiyannah Bishop <a href="#" onClick="location.href='mai' + 'lto:' + 'maiyanna' + 'h.bishop' + '@' + 'postac' + 'tiv.com'; return false;" class=LEMail>maiyanna<span style="display: none">.nosp@m.</span>h.bishop<span>@</span>postac<span style="display: none">.nosp@m.</span>tiv.com</a></li></ul><h4 class=CHeading>Web</h4><ul><li>postActiv <a href="http://www.postactiv.com" class=LURL target=_top>http://www.postactiv.com</a></li><li>GNU social <a href="https://www.gnu.org/s/social/" class=LURL target=_top>https://www.gnu.org/s/social/</a></li></ul></div></div></div>
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="PingQueueHandler"></a>PingQueueHandler</h2><div class=CBody><p>Queue handler for pushing new notices to ping servers.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SFunction"><td class=SEntry><a href="#PingQueueHandler.transport" id=link3 onMouseOver="ShowTip(event, 'tt1', 'link3')" onMouseOut="HideTip('tt1')">transport</a></td><td class=SDescription></td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#PingQueueHandler.handle" id=link4 onMouseOver="ShowTip(event, 'tt2', 'link4')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PingQueueHandler.transport"></a>transport</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>function transport()</td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PingQueueHandler.handle"></a>handle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function handle(</td><td class=PParameter nowrap>$notice</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>function transport()</td></tr></table></blockquote></div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function handle(</td><td class=PParameter nowrap>$notice</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
\ No newline at end of file
<html><head><title>D:\Software\postActiv\classes\queue\PluginQueueHandler.php - postActiv</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.4 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="PluginQueueHandler.php"></a>PluginQueueHandler.php</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#PluginQueueHandler.php" >PluginQueueHandler.php</a></td><td class=SDescription></td></tr><tr class="SSection"><td class=SEntry><a href="#Plugin_Queue_Handler" >Plugin Queue Handler</a></td><td class=SDescription>Queue handler for letting plugins handle stuff.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#PluginQueueHandler" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">PluginQueueHandler</a></td><td class=SDescription>Queue handler for letting plugins handle stuff.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#transport" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">transport</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#handle" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">handle</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="Plugin_Queue_Handler"></a>Plugin Queue Handler</h2><div class=CBody><p>Queue handler for letting plugins handle stuff.</p><h4 class=CHeading>postActiv</h4><p>the micro-blogging software</p><h4 class=CHeading>Copyright</h4><p>Copyright &copy; 2016, Maiyannah Bishop</p><h4 class=CHeading>Derived from code copyright various sources</h4><ul><li>GNU Social &copy; 2013-2016, Free Software Foundation, Inc</li><li>StatusNet &copy; 2008-2012, StatusNet, Inc</li></ul><h4 class=CHeading>License</h4><p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.&nbsp; See the GNU Affero General Public License for more details.</p><p>You should have received a copy of the GNU Affero General Public License along with this program.&nbsp; If not, see <a href="http://www.gnu.org/licenses/" class=LURL target=_top>http://www.gnu.org/licenses/</a>.</p><p><a href="https://www.gnu.org/licenses/agpl.html" class=LURL target=_top>https://www.gnu.org/licenses/agpl.html</a></p><h4 class=CHeading>About</h4><p>Queue handler for letting plugins handle stuff.</p><p>The plugin queue handler accepts notices over the &ldquo;plugin&rdquo; queue and simply passes them through the &ldquo;HandleQueuedNotice&rdquo; event.</p><p>This gives plugins a chance to do background processing without actually registering their own queue and ensuring that things are queued into it.</p><p>Fancier plugins may wish to instead hook the &lsquo;GetQueueHandlerClass&rsquo; event with their own class, in which case they must ensure that their notices get enqueued when they need them.</p><h4 class=CHeading>PHP version</h4><p>Tested with PHP 5.6</p><h4 class=CHeading>File Authors</h4><ul><li>Brion Vibber <a href="#" onClick="location.href='mai' + 'lto:' + 'br' + 'ion' + '@' + 'pobo' + 'x.com'; return false;" class=LEMail>br<span style="display: none">.nosp@m.</span>ion<span>@</span>pobo<span style="display: none">.nosp@m.</span>x.com</a></li><li>Evan Prodromou</li><li>Mikael Nordfeldth <a href="#" onClick="location.href='mai' + 'lto:' + 'm' + 'mn' + '@' + 'hetha' + 'ne.se'; return false;" class=LEMail>m<span style="display: none">.nosp@m.</span>mn<span>@</span>hetha<span style="display: none">.nosp@m.</span>ne.se</a></li><li>Maiyannah Bishop <a href="#" onClick="location.href='mai' + 'lto:' + 'maiyanna' + 'h.bishop' + '@' + 'postac' + 'tiv.com'; return false;" class=LEMail>maiyanna<span style="display: none">.nosp@m.</span>h.bishop<span>@</span>postac<span style="display: none">.nosp@m.</span>tiv.com</a></li></ul><h4 class=CHeading>Web</h4><ul><li>postActiv <a href="http://www.postactiv.com" class=LURL target=_top>http://www.postactiv.com</a></li><li>GNU social <a href="https://www.gnu.org/s/social/" class=LURL target=_top>https://www.gnu.org/s/social/</a></li></ul><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SFunction"><td class=SEntry><a href="#PluginQueueHandler" id=link4 onMouseOver="ShowTip(event, 'tt1', 'link4')" onMouseOut="HideTip('tt1')">PluginQueueHandler</a></td><td class=SDescription>Queue handler for letting plugins handle stuff.</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#transport" id=link5 onMouseOver="ShowTip(event, 'tt2', 'link5')" onMouseOut="HideTip('tt2')">transport</a></td><td class=SDescription></td></tr><tr class="SFunction"><td class=SEntry><a href="#handle" id=link6 onMouseOver="ShowTip(event, 'tt3', 'link6')" onMouseOut="HideTip('tt3')">handle</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PluginQueueHandler"></a>PluginQueueHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>class PluginQueueHandler extends QueueHandler</td></tr></table></blockquote><p>Queue handler for letting plugins handle stuff.</p><p>The plugin queue handler accepts notices over the &ldquo;plugin&rdquo; queue and simply passes them through the &ldquo;HandleQueuedNotice&rdquo; event.</p><p>This gives plugins a chance to do background processing without actually registering their own queue and ensuring that things are queued into it.</p><p>Fancier plugins may wish to instead hook the &lsquo;GetQueueHandlerClass&rsquo; event with their own class, in which case they must ensure that their notices get enqueued when they need them.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="transport"></a>transport</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>function transport()</td></tr></table></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="handle"></a>handle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function handle(</td><td class=PParameter nowrap>$notice</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>class PluginQueueHandler extends QueueHandler</td></tr></table></blockquote>Queue handler for letting plugins handle stuff.</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>function transport()</td></tr></table></blockquote></div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function handle(</td><td class=PParameter nowrap>$notice</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
\ No newline at end of file
<html><head><title>D:\Software\postActiv\classes\queue\QueueHandler.php - postActiv</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.4 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="QueueHandler.php"></a>QueueHandler.php</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#QueueHandler.php" >QueueHandler.php</a></td><td class=SDescription></td></tr><tr class="SSection"><td class=SEntry><a href="#QueueHandler" >QueueHandler</a></td><td class=SDescription>Base class for queue handlers.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#QueueHandler" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">QueueHandler</a></td><td class=SDescription>Base class for queue handlers.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#handle" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription>Here&rsquo;s the meat of your queue handler -- you&rsquo;re handed a Notice or other object, which you may do as you will with.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="QueueHandler"></a>QueueHandler</h2><div class=CBody><p>Base class for queue handlers.</p><h4 class=CHeading>postActiv</h4><p>the micro-blogging software</p><h4 class=CHeading>Copyright</h4><p>Copyright &copy; 2016, Maiyannah Bishop</p><h4 class=CHeading>Derived from code copyright various sources</h4><ul><li>GNU Social &copy; 2013-2016, Free Software Foundation, Inc</li><li>StatusNet &copy; 2008-2012, StatusNet, Inc</li></ul><h4 class=CHeading>License</h4><p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.&nbsp; See the GNU Affero General Public License for more details.</p><p>You should have received a copy of the GNU Affero General Public License along with this program.&nbsp; If not, see <a href="http://www.gnu.org/licenses/" class=LURL target=_top>http://www.gnu.org/licenses/</a>.</p><p><a href="https://www.gnu.org/licenses/agpl.html" class=LURL target=_top>https://www.gnu.org/licenses/agpl.html</a></p><h4 class=CHeading>About</h4><p>Base class for queue handlers.</p><p>As of 0.9, queue handlers are short-lived for items as they are dequeued by a QueueManager running in an IoMaster in a daemon such as queuedaemon.php.</p><p>Extensions requiring long-running maintenance or polling should register an IoManager.</p><h4 class=CHeading>Subclasses must override at least the following methods</h4><ul><li>transport</li><li>handle</li></ul><h4 class=CHeading>PHP version</h4><p>Tested with PHP 5.6</p><h4 class=CHeading>File Authors</h4><ul><li>Neil E. Hodges <a href="#" onClick="location.href='mai' + 'lto:' + '47has' + 'begun' + '@' + 'gmai' + 'l.com'; return false;" class=LEMail>47has<span style="display: none">.nosp@m.</span>begun<span>@</span>gmai<span style="display: none">.nosp@m.</span>l.com</a></li><li>Maiyannah Bishop <a href="#" onClick="location.href='mai' + 'lto:' + 'maiyanna' + 'h.bishop' + '@' + 'postac' + 'tiv.com'; return false;" class=LEMail>maiyanna<span style="display: none">.nosp@m.</span>h.bishop<span>@</span>postac<span style="display: none">.nosp@m.</span>tiv.com</a></li></ul><h4 class=CHeading>File Copyright</h4><ul><li>2016 Neil E. Hodges</li></ul><h4 class=CHeading>Web</h4><ul><li>postActiv <a href="http://www.postactiv.com" class=LURL target=_top>http://www.postactiv.com</a></li><li>GNU social <a href="https://www.gnu.org/s/social/" class=LURL target=_top>https://www.gnu.org/s/social/</a></li></ul><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SFunction"><td class=SEntry><a href="#QueueHandler" id=link3 onMouseOver="ShowTip(event, 'tt1', 'link3')" onMouseOut="HideTip('tt1')">QueueHandler</a></td><td class=SDescription>Base class for queue handlers.</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#handle" id=link4 onMouseOver="ShowTip(event, 'tt2', 'link4')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription>Here&rsquo;s the meat of your queue handler -- you&rsquo;re handed a Notice or other object, which you may do as you will with.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="QueueHandler"></a>QueueHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>class QueueHandler</td></tr></table></blockquote><p>Base class for queue handlers.</p><p>As of 0.9, queue handlers are short-lived for items as they are dequeued by a QueueManager running in an IoMaster in a daemon such as queuedaemon.php.</p><p>Extensions requiring long-running maintenance or polling should register an IoManager.</p><h4 class=CHeading>Subclasses must override at least the following methods</h4><ul><li>transport</li><li>handle</li></ul></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="handle"></a>handle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function handle(</td><td class=PParameter nowrap>$object</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Here&rsquo;s the meat of your queue handler -- you&rsquo;re handed a Notice or other object, which you may do as you will with.</p><p>If this function indicates failure, a warning will be logged and the item is placed back in the queue to be re-run.</p><h4 class=CHeading>Parameters</h4><ul><li>mixed $object</li></ul><h4 class=CHeading>Returns</h4><ul><li>boolean true on success, false on failure</li></ul></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>class QueueHandler</td></tr></table></blockquote>Base class for queue handlers.</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function handle(</td><td class=PParameter nowrap>$object</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Here&rsquo;s the meat of your queue handler -- you&rsquo;re handed a Notice or other object, which you may do as you will with.</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
\ No newline at end of file
<html><head><title>D:\Software\postActiv\classes\queue\RedisQueueManager.php - postActiv</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.4 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="RedisQueueManager.php"></a>RedisQueueManager.php</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#RedisQueueManager.php" >RedisQueueManager.php</a></td><td class=SDescription></td></tr><tr class="SSection"><td class=SEntry><a href="#RedisQueueManager" >RedisQueueManager</a></td><td class=SDescription>Manager class for the Redis Queue</td></tr><tr class="SClass"><td class=SEntry><a href="#TransportItem" >TransportItem</a></td><td class=SDescription></td></tr><tr class="SClass"><td class=SEntry><a href="#RedisQueueManager" >RedisQueueManager</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="RedisQueueManager"></a>RedisQueueManager</h2><div class=CBody><p>Manager class for the Redis Queue</p><h4 class=CHeading>postActiv</h4><p>the micro-blogging software</p><h4 class=CHeading>Copyright</h4><p>Copyright &copy; 2016, Maiyannah Bishop</p><h4 class=CHeading>Derived from code copyright various sources</h4><ul><li>GNU Social &copy; 2013-2016, Free Software Foundation, Inc</li><li>StatusNet &copy; 2008-2012, StatusNet, Inc</li></ul><h4 class=CHeading>License</h4><p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.&nbsp; See the GNU Affero General Public License for more details.</p><p>You should have received a copy of the GNU Affero General Public License along with this program.&nbsp; If not, see <a href="http://www.gnu.org/licenses/" class=LURL target=_top>http://www.gnu.org/licenses/</a>.</p><p><a href="https://www.gnu.org/licenses/agpl.html" class=LURL target=_top>https://www.gnu.org/licenses/agpl.html</a></p><h4 class=CHeading>About</h4><p>Simple-minded queue manager for storing items in the database</p><h4 class=CHeading>PHP version</h4><p>Tested with PHP 5.6</p><h4 class=CHeading>File Authors</h4><ul><li>Neil E. Hodges <a href="#" onClick="location.href='mai' + 'lto:' + '47has' + 'begun' + '@' + 'gmai' + 'l.com'; return false;" class=LEMail>47has<span style="display: none">.nosp@m.</span>begun<span>@</span>gmai<span style="display: none">.nosp@m.</span>l.com</a></li><li>Maiyannah Bishop <a href="#" onClick="location.href='mai' + 'lto:' + 'maiyanna' + 'h.bishop' + '@' + 'postac' + 'tiv.com'; return false;" class=LEMail>maiyanna<span style="display: none">.nosp@m.</span>h.bishop<span>@</span>postac<span style="display: none">.nosp@m.</span>tiv.com</a></li></ul><h4 class=CHeading>File Copyright</h4><ul><li>2016 Neil E. Hodges</li></ul><h4 class=CHeading>Web</h4><ul><li>postActiv <a href="http://www.postactiv.com" class=LURL target=_top>http://www.postactiv.com</a></li><li>GNU social <a href="https://www.gnu.org/s/social/" class=LURL target=_top>https://www.gnu.org/s/social/</a></li></ul></div></div></div>
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="TransportItem"></a>TransportItem</h2><div class=CBody></div></div></div>
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="RedisQueueManager"></a>RedisQueueManager</h2><div class=CBody></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
\ No newline at end of file
<html><head><title>D:\Software\postActiv\classes\queue\SmsQueueHandler.php - postActiv</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.4 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="SmsQueueHandler.php"></a>SmsQueueHandler.php</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#SmsQueueHandler.php" >SmsQueueHandler.php</a></td><td class=SDescription></td></tr><tr class="SSection"><td class=SEntry><a href="#SMS_Queue_Handler" >SMS Queue Handler</a></td><td class=SDescription>Queue handler for pushing new notices to local subscribers using SMS.</td></tr><tr class="SClass"><td class=SEntry><a href="#SmsQueueHandler" >SmsQueueHandler</a></td><td class=SDescription>Queue handler for pushing new notices to local subscribers using SMS.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#SmsQueueHandler.transport" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">transport</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#SmsQueueHandler.handle" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="SMS_Queue_Handler"></a>SMS Queue Handler</h2><div class=CBody><p>Queue handler for pushing new notices to local subscribers using SMS.</p><h4 class=CHeading>postActiv</h4><p>the micro-blogging software</p><h4 class=CHeading>Copyright</h4><p>Copyright &copy; 2016, Maiyannah Bishop</p><h4 class=CHeading>Derived from code copyright various sources</h4><ul><li>GNU Social &copy; 2013-2016, Free Software Foundation, Inc</li><li>StatusNet &copy; 2008-2012, StatusNet, Inc</li></ul><h4 class=CHeading>License</h4><p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.&nbsp; See the GNU Affero General Public License for more details.</p><p>You should have received a copy of the GNU Affero General Public License along with this program.&nbsp; If not, see <a href="http://www.gnu.org/licenses/" class=LURL target=_top>http://www.gnu.org/licenses/</a>.</p><p><a href="https://www.gnu.org/licenses/agpl.html" class=LURL target=_top>https://www.gnu.org/licenses/agpl.html</a></p><h4 class=CHeading>About</h4><p>Queue handler for pushing new notices to local subscribers using SMS.</p><h4 class=CHeading>PHP version</h4><p>Tested with PHP 5.6</p><h4 class=CHeading>File Authors</h4><ul><li>Brion Vibber <a href="#" onClick="location.href='mai' + 'lto:' + 'br' + 'ion' + '@' + 'pobo' + 'x.com'; return false;" class=LEMail>br<span style="display: none">.nosp@m.</span>ion<span>@</span>pobo<span style="display: none">.nosp@m.</span>x.com</a></li><li>Maiyannah Bishop <a href="#" onClick="location.href='mai' + 'lto:' + 'maiyanna' + 'h.bishop' + '@' + 'postac' + 'tiv.com'; return false;" class=LEMail>maiyanna<span style="display: none">.nosp@m.</span>h.bishop<span>@</span>postac<span style="display: none">.nosp@m.</span>tiv.com</a></li></ul><h4 class=CHeading>Web</h4><ul><li>postActiv <a href="http://www.postactiv.com" class=LURL target=_top>http://www.postactiv.com</a></li><li>GNU social <a href="https://www.gnu.org/s/social/" class=LURL target=_top>https://www.gnu.org/s/social/</a></li></ul></div></div></div>
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="SmsQueueHandler"></a>SmsQueueHandler</h2><div class=CBody><p>Queue handler for pushing new notices to local subscribers using SMS.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SFunction"><td class=SEntry><a href="#SmsQueueHandler.transport" id=link3 onMouseOver="ShowTip(event, 'tt1', 'link3')" onMouseOut="HideTip('tt1')">transport</a></td><td class=SDescription></td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#SmsQueueHandler.handle" id=link4 onMouseOver="ShowTip(event, 'tt2', 'link4')" onMouseOut="HideTip('tt2')">handle</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="SmsQueueHandler.transport"></a>transport</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>function transport()</td></tr></table></blockquote><h4 class=CHeading>Returns</h4><ul><li>string &ldquo;sms&rdquo;</li></ul></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="SmsQueueHandler.handle"></a>handle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function handle(</td><td class=PParameter nowrap>$notice</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><ul><li>Notice $notice</li></ul><h4 class=CHeading>Returns</h4><ul><li>Result of the broadcast (success true/false)</li></ul></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>function transport()</td></tr></table></blockquote></div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function handle(</td><td class=PParameter nowrap>$notice</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
\ No newline at end of file
<html><head><title>D:\Software\postActiv\classes\queue\UnQueueManager.php - postActiv</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.4 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="UnQueueManager.php"></a>UnQueueManager.php</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#UnQueueManager.php" >UnQueueManager.php</a></td><td class=SDescription></td></tr><tr class="SSection"><td class=SEntry><a href="#Un-Queue_Manager" >Un-Queue Manager</a></td><td class=SDescription>A queue manager interface for just doing things immediately</td></tr><tr class="SClass"><td class=SEntry><a href="#UnQueueManager" >UnQueueManager</a></td><td class=SDescription>Class for when we&rsquo;re telling the queue something is handled immediately.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#UnQueueManager.enqueue" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">enqueue</a></td><td class=SDescription>Dummy queue storage manager: instead of saving events for later, we just process them immediately. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="Un-Queue_Manager"></a>Un-Queue Manager</h2><div class=CBody><p>A queue manager interface for just doing things immediately</p><h4 class=CHeading>postActiv</h4><p>the micro-blogging software</p><h4 class=CHeading>Copyright</h4><p>Copyright &copy; 2016, Maiyannah Bishop</p><h4 class=CHeading>Derived from code copyright various sources</h4><ul><li>GNU Social &copy; 2013-2016, Free Software Foundation, Inc</li><li>StatusNet &copy; 2008-2012, StatusNet, Inc</li></ul><h4 class=CHeading>License</h4><p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.&nbsp; See the GNU Affero General Public License for more details.</p><p>You should have received a copy of the GNU Affero General Public License along with this program.&nbsp; If not, see <a href="http://www.gnu.org/licenses/" class=LURL target=_top>http://www.gnu.org/licenses/</a>.</p><p><a href="https://www.gnu.org/licenses/agpl.html" class=LURL target=_top>https://www.gnu.org/licenses/agpl.html</a></p><h4 class=CHeading>About</h4><p>A queue manager interface for just doing things immediately</p><p>Dummy queue storage manager: instead of saving events for later, we just process them immediately.&nbsp; This is only suitable for events that can be processed quickly and don&rsquo;t need polling or long-running connections to another server such as XMPP.</p><h4 class=CHeading>PHP version</h4><p>Tested with PHP 5.6</p><h4 class=CHeading>File Authors</h4><ul><li>Evan Prodromou</li><li>Adrian Lang <a href="#" onClick="location.href='mai' + 'lto:' + 'ma' + 'il' + '@' + 'adrian' + 'lang.de'; return false;" class=LEMail>ma<span style="display: none">.nosp@m.</span>il<span>@</span>adrian<span style="display: none">.nosp@m.</span>lang.de</a></li><li>Marcel van der Boom <a href="#" onClick="location.href='mai' + 'lto:' + 'mar' + 'cel' + '@' + 'hsde' + 'v.com'; return false;" class=LEMail>mar<span style="display: none">.nosp@m.</span>cel<span>@</span>hsde<span style="display: none">.nosp@m.</span>v.com</a></li><li>Zach Copley</li><li>Brion Vibber <a href="#" onClick="location.href='mai' + 'lto:' + 'br' + 'ion' + '@' + 'pobo' + 'x.com'; return false;" class=LEMail>br<span style="display: none">.nosp@m.</span>ion<span>@</span>pobo<span style="display: none">.nosp@m.</span>x.com</a></li><li>Mikael Nordfeldth <a href="#" onClick="location.href='mai' + 'lto:' + 'm' + 'mn' + '@' + 'hetha' + 'ne.se'; return false;" class=LEMail>m<span style="display: none">.nosp@m.</span>mn<span>@</span>hetha<span style="display: none">.nosp@m.</span>ne.se</a></li><li>Maiyannah Bishop <a href="#" onClick="location.href='mai' + 'lto:' + 'maiyanna' + 'h.bishop' + '@' + 'postac' + 'tiv.com'; return false;" class=LEMail>maiyanna<span style="display: none">.nosp@m.</span>h.bishop<span>@</span>postac<span style="display: none">.nosp@m.</span>tiv.com</a></li></ul><h4 class=CHeading>Web</h4><ul><li>postActiv <a href="http://www.postactiv.com" class=LURL target=_top>http://www.postactiv.com</a></li><li>GNU social <a href="https://www.gnu.org/s/social/" class=LURL target=_top>https://www.gnu.org/s/social/</a></li></ul></div></div></div>
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="UnQueueManager"></a>UnQueueManager</h2><div class=CBody><p>Class for when we&rsquo;re telling the queue something is handled immediately.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="UnQueueManager.enqueue"></a>enqueue</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function enqueue(</td><td class=PParameter nowrap>$object,</td></tr><tr><td></td><td class=PParameter nowrap>$transport</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Dummy queue storage manager: instead of saving events for later, we just process them immediately.&nbsp; This is only suitable for events that can be processed quickly and don&rsquo;t need polling or long-running connections to another server such as XMPP.</p><h4 class=CHeading>Parameter</h4><ul><li>Notice $object this specific manager just handles Notice objects anyway</li><li>string $queue</li></ul></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function enqueue(</td><td class=PParameter nowrap>$object,</td></tr><tr><td></td><td class=PParameter nowrap>$transport</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Dummy queue storage manager: instead of saving events for later, we just process them immediately. </div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
\ No newline at end of file
......@@ -14,13 +14,41 @@ if (browserType) {document.write("<div class=" + browserType + ">");if (browserV
<div id=Index><div class=IPageTitle>Class Index</div><div class=INavigationBar>$#! &middot; 0-9 &middot; A &middot; B &middot; C &middot; D &middot; E &middot; F &middot; G &middot; <a href="#H">H</a> &middot; I &middot; J &middot; K &middot; L &middot; M &middot; N &middot; O &middot; P &middot; Q &middot; <a href="#R">R</a> &middot; S &middot; T &middot; U &middot; V &middot; W &middot; X &middot; Y &middot; Z</div><table border=0 cellspacing=0 cellpadding=0><tr><td class=IHeading id=IFirstHeading><a name="H"></a>H</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/lib/RedisQueue-php.html#HostPort" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')" class=ISymbol>HostPort</a></td></tr><tr><td class=IHeading><a name="R"></a>R</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/lib/RedisQueue-php.html#RedisContainer" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')" class=ISymbol>RedisContainer</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/lib/RedisQueue-php.html#RedisLock" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')" class=ISymbol>RedisLock</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/lib/RedisQueue-php.html#RedisQueue" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')" class=ISymbol>RedisQueue</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/lib/RedisQueue-php.html#RedisQueueItem" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')" class=ISymbol>RedisQueueItem</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/lib/RedisQueue-php.html#RedisTimeout" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')" class=ISymbol>RedisTimeout</a></td></tr></table>
<div id=Index><div class=IPageTitle>Class Index</div><div class=INavigationBar>$#! &middot; 0-9 &middot; A &middot; B &middot; C &middot; <a href="#D">D</a> &middot; E &middot; F &middot; G &middot; <a href="#H">H</a> &middot; <a href="#I">I</a> &middot; J &middot; K &middot; <a href="#L">L</a> &middot; M &middot; N &middot; O &middot; <a href="#P">P</a> &middot; Q &middot; <a href="#R">R</a> &middot; <a href="#S">S</a> &middot; <a href="#T">T</a> &middot; <a href="#U">U</a> &middot; V &middot; W &middot; X &middot; Y &middot; Z</div><table border=0 cellspacing=0 cellpadding=0><tr><td class=IHeading id=IFirstHeading><a name="D"></a>D</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/DBQueueManager-php.html#DBQueueManager" class=ISymbol>DBQueueManager</a></td></tr><tr><td class=IHeading><a name="H"></a>H</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/RedisQueue-php.html#HostPort" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')" class=ISymbol>HostPort</a></td></tr><tr><td class=IHeading><a name="I"></a>I</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/ImManager-php.html#ImManager" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')" class=ISymbol>ImManager</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/ImQueueHandler-php.html#ImQueueHandler" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')" class=ISymbol>ImQueueHandler</a></td></tr><tr><td class=IHeading><a name="L"></a>L</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/LiberalStomp-php.html#LiberalStomp" class=ISymbol>LiberalStomp</a></td></tr><tr><td class=IHeading><a name="P"></a>P</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/ParallelizingDaemon-php.html#ParallelizingDaemon" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')" class=ISymbol>ParallelizingDaemon</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/PingQueueHandler-php.html#PingQueueHandler" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')" class=ISymbol>PingQueueHandler</a></td></tr><tr><td class=IHeading><a name="R"></a>R</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/RedisQueue-php.html#RedisContainer" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')" class=ISymbol>RedisContainer</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/RedisQueue-php.html#RedisLock" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')" class=ISymbol>RedisLock</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/RedisQueue-php.html#RedisQueue" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')" class=ISymbol>RedisQueue</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/RedisQueue-php.html#RedisQueueItem" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')" class=ISymbol>RedisQueueItem</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/RedisQueue-php.html#RedisTimeout" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')" class=ISymbol>RedisTimeout</a></td></tr><tr><td class=IHeading><a name="S"></a>S</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/SmsQueueHandler-php.html#SmsQueueHandler" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')" class=ISymbol>SmsQueueHandler</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/SpawningDaemon-php.html#SpawningDaemon" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')" class=ISymbol>SpawningDaemon</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/StompQueueManager-php.html#StompQueueManager" class=ISymbol>StompQueueManager</a></td></tr><tr><td class=IHeading><a name="T"></a>T</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/RedisQueueManager-php.html#TransportItem" class=ISymbol>TransportItem</a></td></tr><tr><td class=IHeading><a name="U"></a>U</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/UnQueueManager-php.html#UnQueueManager" id=link13 onMouseOver="ShowTip(event, 'tt13', 'link13')" onMouseOut="HideTip('tt13')" class=ISymbol>UnQueueManager</a></td></tr></table>
<!--START_ND_TOOLTIPS-->
<!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CClass>Contains information about the connection used to connect to Redis if we&rsquo;re using a TCP connection.</div></div><!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt2"><div class=CClass>Object to contain the queue item being passed to Redis</div></div><div class=CToolTip id="tt3"><div class=CClass>A class to abstract a redis lock</div></div><div class=CToolTip id="tt4"><div class=CClass>Abstraction for the actual Redis queue</div></div><div class=CToolTip id="tt5"><div class=CClass>Class representation of a queue item as needed for Redis</div></div><div class=CToolTip id="tt6"><div class=CClass>Exception for when we time out waiting for Redis</div></div><!--END_ND_TOOLTIPS-->
<div class=CToolTip id="tt2"><div class=CClass>IKM background connection manager for IM-using queue handlers, allowing them to send outgoing messages on the right connection.</div></div><div class=CToolTip id="tt3"><div class=CClass>Common superclass for all IM sending queue handlers.</div></div><!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
<!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt4"><div class=CClass>Daemon able to spawn multiple child processes to do work in parallel</div></div><div class=CToolTip id="tt5"><div class=CClass>Queue handler for pushing new notices to ping servers.</div></div><!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt6"><div class=CClass>Object to contain the queue item being passed to Redis</div></div><div class=CToolTip id="tt7"><div class=CClass>A class to abstract a redis lock</div></div><div class=CToolTip id="tt8"><div class=CClass>Abstraction for the actual Redis queue</div></div><div class=CToolTip id="tt9"><div class=CClass>Class representation of a queue item as needed for Redis</div></div><div class=CToolTip id="tt10"><div class=CClass>Exception for when we time out waiting for Redis</div></div><!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt11"><div class=CClass>Queue handler for pushing new notices to local subscribers using SMS.</div></div><div class=CToolTip id="tt12"><div class=CClass>Base class for daemon that can launch one or more processing threads, respawning them if they exit.</div></div><!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
<!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt13"><div class=CClass>Class for when we&rsquo;re telling the queue something is handled immediately.</div></div><!--END_ND_TOOLTIPS-->
</div><!--Index-->
......
......@@ -14,7 +14,23 @@ if (browserType) {document.write("<div class=" + browserType + ">");if (browserV
<div id=Index><div class=IPageTitle>File Index</div><div class=INavigationBar>$#! &middot; 0-9 &middot; A &middot; B &middot; C &middot; D &middot; E &middot; F &middot; G &middot; H &middot; <a href="#I">I</a> &middot; <a href="#J">J</a> &middot; K &middot; L &middot; M &middot; N &middot; O &middot; <a href="#P">P</a> &middot; Q &middot; <a href="#R">R</a> &middot; <a href="#S">S</a> &middot; T &middot; U &middot; V &middot; W &middot; X &middot; Y &middot; Z</div><table border=0 cellspacing=0 cellpadding=0><tr><td class=IHeading id=IFirstHeading><a name="I"></a>I</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/index-php.html#index.php" class=ISymbol>index.php</a></td></tr><tr><td class=IHeading><a name="J"></a>J</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/media/js/extlib/jquery-js.html#jquery.js" class=ISymbol>jquery.js</a></td></tr><tr><td class=IHeading><a name="P"></a>P</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/media/js/extlib/jquery-js.html#protocol_always_yields_status_0;see#8605,#14207" class=ISymbol>protocol always yields status 0;see#8605,#14207</a></td></tr><tr><td class=IHeading><a name="R"></a>R</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/lib/RedisQueue-php.html#RedisQueue.php" class=ISymbol>RedisQueue.php</a></td></tr><tr><td class=IHeading><a name="S"></a>S</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/extlib/Smarty/plugins/shared-make_timestamp-php.html#shared.make_timestamp.php" class=ISymbol>shared.<wbr>make_timestamp.php</a></td></tr></table>
<div id=Index><div class=IPageTitle>File Index</div><div class=INavigationBar>$#! &middot; 0-9 &middot; A &middot; B &middot; C &middot; <a href="#D">D</a> &middot; E &middot; F &middot; G &middot; H &middot; <a href="#I">I</a> &middot; <a href="#J">J</a> &middot; K &middot; <a href="#L">L</a> &middot; M &middot; N &middot; O &middot; <a href="#P">P</a> &middot; <a href="#Q">Q</a> &middot; <a href="#R">R</a> &middot; <a href="#S">S</a> &middot; T &middot; <a href="#U">U</a> &middot; V &middot; W &middot; X &middot; Y &middot; Z</div><table border=0 cellspacing=0 cellpadding=0><tr><td class=IHeading id=IFirstHeading><a name="D"></a>D</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/DBQueueManager-php.html#DBQueueManager.php" class=ISymbol>DBQueueManager.php</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/DelUserQueueHandler-php.html#DelUserQueueHandler.php" class=ISymbol>DelUserQueueHandler.php</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/DistribQueueHandler-php.html#DistribQueueHandler.php" class=ISymbol>DistribQueueHandler.php</a></td></tr><tr><td class=IHeading><a name="I"></a>I</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/ImManager-php.html#ImManager.php" class=ISymbol>ImManager.php</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/ImQueueHandler-php.html#ImQueueHandler.php" class=ISymbol>ImQueueHandler.php</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/ImReceiverQueueHandler-php.html#ImReceiverQueueHandler.php" class=ISymbol>ImReceiverQueueHandler.php</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/ImSenderQueueHandler-php.html#ImSenderQueueHandler.php" class=ISymbol>ImSenderQueueHandler.php</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/index-php.html#index.php" class=ISymbol>index.php</a></td></tr><tr><td class=IHeading><a name="J"></a>J</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/media/js/extlib/jquery-js.html#jquery.js" class=ISymbol>jquery.js</a></td></tr><tr><td class=IHeading><a name="L"></a>L</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/LiberalStomp-php.html#LiberalStomp.php" class=ISymbol>LiberalStomp.php</a></td></tr><tr><td class=IHeading><a name="P"></a>P</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/ParallelizingDaemon-php.html#ParallelizingDaemon.php" class=ISymbol>ParallelizingDaemon.php</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/PingQueueHandler-php.html#PingQueueHandler.php" class=ISymbol>PingQueueHandler.php</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/PluginQueueHandler-php.html#PluginQueueHandler.php" class=ISymbol>PluginQueueHandler.php</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/media/js/extlib/jquery-js.html#protocol_always_yields_status_0;see#8605,#14207" class=ISymbol>protocol always yields status 0;see#8605,#14207</a></td></tr><tr><td class=IHeading><a name="Q"></a>Q</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/QueueHandler-php.html#QueueHandler.php" class=ISymbol>QueueHandler.php</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/QueueManager-php.html#QueueManager.php" class=ISymbol>QueueManager.php</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/QueueMonitor-php.html#QueueMonitor.php" class=ISymbol>QueueMonitor.php</a></td></tr><tr><td class=IHeading><a name="R"></a>R</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/RedisQueue-php.html#RedisQueue.php" class=ISymbol>RedisQueue.php</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/RedisQueueManager-php.html#RedisQueueManager.php" class=ISymbol>RedisQueueManager.php</a></td></tr><tr><td class=IHeading><a name="S"></a>S</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/extlib/Smarty/plugins/shared-make_timestamp-php.html#shared.make_timestamp.php" class=ISymbol>shared.<wbr>make_timestamp.php</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/SmsQueueHandler-php.html#SmsQueueHandler.php" class=ISymbol>SmsQueueHandler.php</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/SpawningDaemon-php.html#SpawningDaemon.php" class=ISymbol>SpawningDaemon.php</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/StompQueueManager-php.html#StompQueueManager.php" class=ISymbol>StompQueueManager.php</a></td></tr><tr><td class=IHeading><a name="U"></a>U</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/classes/queue/UnQueueManager-php.html#UnQueueManager.php" class=ISymbol>UnQueueManager.php</a></td></tr></table>
<!--START_ND_TOOLTIPS-->
<!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
<!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
<!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
<!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
<!--END_ND_TOOLTIPS-->
......
var indexSectionsWithContent = {
"Functions": {
"General": {
"Symbols": true,
"Numbers": false,
"A": true,
"B": false,
"B": true,
"C": true,
"D": false,
"E": false,
"D": true,
"E": true,
"F": true,
"G": true,
"H": true,
"I": true,
"J": false,
"J": true,
"K": false,
"L": true,
"M": true,
"N": true,
"O": false,
"P": true,
"Q": false,
"R": false,
"Q": true,
"R": true,
"S": true,
"T": false,
"T": true,
"U": true,
"V": false,
"W": false,
......@@ -29,89 +29,59 @@ var indexSectionsWithContent = {
"Y": false,
"Z": false
},
"Variables": {
"Symbols": true,
"Numbers": false,
"A": false,
"B": false,
"C": false,
"D": false,
"E": false,
"F": false,
"G": false,
"H": false,
"I": false,
"J": false,
"K": false,
"L": false,
"M": false,
"N": false,
"O": false,
"P": false,
"Q": false,
"R": false,
"S": false,
"T": false,
"U": false,
"V": false,
"W": false,
"X": false,
"Y": false,
"Z": false
},
"Classes": {
"Symbols": false,
"Numbers": false,
"A": false,
"B": false,
"C": false,
"D": false,
"D": true,
"E": false,
"F": false,
"G": false,
"H": true,
"I": false,
"I": true,
"J": false,
"K": false,
"L": false,
"L": true,
"M": false,
"N": false,
"O": false,
"P": false,
"P": true,
"Q": false,
"R": true,
"S": false,
"T": false,
"U": false,
"S": true,
"T": true,
"U": true,
"V": false,
"W": false,
"X": false,
"Y": false,
"Z": false
},
"General": {
"Functions": {
"Symbols": true,
"Numbers": false,
"A": true,
"B": false,
"B": true,
"C": true,
"D": false,
"D": true,
"E": true,
"F": true,
"G": true,
"H": true,
"I": true,
"J": true,
"J": false,
"K": false,
"L": true,
"M": true,
"N": true,