source: branches/supervisor/doc/omq/server/RemoteWrapper.html

Last change on this file was 85, checked in by stoda, 11 years ago

Javadocs updated

File size: 14.1 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="es">
4<head>
5<!-- Generated by javadoc (version 1.7.0_25) on Wed Jul 10 13:13:17 CEST 2013 -->
6<title>RemoteWrapper</title>
7<meta name="date" content="2013-07-10">
8<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
9</head>
10<body>
11<script type="text/javascript"><!--
12    if (location.href.indexOf('is-external=true') == -1) {
13        parent.document.title="RemoteWrapper";
14    }
15//-->
16</script>
17<noscript>
18<div>JavaScript is disabled on your browser.</div>
19</noscript>
20<!-- ========= START OF TOP NAVBAR ======= -->
21<div class="topNav"><a name="navbar_top">
22<!--   -->
23</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24<!--   -->
25</a>
26<ul class="navList" title="Navigation">
27<li><a href="../../overview-summary.html">Overview</a></li>
28<li><a href="package-summary.html">Package</a></li>
29<li class="navBarCell1Rev">Class</li>
30<li><a href="class-use/RemoteWrapper.html">Use</a></li>
31<li><a href="package-tree.html">Tree</a></li>
32<li><a href="../../deprecated-list.html">Deprecated</a></li>
33<li><a href="../../index-files/index-1.html">Index</a></li>
34<li><a href="../../help-doc.html">Help</a></li>
35</ul>
36</div>
37<div class="subNav">
38<ul class="navList">
39<li><a href="../../omq/server/RemoteObject.html" title="class in omq.server"><span class="strong">Prev Class</span></a></li>
40<li>Next Class</li>
41</ul>
42<ul class="navList">
43<li><a href="../../index.html?omq/server/RemoteWrapper.html" target="_top">Frames</a></li>
44<li><a href="RemoteWrapper.html" target="_top">No Frames</a></li>
45</ul>
46<ul class="navList" id="allclasses_navbar_top">
47<li><a href="../../allclasses-noframe.html">All Classes</a></li>
48</ul>
49<div>
50<script type="text/javascript"><!--
51  allClassesLink = document.getElementById("allclasses_navbar_top");
52  if(window==top) {
53    allClassesLink.style.display = "block";
54  }
55  else {
56    allClassesLink.style.display = "none";
57  }
58  //-->
59</script>
60</div>
61<div>
62<ul class="subNavList">
63<li>Summary:&nbsp;</li>
64<li>Nested&nbsp;|&nbsp;</li>
65<li>Field&nbsp;|&nbsp;</li>
66<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
67<li><a href="#method_summary">Method</a></li>
68</ul>
69<ul class="subNavList">
70<li>Detail:&nbsp;</li>
71<li>Field&nbsp;|&nbsp;</li>
72<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
73<li><a href="#method_detail">Method</a></li>
74</ul>
75</div>
76<a name="skip-navbar_top">
77<!--   -->
78</a></div>
79<!-- ========= END OF TOP NAVBAR ========= -->
80<!-- ======== START OF CLASS DATA ======== -->
81<div class="header">
82<div class="subTitle">omq.server</div>
83<h2 title="Class RemoteWrapper" class="title">Class RemoteWrapper</h2>
84</div>
85<div class="contentContainer">
86<ul class="inheritance">
87<li>java.lang.Object</li>
88<li>
89<ul class="inheritance">
90<li>omq.server.RemoteWrapper</li>
91</ul>
92</li>
93</ul>
94<div class="description">
95<ul class="blockList">
96<li class="blockList">
97<hr>
98<br>
99<pre>public class <span class="strong">RemoteWrapper</span>
100extends java.lang.Object</pre>
101<div class="block">This class is used to encapsulate the invocationThreads under the
102 RemoteObject.</div>
103<dl><dt><span class="strong">Author:</span></dt>
104  <dd>Sergi Toda <sergi.toda@estudiants.urv.cat></dd></dl>
105</li>
106</ul>
107</div>
108<div class="summary">
109<ul class="blockList">
110<li class="blockList">
111<!-- ======== CONSTRUCTOR SUMMARY ======== -->
112<ul class="blockList">
113<li class="blockList"><a name="constructor_summary">
114<!--   -->
115</a>
116<h3>Constructor Summary</h3>
117<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
118<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
119<tr>
120<th class="colOne" scope="col">Constructor and Description</th>
121</tr>
122<tr class="altColor">
123<td class="colOne"><code><strong><a href="../../omq/server/RemoteWrapper.html#RemoteWrapper(omq.server.RemoteObject, int, omq.common.util.Serializer)">RemoteWrapper</a></strong>(<a href="../../omq/server/RemoteObject.html" title="class in omq.server">RemoteObject</a>&nbsp;obj,
124             int&nbsp;numThreads,
125             <a href="../../omq/common/util/Serializer.html" title="class in omq.common.util">Serializer</a>&nbsp;serializer)</code>&nbsp;</td>
126</tr>
127</table>
128</li>
129</ul>
130<!-- ========== METHOD SUMMARY =========== -->
131<ul class="blockList">
132<li class="blockList"><a name="method_summary">
133<!--   -->
134</a>
135<h3>Method Summary</h3>
136<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
137<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
138<tr>
139<th class="colFirst" scope="col">Modifier and Type</th>
140<th class="colLast" scope="col">Method and Description</th>
141</tr>
142<tr class="altColor">
143<td class="colFirst"><code>java.util.concurrent.BlockingQueue&lt;com.rabbitmq.client.QueueingConsumer.Delivery&gt;</code></td>
144<td class="colLast"><code><strong><a href="../../omq/server/RemoteWrapper.html#getDeliveryQueue()">getDeliveryQueue</a></strong>()</code>&nbsp;</td>
145</tr>
146<tr class="rowColor">
147<td class="colFirst"><code>java.util.ArrayList&lt;<a href="../../omq/server/InvocationThread.html" title="class in omq.server">InvocationThread</a>&gt;</code></td>
148<td class="colLast"><code><strong><a href="../../omq/server/RemoteWrapper.html#getInvocationList()">getInvocationList</a></strong>()</code>&nbsp;</td>
149</tr>
150<tr class="altColor">
151<td class="colFirst"><code>int</code></td>
152<td class="colLast"><code><strong><a href="../../omq/server/RemoteWrapper.html#getNumThreads()">getNumThreads</a></strong>()</code>&nbsp;</td>
153</tr>
154<tr class="rowColor">
155<td class="colFirst"><code><a href="../../omq/server/RemoteObject.html" title="class in omq.server">RemoteObject</a></code></td>
156<td class="colLast"><code><strong><a href="../../omq/server/RemoteWrapper.html#getObj()">getObj</a></strong>()</code>&nbsp;</td>
157</tr>
158<tr class="altColor">
159<td class="colFirst"><code>void</code></td>
160<td class="colLast"><code><strong><a href="../../omq/server/RemoteWrapper.html#notifyDelivery(com.rabbitmq.client.QueueingConsumer.Delivery)">notifyDelivery</a></strong>(com.rabbitmq.client.QueueingConsumer.Delivery&nbsp;delivery)</code>
161<div class="block">This method notifies a delivery to an invocationThread using a
162 blockingQueue.</div>
163</td>
164</tr>
165<tr class="rowColor">
166<td class="colFirst"><code>void</code></td>
167<td class="colLast"><code><strong><a href="../../omq/server/RemoteWrapper.html#setDeliveryQueue(java.util.concurrent.BlockingQueue)">setDeliveryQueue</a></strong>(java.util.concurrent.BlockingQueue&lt;com.rabbitmq.client.QueueingConsumer.Delivery&gt;&nbsp;deliveryQueue)</code>&nbsp;</td>
168</tr>
169<tr class="altColor">
170<td class="colFirst"><code>void</code></td>
171<td class="colLast"><code><strong><a href="../../omq/server/RemoteWrapper.html#setInvocationList(java.util.ArrayList)">setInvocationList</a></strong>(java.util.ArrayList&lt;<a href="../../omq/server/InvocationThread.html" title="class in omq.server">InvocationThread</a>&gt;&nbsp;invocationList)</code>&nbsp;</td>
172</tr>
173<tr class="rowColor">
174<td class="colFirst"><code>void</code></td>
175<td class="colLast"><code><strong><a href="../../omq/server/RemoteWrapper.html#setNumThreads(int)">setNumThreads</a></strong>(int&nbsp;numThreads)</code>&nbsp;</td>
176</tr>
177<tr class="altColor">
178<td class="colFirst"><code>void</code></td>
179<td class="colLast"><code><strong><a href="../../omq/server/RemoteWrapper.html#setObj(omq.server.RemoteObject)">setObj</a></strong>(<a href="../../omq/server/RemoteObject.html" title="class in omq.server">RemoteObject</a>&nbsp;obj)</code>&nbsp;</td>
180</tr>
181<tr class="rowColor">
182<td class="colFirst"><code>void</code></td>
183<td class="colLast"><code><strong><a href="../../omq/server/RemoteWrapper.html#stopRemoteWrapper()">stopRemoteWrapper</a></strong>()</code>
184<div class="block">This method interrups all the invocationThreads under this remoteWrapper</div>
185</td>
186</tr>
187</table>
188<ul class="blockList">
189<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
190<!--   -->
191</a>
192<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
193<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
194</ul>
195</li>
196</ul>
197</li>
198</ul>
199</div>
200<div class="details">
201<ul class="blockList">
202<li class="blockList">
203<!-- ========= CONSTRUCTOR DETAIL ======== -->
204<ul class="blockList">
205<li class="blockList"><a name="constructor_detail">
206<!--   -->
207</a>
208<h3>Constructor Detail</h3>
209<a name="RemoteWrapper(omq.server.RemoteObject, int, omq.common.util.Serializer)">
210<!--   -->
211</a>
212<ul class="blockListLast">
213<li class="blockList">
214<h4>RemoteWrapper</h4>
215<pre>public&nbsp;RemoteWrapper(<a href="../../omq/server/RemoteObject.html" title="class in omq.server">RemoteObject</a>&nbsp;obj,
216             int&nbsp;numThreads,
217             <a href="../../omq/common/util/Serializer.html" title="class in omq.common.util">Serializer</a>&nbsp;serializer)</pre>
218</li>
219</ul>
220</li>
221</ul>
222<!-- ============ METHOD DETAIL ========== -->
223<ul class="blockList">
224<li class="blockList"><a name="method_detail">
225<!--   -->
226</a>
227<h3>Method Detail</h3>
228<a name="notifyDelivery(com.rabbitmq.client.QueueingConsumer.Delivery)">
229<!--   -->
230</a>
231<ul class="blockList">
232<li class="blockList">
233<h4>notifyDelivery</h4>
234<pre>public&nbsp;void&nbsp;notifyDelivery(com.rabbitmq.client.QueueingConsumer.Delivery&nbsp;delivery)
235                    throws java.lang.Exception</pre>
236<div class="block">This method notifies a delivery to an invocationThread using a
237 blockingQueue.</div>
238<dl><dt><span class="strong">Parameters:</span></dt><dd><code>delivery</code> - - delivery which contains a Request to be invoked</dd>
239<dt><span class="strong">Throws:</span></dt>
240<dd><code>java.lang.Exception</code></dd></dl>
241</li>
242</ul>
243<a name="stopRemoteWrapper()">
244<!--   -->
245</a>
246<ul class="blockList">
247<li class="blockList">
248<h4>stopRemoteWrapper</h4>
249<pre>public&nbsp;void&nbsp;stopRemoteWrapper()</pre>
250<div class="block">This method interrups all the invocationThreads under this remoteWrapper</div>
251</li>
252</ul>
253<a name="getObj()">
254<!--   -->
255</a>
256<ul class="blockList">
257<li class="blockList">
258<h4>getObj</h4>
259<pre>public&nbsp;<a href="../../omq/server/RemoteObject.html" title="class in omq.server">RemoteObject</a>&nbsp;getObj()</pre>
260</li>
261</ul>
262<a name="setObj(omq.server.RemoteObject)">
263<!--   -->
264</a>
265<ul class="blockList">
266<li class="blockList">
267<h4>setObj</h4>
268<pre>public&nbsp;void&nbsp;setObj(<a href="../../omq/server/RemoteObject.html" title="class in omq.server">RemoteObject</a>&nbsp;obj)</pre>
269</li>
270</ul>
271<a name="getNumThreads()">
272<!--   -->
273</a>
274<ul class="blockList">
275<li class="blockList">
276<h4>getNumThreads</h4>
277<pre>public&nbsp;int&nbsp;getNumThreads()</pre>
278</li>
279</ul>
280<a name="setNumThreads(int)">
281<!--   -->
282</a>
283<ul class="blockList">
284<li class="blockList">
285<h4>setNumThreads</h4>
286<pre>public&nbsp;void&nbsp;setNumThreads(int&nbsp;numThreads)</pre>
287</li>
288</ul>
289<a name="getInvocationList()">
290<!--   -->
291</a>
292<ul class="blockList">
293<li class="blockList">
294<h4>getInvocationList</h4>
295<pre>public&nbsp;java.util.ArrayList&lt;<a href="../../omq/server/InvocationThread.html" title="class in omq.server">InvocationThread</a>&gt;&nbsp;getInvocationList()</pre>
296</li>
297</ul>
298<a name="setInvocationList(java.util.ArrayList)">
299<!--   -->
300</a>
301<ul class="blockList">
302<li class="blockList">
303<h4>setInvocationList</h4>
304<pre>public&nbsp;void&nbsp;setInvocationList(java.util.ArrayList&lt;<a href="../../omq/server/InvocationThread.html" title="class in omq.server">InvocationThread</a>&gt;&nbsp;invocationList)</pre>
305</li>
306</ul>
307<a name="getDeliveryQueue()">
308<!--   -->
309</a>
310<ul class="blockList">
311<li class="blockList">
312<h4>getDeliveryQueue</h4>
313<pre>public&nbsp;java.util.concurrent.BlockingQueue&lt;com.rabbitmq.client.QueueingConsumer.Delivery&gt;&nbsp;getDeliveryQueue()</pre>
314</li>
315</ul>
316<a name="setDeliveryQueue(java.util.concurrent.BlockingQueue)">
317<!--   -->
318</a>
319<ul class="blockListLast">
320<li class="blockList">
321<h4>setDeliveryQueue</h4>
322<pre>public&nbsp;void&nbsp;setDeliveryQueue(java.util.concurrent.BlockingQueue&lt;com.rabbitmq.client.QueueingConsumer.Delivery&gt;&nbsp;deliveryQueue)</pre>
323</li>
324</ul>
325</li>
326</ul>
327</li>
328</ul>
329</div>
330</div>
331<!-- ========= END OF CLASS DATA ========= -->
332<!-- ======= START OF BOTTOM NAVBAR ====== -->
333<div class="bottomNav"><a name="navbar_bottom">
334<!--   -->
335</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
336<!--   -->
337</a>
338<ul class="navList" title="Navigation">
339<li><a href="../../overview-summary.html">Overview</a></li>
340<li><a href="package-summary.html">Package</a></li>
341<li class="navBarCell1Rev">Class</li>
342<li><a href="class-use/RemoteWrapper.html">Use</a></li>
343<li><a href="package-tree.html">Tree</a></li>
344<li><a href="../../deprecated-list.html">Deprecated</a></li>
345<li><a href="../../index-files/index-1.html">Index</a></li>
346<li><a href="../../help-doc.html">Help</a></li>
347</ul>
348</div>
349<div class="subNav">
350<ul class="navList">
351<li><a href="../../omq/server/RemoteObject.html" title="class in omq.server"><span class="strong">Prev Class</span></a></li>
352<li>Next Class</li>
353</ul>
354<ul class="navList">
355<li><a href="../../index.html?omq/server/RemoteWrapper.html" target="_top">Frames</a></li>
356<li><a href="RemoteWrapper.html" target="_top">No Frames</a></li>
357</ul>
358<ul class="navList" id="allclasses_navbar_bottom">
359<li><a href="../../allclasses-noframe.html">All Classes</a></li>
360</ul>
361<div>
362<script type="text/javascript"><!--
363  allClassesLink = document.getElementById("allclasses_navbar_bottom");
364  if(window==top) {
365    allClassesLink.style.display = "block";
366  }
367  else {
368    allClassesLink.style.display = "none";
369  }
370  //-->
371</script>
372</div>
373<div>
374<ul class="subNavList">
375<li>Summary:&nbsp;</li>
376<li>Nested&nbsp;|&nbsp;</li>
377<li>Field&nbsp;|&nbsp;</li>
378<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
379<li><a href="#method_summary">Method</a></li>
380</ul>
381<ul class="subNavList">
382<li>Detail:&nbsp;</li>
383<li>Field&nbsp;|&nbsp;</li>
384<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
385<li><a href="#method_detail">Method</a></li>
386</ul>
387</div>
388<a name="skip-navbar_bottom">
389<!--   -->
390</a></div>
391<!-- ======== END OF BOTTOM NAVBAR ======= -->
392</body>
393</html>
Note: See TracBrowser for help on using the repository browser.