Download this file

Slap.html    351 lines (350 with data), 14.4 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="es">
<head>
<!-- Generated by javadoc (1.8.0_92) on Mon Jun 20 20:53:32 CEST 2016 -->
<title>Slap (ECloud Java Runtime API Specification)</title>
<meta name="date" content="2016-06-20">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Slap (ECloud Java Runtime API Specification)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/Slap.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="../kumori/ComponentConfig.html" title="interface in kumori"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../kumori/Slap.LOG_LEVEL.html" title="enum in kumori"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?kumori/Slap.html" target="_top">Frames</a></li>
<li><a href="Slap.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">kumori</div>
<h2 title="Interface Slap" class="title">Interface Slap</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Slap</span></pre>
<div class="block">The Interface Slap offers a set of services to interact with ECloud.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../kumori/Slap.LOG_LEVEL.html" title="enum in kumori">Slap.LOG_LEVEL</a></span></code>
<div class="block">The enumeration for indicating the severity of logging message.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../kumori/channels/Duplex.html" title="interface in kumori.channels">Duplex</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../kumori/Slap.html#createDuplexChannel-kumori.messages.MessageHandler-kumori.channels.MembershipChangeHandler-">createDuplexChannel</a></span>(<a href="../kumori/messages/MessageHandler.html" title="interface in kumori.messages">MessageHandler</a>&nbsp;handler,
<a href="../kumori/channels/MembershipChangeHandler.html" title="interface in kumori.channels">MembershipChangeHandler</a>&nbsp;mchandler)</code>
<div class="block">The createDuplexChannel method returns a Duplex channel ready to be used.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../kumori/channels/Reply.html" title="interface in kumori.channels">Reply</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../kumori/Slap.html#createReplyChannel-kumori.messages.RequestMessageHandler-">createReplyChannel</a></span>(<a href="../kumori/messages/RequestMessageHandler.html" title="interface in kumori.messages">RequestMessageHandler</a>&nbsp;handler)</code>
<div class="block">The createReplyChannel method returns a Reply channel ready to be used.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../kumori/Slap.html#log-kumori.Slap.LOG_LEVEL-java.lang.String-">log</a></span>(<a href="../kumori/Slap.LOG_LEVEL.html" title="enum in kumori">Slap.LOG_LEVEL</a>&nbsp;level,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message)</code>
<div class="block">General logging facility</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../kumori/Slap.html#ping--">ping</a></span>()</code>
<div class="block">The method ping must be used by the instance to periodically signal its
good health to ECloud.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../kumori/Slap.html#timeout-kumori.channels.Channel-java.util.Map-">timeout</a></span>(<a href="../kumori/channels/Channel.html" title="interface in kumori.channels">Channel</a>&nbsp;channel,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;data)</code>
<div class="block">The timeout method is used by the instance to indicate that a particular
channel did not respond in time to some request, or failed to present
information when expected.</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="ping--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ping</h4>
<pre>void&nbsp;ping()</pre>
<div class="block">The method ping must be used by the instance to periodically signal its
good health to ECloud.</div>
</li>
</ul>
<a name="timeout-kumori.channels.Channel-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>timeout</h4>
<pre>void&nbsp;timeout(<a href="../kumori/channels/Channel.html" title="interface in kumori.channels">Channel</a>&nbsp;channel,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;data)</pre>
<div class="block">The timeout method is used by the instance to indicate that a particular
channel did not respond in time to some request, or failed to present
information when expected. These indications will eventually be used by
ECloud to quickly infer instance malfunctions in a service.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - the channel</dd>
<dd><code>data</code> - the data</dd>
</dl>
</li>
</ul>
<a name="log-kumori.Slap.LOG_LEVEL-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>log</h4>
<pre>void&nbsp;log(<a href="../kumori/Slap.LOG_LEVEL.html" title="enum in kumori">Slap.LOG_LEVEL</a>&nbsp;level,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message)</pre>
<div class="block">General logging facility</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>level</code> - the log level</dd>
<dd><code>message</code> - the message to be logged</dd>
</dl>
</li>
</ul>
<a name="createReplyChannel-kumori.messages.RequestMessageHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createReplyChannel</h4>
<pre><a href="../kumori/channels/Reply.html" title="interface in kumori.channels">Reply</a>&nbsp;createReplyChannel(<a href="../kumori/messages/RequestMessageHandler.html" title="interface in kumori.messages">RequestMessageHandler</a>&nbsp;handler)</pre>
<div class="block">The createReplyChannel method returns a Reply channel ready to be used.
The handler parameter will be invoked when messages arrive through the
channel.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handler</code> - the handler for messages that arrive through the new channel</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the reply channel</dd>
</dl>
</li>
</ul>
<a name="createDuplexChannel-kumori.messages.MessageHandler-kumori.channels.MembershipChangeHandler-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createDuplexChannel</h4>
<pre><a href="../kumori/channels/Duplex.html" title="interface in kumori.channels">Duplex</a>&nbsp;createDuplexChannel(<a href="../kumori/messages/MessageHandler.html" title="interface in kumori.messages">MessageHandler</a>&nbsp;handler,
<a href="../kumori/channels/MembershipChangeHandler.html" title="interface in kumori.channels">MembershipChangeHandler</a>&nbsp;mchandler)</pre>
<div class="block">The createDuplexChannel method returns a Duplex channel ready to be used.
A Duplex channel is an event emitter, so it must be supplied handlers for
messages and membership events.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handler</code> - the handler for messages</dd>
<dd><code>mchandler</code> - the handler for membership change events.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the duplex channel</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/Slap.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="../kumori/ComponentConfig.html" title="interface in kumori"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../kumori/Slap.LOG_LEVEL.html" title="enum in kumori"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?kumori/Slap.html" target="_top">Frames</a></li>
<li><a href="Slap.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>