UNPKG

cassandra-server

Version:

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

440 lines (439 loc) 16.5 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>Server (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="Server (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/Server.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/transport/RequestThreadPoolExecutor.html" title="class in org.apache.cassandra.transport"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/transport/Server.ConnectionTracker.html" title="class in org.apache.cassandra.transport"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/transport/Server.html" target="_top">Frames</a></li> <li><a href="Server.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_class_summary">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.transport</div> <h2 title="Class Server" class="title">Class Server</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.transport.Server</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html" title="interface in org.apache.cassandra.service">CassandraDaemon.Server</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">Server</span> extends java.lang.Object implements <a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html" title="interface in org.apache.cassandra.service">CassandraDaemon.Server</a></pre> </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> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Class and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static class&nbsp;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/Server.ConnectionTracker.html" title="class in org.apache.cassandra.transport">Server.ConnectionTracker</a></strong></code>&nbsp;</td> </tr> </table> </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>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/Server.html#CURRENT_VERSION">CURRENT_VERSION</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.net.InetSocketAddress</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/Server.html#socket">socket</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/Server.html#VERSION_3">VERSION_3</a></strong></code>&nbsp;</td> </tr> </table> </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/transport/Server.html#Server(java.net.InetAddress,%20int)">Server</a></strong>(java.net.InetAddress&nbsp;host, int&nbsp;port)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/transport/Server.html#Server(java.net.InetSocketAddress)">Server</a></strong>(java.net.InetSocketAddress&nbsp;socket)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/transport/Server.html#Server(int)">Server</a></strong>(int&nbsp;port)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/transport/Server.html#Server(java.lang.String,%20int)">Server</a></strong>(java.lang.String&nbsp;hostname, int&nbsp;port)</code>&nbsp;</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>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/Server.html#isRunning()">isRunning</a></strong>()</code> <div class="block">Returns whether the server is currently running.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/Server.html#start()">start</a></strong>()</code> <div class="block">Start the server.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/Server.html#stop()">stop</a></strong>()</code> <div class="block">Stop the server.</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"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field_detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="VERSION_3"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>VERSION_3</h4> <pre>public static final&nbsp;int VERSION_3</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.transport.Server.VERSION_3">Constant Field Values</a></dd></dl> </li> </ul> <a name="CURRENT_VERSION"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>CURRENT_VERSION</h4> <pre>public static final&nbsp;int CURRENT_VERSION</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.transport.Server.CURRENT_VERSION">Constant Field Values</a></dd></dl> </li> </ul> <a name="socket"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>socket</h4> <pre>public final&nbsp;java.net.InetSocketAddress socket</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="Server(java.net.InetSocketAddress)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>Server</h4> <pre>public&nbsp;Server(java.net.InetSocketAddress&nbsp;socket)</pre> </li> </ul> <a name="Server(java.lang.String, int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>Server</h4> <pre>public&nbsp;Server(java.lang.String&nbsp;hostname, int&nbsp;port)</pre> </li> </ul> <a name="Server(java.net.InetAddress, int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>Server</h4> <pre>public&nbsp;Server(java.net.InetAddress&nbsp;host, int&nbsp;port)</pre> </li> </ul> <a name="Server(int)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Server</h4> <pre>public&nbsp;Server(int&nbsp;port)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="start()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>start</h4> <pre>public&nbsp;void&nbsp;start()</pre> <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html#start()">CassandraDaemon.Server</a></code></strong></div> <div class="block">Start the server. This method shoud be able to restart a server stopped through stop(). Should throw a RuntimeException if the server cannot be started</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html#start()">start</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html" title="interface in org.apache.cassandra.service">CassandraDaemon.Server</a></code></dd> </dl> </li> </ul> <a name="stop()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>stop</h4> <pre>public&nbsp;void&nbsp;stop()</pre> <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html#stop()">CassandraDaemon.Server</a></code></strong></div> <div class="block">Stop the server. This method should be able to stop server started through start(). Should throw a RuntimeException if the server cannot be stopped</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html#stop()">stop</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html" title="interface in org.apache.cassandra.service">CassandraDaemon.Server</a></code></dd> </dl> </li> </ul> <a name="isRunning()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>isRunning</h4> <pre>public&nbsp;boolean&nbsp;isRunning()</pre> <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html#isRunning()">CassandraDaemon.Server</a></code></strong></div> <div class="block">Returns whether the server is currently running.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html#isRunning()">isRunning</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html" title="interface in org.apache.cassandra.service">CassandraDaemon.Server</a></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/Server.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/transport/RequestThreadPoolExecutor.html" title="class in org.apache.cassandra.transport"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/transport/Server.ConnectionTracker.html" title="class in org.apache.cassandra.transport"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/transport/Server.html" target="_top">Frames</a></li> <li><a href="Server.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_class_summary">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>