source: branches/supervisor/doc/omq/client/annotation/SyncMethod.html

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

Javadocs updated
File size: 7.4 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>SyncMethod</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="SyncMethod";
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/SyncMethod.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/annotation/RemoteInterface.html" title="annotation in omq.client.annotation"><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/annotation/SyncMethod.html" target="_top">Frames</a></li>
44<li><a href="SyncMethod.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>Required&nbsp;|&nbsp;</li>
65<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
66</ul>
67<ul class="subNavList">
68<li>Detail:&nbsp;</li>
69<li><a href="#annotation_type_element_detail">Element</a></li>
70</ul>
71</div>
72<a name="skip-navbar_top">
73<!--   -->
74</a></div>
75<!-- ========= END OF TOP NAVBAR ========= -->
76<!-- ======== START OF CLASS DATA ======== -->
77<div class="header">
78<div class="subTitle">omq.client.annotation</div>
79<h2 title="Annotation Type SyncMethod" class="title">Annotation Type SyncMethod</h2>
80</div>
81<div class="contentContainer">
82<div class="description">
83<ul class="blockList">
84<li class="blockList">
85<hr>
86<br>
87<pre>@Retention(value=RUNTIME)
88@Target(value=METHOD)
89public @interface <span class="strong">SyncMethod</span></pre>
90<div class="block">Annotation which indicates a method as Synchronous. It can have two
91 parameters: timeout and retry which will give you how long you have to wait a
92 synchronous method and how many times you'll wait for the response.</div>
93<dl><dt><span class="strong">Author:</span></dt>
94  <dd>Sergi Toda <sergi.toda@estudiants.urv.cat></dd></dl>
95</li>
96</ul>
97</div>
98<div class="summary">
99<ul class="blockList">
100<li class="blockList">
101<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
102<ul class="blockList">
103<li class="blockList"><a name="annotation_type_optional_element_summary">
104<!--   -->
105</a>
106<h3>Optional Element Summary</h3>
107<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
108<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
109<tr>
110<th class="colFirst" scope="col">Modifier and Type</th>
111<th class="colLast" scope="col">Optional Element and Description</th>
112</tr>
113<tr class="altColor">
114<td class="colFirst"><code>int</code></td>
115<td class="colLast"><code><strong><a href="../../../omq/client/annotation/SyncMethod.html#retry()">retry</a></strong></code>
116<div class="block">Number of retries of a synchronous method</div>
117</td>
118</tr>
119<tr class="rowColor">
120<td class="colFirst"><code>long</code></td>
121<td class="colLast"><code><strong><a href="../../../omq/client/annotation/SyncMethod.html#timeout()">timeout</a></strong></code>
122<div class="block">Timeout of a synchronous method</div>
123</td>
124</tr>
125</table>
126</li>
127</ul>
128</li>
129</ul>
130</div>
131<div class="details">
132<ul class="blockList">
133<li class="blockList">
134<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
135<ul class="blockList">
136<li class="blockList"><a name="annotation_type_element_detail">
137<!--   -->
138</a>
139<h3>Element Detail</h3>
140<a name="timeout()">
141<!--   -->
142</a>
143<ul class="blockList">
144<li class="blockList">
145<h4>timeout</h4>
146<pre>public abstract&nbsp;long&nbsp;timeout</pre>
147<div class="block">Timeout of a synchronous method</div>
148<dl><dt><span class="strong">Returns:</span></dt><dd>how long we'll wait for a response</dd></dl>
149<dl>
150<dt>Default:</dt>
151<dd>60000L</dd>
152</dl>
153</li>
154</ul>
155<a name="retry()">
156<!--   -->
157</a>
158<ul class="blockListLast">
159<li class="blockList">
160<h4>retry</h4>
161<pre>public abstract&nbsp;int&nbsp;retry</pre>
162<div class="block">Number of retries of a synchronous method</div>
163<dl><dt><span class="strong">Returns:</span></dt><dd>how many retries we'll make. If the timeout is set, every timeout
164         will use it</dd></dl>
165<dl>
166<dt>Default:</dt>
167<dd>1</dd>
168</dl>
169</li>
170</ul>
171</li>
172</ul>
173</li>
174</ul>
175</div>
176</div>
177<!-- ========= END OF CLASS DATA ========= -->
178<!-- ======= START OF BOTTOM NAVBAR ====== -->
179<div class="bottomNav"><a name="navbar_bottom">
180<!--   -->
181</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
182<!--   -->
183</a>
184<ul class="navList" title="Navigation">
185<li><a href="../../../overview-summary.html">Overview</a></li>
186<li><a href="package-summary.html">Package</a></li>
187<li class="navBarCell1Rev">Class</li>
188<li><a href="class-use/SyncMethod.html">Use</a></li>
189<li><a href="package-tree.html">Tree</a></li>
190<li><a href="../../../deprecated-list.html">Deprecated</a></li>
191<li><a href="../../../index-files/index-1.html">Index</a></li>
192<li><a href="../../../help-doc.html">Help</a></li>
193</ul>
194</div>
195<div class="subNav">
196<ul class="navList">
197<li><a href="../../../omq/client/annotation/RemoteInterface.html" title="annotation in omq.client.annotation"><span class="strong">Prev Class</span></a></li>
198<li>Next Class</li>
199</ul>
200<ul class="navList">
201<li><a href="../../../index.html?omq/client/annotation/SyncMethod.html" target="_top">Frames</a></li>
202<li><a href="SyncMethod.html" target="_top">No Frames</a></li>
203</ul>
204<ul class="navList" id="allclasses_navbar_bottom">
205<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
206</ul>
207<div>
208<script type="text/javascript"><!--
209  allClassesLink = document.getElementById("allclasses_navbar_bottom");
210  if(window==top) {
211    allClassesLink.style.display = "block";
212  }
213  else {
214    allClassesLink.style.display = "none";
215  }
216  //-->
217</script>
218</div>
219<div>
220<ul class="subNavList">
221<li>Summary:&nbsp;</li>
222<li>Required&nbsp;|&nbsp;</li>
223<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
224</ul>
225<ul class="subNavList">
226<li>Detail:&nbsp;</li>
227<li><a href="#annotation_type_element_detail">Element</a></li>
228</ul>
229</div>
230<a name="skip-navbar_bottom">
231<!--   -->
232</a></div>
233<!-- ======== END OF BOTTOM NAVBAR ======= -->
234</body>
235</html>
Note: See TracBrowser for help on using the repository browser.