diff options
| author | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
|---|---|---|
| committer | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
| commit | d479253768d296a40b4f699e1de9b03c7146a97a (patch) | |
| tree | 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html | 288 |
1 files changed, 288 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html new file mode 100644 index 0000000..04a63b8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html @@ -0,0 +1,288 @@ +<!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.Request (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.Request (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.Request.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.Reply.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.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.Request.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Request.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.Request" class="title">Interface RemoteProcedure.Request<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.Request<R,D></span></pre> +<div class="block">Request into a remote procedure, as seen by procedure implementation. To + avoid leaking resources, the request or reply object must always be + finished. If an exception is thrown by a method defined in this + interface, resources are automatically released.</div> +</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><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">R</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#beginReply()">beginReply</a></strong>()</code> +<div class="block">Begin a reply after receiving all data.</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.Request.html#finish()">finish</a></strong>()</code> +<div class="block">Reply and immediately finish, without sending any data to caller.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#receive()">receive</a></strong>()</code> +<div class="block">Receive data from caller.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#receiveInto(java.util.Collection)">receiveInto</a></strong>(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a>> c)</code> +<div class="block">Receive all remaining data from caller.</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="receive()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>receive</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a> receive() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Receive data from caller.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if no more data</dd> +<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="receiveInto(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>receiveInto</h4> +<pre>int receiveInto(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a>> c) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Receive all remaining data from caller.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - collection to receive data</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount received</dd> +<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="beginReply()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beginReply</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">R</a>> beginReply() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Begin a reply after receiving all data. If no data is expected, + reply can be made without calling receive.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if reply was already begun, or if + request is finished, or if more data must be received</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="finish()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>finish</h4> +<pre>void finish() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Reply and immediately finish, without sending any data to caller.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a reply was already begun or if + more data must be received</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.Request.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.Reply.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.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.Request.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Request.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> |