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

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

Javadocs updated
File size: 16.9 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>RemoteObject</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="RemoteObject";
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/RemoteObject.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/InvocationThread.html" title="class in omq.server"><span class="strong">Prev Class</span></a></li>
40<li><a href="../../omq/server/RemoteWrapper.html" title="class in omq.server"><span class="strong">Next Class</span></a></li>
41</ul>
42<ul class="navList">
43<li><a href="../../index.html?omq/server/RemoteObject.html" target="_top">Frames</a></li>
44<li><a href="RemoteObject.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><a href="#nested_classes_inherited_from_class_java.lang.Thread">Nested</a>&nbsp;|&nbsp;</li>
65<li><a href="#fields_inherited_from_class_java.lang.Thread">Field</a>&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 RemoteObject" class="title">Class RemoteObject</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>java.lang.Thread</li>
91<li>
92<ul class="inheritance">
93<li>omq.server.RemoteObject</li>
94</ul>
95</li>
96</ul>
97</li>
98</ul>
99<div class="description">
100<ul class="blockList">
101<li class="blockList">
102<dl>
103<dt>All Implemented Interfaces:</dt>
104<dd>java.io.Serializable, java.lang.Runnable, <a href="../../omq/Remote.html" title="interface in omq">Remote</a></dd>
105</dl>
106<dl>
107<dt>Direct Known Subclasses:</dt>
108<dd><a href="../../omq/test/stopBroker/BrokerKillerImpl.html" title="class in omq.test.stopBroker">BrokerKillerImpl</a>, <a href="../../omq/test/python/CalculatorImpl.html" title="class in omq.test.python">CalculatorImpl</a>, <a href="../../omq/test/calculator/CalculatorImpl.html" title="class in omq.test.calculator">CalculatorImpl</a>, <a href="../../omq/test/python/ContactListImpl.html" title="class in omq.test.python">ContactListImpl</a>, <a href="../../omq/test/event/MessageImpl.html" title="class in omq.test.event">MessageImpl</a>, <a href="../../omq/test/persistence/MessageImpl.html" title="class in omq.test.persistence">MessageImpl</a>, <a href="../../omq/test/multiProcess/NumberImpl.html" title="class in omq.test.multiProcess">NumberImpl</a>, <a href="../../omq/test/exception/OmqServerImpl.html" title="class in omq.test.exception">OmqServerImpl</a>, <a href="../../omq/test/observer/RemoteObserverImpl.html" title="class in omq.test.observer">RemoteObserverImpl</a>, <a href="../../omq/test/observer/RemoteSubjectImpl.html" title="class in omq.test.observer">RemoteSubjectImpl</a>, <a href="../../omq/test/workspace/RemoteWorkspaceImpl.html" title="class in omq.test.workspace">RemoteWorkspaceImpl</a></dd>
109</dl>
110<hr>
111<br>
112<pre>public abstract class <span class="strong">RemoteObject</span>
113extends java.lang.Thread
114implements <a href="../../omq/Remote.html" title="interface in omq">Remote</a></pre>
115<div class="block">A RemoteObject when it's started will be waiting for requests and will invoke
116 them. When a RemoteObject is started it listens two queues, the first one has
117 the same name as its reference and the second one is its multiqueue -this
118 name can be set using a property, be aware to use a name not used by another
119 object!!!-.</div>
120<dl><dt><span class="strong">Author:</span></dt>
121  <dd>Sergi Toda <sergi.toda@estudiants.urv.cat></dd>
122<dt><span class="strong">See Also:</span></dt><dd><a href="../../serialized-form.html#omq.server.RemoteObject">Serialized Form</a></dd></dl>
123</li>
124</ul>
125</div>
126<div class="summary">
127<ul class="blockList">
128<li class="blockList">
129<!-- ======== NESTED CLASS SUMMARY ======== -->
130<ul class="blockList">
131<li class="blockList"><a name="nested_class_summary">
132<!--   -->
133</a>
134<h3>Nested Class Summary</h3>
135<ul class="blockList">
136<li class="blockList"><a name="nested_classes_inherited_from_class_java.lang.Thread">
137<!--   -->
138</a>
139<h3>Nested classes/interfaces inherited from class&nbsp;java.lang.Thread</h3>
140<code>java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler</code></li>
141</ul>
142</li>
143</ul>
144<!-- =========== FIELD SUMMARY =========== -->
145<ul class="blockList">
146<li class="blockList"><a name="field_summary">
147<!--   -->
148</a>
149<h3>Field Summary</h3>
150<ul class="blockList">
151<li class="blockList"><a name="fields_inherited_from_class_java.lang.Thread">
152<!--   -->
153</a>
154<h3>Fields inherited from class&nbsp;java.lang.Thread</h3>
155<code>MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY</code></li>
156</ul>
157</li>
158</ul>
159<!-- ======== CONSTRUCTOR SUMMARY ======== -->
160<ul class="blockList">
161<li class="blockList"><a name="constructor_summary">
162<!--   -->
163</a>
164<h3>Constructor Summary</h3>
165<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
166<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
167<tr>
168<th class="colOne" scope="col">Constructor and Description</th>
169</tr>
170<tr class="altColor">
171<td class="colOne"><code><strong><a href="../../omq/server/RemoteObject.html#RemoteObject()">RemoteObject</a></strong>()</code>&nbsp;</td>
172</tr>
173</table>
174</li>
175</ul>
176<!-- ========== METHOD SUMMARY =========== -->
177<ul class="blockList">
178<li class="blockList"><a name="method_summary">
179<!--   -->
180</a>
181<h3>Method Summary</h3>
182<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
183<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
184<tr>
185<th class="colFirst" scope="col">Modifier and Type</th>
186<th class="colLast" scope="col">Method and Description</th>
187</tr>
188<tr class="altColor">
189<td class="colFirst"><code>com.rabbitmq.client.Channel</code></td>
190<td class="colLast"><code><strong><a href="../../omq/server/RemoteObject.html#getChannel()">getChannel</a></strong>()</code>&nbsp;</td>
191</tr>
192<tr class="rowColor">
193<td class="colFirst"><code>java.util.List&lt;java.lang.Class&lt;?&gt;&gt;</code></td>
194<td class="colLast"><code><strong><a href="../../omq/server/RemoteObject.html#getParams(java.lang.String)">getParams</a></strong>(java.lang.String&nbsp;methodName)</code>&nbsp;</td>
195</tr>
196<tr class="altColor">
197<td class="colFirst"><code>java.lang.String</code></td>
198<td class="colLast"><code><strong><a href="../../omq/server/RemoteObject.html#getRef()">getRef</a></strong>()</code>
199<div class="block">Returns the UID of a RemoteObject</div>
200</td>
201</tr>
202<tr class="rowColor">
203<td class="colFirst"><code>java.lang.Object</code></td>
204<td class="colLast"><code><strong><a href="../../omq/server/RemoteObject.html#invokeMethod(java.lang.String, java.lang.Object[])">invokeMethod</a></strong>(java.lang.String&nbsp;methodName,
205            java.lang.Object[]&nbsp;arguments)</code>
206<div class="block">This method invokes the method specified by methodName and arguments</div>
207</td>
208</tr>
209<tr class="altColor">
210<td class="colFirst"><code>void</code></td>
211<td class="colLast"><code><strong><a href="../../omq/server/RemoteObject.html#kill()">kill</a></strong>()</code>
212<div class="block">This method kills all the threads waiting for requests</div>
213</td>
214</tr>
215<tr class="rowColor">
216<td class="colFirst"><code>void</code></td>
217<td class="colLast"><code><strong><a href="../../omq/server/RemoteObject.html#run()">run</a></strong>()</code>&nbsp;</td>
218</tr>
219<tr class="altColor">
220<td class="colFirst"><code>void</code></td>
221<td class="colLast"><code><strong><a href="../../omq/server/RemoteObject.html#startRemoteObject(java.lang.String, omq.common.broker.Broker, java.util.Properties)">startRemoteObject</a></strong>(java.lang.String&nbsp;reference,
222                 <a href="../../omq/common/broker/Broker.html" title="class in omq.common.broker">Broker</a>&nbsp;broker,
223                 java.util.Properties&nbsp;env)</code>
224<div class="block">This method starts a remoteObject.</div>
225</td>
226</tr>
227</table>
228<ul class="blockList">
229<li class="blockList"><a name="methods_inherited_from_class_java.lang.Thread">
230<!--   -->
231</a>
232<h3>Methods inherited from class&nbsp;java.lang.Thread</h3>
233<code>activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield</code></li>
234</ul>
235<ul class="blockList">
236<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
237<!--   -->
238</a>
239<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
240<code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
241</ul>
242</li>
243</ul>
244</li>
245</ul>
246</div>
247<div class="details">
248<ul class="blockList">
249<li class="blockList">
250<!-- ========= CONSTRUCTOR DETAIL ======== -->
251<ul class="blockList">
252<li class="blockList"><a name="constructor_detail">
253<!--   -->
254</a>
255<h3>Constructor Detail</h3>
256<a name="RemoteObject()">
257<!--   -->
258</a>
259<ul class="blockListLast">
260<li class="blockList">
261<h4>RemoteObject</h4>
262<pre>public&nbsp;RemoteObject()</pre>
263</li>
264</ul>
265</li>
266</ul>
267<!-- ============ METHOD DETAIL ========== -->
268<ul class="blockList">
269<li class="blockList"><a name="method_detail">
270<!--   -->
271</a>
272<h3>Method Detail</h3>
273<a name="startRemoteObject(java.lang.String, omq.common.broker.Broker, java.util.Properties)">
274<!--   -->
275</a>
276<ul class="blockList">
277<li class="blockList">
278<h4>startRemoteObject</h4>
279<pre>public&nbsp;void&nbsp;startRemoteObject(java.lang.String&nbsp;reference,
280                     <a href="../../omq/common/broker/Broker.html" title="class in omq.common.broker">Broker</a>&nbsp;broker,
281                     java.util.Properties&nbsp;env)
282                       throws java.lang.Exception</pre>
283<div class="block">This method starts a remoteObject.</div>
284<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reference</code> - - broker's binding referece</dd><dd><code>broker</code> - - broker that binds this remoteObject</dd><dd><code>env</code> - - properties of this remoteObject</dd>
285<dt><span class="strong">Throws:</span></dt>
286<dd><code>java.lang.Exception</code></dd></dl>
287</li>
288</ul>
289<a name="run()">
290<!--   -->
291</a>
292<ul class="blockList">
293<li class="blockList">
294<h4>run</h4>
295<pre>public&nbsp;void&nbsp;run()</pre>
296<dl>
297<dt><strong>Specified by:</strong></dt>
298<dd><code>run</code>&nbsp;in interface&nbsp;<code>java.lang.Runnable</code></dd>
299<dt><strong>Overrides:</strong></dt>
300<dd><code>run</code>&nbsp;in class&nbsp;<code>java.lang.Thread</code></dd>
301</dl>
302</li>
303</ul>
304<a name="getRef()">
305<!--   -->
306</a>
307<ul class="blockList">
308<li class="blockList">
309<h4>getRef</h4>
310<pre>public&nbsp;java.lang.String&nbsp;getRef()</pre>
311<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../omq/Remote.html#getRef()">Remote</a></code></strong></div>
312<div class="block">Returns the UID of a RemoteObject</div>
313<dl>
314<dt><strong>Specified by:</strong></dt>
315<dd><code><a href="../../omq/Remote.html#getRef()">getRef</a></code>&nbsp;in interface&nbsp;<code><a href="../../omq/Remote.html" title="interface in omq">Remote</a></code></dd>
316<dt><span class="strong">Returns:</span></dt><dd>UID</dd></dl>
317</li>
318</ul>
319<a name="kill()">
320<!--   -->
321</a>
322<ul class="blockList">
323<li class="blockList">
324<h4>kill</h4>
325<pre>public&nbsp;void&nbsp;kill()
326          throws java.io.IOException</pre>
327<div class="block">This method kills all the threads waiting for requests</div>
328<dl><dt><span class="strong">Throws:</span></dt>
329<dd><code>java.io.IOException</code> - - If an operation failed.</dd></dl>
330</li>
331</ul>
332<a name="invokeMethod(java.lang.String, java.lang.Object[])">
333<!--   -->
334</a>
335<ul class="blockList">
336<li class="blockList">
337<h4>invokeMethod</h4>
338<pre>public&nbsp;java.lang.Object&nbsp;invokeMethod(java.lang.String&nbsp;methodName,
339                            java.lang.Object[]&nbsp;arguments)
340                              throws java.lang.Exception</pre>
341<div class="block">This method invokes the method specified by methodName and arguments</div>
342<dl><dt><span class="strong">Parameters:</span></dt><dd><code>methodName</code> - </dd><dd><code>arguments</code> - </dd>
343<dt><span class="strong">Returns:</span></dt><dd>result</dd>
344<dt><span class="strong">Throws:</span></dt>
345<dd><code>java.lang.Exception</code></dd></dl>
346</li>
347</ul>
348<a name="getParams(java.lang.String)">
349<!--   -->
350</a>
351<ul class="blockList">
352<li class="blockList">
353<h4>getParams</h4>
354<pre>public&nbsp;java.util.List&lt;java.lang.Class&lt;?&gt;&gt;&nbsp;getParams(java.lang.String&nbsp;methodName)</pre>
355</li>
356</ul>
357<a name="getChannel()">
358<!--   -->
359</a>
360<ul class="blockListLast">
361<li class="blockList">
362<h4>getChannel</h4>
363<pre>public&nbsp;com.rabbitmq.client.Channel&nbsp;getChannel()</pre>
364</li>
365</ul>
366</li>
367</ul>
368</li>
369</ul>
370</div>
371</div>
372<!-- ========= END OF CLASS DATA ========= -->
373<!-- ======= START OF BOTTOM NAVBAR ====== -->
374<div class="bottomNav"><a name="navbar_bottom">
375<!--   -->
376</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
377<!--   -->
378</a>
379<ul class="navList" title="Navigation">
380<li><a href="../../overview-summary.html">Overview</a></li>
381<li><a href="package-summary.html">Package</a></li>
382<li class="navBarCell1Rev">Class</li>
383<li><a href="class-use/RemoteObject.html">Use</a></li>
384<li><a href="package-tree.html">Tree</a></li>
385<li><a href="../../deprecated-list.html">Deprecated</a></li>
386<li><a href="../../index-files/index-1.html">Index</a></li>
387<li><a href="../../help-doc.html">Help</a></li>
388</ul>
389</div>
390<div class="subNav">
391<ul class="navList">
392<li><a href="../../omq/server/InvocationThread.html" title="class in omq.server"><span class="strong">Prev Class</span></a></li>
393<li><a href="../../omq/server/RemoteWrapper.html" title="class in omq.server"><span class="strong">Next Class</span></a></li>
394</ul>
395<ul class="navList">
396<li><a href="../../index.html?omq/server/RemoteObject.html" target="_top">Frames</a></li>
397<li><a href="RemoteObject.html" target="_top">No Frames</a></li>
398</ul>
399<ul class="navList" id="allclasses_navbar_bottom">
400<li><a href="../../allclasses-noframe.html">All Classes</a></li>
401</ul>
402<div>
403<script type="text/javascript"><!--
404  allClassesLink = document.getElementById("allclasses_navbar_bottom");
405  if(window==top) {
406    allClassesLink.style.display = "block";
407  }
408  else {
409    allClassesLink.style.display = "none";
410  }
411  //-->
412</script>
413</div>
414<div>
415<ul class="subNavList">
416<li>Summary:&nbsp;</li>
417<li><a href="#nested_classes_inherited_from_class_java.lang.Thread">Nested</a>&nbsp;|&nbsp;</li>
418<li><a href="#fields_inherited_from_class_java.lang.Thread">Field</a>&nbsp;|&nbsp;</li>
419<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
420<li><a href="#method_summary">Method</a></li>
421</ul>
422<ul class="subNavList">
423<li>Detail:&nbsp;</li>
424<li>Field&nbsp;|&nbsp;</li>
425<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
426<li><a href="#method_detail">Method</a></li>
427</ul>
428</div>
429<a name="skip-navbar_bottom">
430<!--   -->
431</a></div>
432<!-- ======== END OF BOTTOM NAVBAR ======= -->
433</body>
434</html>
Note: See TracBrowser for help on using the repository browser.