UNPKG

cassandra-server

Version:

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

470 lines (469 loc) 19.4 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:35 CEST 2014 --> <title>AbstractColumnFamilyRecordWriter.AbstractRangeClient (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="AbstractColumnFamilyRecordWriter.AbstractRangeClient (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/AbstractColumnFamilyRecordWriter.AbstractRangeClient.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/hadoop/AbstractColumnFamilyRecordWriter.html" title="class in org.apache.cassandra.hadoop"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/hadoop/BulkOutputFormat.html" title="class in org.apache.cassandra.hadoop"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html" target="_top">Frames</a></li> <li><a href="AbstractColumnFamilyRecordWriter.AbstractRangeClient.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><a href="#nested_classes_inherited_from_class_java.lang.Thread">Nested</a>&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&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.hadoop</div> <h2 title="Class AbstractColumnFamilyRecordWriter.AbstractRangeClient" class="title">Class AbstractColumnFamilyRecordWriter.AbstractRangeClient&lt;K&gt;</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>java.lang.Thread</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.hadoop.AbstractColumnFamilyRecordWriter.AbstractRangeClient&lt;K&gt;</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.lang.Runnable</dd> </dl> <dl> <dt>Enclosing class:</dt> <dd><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html" title="class in org.apache.cassandra.hadoop">AbstractColumnFamilyRecordWriter</a>&lt;<a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html" title="type parameter in AbstractColumnFamilyRecordWriter">K</a>,<a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html" title="type parameter in AbstractColumnFamilyRecordWriter">Y</a>&gt;</dd> </dl> <hr> <br> <pre>public abstract class <span class="strong">AbstractColumnFamilyRecordWriter.AbstractRangeClient&lt;K&gt;</span> extends java.lang.Thread</pre> <div class="block">A client that runs in a threadpool and connects to the list of endpoints for a particular range. Mutations for keys in that range are sent to this client via a queue.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="nested_class_summary"> <!-- --> </a> <h3>Nested Class Summary</h3> <ul class="blockList"> <li class="blockList"><a name="nested_classes_inherited_from_class_java.lang.Thread"> <!-- --> </a> <h3>Nested classes/interfaces inherited from class&nbsp;java.lang.Thread</h3> <code>java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler</code></li> </ul> </li> </ul> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field_summary"> <!-- --> </a> <h3>Field Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected <a href="../../../../org/apache/cassandra/thrift/Cassandra.Client.html" title="class in org.apache.cassandra.thrift">Cassandra.Client</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html#client">client</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected java.util.List&lt;java.net.InetAddress&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html#endpoints">endpoints</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected java.io.IOException</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html#lastException">lastException</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected java.util.concurrent.BlockingQueue&lt;<a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html" title="type parameter in AbstractColumnFamilyRecordWriter.AbstractRangeClient">K</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html#queue">queue</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html#run">run</a></strong></code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_java.lang.Thread"> <!-- --> </a> <h3>Fields inherited from class&nbsp;java.lang.Thread</h3> <code>MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY</code></li> </ul> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html#AbstractColumnFamilyRecordWriter.AbstractRangeClient(java.util.List)">AbstractColumnFamilyRecordWriter.AbstractRangeClient</a></strong>(java.util.List&lt;java.net.InetAddress&gt;&nbsp;endpoints)</code> <div class="block">Constructs an <a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html" title="class in org.apache.cassandra.hadoop"><code>AbstractColumnFamilyRecordWriter.AbstractRangeClient</code></a> for the given endpoints.</div> </td> </tr> </table> </li> </ul> <!-- ========== 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/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html#close()">close</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html#closeInternal()">closeInternal</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html#put(K)">put</a></strong>(<a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html" title="type parameter in AbstractColumnFamilyRecordWriter.AbstractRangeClient">K</a>&nbsp;value)</code> <div class="block">enqueues the given value to Cassandra</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html#run()">run</a></strong>()</code> <div class="block">Loops collecting mutations from the queue and sending to Cassandra</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html#toString()">toString</a></strong>()</code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Thread"> <!-- --> </a> <h3>Methods inherited from class&nbsp;java.lang.Thread</h3> <code>activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, yield</code></li> </ul> <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>equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field_detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="endpoints"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>endpoints</h4> <pre>protected final&nbsp;java.util.List&lt;java.net.InetAddress&gt; endpoints</pre> </li> </ul> <a name="queue"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>queue</h4> <pre>protected final&nbsp;java.util.concurrent.BlockingQueue&lt;<a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html" title="type parameter in AbstractColumnFamilyRecordWriter.AbstractRangeClient">K</a>&gt; queue</pre> </li> </ul> <a name="run"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>run</h4> <pre>protected volatile&nbsp;boolean run</pre> </li> </ul> <a name="lastException"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>lastException</h4> <pre>protected volatile&nbsp;java.io.IOException lastException</pre> </li> </ul> <a name="client"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>client</h4> <pre>protected&nbsp;<a href="../../../../org/apache/cassandra/thrift/Cassandra.Client.html" title="class in org.apache.cassandra.thrift">Cassandra.Client</a> client</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="AbstractColumnFamilyRecordWriter.AbstractRangeClient(java.util.List)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>AbstractColumnFamilyRecordWriter.AbstractRangeClient</h4> <pre>public&nbsp;AbstractColumnFamilyRecordWriter.AbstractRangeClient(java.util.List&lt;java.net.InetAddress&gt;&nbsp;endpoints)</pre> <div class="block">Constructs an <a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html" title="class in org.apache.cassandra.hadoop"><code>AbstractColumnFamilyRecordWriter.AbstractRangeClient</code></a> for the given endpoints.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>endpoints</code> - the possible endpoints to execute the mutations on</dd></dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="put(java.lang.Object)"> <!-- --> </a><a name="put(K)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>put</h4> <pre>public&nbsp;void&nbsp;put(<a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html" title="type parameter in AbstractColumnFamilyRecordWriter.AbstractRangeClient">K</a>&nbsp;value) throws java.io.IOException</pre> <div class="block">enqueues the given value to Cassandra</div> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="close()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>close</h4> <pre>public&nbsp;void&nbsp;close() throws java.io.IOException</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="closeInternal()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>closeInternal</h4> <pre>protected&nbsp;void&nbsp;closeInternal()</pre> </li> </ul> <a name="run()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>run</h4> <pre>public abstract&nbsp;void&nbsp;run()</pre> <div class="block">Loops collecting mutations from the queue and sending to Cassandra</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>run</code>&nbsp;in interface&nbsp;<code>java.lang.Runnable</code></dd> <dt><strong>Overrides:</strong></dt> <dd><code>run</code>&nbsp;in class&nbsp;<code>java.lang.Thread</code></dd> </dl> </li> </ul> <a name="toString()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> <pre>public&nbsp;java.lang.String&nbsp;toString()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Thread</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/AbstractColumnFamilyRecordWriter.AbstractRangeClient.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/hadoop/AbstractColumnFamilyRecordWriter.html" title="class in org.apache.cassandra.hadoop"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/hadoop/BulkOutputFormat.html" title="class in org.apache.cassandra.hadoop"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html" target="_top">Frames</a></li> <li><a href="AbstractColumnFamilyRecordWriter.AbstractRangeClient.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><a href="#nested_classes_inherited_from_class_java.lang.Thread">Nested</a>&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&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>