Commit 52083eb8 by Maiyannah Bishop

A few documentation clarifications suggested by Neil

1 parent f0acb1ef
......@@ -16,7 +16,7 @@ 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>
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CClass>Contains information about the connection used to connect to Redis</div></div><!--END_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-->
......
......@@ -52,7 +52,7 @@ if (browserType) {document.write("<div class=" + browserType + ">");if (browserV
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt20"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>protected function nextId()</td></tr></table></blockquote>Find the next queue item (locking it while we process)</div></div><div class=CToolTip id="tt21"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>protected function nextIdLock()</td></tr></table></blockquote>Create a Redis lock</div></div><!--END_ND_TOOLTIPS-->
<div class=CToolTip id="tt20"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>protected function nextId()</td></tr></table></blockquote>Find the next queue item&rsquo;s ID (locking it while we process)</div></div><div class=CToolTip id="tt21"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>protected function nextIdLock()</td></tr></table></blockquote>Create a Redis lock</div></div><!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
......
......@@ -40,7 +40,7 @@ if (browserType) {document.write("<div class=" + browserType + ">");if (browserV
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt16"><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 handleError(</td><td class=PParameter nowrap>$error</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Logs and then displays error messages</div></div><div class=CToolTip id="tt17"><div class=CGroup>Functions used to help bootstrap the application.</div></div><div class=CToolTip id="tt18"><div class=CClass>Contains information about the connection used to connect to Redis</div></div><!--END_ND_TOOLTIPS-->
<div class=CToolTip id="tt16"><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 handleError(</td><td class=PParameter nowrap>$error</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Logs and then displays error messages</div></div><div class=CToolTip id="tt17"><div class=CGroup>Functions used to help bootstrap the application.</div></div><div class=CToolTip id="tt18"><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-->
......@@ -60,7 +60,7 @@ if (browserType) {document.write("<div class=" + browserType + ">");if (browserV
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt25"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>protected function nextId()</td></tr></table></blockquote>Find the next queue item (locking it while we process)</div></div><div class=CToolTip id="tt26"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>protected function nextIdLock()</td></tr></table></blockquote>Create a Redis lock</div></div><!--END_ND_TOOLTIPS-->
<div class=CToolTip id="tt25"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>protected function nextId()</td></tr></table></blockquote>Find the next queue item&rsquo;s ID (locking it while we process)</div></div><div class=CToolTip id="tt26"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>protected function nextIdLock()</td></tr></table></blockquote>Create a Redis lock</div></div><!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
......
var indexSectionsWithContent = {
"General": {
"Functions": {
"Symbols": true,
"Numbers": false,
"A": true,
"B": false,
"C": true,
"D": false,
"E": true,
"E": false,
"F": true,
"G": true,
"H": true,
"I": true,
"J": true,
"J": false,
"K": false,
"L": true,
"M": true,
......@@ -19,7 +19,7 @@ var indexSectionsWithContent = {
"O": false,
"P": true,
"Q": false,
"R": true,
"R": false,
"S": true,
"T": false,
"U": true,
......@@ -59,67 +59,67 @@ var indexSectionsWithContent = {
"Y": false,
"Z": false
},
"Functions": {
"Symbols": true,
"Classes": {
"Symbols": false,
"Numbers": false,
"A": true,
"A": false,
"B": false,
"C": true,
"C": false,
"D": false,
"E": false,
"F": true,
"G": true,
"F": false,
"G": false,
"H": true,
"I": true,
"I": false,
"J": false,
"K": false,
"L": true,
"M": true,
"N": true,
"L": false,
"M": false,
"N": false,
"O": false,
"P": true,
"P": false,
"Q": false,
"R": false,
"S": true,
"R": true,
"S": false,
"T": false,
"U": true,
"U": false,
"V": false,
"W": false,
"X": false,
"Y": false,
"Z": false
},
"Files": {
"Symbols": false,
"General": {
"Symbols": true,
"Numbers": false,
"A": false,
"A": true,
"B": false,
"C": false,
"C": true,
"D": false,
"E": false,
"F": false,
"G": false,
"H": false,
"E": true,
"F": true,
"G": true,
"H": true,
"I": true,
"J": true,
"K": false,
"L": false,
"M": false,
"N": false,
"L": true,
"M": true,
"N": true,
"O": false,
"P": true,
"Q": false,
"R": true,
"S": true,
"T": false,
"U": false,
"U": true,
"V": false,
"W": false,
"X": false,
"Y": false,
"Z": false
},
"Classes": {
"Files": {
"Symbols": false,
"Numbers": false,
"A": false,
......@@ -129,18 +129,18 @@ var indexSectionsWithContent = {
"E": false,
"F": false,
"G": false,
"H": true,
"I": false,
"J": false,
"H": false,
"I": true,
"J": true,
"K": false,
"L": false,
"M": false,
"N": false,
"O": false,
"P": false,
"P": true,
"Q": false,
"R": true,
"S": false,
"S": true,
"T": false,
"U": false,
"V": false,
......
......@@ -53,7 +53,8 @@
// ----------------------------------------------------------------------------
// Class: HostPort
// Contains information about the connection used to connect to Redis
// Contains information about the connection used to connect to Redis if we're
// using a TCP connection.
//
// Variables:
// o host: IP address of host
......@@ -281,7 +282,9 @@ class RedisQueue {
// Class constructor
//
// Parameters:
// o address - URI of the Redis we're connecting to
// o address - location of the Redis we're connecting to, either a string
// containing the Unix socket location, or a HostPort object w/
// TCP connection information
// o namespace - namespace for queue items
// o expiration - Expiration of the queue items
//
......@@ -378,7 +381,7 @@ class RedisQueue {
// --------------------------------------------------------------------------
// Function: nextId
// Find the next queue item (locking it while we process)
// Find the next queue item's ID (locking it while we process)
//
// Error State:
// o will throw an exception if the connection has been closed
......@@ -544,6 +547,8 @@ class RedisQueue {
// Function: scrub
// Cleanup the Redis queue
//
// Used for when we're testing the queue, not meant for use in production
//
// Error State:
// o will throw an exception if the connection has been closed
public function scrub() {
......
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!