Gitiles
Code Review Sign In
gerrit.named-data.net / jndn-management / refs/heads/gh-pages / . / com / intel / jndn / management / helpers / FetchHelper.html
blob: 3fcacc6ff0cd0fb4cb9189c5bd9490d0f4948e51 [file] [log] [blame]
Andrew Brownd4d0eda2016-02-22 16:41:07 -0800[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
5<!-- Generated by javadoc (1.8.0_66) on Mon Feb 22 16:40:14 PST 2016 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>FetchHelper (jndn-management 1.1.0 API)</title>
8<meta name="date" content="2016-02-22">
9<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
10<script type="text/javascript" src="../../../../../script.js"></script>
11</head>
12<body>
13<script type="text/javascript"><!--
14 try {
15 if (location.href.indexOf('is-external=true') == -1) {
16 parent.document.title="FetchHelper (jndn-management 1.1.0 API)";
17 }
18 }
19 catch(err) {
20 }
21//-->
22var methods = {"i0":9,"i1":9,"i2":9,"i3":10,"i4":10};
23var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
24var altColor = "altColor";
25var rowColor = "rowColor";
26var tableTab = "tableTab";
27var activeTableTab = "activeTableTab";
28</script>
29<noscript>
30<div>JavaScript is disabled on your browser.</div>
31</noscript>
32<!-- ========= START OF TOP NAVBAR ======= -->
33<div class="topNav"><a name="navbar.top">
34<!-- -->
35</a>
36<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
37<a name="navbar.top.firstrow">
38<!-- -->
39</a>
40<ul class="navList" title="Navigation">
41<li><a href="../../../../../overview-summary.html">Overview</a></li>
42<li><a href="package-summary.html">Package</a></li>
43<li class="navBarCell1Rev">Class</li>
44<li><a href="class-use/FetchHelper.html">Use</a></li>
45<li><a href="package-tree.html">Tree</a></li>
46<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
47<li><a href="../../../../../index-all.html">Index</a></li>
48<li><a href="../../../../../help-doc.html">Help</a></li>
49</ul>
50</div>
51<div class="subNav">
52<ul class="navList">
53<li><a href="../../../../../com/intel/jndn/management/helpers/EncodingHelper.html" title="class in com.intel.jndn.management.helpers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
54<li><a href="../../../../../com/intel/jndn/management/helpers/StatusDatasetHelper.html" title="class in com.intel.jndn.management.helpers"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
55</ul>
56<ul class="navList">
57<li><a href="../../../../../index.html?com/intel/jndn/management/helpers/FetchHelper.html" target="_top">Frames</a></li>
58<li><a href="FetchHelper.html" target="_top">No&nbsp;Frames</a></li>
59</ul>
60<ul class="navList" id="allclasses_navbar_top">
61<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
62</ul>
63<div>
64<script type="text/javascript"><!--
65 allClassesLink = document.getElementById("allclasses_navbar_top");
66 if(window==top) {
67 allClassesLink.style.display = "block";
68 }
69 else {
70 allClassesLink.style.display = "none";
71 }
72 //-->
73</script>
74</div>
75<div>
76<ul class="subNavList">
77<li>Summary:&nbsp;</li>
78<li>Nested&nbsp;|&nbsp;</li>
79<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
80<li>Constr&nbsp;|&nbsp;</li>
81<li><a href="#method.summary">Method</a></li>
82</ul>
83<ul class="subNavList">
84<li>Detail:&nbsp;</li>
85<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
86<li>Constr&nbsp;|&nbsp;</li>
87<li><a href="#method.detail">Method</a></li>
88</ul>
89</div>
90<a name="skip.navbar.top">
91<!-- -->
92</a></div>
93<!-- ========= END OF TOP NAVBAR ========= -->
94<!-- ======== START OF CLASS DATA ======== -->
95<div class="header">
96<div class="subTitle">com.intel.jndn.management.helpers</div>
97<h2 title="Class FetchHelper" class="title">Class FetchHelper</h2>
98</div>
99<div class="contentContainer">
100<ul class="inheritance">
101<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
102<li>
103<ul class="inheritance">
104<li>com.intel.jndn.management.helpers.FetchHelper</li>
105</ul>
106</li>
107</ul>
108<div class="description">
109<ul class="blockList">
110<li class="blockList">
111<dl>
112<dt>All Implemented Interfaces:</dt>
113<dd>net.named_data.jndn.OnData, net.named_data.jndn.OnTimeout</dd>
114</dl>
115<hr>
116<br>
117<pre>public final class <span class="typeNameLabel">FetchHelper</span>
118extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
119implements net.named_data.jndn.OnData, net.named_data.jndn.OnTimeout</pre>
120<div class="block">Trival NDN client to fetch one or multiple Data packets.</div>
121</li>
122</ul>
123</div>
124<div class="summary">
125<ul class="blockList">
126<li class="blockList">
127<!-- =========== FIELD SUMMARY =========== -->
128<ul class="blockList">
129<li class="blockList"><a name="field.summary">
130<!-- -->
131</a>
132<h3>Field Summary</h3>
133<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
134<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
135<tr>
136<th class="colFirst" scope="col">Modifier and Type</th>
137<th class="colLast" scope="col">Field and Description</th>
138</tr>
139<tr class="altColor">
140<td class="colFirst"><code>static long</code></td>
141<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/FetchHelper.html#DEFAULT_TIMEOUT">DEFAULT_TIMEOUT</a></span></code>&nbsp;</td>
142</tr>
143</table>
144</li>
145</ul>
146<!-- ========== METHOD SUMMARY =========== -->
147<ul class="blockList">
148<li class="blockList"><a name="method.summary">
149<!-- -->
150</a>
151<h3>Method Summary</h3>
152<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
153<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
154<tr>
155<th class="colFirst" scope="col">Modifier and Type</th>
156<th class="colLast" scope="col">Method and Description</th>
157</tr>
158<tr id="i0" class="altColor">
159<td class="colFirst"><code>static net.named_data.jndn.Data</code></td>
160<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/FetchHelper.html#getData-net.named_data.jndn.Face-net.named_data.jndn.Interest-">getData</a></span>(net.named_data.jndn.Face&nbsp;face,
161 net.named_data.jndn.Interest&nbsp;interest)</code>
162<div class="block">Get a single Data packet.</div>
163</td>
164</tr>
165<tr id="i1" class="rowColor">
166<td class="colFirst"><code>static net.named_data.jndn.Data</code></td>
167<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/FetchHelper.html#getData-net.named_data.jndn.Face-net.named_data.jndn.Name-">getData</a></span>(net.named_data.jndn.Face&nbsp;face,
168 net.named_data.jndn.Name&nbsp;name)</code>
169<div class="block">Get data using the exact name (without implicit digest).</div>
170</td>
171</tr>
172<tr id="i2" class="altColor">
173<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;net.named_data.jndn.Data&gt;</code></td>
174<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/FetchHelper.html#getSegmentedData-net.named_data.jndn.Face-net.named_data.jndn.Name-">getSegmentedData</a></span>(net.named_data.jndn.Face&nbsp;face,
175 net.named_data.jndn.Name&nbsp;prefix)</code>
176<div class="block">Get concatenated data from the segmented.</div>
177</td>
178</tr>
179<tr id="i3" class="rowColor">
180<td class="colFirst"><code>void</code></td>
181<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/FetchHelper.html#onData-net.named_data.jndn.Interest-net.named_data.jndn.Data-">onData</a></span>(net.named_data.jndn.Interest&nbsp;interest,
182 net.named_data.jndn.Data&nbsp;data)</code>&nbsp;</td>
183</tr>
184<tr id="i4" class="altColor">
185<td class="colFirst"><code>void</code></td>
186<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/FetchHelper.html#onTimeout-net.named_data.jndn.Interest-">onTimeout</a></span>(net.named_data.jndn.Interest&nbsp;interest)</code>&nbsp;</td>
187</tr>
188</table>
189<ul class="blockList">
190<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
191<!-- -->
192</a>
193<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
194<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
195</ul>
196</li>
197</ul>
198</li>
199</ul>
200</div>
201<div class="details">
202<ul class="blockList">
203<li class="blockList">
204<!-- ============ FIELD DETAIL =========== -->
205<ul class="blockList">
206<li class="blockList"><a name="field.detail">
207<!-- -->
208</a>
209<h3>Field Detail</h3>
210<a name="DEFAULT_TIMEOUT">
211<!-- -->
212</a>
213<ul class="blockListLast">
214<li class="blockList">
215<h4>DEFAULT_TIMEOUT</h4>
216<pre>public static final&nbsp;long DEFAULT_TIMEOUT</pre>
217<dl>
218<dt><span class="seeLabel">See Also:</span></dt>
219<dd><a href="../../../../../constant-values.html#com.intel.jndn.management.helpers.FetchHelper.DEFAULT_TIMEOUT">Constant Field Values</a></dd>
220</dl>
221</li>
222</ul>
223</li>
224</ul>
225<!-- ============ METHOD DETAIL ========== -->
226<ul class="blockList">
227<li class="blockList"><a name="method.detail">
228<!-- -->
229</a>
230<h3>Method Detail</h3>
231<a name="getData-net.named_data.jndn.Face-net.named_data.jndn.Interest-">
232<!-- -->
233</a>
234<ul class="blockList">
235<li class="blockList">
236<h4>getData</h4>
237<pre>public static&nbsp;net.named_data.jndn.Data&nbsp;getData(net.named_data.jndn.Face&nbsp;face,
238 net.named_data.jndn.Interest&nbsp;interest)
239 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
240<div class="block">Get a single Data packet.</div>
241<dl>
242<dt><span class="paramLabel">Parameters:</span></dt>
243<dd><code>face</code> - Face instance</dd>
244<dd><code>interest</code> - Interest to retrieve Data</dd>
245<dt><span class="returnLabel">Returns:</span></dt>
246<dd>Data packet</dd>
247<dt><span class="throwsLabel">Throws:</span></dt>
248<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if failed to retrieve packet, e.g., timeout occured</dd>
249</dl>
250</li>
251</ul>
252<a name="getData-net.named_data.jndn.Face-net.named_data.jndn.Name-">
253<!-- -->
254</a>
255<ul class="blockList">
256<li class="blockList">
257<h4>getData</h4>
258<pre>public static&nbsp;net.named_data.jndn.Data&nbsp;getData(net.named_data.jndn.Face&nbsp;face,
259 net.named_data.jndn.Name&nbsp;name)
260 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
261<div class="block">Get data using the exact name (without implicit digest).
262 <p/>
263 TODO: Allow authentication of retrieved data packets</div>
264<dl>
265<dt><span class="paramLabel">Parameters:</span></dt>
266<dd><code>face</code> - Face instance</dd>
267<dd><code>name</code> - Exact name of the data packet to retrieve</dd>
268<dt><span class="returnLabel">Returns:</span></dt>
269<dd>retrieved Data packet</dd>
270<dt><span class="throwsLabel">Throws:</span></dt>
271<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - when communication with NFD fails</dd>
272</dl>
273</li>
274</ul>
275<a name="getSegmentedData-net.named_data.jndn.Face-net.named_data.jndn.Name-">
276<!-- -->
277</a>
278<ul class="blockList">
279<li class="blockList">
280<h4>getSegmentedData</h4>
281<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;net.named_data.jndn.Data&gt;&nbsp;getSegmentedData(net.named_data.jndn.Face&nbsp;face,
282 net.named_data.jndn.Name&nbsp;prefix)
283 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
284<div class="block">Get concatenated data from the segmented.
285 <p/>
286 Note that this method will first send interest with MustBeFresh selector to discover "latest" version of the
287 stream and then retrieve the rest of the stream
288 <p/>
289 TODO: Allow authentication of retrieved data packets</div>
290<dl>
291<dt><span class="paramLabel">Parameters:</span></dt>
292<dd><code>face</code> - Face instance</dd>
293<dd><code>prefix</code> - Prefix of the retrieved data. The retrieved data must have version and segment numbers after this
294 prefix</dd>
295<dt><span class="returnLabel">Returns:</span></dt>
296<dd>list of retrieved Data packets</dd>
297<dt><span class="throwsLabel">Throws:</span></dt>
298<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - when communication with NFD fails</dd>
299</dl>
300</li>
301</ul>
302<a name="onData-net.named_data.jndn.Interest-net.named_data.jndn.Data-">
303<!-- -->
304</a>
305<ul class="blockList">
306<li class="blockList">
307<h4>onData</h4>
308<pre>public&nbsp;void&nbsp;onData(net.named_data.jndn.Interest&nbsp;interest,
309 net.named_data.jndn.Data&nbsp;data)</pre>
310<dl>
311<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
312<dd><code>onData</code>&nbsp;in interface&nbsp;<code>net.named_data.jndn.OnData</code></dd>
313</dl>
314</li>
315</ul>
316<a name="onTimeout-net.named_data.jndn.Interest-">
317<!-- -->
318</a>
319<ul class="blockListLast">
320<li class="blockList">
321<h4>onTimeout</h4>
322<pre>public&nbsp;void&nbsp;onTimeout(net.named_data.jndn.Interest&nbsp;interest)</pre>
323<dl>
324<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
325<dd><code>onTimeout</code>&nbsp;in interface&nbsp;<code>net.named_data.jndn.OnTimeout</code></dd>
326</dl>
327</li>
328</ul>
329</li>
330</ul>
331</li>
332</ul>
333</div>
334</div>
335<!-- ========= END OF CLASS DATA ========= -->
336<!-- ======= START OF BOTTOM NAVBAR ====== -->
337<div class="bottomNav"><a name="navbar.bottom">
338<!-- -->
339</a>
340<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
341<a name="navbar.bottom.firstrow">
342<!-- -->
343</a>
344<ul class="navList" title="Navigation">
345<li><a href="../../../../../overview-summary.html">Overview</a></li>
346<li><a href="package-summary.html">Package</a></li>
347<li class="navBarCell1Rev">Class</li>
348<li><a href="class-use/FetchHelper.html">Use</a></li>
349<li><a href="package-tree.html">Tree</a></li>
350<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
351<li><a href="../../../../../index-all.html">Index</a></li>
352<li><a href="../../../../../help-doc.html">Help</a></li>
353</ul>
354</div>
355<div class="subNav">
356<ul class="navList">
357<li><a href="../../../../../com/intel/jndn/management/helpers/EncodingHelper.html" title="class in com.intel.jndn.management.helpers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
358<li><a href="../../../../../com/intel/jndn/management/helpers/StatusDatasetHelper.html" title="class in com.intel.jndn.management.helpers"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
359</ul>
360<ul class="navList">
361<li><a href="../../../../../index.html?com/intel/jndn/management/helpers/FetchHelper.html" target="_top">Frames</a></li>
362<li><a href="FetchHelper.html" target="_top">No&nbsp;Frames</a></li>
363</ul>
364<ul class="navList" id="allclasses_navbar_bottom">
365<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
366</ul>
367<div>
368<script type="text/javascript"><!--
369 allClassesLink = document.getElementById("allclasses_navbar_bottom");
370 if(window==top) {
371 allClassesLink.style.display = "block";
372 }
373 else {
374 allClassesLink.style.display = "none";
375 }
376 //-->
377</script>
378</div>
379<div>
380<ul class="subNavList">
381<li>Summary:&nbsp;</li>
382<li>Nested&nbsp;|&nbsp;</li>
383<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
384<li>Constr&nbsp;|&nbsp;</li>
385<li><a href="#method.summary">Method</a></li>
386</ul>
387<ul class="subNavList">
388<li>Detail:&nbsp;</li>
389<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
390<li>Constr&nbsp;|&nbsp;</li>
391<li><a href="#method.detail">Method</a></li>
392</ul>
393</div>
394<a name="skip.navbar.bottom">
395<!-- -->
396</a></div>
397<!-- ======== END OF BOTTOM NAVBAR ======= -->
398<p class="legalCopy"><small>Copyright &#169; 2016. All rights reserved.</small></p>
399</body>
400</html>