cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
431 lines (429 loc) • 15.4 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>TCustomSocket (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="TCustomSocket (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/TCustomSocket.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/TCustomServerSocket.html" title="class in org.apache.cassandra.thrift"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/thrift/TFramedTransportFactory.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/TCustomSocket.html" target="_top">Frames</a></li>
<li><a href="TCustomSocket.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="#fields_inherited_from_class_org.apache.thrift.transport.TIOStreamTransport">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>Field | </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 TCustomSocket" class="title">Class TCustomSocket</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.thrift.transport.TTransport</li>
<li>
<ul class="inheritance">
<li>org.apache.thrift.transport.TIOStreamTransport</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.thrift.TCustomSocket</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">TCustomSocket</span>
extends org.apache.thrift.transport.TIOStreamTransport</pre>
<div class="block">Socket implementation of the TTransport interface.
Adds socket buffering</div>
</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>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.thrift.transport.TIOStreamTransport">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.thrift.transport.TIOStreamTransport</h3>
<code>inputStream_, outputStream_</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"> </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/TCustomSocket.html#TCustomSocket(java.net.Socket)">TCustomSocket</a></strong>(java.net.Socket socket)</code>
<div class="block">Constructor that takes an already created socket.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/thrift/TCustomSocket.html#TCustomSocket(java.lang.String,%20int)">TCustomSocket</a></strong>(java.lang.String host,
int port)</code>
<div class="block">Creates a new unconnected socket that will connect to the given host
on the given port.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/thrift/TCustomSocket.html#TCustomSocket(java.lang.String,%20int,%20int)">TCustomSocket</a></strong>(java.lang.String host,
int port,
int timeout)</code>
<div class="block">Creates a new unconnected socket that will connect to the given host
on the given port.</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"> </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/thrift/TCustomSocket.html#close()">close</a></strong>()</code>
<div class="block">Closes the socket.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.net.Socket</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/TCustomSocket.html#getSocket()">getSocket</a></strong>()</code>
<div class="block">Returns a reference to the underlying socket.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/TCustomSocket.html#isOpen()">isOpen</a></strong>()</code>
<div class="block">Checks whether the socket is connected.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/TCustomSocket.html#open()">open</a></strong>()</code>
<div class="block">Connects the socket, creating a new socket object if necessary.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/TCustomSocket.html#setTimeout(int)">setTimeout</a></strong>(int timeout)</code>
<div class="block">Sets the socket timeout</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.thrift.transport.TIOStreamTransport">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.thrift.transport.TIOStreamTransport</h3>
<code>flush, read, write</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.thrift.transport.TTransport">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.thrift.transport.TTransport</h3>
<code>consumeBuffer, getBuffer, getBufferPosition, getBytesRemainingInBuffer, peek, readAll, write</code></li>
</ul>
<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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TCustomSocket(java.net.Socket)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TCustomSocket</h4>
<pre>public TCustomSocket(java.net.Socket socket)
throws org.apache.thrift.transport.TTransportException</pre>
<div class="block">Constructor that takes an already created socket.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>socket</code> - Already created socket object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.thrift.transport.TTransportException</code> - if there is an error setting up the streams</dd></dl>
</li>
</ul>
<a name="TCustomSocket(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TCustomSocket</h4>
<pre>public TCustomSocket(java.lang.String host,
int port)</pre>
<div class="block">Creates a new unconnected socket that will connect to the given host
on the given port.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>host</code> - Remote host</dd><dd><code>port</code> - Remote port</dd></dl>
</li>
</ul>
<a name="TCustomSocket(java.lang.String, int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TCustomSocket</h4>
<pre>public TCustomSocket(java.lang.String host,
int port,
int timeout)</pre>
<div class="block">Creates a new unconnected socket that will connect to the given host
on the given port.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>host</code> - Remote host</dd><dd><code>port</code> - Remote port</dd><dd><code>timeout</code> - Socket timeout</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="setTimeout(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTimeout</h4>
<pre>public void setTimeout(int timeout)</pre>
<div class="block">Sets the socket timeout</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - Milliseconds timeout</dd></dl>
</li>
</ul>
<a name="getSocket()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSocket</h4>
<pre>public java.net.Socket getSocket()</pre>
<div class="block">Returns a reference to the underlying socket.</div>
</li>
</ul>
<a name="isOpen()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOpen</h4>
<pre>public boolean isOpen()</pre>
<div class="block">Checks whether the socket is connected.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>isOpen</code> in class <code>org.apache.thrift.transport.TIOStreamTransport</code></dd>
</dl>
</li>
</ul>
<a name="open()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre>public void open()
throws org.apache.thrift.transport.TTransportException</pre>
<div class="block">Connects the socket, creating a new socket object if necessary.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>open</code> in class <code>org.apache.thrift.transport.TIOStreamTransport</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.thrift.transport.TTransportException</code></dd></dl>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public void close()</pre>
<div class="block">Closes the socket.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>close</code> in class <code>org.apache.thrift.transport.TIOStreamTransport</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/TCustomSocket.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/TCustomServerSocket.html" title="class in org.apache.cassandra.thrift"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/thrift/TFramedTransportFactory.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/TCustomSocket.html" target="_top">Frames</a></li>
<li><a href="TCustomSocket.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="#fields_inherited_from_class_org.apache.thrift.transport.TIOStreamTransport">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>Field | </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>