cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
464 lines (463 loc) • 17.9 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:35 CEST 2014 -->
<title>ThriftServer (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="ThriftServer (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/ThriftServer.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/thrift/ThriftConversion.html" title="class in org.apache.cassandra.thrift"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/thrift/ThriftSessionManager.html" title="class in org.apache.cassandra.thrift"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/thrift/ThriftServer.html" target="_top">Frames</a></li>
<li><a href="ThriftServer.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: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </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.thrift</div>
<h2 title="Class ThriftServer" class="title">Class ThriftServer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.thrift.ThriftServer</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">ThriftServer</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">
<!-- =========== 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"> </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 java.net.InetAddress</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/ThriftServer.html#address">address</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/ThriftServer.html#ASYNC">ASYNC</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/ThriftServer.html#backlog">backlog</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/ThriftServer.html#HSHA">HSHA</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/ThriftServer.html#port">port</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/ThriftServer.html#SYNC">SYNC</a></strong></code> </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"> </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/thrift/ThriftServer.html#ThriftServer(java.net.InetAddress,%20int,%20int)">ThriftServer</a></strong>(java.net.InetAddress address,
int port,
int backlog)</code> </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"> </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>protected <a href="../../../../org/apache/cassandra/thrift/CassandraServer.html" title="class in org.apache.cassandra.thrift">CassandraServer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/ThriftServer.html#getCassandraServer()">getCassandraServer</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.apache.thrift.TProcessor</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/ThriftServer.html#getProcessor(org.apache.cassandra.thrift.CassandraServer)">getProcessor</a></strong>(<a href="../../../../org/apache/cassandra/thrift/CassandraServer.html" title="class in org.apache.cassandra.thrift">CassandraServer</a> server)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.apache.thrift.transport.TTransportFactory</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/ThriftServer.html#getTransportFactory()">getTransportFactory</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/ThriftServer.html#isRunning()">isRunning</a></strong>()</code>
<div class="block">Returns whether the server is currently running.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/ThriftServer.html#start()">start</a></strong>()</code>
<div class="block">Start the server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/ThriftServer.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 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="SYNC">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SYNC</h4>
<pre>protected static final java.lang.String SYNC</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.thrift.ThriftServer.SYNC">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ASYNC">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ASYNC</h4>
<pre>protected static final java.lang.String ASYNC</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.thrift.ThriftServer.ASYNC">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="HSHA">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HSHA</h4>
<pre>protected static final java.lang.String HSHA</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.thrift.ThriftServer.HSHA">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="address">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>address</h4>
<pre>protected final java.net.InetAddress address</pre>
</li>
</ul>
<a name="port">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>port</h4>
<pre>protected final int port</pre>
</li>
</ul>
<a name="backlog">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>backlog</h4>
<pre>protected final int backlog</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ThriftServer(java.net.InetAddress, int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ThriftServer</h4>
<pre>public ThriftServer(java.net.InetAddress address,
int port,
int backlog)</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 void start()</pre>
<div class="block"><strong>Description copied from interface: <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> in interface <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 void stop()</pre>
<div class="block"><strong>Description copied from interface: <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> in interface <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="blockList">
<li class="blockList">
<h4>isRunning</h4>
<pre>public boolean isRunning()</pre>
<div class="block"><strong>Description copied from interface: <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> in interface <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="getCassandraServer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCassandraServer</h4>
<pre>protected <a href="../../../../org/apache/cassandra/thrift/CassandraServer.html" title="class in org.apache.cassandra.thrift">CassandraServer</a> getCassandraServer()</pre>
</li>
</ul>
<a name="getProcessor(org.apache.cassandra.thrift.CassandraServer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProcessor</h4>
<pre>protected org.apache.thrift.TProcessor getProcessor(<a href="../../../../org/apache/cassandra/thrift/CassandraServer.html" title="class in org.apache.cassandra.thrift">CassandraServer</a> server)</pre>
</li>
</ul>
<a name="getTransportFactory()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTransportFactory</h4>
<pre>protected org.apache.thrift.transport.TTransportFactory getTransportFactory()</pre>
</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/ThriftServer.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/thrift/ThriftConversion.html" title="class in org.apache.cassandra.thrift"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/thrift/ThriftSessionManager.html" title="class in org.apache.cassandra.thrift"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/thrift/ThriftServer.html" target="_top">Frames</a></li>
<li><a href="ThriftServer.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: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </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 © 2014 The Apache Software Foundation</small></p>
</body>
</html>