diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html | 383 |
1 files changed, 383 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html new file mode 100644 index 0000000..f4dd965 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html @@ -0,0 +1,383 @@ +<!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_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>RemoteProcedure.Call (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="RemoteProcedure.Call (Carbonado 1.2.3 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/RemoteProcedure.Call.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.Call.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Call.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>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.amazon.carbonado.capability</div> +<h2 title="Interface RemoteProcedure.Call" class="title">Interface RemoteProcedure.Call<R,D></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>R</code> - reply object type</dd><dd><code>D</code> - request data object type</dd></dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">RemoteProcedure.Call<R,D></span></pre> +<div class="block">Client-side call into a remote procedure. To avoid leaking resources, + the finish method must be invoked or all reply data be fully read. If an + exception is thrown by a method defined in this interface, resources are + automatically released.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html#beginCall(com.amazon.carbonado.capability.RemoteProcedure)"><code>RemoteProcedureCapability.beginCall(com.amazon.carbonado.capability.RemoteProcedure<R, D>)</code></a></dd></dl> +</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"> </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="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#execute()">execute</a></strong>()</code> +<div class="block">Executes the call without expecting a reply.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#executeAsync()">executeAsync</a></strong>()</code> +<div class="block">Executes the call without expecting a reply.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#fetchReply()">fetchReply</a></strong>()</code> +<div class="block">Executes the call and receive a reply.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#flush()">flush</a></strong>()</code> +<div class="block">Flushes all the data sent so far.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#reset()">reset</a></strong>()</code> +<div class="block">Reset the internal object stream of the call, allowing cached + objects to get freed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#send(D)">send</a></strong>(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a> data)</code> +<div class="block">Send data to the remote procedure.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#sendAll(com.amazon.carbonado.Cursor)">sendAll</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> cursor)</code> +<div class="block">Send all data from the given cursor to the remote procedure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#sendAll(java.lang.Iterable)">sendAll</a></strong>(java.lang.Iterable<? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> iterable)</code> +<div class="block">Send all data from the given iterable to the remote procedure.</div> +</td> +</tr> +</table> +</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="send(java.lang.Object)"> +<!-- --> +</a><a name="send(D)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>send</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> send(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a> data) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Send data to the remote procedure.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Call instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if data is null</dd> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="sendAll(java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sendAll</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> sendAll(java.lang.Iterable<? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> iterable) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Send all data from the given iterable to the remote procedure.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Call instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if data is null</dd> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="sendAll(com.amazon.carbonado.Cursor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sendAll</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> sendAll(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> cursor) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Send all data from the given cursor to the remote procedure.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Call instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if data is null</dd> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="reset()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reset</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> reset() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Reset the internal object stream of the call, allowing cached + objects to get freed.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Call instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="flush()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flush</h4> +<pre>void flush() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Flushes all the data sent so far. Flush is invoked automatically + when call is executed.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="fetchReply()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchReply</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>> fetchReply() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Executes the call and receive a reply. Calling this method does not + block, but methods on the returned Cursor may block waiting for + data.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="execute()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>void execute() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Executes the call without expecting a reply. Method blocks waiting + for procedure to finish.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="executeAsync()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>executeAsync</h4> +<pre>void executeAsync() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Executes the call without expecting a reply. Method does not block + waiting for procedure to finish. Asynchronous execution is not + allowed if the current thread is in a transaction. This is because + transaction ownership becomes ambiguous.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed or if + current thread is in a transaction</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/RemoteProcedure.Call.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-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.Call.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Call.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>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |