UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

311 lines (310 loc) 13.1 kB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:30 CEST 2014 --> <title>OpOrder.Group (apache-cassandra API)</title> <meta name="date" content="2014-09-07"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="OpOrder.Group (apache-cassandra API)"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/OpOrder.Group.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../../index-all.html">Index</a></li> <li><a href="../../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Barrier.html" title="class in org.apache.cassandra.utils.concurrent"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/utils/concurrent/SimpleCondition.html" title="class in org.apache.cassandra.utils.concurrent"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/utils/concurrent/OpOrder.Group.html" target="_top">Frames</a></li> <li><a href="OpOrder.Group.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">org.apache.cassandra.utils.concurrent</div> <h2 title="Class OpOrder.Group" class="title">Class OpOrder.Group</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.utils.concurrent.OpOrder.Group</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.lang.AutoCloseable, java.lang.Comparable&lt;<a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a>&gt;</dd> </dl> <dl> <dt>Enclosing class:</dt> <dd><a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder</a></dd> </dl> <hr> <br> <pre>public static final class <span class="strong">OpOrder.Group</span> extends java.lang.Object implements java.lang.Comparable&lt;<a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a>&gt;, java.lang.AutoCloseable</pre> <div class="block">Represents a group of identically ordered operations, i.e. all operations started in the interval between two barrier issuances. For each register() call this is returned, close() must be called exactly once. It should be treated like taking a lock().</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html#close()">close</a></strong>()</code> <div class="block">To be called exactly once for each register() call this object is returned for, indicating the operation is complete</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html#compareTo(org.apache.cassandra.utils.concurrent.OpOrder.Group)">compareTo</a></strong>(<a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a>&nbsp;that)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html#isBlocking()">isBlocking</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/utils/concurrent/WaitQueue.Signal.html" title="interface in org.apache.cassandra.utils.concurrent">WaitQueue.Signal</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html#isBlockingSignal()">isBlockingSignal</a></strong>()</code> <div class="block">register to be signalled when a barrier waiting on us is, or maybe, blocking general progress, so we should try more aggressively to progress</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/utils/concurrent/WaitQueue.Signal.html" title="interface in org.apache.cassandra.utils.concurrent">WaitQueue.Signal</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html#isBlockingSignal(org.apache.cassandra.utils.concurrent.WaitQueue.Signal)">isBlockingSignal</a></strong>(<a href="../../../../../org/apache/cassandra/utils/concurrent/WaitQueue.Signal.html" title="interface in org.apache.cassandra.utils.concurrent">WaitQueue.Signal</a>&nbsp;signal)</code> <div class="block">wrap the provided signal to also be signalled if the operation gets marked blocking</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class&nbsp;java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="close()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>close</h4> <pre>public&nbsp;void&nbsp;close()</pre> <div class="block">To be called exactly once for each register() call this object is returned for, indicating the operation is complete</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd> </dl> </li> </ul> <a name="isBlocking()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isBlocking</h4> <pre>public&nbsp;boolean&nbsp;isBlocking()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>true if a barrier we are behind is, or may be, blocking general progress, so we should try more aggressively to progress</dd></dl> </li> </ul> <a name="isBlockingSignal()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isBlockingSignal</h4> <pre>public&nbsp;<a href="../../../../../org/apache/cassandra/utils/concurrent/WaitQueue.Signal.html" title="interface in org.apache.cassandra.utils.concurrent">WaitQueue.Signal</a>&nbsp;isBlockingSignal()</pre> <div class="block">register to be signalled when a barrier waiting on us is, or maybe, blocking general progress, so we should try more aggressively to progress</div> </li> </ul> <a name="isBlockingSignal(org.apache.cassandra.utils.concurrent.WaitQueue.Signal)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isBlockingSignal</h4> <pre>public&nbsp;<a href="../../../../../org/apache/cassandra/utils/concurrent/WaitQueue.Signal.html" title="interface in org.apache.cassandra.utils.concurrent">WaitQueue.Signal</a>&nbsp;isBlockingSignal(<a href="../../../../../org/apache/cassandra/utils/concurrent/WaitQueue.Signal.html" title="interface in org.apache.cassandra.utils.concurrent">WaitQueue.Signal</a>&nbsp;signal)</pre> <div class="block">wrap the provided signal to also be signalled if the operation gets marked blocking</div> </li> </ul> <a name="compareTo(org.apache.cassandra.utils.concurrent.OpOrder.Group)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>compareTo</h4> <pre>public&nbsp;int&nbsp;compareTo(<a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a>&nbsp;that)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>compareTo</code>&nbsp;in interface&nbsp;<code>java.lang.Comparable&lt;<a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a>&gt;</code></dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/OpOrder.Group.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../../index-all.html">Index</a></li> <li><a href="../../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Barrier.html" title="class in org.apache.cassandra.utils.concurrent"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/utils/concurrent/SimpleCondition.html" title="class in org.apache.cassandra.utils.concurrent"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/utils/concurrent/OpOrder.Group.html" target="_top">Frames</a></li> <li><a href="OpOrder.Group.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small>Copyright &copy; 2014 The Apache Software Foundation</small></p> </body> </html>