source: trunk/doc/omq/client/proxy/Proxymq.html @ 100

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

Javadocs updated
File size: 12.0 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>Proxymq</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="Proxymq";
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/Proxymq.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/client/proxy/MultiProxymq.html" title="class in omq.client.proxy"><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/client/proxy/Proxymq.html" target="_top">Frames</a></li>
44<li><a href="Proxymq.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.client.proxy</div>
83<h2 title="Class Proxymq" class="title">Class Proxymq</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.client.proxy.Proxymq</li>
91</ul>
92</li>
93</ul>
94<div class="description">
95<ul class="blockList">
96<li class="blockList">
97<dl>
98<dt>All Implemented Interfaces:</dt>
99<dd>java.io.Serializable, java.lang.reflect.InvocationHandler, <a href="../../../omq/Remote.html" title="interface in omq">Remote</a></dd>
100</dl>
101<hr>
102<br>
103<pre>public class <span class="strong">Proxymq</span>
104extends java.lang.Object
105implements java.lang.reflect.InvocationHandler, <a href="../../../omq/Remote.html" title="interface in omq">Remote</a></pre>
106<div class="block">Proxymq class. This class inherits from InvocationHandler, for this reason
107 each proxymq instance has an associated invocation handler. When a method is
108 invoked on a proxymq instance, the method invocation is encoded and
109 dispatched to the invoke method of its invocation handler.</div>
110<dl><dt><span class="strong">Author:</span></dt>
111  <dd>Sergi Toda <sergi.toda@estudiants.urv.cat></dd>
112<dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#omq.client.proxy.Proxymq">Serialized Form</a></dd></dl>
113</li>
114</ul>
115</div>
116<div class="summary">
117<ul class="blockList">
118<li class="blockList">
119<!-- ======== CONSTRUCTOR SUMMARY ======== -->
120<ul class="blockList">
121<li class="blockList"><a name="constructor_summary">
122<!--   -->
123</a>
124<h3>Constructor Summary</h3>
125<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
126<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
127<tr>
128<th class="colOne" scope="col">Constructor and Description</th>
129</tr>
130<tr class="altColor">
131<td class="colOne"><code><strong><a href="../../../omq/client/proxy/Proxymq.html#Proxymq(java.lang.String, java.lang.Class, omq.common.broker.Broker)">Proxymq</a></strong>(java.lang.String&nbsp;uid,
132       java.lang.Class&lt;?&gt;&nbsp;clazz,
133       <a href="../../../omq/common/broker/Broker.html" title="class in omq.common.broker">Broker</a>&nbsp;broker)</code>
134<div class="block">Proxymq Constructor.</div>
135</td>
136</tr>
137</table>
138</li>
139</ul>
140<!-- ========== METHOD SUMMARY =========== -->
141<ul class="blockList">
142<li class="blockList"><a name="method_summary">
143<!--   -->
144</a>
145<h3>Method Summary</h3>
146<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
147<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
148<tr>
149<th class="colFirst" scope="col">Modifier and Type</th>
150<th class="colLast" scope="col">Method and Description</th>
151</tr>
152<tr class="altColor">
153<td class="colFirst"><code>java.lang.String</code></td>
154<td class="colLast"><code><strong><a href="../../../omq/client/proxy/Proxymq.html#getRef()">getRef</a></strong>()</code>
155<div class="block">Returns the UID of a RemoteObject</div>
156</td>
157</tr>
158<tr class="rowColor">
159<td class="colFirst"><code>java.util.Map&lt;java.lang.String,byte[]&gt;</code></td>
160<td class="colLast"><code><strong><a href="../../../omq/client/proxy/Proxymq.html#getResults()">getResults</a></strong>()</code>
161<div class="block">Gets the Map used internally to retreive the response of the server</div>
162</td>
163</tr>
164<tr class="altColor">
165<td class="colFirst"><code>java.lang.Object</code></td>
166<td class="colLast"><code><strong><a href="../../../omq/client/proxy/Proxymq.html#invoke(java.lang.Object, java.lang.reflect.Method, java.lang.Object[])">invoke</a></strong>(java.lang.Object&nbsp;proxy,
167      java.lang.reflect.Method&nbsp;method,
168      java.lang.Object[]&nbsp;arguments)</code>&nbsp;</td>
169</tr>
170</table>
171<ul class="blockList">
172<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
173<!--   -->
174</a>
175<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
176<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
177</ul>
178</li>
179</ul>
180</li>
181</ul>
182</div>
183<div class="details">
184<ul class="blockList">
185<li class="blockList">
186<!-- ========= CONSTRUCTOR DETAIL ======== -->
187<ul class="blockList">
188<li class="blockList"><a name="constructor_detail">
189<!--   -->
190</a>
191<h3>Constructor Detail</h3>
192<a name="Proxymq(java.lang.String, java.lang.Class, omq.common.broker.Broker)">
193<!--   -->
194</a>
195<ul class="blockListLast">
196<li class="blockList">
197<h4>Proxymq</h4>
198<pre>public&nbsp;Proxymq(java.lang.String&nbsp;uid,
199       java.lang.Class&lt;?&gt;&nbsp;clazz,
200       <a href="../../../omq/common/broker/Broker.html" title="class in omq.common.broker">Broker</a>&nbsp;broker)
201        throws java.lang.Exception</pre>
202<div class="block">Proxymq Constructor.
203 
204 This constructor uses an uid to know which object will call. It also uses
205 Properties to set where to send the messages</div>
206<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uid</code> - The uid represents the unique identifier of a remote object</dd><dd><code>clazz</code> - It represents the real class of the remote object. With this
207            class the system can know the remoteInterface used and it can
208            also see which annotations are used</dd><dd><code>env</code> - The environment is used to know where to send the messages</dd>
209<dt><span class="strong">Throws:</span></dt>
210<dd><code>java.lang.Exception</code></dd></dl>
211</li>
212</ul>
213</li>
214</ul>
215<!-- ============ METHOD DETAIL ========== -->
216<ul class="blockList">
217<li class="blockList"><a name="method_detail">
218<!--   -->
219</a>
220<h3>Method Detail</h3>
221<a name="invoke(java.lang.Object, java.lang.reflect.Method, java.lang.Object[])">
222<!--   -->
223</a>
224<ul class="blockList">
225<li class="blockList">
226<h4>invoke</h4>
227<pre>public&nbsp;java.lang.Object&nbsp;invoke(java.lang.Object&nbsp;proxy,
228                      java.lang.reflect.Method&nbsp;method,
229                      java.lang.Object[]&nbsp;arguments)
230                        throws java.lang.Throwable</pre>
231<dl>
232<dt><strong>Specified by:</strong></dt>
233<dd><code>invoke</code>&nbsp;in interface&nbsp;<code>java.lang.reflect.InvocationHandler</code></dd>
234<dt><span class="strong">Throws:</span></dt>
235<dd><code>java.lang.Throwable</code></dd></dl>
236</li>
237</ul>
238<a name="getResults()">
239<!--   -->
240</a>
241<ul class="blockList">
242<li class="blockList">
243<h4>getResults</h4>
244<pre>public&nbsp;java.util.Map&lt;java.lang.String,byte[]&gt;&nbsp;getResults()</pre>
245<div class="block">Gets the Map used internally to retreive the response of the server</div>
246<dl><dt><span class="strong">Returns:</span></dt><dd>a map with all the keys processed. Every key is a correlation id
247         of a method invoked remotely</dd></dl>
248</li>
249</ul>
250<a name="getRef()">
251<!--   -->
252</a>
253<ul class="blockListLast">
254<li class="blockList">
255<h4>getRef</h4>
256<pre>public&nbsp;java.lang.String&nbsp;getRef()</pre>
257<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../omq/Remote.html#getRef()">Remote</a></code></strong></div>
258<div class="block">Returns the UID of a RemoteObject</div>
259<dl>
260<dt><strong>Specified by:</strong></dt>
261<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>
262<dt><span class="strong">Returns:</span></dt><dd>UID</dd></dl>
263</li>
264</ul>
265</li>
266</ul>
267</li>
268</ul>
269</div>
270</div>
271<!-- ========= END OF CLASS DATA ========= -->
272<!-- ======= START OF BOTTOM NAVBAR ====== -->
273<div class="bottomNav"><a name="navbar_bottom">
274<!--   -->
275</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
276<!--   -->
277</a>
278<ul class="navList" title="Navigation">
279<li><a href="../../../overview-summary.html">Overview</a></li>
280<li><a href="package-summary.html">Package</a></li>
281<li class="navBarCell1Rev">Class</li>
282<li><a href="class-use/Proxymq.html">Use</a></li>
283<li><a href="package-tree.html">Tree</a></li>
284<li><a href="../../../deprecated-list.html">Deprecated</a></li>
285<li><a href="../../../index-files/index-1.html">Index</a></li>
286<li><a href="../../../help-doc.html">Help</a></li>
287</ul>
288</div>
289<div class="subNav">
290<ul class="navList">
291<li><a href="../../../omq/client/proxy/MultiProxymq.html" title="class in omq.client.proxy"><span class="strong">Prev Class</span></a></li>
292<li>Next Class</li>
293</ul>
294<ul class="navList">
295<li><a href="../../../index.html?omq/client/proxy/Proxymq.html" target="_top">Frames</a></li>
296<li><a href="Proxymq.html" target="_top">No Frames</a></li>
297</ul>
298<ul class="navList" id="allclasses_navbar_bottom">
299<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
300</ul>
301<div>
302<script type="text/javascript"><!--
303  allClassesLink = document.getElementById("allclasses_navbar_bottom");
304  if(window==top) {
305    allClassesLink.style.display = "block";
306  }
307  else {
308    allClassesLink.style.display = "none";
309  }
310  //-->
311</script>
312</div>
313<div>
314<ul class="subNavList">
315<li>Summary:&nbsp;</li>
316<li>Nested&nbsp;|&nbsp;</li>
317<li>Field&nbsp;|&nbsp;</li>
318<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
319<li><a href="#method_summary">Method</a></li>
320</ul>
321<ul class="subNavList">
322<li>Detail:&nbsp;</li>
323<li>Field&nbsp;|&nbsp;</li>
324<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
325<li><a href="#method_detail">Method</a></li>
326</ul>
327</div>
328<a name="skip-navbar_bottom">
329<!--   -->
330</a></div>
331<!-- ======== END OF BOTTOM NAVBAR ======= -->
332</body>
333</html>
Note: See TracBrowser for help on using the repository browser.