Gitiles
Code Review Sign In
gerrit.named-data.net / jndn-management / 6ac7d4ae1b4b6520d6919c630b57041cf470bb6d / . / com / intel / jndn / management / NFD.html
blob: 612071f883b0da23f4b9ab4846c6587c5aa28695 [file] [log] [blame]
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[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 (version 1.7.0_51) on Tue Mar 24 09:26:48 PDT 2015 -->
6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
7<title>NFD (jndn-management 0.9.6 API)</title>
8<meta name="date" content="2015-03-24">
9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
10</head>
11<body>
12<script type="text/javascript"><!--
13 if (location.href.indexOf('is-external=true') == -1) {
14 parent.document.title="NFD (jndn-management 0.9.6 API)";
15 }
16//-->
17</script>
18<noscript>
19<div>JavaScript is disabled on your browser.</div>
20</noscript>
21<!-- ========= START OF TOP NAVBAR ======= -->
22<div class="topNav"><a name="navbar_top">
23<!-- -->
24</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
25<!-- -->
26</a>
27<ul class="navList" title="Navigation">
28<li><a href="../../../../overview-summary.html">Overview</a></li>
29<li><a href="package-summary.html">Package</a></li>
30<li class="navBarCell1Rev">Class</li>
31<li><a href="class-use/NFD.html">Use</a></li>
32<li><a href="package-tree.html">Tree</a></li>
33<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
34<li><a href="../../../../index-all.html">Index</a></li>
35<li><a href="../../../../help-doc.html">Help</a></li>
36</ul>
37</div>
38<div class="subNav">
39<ul class="navList">
40<li><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management"><span class="strong">Prev Class</span></a></li>
41<li>Next Class</li>
42</ul>
43<ul class="navList">
44<li><a href="../../../../index.html?com/intel/jndn/management/NFD.html" target="_top">Frames</a></li>
45<li><a href="NFD.html" target="_top">No Frames</a></li>
46</ul>
47<ul class="navList" id="allclasses_navbar_top">
48<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
49</ul>
50<div>
51<script type="text/javascript"><!--
52 allClassesLink = document.getElementById("allclasses_navbar_top");
53 if(window==top) {
54 allClassesLink.style.display = "block";
55 }
56 else {
57 allClassesLink.style.display = "none";
58 }
59 //-->
60</script>
61</div>
62<div>
63<ul class="subNavList">
64<li>Summary:&nbsp;</li>
65<li>Nested&nbsp;|&nbsp;</li>
66<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
67<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
68<li><a href="#method_summary">Method</a></li>
69</ul>
70<ul class="subNavList">
71<li>Detail:&nbsp;</li>
72<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
73<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
74<li><a href="#method_detail">Method</a></li>
75</ul>
76</div>
77<a name="skip-navbar_top">
78<!-- -->
79</a></div>
80<!-- ========= END OF TOP NAVBAR ========= -->
81<!-- ======== START OF CLASS DATA ======== -->
82<div class="header">
83<div class="subTitle">com.intel.jndn.management</div>
84<h2 title="Class NFD" class="title">Class NFD</h2>
85</div>
86<div class="contentContainer">
87<ul class="inheritance">
88<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
89<li>
90<ul class="inheritance">
91<li>com.intel.jndn.management.NFD</li>
92</ul>
93</li>
94</ul>
95<div class="description">
96<ul class="blockList">
97<li class="blockList">
98<hr>
99<br>
100<pre>public class <span class="strong">NFD</span>
101extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
102<div class="block">Helper class for interacting with an NDN forwarder daemon; see
103 http://redmine.named-data.net/projects/nfd/wiki/Management for explanations
104 of the various protocols used.</div>
105<dl><dt><span class="strong">Author:</span></dt>
106 <dd>Andrew Brown <andrew.brown@intel.com></dd></dl>
107</li>
108</ul>
109</div>
110<div class="summary">
111<ul class="blockList">
112<li class="blockList">
113<!-- =========== FIELD SUMMARY =========== -->
114<ul class="blockList">
115<li class="blockList"><a name="field_summary">
116<!-- -->
117</a>
118<h3>Field Summary</h3>
119<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
120<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
121<tr>
122<th class="colFirst" scope="col">Modifier and Type</th>
123<th class="colLast" scope="col">Field and Description</th>
124</tr>
125<tr class="altColor">
126<td class="colFirst"><code>static long</code></td>
127<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#DEFAULT_TIMEOUT">DEFAULT_TIMEOUT</a></strong></code>&nbsp;</td>
128</tr>
129<tr class="rowColor">
130<td class="colFirst"><code>static int</code></td>
131<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#OK_STATUS">OK_STATUS</a></strong></code>&nbsp;</td>
132</tr>
133</table>
134</li>
135</ul>
136<!-- ======== CONSTRUCTOR SUMMARY ======== -->
137<ul class="blockList">
138<li class="blockList"><a name="constructor_summary">
139<!-- -->
140</a>
141<h3>Constructor Summary</h3>
142<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
143<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
144<tr>
145<th class="colOne" scope="col">Constructor and Description</th>
146</tr>
147<tr class="altColor">
148<td class="colOne"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#NFD()">NFD</a></strong>()</code>&nbsp;</td>
149</tr>
150</table>
151</li>
152</ul>
153<!-- ========== METHOD SUMMARY =========== -->
154<ul class="blockList">
155<li class="blockList"><a name="method_summary">
156<!-- -->
157</a>
158<h3>Method Summary</h3>
159<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
160<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
161<tr>
162<th class="colFirst" scope="col">Modifier and Type</th>
163<th class="colLast" scope="col">Method and Description</th>
164</tr>
165<tr class="altColor">
166<td class="colFirst"><code>static void</code></td>
167<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#addNextHop(net.named_data.jndn.Face, int, net.named_data.jndn.Name)">addNextHop</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
168 int&nbsp;faceId,
169 net.named_data.jndn.Name&nbsp;prefix)</code>
170<div class="block">Helper method to register a new face on the forwarder; as mentioned at
171 http://named-data.net/doc/NFD/current/manpages/nfdc.html, this is more for
172 debugging; use 'register' instead</div>
173</td>
174</tr>
175<tr class="rowColor">
176<td class="colFirst"><code>static int</code></td>
177<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#createFace(net.named_data.jndn.Face, java.lang.String)">createFace</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
178 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri)</code>
179<div class="block">Create a new face on the given forwarder.</div>
180</td>
181</tr>
182<tr class="altColor">
183<td class="colFirst"><code>static void</code></td>
184<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#destroyFace(net.named_data.jndn.Face, int)">destroyFace</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
185 int&nbsp;faceId)</code>
186<div class="block">Destroy a face on given forwarder.</div>
187</td>
188</tr>
189<tr class="rowColor">
190<td class="colFirst"><code>static void</code></td>
191<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#disableLocalControlHeader(net.named_data.jndn.Face, com.intel.jndn.management.types.LocalControlHeader)">disableLocalControlHeader</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
192 <a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a>&nbsp;header)</code>
193<div class="block">Disable a local control feature on the given forwarder.</div>
194</td>
195</tr>
196<tr class="altColor">
197<td class="colFirst"><code>static void</code></td>
198<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#enableLocalControlHeader(net.named_data.jndn.Face, com.intel.jndn.management.types.LocalControlHeader)">enableLocalControlHeader</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
199 <a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a>&nbsp;header)</code>
200<div class="block">Enable a local control feature on the given forwarder.</div>
201</td>
202</tr>
203<tr class="rowColor">
204<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/intel/jndn/management/types/FaceStatus.html" title="class in com.intel.jndn.management.types">FaceStatus</a>&gt;</code></td>
205<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#getFaceList(net.named_data.jndn.Face)">getFaceList</a></strong>(net.named_data.jndn.Face&nbsp;forwarder)</code>
206<div class="block">Retrieve a list of faces and their status from the given forwarder; calls
207 /localhost/nfd/faces/list which requires a local Face (all non-local
208 packets are dropped)</div>
209</td>
210</tr>
211<tr class="altColor">
212<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/intel/jndn/management/types/FibEntry.html" title="class in com.intel.jndn.management.types">FibEntry</a>&gt;</code></td>
213<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#getFibList(net.named_data.jndn.Face)">getFibList</a></strong>(net.named_data.jndn.Face&nbsp;forwarder)</code>
214<div class="block">Retrieve a list of FIB entries and their NextHopRecords from the given
215 forwarder; calls /localhost/nfd/fib/list which requires a local Face (all
216 non-local packets are dropped).</div>
217</td>
218</tr>
219<tr class="rowColor">
220<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/intel/jndn/management/types/RibEntry.html" title="class in com.intel.jndn.management.types">RibEntry</a>&gt;</code></td>
221<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#getRouteList(net.named_data.jndn.Face)">getRouteList</a></strong>(net.named_data.jndn.Face&nbsp;forwarder)</code>
222<div class="block">Retrieve a list of routing entries from the RIB; calls
223 /localhost/nfd/rib/list which requires a local Face (all non-local packets
224 are dropped).</div>
225</td>
226</tr>
227<tr class="altColor">
228<td class="colFirst"><code>static boolean</code></td>
229<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#ping(net.named_data.jndn.Face, net.named_data.jndn.Name)">ping</a></strong>(net.named_data.jndn.Face&nbsp;face,
230 net.named_data.jndn.Name&nbsp;name)</code>
231<div class="block">Request a name on an existing face to verify the forwarder is working and
232 responding to requests.</div>
233</td>
234</tr>
235<tr class="rowColor">
236<td class="colFirst"><code>static boolean</code></td>
237<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#pingLocal(net.named_data.jndn.Face)">pingLocal</a></strong>(net.named_data.jndn.Face&nbsp;face)</code>
238<div class="block">Ping a forwarder on an existing face to verify that the forwarder is
239 working and responding to requests; this version sends a discovery packet
240 to /localhost/nfd which should always respond if the requestor is on the
241 same machine as the NDN forwarding daemon.</div>
242</td>
243</tr>
244<tr class="altColor">
245<td class="colFirst"><code>static void</code></td>
246<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#register(net.named_data.jndn.Face, net.named_data.jndn.ControlParameters)">register</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
247 net.named_data.jndn.ControlParameters&nbsp;controlParameters)</code>
248<div class="block">Register a route on the forwarder; see
249 http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
250 usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
251 protocol documentation.</div>
252</td>
253</tr>
254<tr class="rowColor">
255<td class="colFirst"><code>static void</code></td>
256<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#register(net.named_data.jndn.Face, int, net.named_data.jndn.Name, int)">register</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
257 int&nbsp;faceId,
258 net.named_data.jndn.Name&nbsp;route,
259 int&nbsp;cost)</code>
260<div class="block">Register a route on a forwarder; this will not create a new face since it
261 is provided a faceId.</div>
262</td>
263</tr>
264<tr class="altColor">
265<td class="colFirst"><code>static void</code></td>
266<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#register(net.named_data.jndn.Face, java.lang.String, net.named_data.jndn.Name, int)">register</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
267 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri,
268 net.named_data.jndn.Name&nbsp;route,
269 int&nbsp;cost)</code>
270<div class="block">Register a route on a forwarder; this will create a new face on the
271 forwarder to the given URI/route pair.</div>
272</td>
273</tr>
274<tr class="rowColor">
275<td class="colFirst"><code>static net.named_data.jndn.Data</code></td>
276<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#retrieveDataSet(net.named_data.jndn.Face, net.named_data.jndn.Name)">retrieveDataSet</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
277 net.named_data.jndn.Name&nbsp;datasetName)</code>
278<div class="block">Build an interest to retrieve a segmented data set from the NFD; for
279 details on the DataSet, see
280 http://redmine.named-data.net/projects/nfd/wiki/StatusDataset</div>
281</td>
282</tr>
283<tr class="altColor">
284<td class="colFirst"><code>static <a href="../../../../com/intel/jndn/management/types/ControlResponse.html" title="class in com.intel.jndn.management.types">ControlResponse</a></code></td>
285<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#sendCommand(net.named_data.jndn.Face, net.named_data.jndn.Interest)">sendCommand</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
286 net.named_data.jndn.Interest&nbsp;interest)</code>
287<div class="block">Send an interest as a command to the forwarder; this method will convert
288 the interest to a command interest and block until a response is received
289 from the forwarder.</div>
290</td>
291</tr>
292<tr class="rowColor">
293<td class="colFirst"><code>static void</code></td>
294<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#setStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name, net.named_data.jndn.Name)">setStrategy</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
295 net.named_data.jndn.Name&nbsp;prefix,
296 net.named_data.jndn.Name&nbsp;strategy)</code>
297<div class="block">Set a strategy on the forwarder; see
298 http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
299 usage and http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice
300 for protocol documentation.</div>
301</td>
302</tr>
303<tr class="altColor">
304<td class="colFirst"><code>static void</code></td>
305<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#unregister(net.named_data.jndn.Face, net.named_data.jndn.ControlParameters)">unregister</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
306 net.named_data.jndn.ControlParameters&nbsp;controlParameters)</code>
307<div class="block">Unregister a route on a forwarder; see
308 http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
309 usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
310 protocol documentation.</div>
311</td>
312</tr>
313<tr class="rowColor">
314<td class="colFirst"><code>static void</code></td>
315<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#unregister(net.named_data.jndn.Face, net.named_data.jndn.Name)">unregister</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
316 net.named_data.jndn.Name&nbsp;route)</code>
317<div class="block">Unregister a route on a forwarder; see
318 http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
319 usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
320 protocol documentation.</div>
321</td>
322</tr>
323<tr class="altColor">
324<td class="colFirst"><code>static void</code></td>
325<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#unregister(net.named_data.jndn.Face, net.named_data.jndn.Name, int)">unregister</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
326 net.named_data.jndn.Name&nbsp;route,
327 int&nbsp;faceId)</code>
328<div class="block">Unregister a route on a forwarder; see
329 http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
330 usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
331 protocol documentation.</div>
332</td>
333</tr>
334<tr class="rowColor">
335<td class="colFirst"><code>static void</code></td>
336<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#unregister(net.named_data.jndn.Face, net.named_data.jndn.Name, java.lang.String)">unregister</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
337 net.named_data.jndn.Name&nbsp;route,
338 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri)</code>
339<div class="block">Unregister a route on a forwarder; see
340 http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
341 usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
342 protocol documentation.</div>
343</td>
344</tr>
345</table>
346<ul class="blockList">
347<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
348<!-- -->
349</a>
350<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
351<code><a href="http://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
352</ul>
353</li>
354</ul>
355</li>
356</ul>
357</div>
358<div class="details">
359<ul class="blockList">
360<li class="blockList">
361<!-- ============ FIELD DETAIL =========== -->
362<ul class="blockList">
363<li class="blockList"><a name="field_detail">
364<!-- -->
365</a>
366<h3>Field Detail</h3>
367<a name="DEFAULT_TIMEOUT">
368<!-- -->
369</a>
370<ul class="blockList">
371<li class="blockList">
372<h4>DEFAULT_TIMEOUT</h4>
373<pre>public static final&nbsp;long DEFAULT_TIMEOUT</pre>
374<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.intel.jndn.management.NFD.DEFAULT_TIMEOUT">Constant Field Values</a></dd></dl>
375</li>
376</ul>
377<a name="OK_STATUS">
378<!-- -->
379</a>
380<ul class="blockListLast">
381<li class="blockList">
382<h4>OK_STATUS</h4>
383<pre>public static final&nbsp;int OK_STATUS</pre>
384<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.intel.jndn.management.NFD.OK_STATUS">Constant Field Values</a></dd></dl>
385</li>
386</ul>
387</li>
388</ul>
389<!-- ========= CONSTRUCTOR DETAIL ======== -->
390<ul class="blockList">
391<li class="blockList"><a name="constructor_detail">
392<!-- -->
393</a>
394<h3>Constructor Detail</h3>
395<a name="NFD()">
396<!-- -->
397</a>
398<ul class="blockListLast">
399<li class="blockList">
400<h4>NFD</h4>
401<pre>public&nbsp;NFD()</pre>
402</li>
403</ul>
404</li>
405</ul>
406<!-- ============ METHOD DETAIL ========== -->
407<ul class="blockList">
408<li class="blockList"><a name="method_detail">
409<!-- -->
410</a>
411<h3>Method Detail</h3>
412<a name="pingLocal(net.named_data.jndn.Face)">
413<!-- -->
414</a>
415<ul class="blockList">
416<li class="blockList">
417<h4>pingLocal</h4>
418<pre>public static&nbsp;boolean&nbsp;pingLocal(net.named_data.jndn.Face&nbsp;face)</pre>
419<div class="block">Ping a forwarder on an existing face to verify that the forwarder is
420 working and responding to requests; this version sends a discovery packet
421 to /localhost/nfd which should always respond if the requestor is on the
422 same machine as the NDN forwarding daemon.</div>
423<dl><dt><span class="strong">Parameters:</span></dt><dd><code>face</code> - </dd>
424<dt><span class="strong">Returns:</span></dt><dd>true if successful, false otherwise</dd></dl>
425</li>
426</ul>
427<a name="ping(net.named_data.jndn.Face, net.named_data.jndn.Name)">
428<!-- -->
429</a>
430<ul class="blockList">
431<li class="blockList">
432<h4>ping</h4>
433<pre>public static&nbsp;boolean&nbsp;ping(net.named_data.jndn.Face&nbsp;face,
434 net.named_data.jndn.Name&nbsp;name)</pre>
435<div class="block">Request a name on an existing face to verify the forwarder is working and
436 responding to requests. Note that the name must be served or cached on the
437 forwarder for this to return true.</div>
438<dl><dt><span class="strong">Parameters:</span></dt><dd><code>face</code> - </dd><dd><code>name</code> - </dd>
439<dt><span class="strong">Returns:</span></dt><dd>true if successful, false otherwise</dd></dl>
440</li>
441</ul>
442<a name="getFaceList(net.named_data.jndn.Face)">
443<!-- -->
444</a>
445<ul class="blockList">
446<li class="blockList">
447<h4>getFaceList</h4>
448<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/intel/jndn/management/types/FaceStatus.html" title="class in com.intel.jndn.management.types">FaceStatus</a>&gt;&nbsp;getFaceList(net.named_data.jndn.Face&nbsp;forwarder)
449 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
450<div class="block">Retrieve a list of faces and their status from the given forwarder; calls
451 /localhost/nfd/faces/list which requires a local Face (all non-local
452 packets are dropped)</div>
453<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd>
454<dt><span class="strong">Returns:</span></dt><dd></dd>
455<dt><span class="strong">Throws:</span></dt>
456<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
457</li>
458</ul>
459<a name="getFibList(net.named_data.jndn.Face)">
460<!-- -->
461</a>
462<ul class="blockList">
463<li class="blockList">
464<h4>getFibList</h4>
465<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/intel/jndn/management/types/FibEntry.html" title="class in com.intel.jndn.management.types">FibEntry</a>&gt;&nbsp;getFibList(net.named_data.jndn.Face&nbsp;forwarder)
466 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
467<div class="block">Retrieve a list of FIB entries and their NextHopRecords from the given
468 forwarder; calls /localhost/nfd/fib/list which requires a local Face (all
469 non-local packets are dropped).</div>
470<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd>
471<dt><span class="strong">Returns:</span></dt><dd></dd>
472<dt><span class="strong">Throws:</span></dt>
473<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
474</li>
475</ul>
476<a name="getRouteList(net.named_data.jndn.Face)">
477<!-- -->
478</a>
479<ul class="blockList">
480<li class="blockList">
481<h4>getRouteList</h4>
482<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/intel/jndn/management/types/RibEntry.html" title="class in com.intel.jndn.management.types">RibEntry</a>&gt;&nbsp;getRouteList(net.named_data.jndn.Face&nbsp;forwarder)
483 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
484<div class="block">Retrieve a list of routing entries from the RIB; calls
485 /localhost/nfd/rib/list which requires a local Face (all non-local packets
486 are dropped).</div>
487<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd>
488<dt><span class="strong">Returns:</span></dt><dd></dd>
489<dt><span class="strong">Throws:</span></dt>
490<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
491</li>
492</ul>
493<a name="addNextHop(net.named_data.jndn.Face, int, net.named_data.jndn.Name)">
494<!-- -->
495</a>
496<ul class="blockList">
497<li class="blockList">
498<h4>addNextHop</h4>
499<pre>public static&nbsp;void&nbsp;addNextHop(net.named_data.jndn.Face&nbsp;forwarder,
500 int&nbsp;faceId,
501 net.named_data.jndn.Name&nbsp;prefix)
502 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
503<div class="block">Helper method to register a new face on the forwarder; as mentioned at
504 http://named-data.net/doc/NFD/current/manpages/nfdc.html, this is more for
505 debugging; use 'register' instead</div>
506<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd><dd><code>faceId</code> - </dd><dd><code>prefix</code> - </dd>
507<dt><span class="strong">Throws:</span></dt>
508<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
509</li>
510</ul>
511<a name="createFace(net.named_data.jndn.Face, java.lang.String)">
512<!-- -->
513</a>
514<ul class="blockList">
515<li class="blockList">
516<h4>createFace</h4>
517<pre>public static&nbsp;int&nbsp;createFace(net.named_data.jndn.Face&nbsp;forwarder,
518 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri)
519 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
520<div class="block">Create a new face on the given forwarder. Ensure the forwarding face is on
521 the local machine (management requests are to /localhost/...) and that
522 command signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
523<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd><dd><code>uri</code> - </dd>
524<dt><span class="strong">Returns:</span></dt><dd></dd>
525<dt><span class="strong">Throws:</span></dt>
526<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
527</li>
528</ul>
529<a name="destroyFace(net.named_data.jndn.Face, int)">
530<!-- -->
531</a>
532<ul class="blockList">
533<li class="blockList">
534<h4>destroyFace</h4>
535<pre>public static&nbsp;void&nbsp;destroyFace(net.named_data.jndn.Face&nbsp;forwarder,
536 int&nbsp;faceId)
537 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
538<div class="block">Destroy a face on given forwarder. Ensure the forwarding face is on the
539 local machine (management requests are to /localhost/...) and that command
540 signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
541<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd><dd><code>faceId</code> - </dd>
542<dt><span class="strong">Throws:</span></dt>
543<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
544</li>
545</ul>
546<a name="enableLocalControlHeader(net.named_data.jndn.Face, com.intel.jndn.management.types.LocalControlHeader)">
547<!-- -->
548</a>
549<ul class="blockList">
550<li class="blockList">
551<h4>enableLocalControlHeader</h4>
552<pre>public static&nbsp;void&nbsp;enableLocalControlHeader(net.named_data.jndn.Face&nbsp;forwarder,
553 <a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a>&nbsp;header)
554 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
555<div class="block">Enable a local control feature on the given forwarder. See
556 http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Enable-a-LocalControlHeader-feature</div>
557<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>header</code> - </dd>
558<dt><span class="strong">Throws:</span></dt>
559<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
560</li>
561</ul>
562<a name="disableLocalControlHeader(net.named_data.jndn.Face, com.intel.jndn.management.types.LocalControlHeader)">
563<!-- -->
564</a>
565<ul class="blockList">
566<li class="blockList">
567<h4>disableLocalControlHeader</h4>
568<pre>public static&nbsp;void&nbsp;disableLocalControlHeader(net.named_data.jndn.Face&nbsp;forwarder,
569 <a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a>&nbsp;header)
570 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
571<div class="block">Disable a local control feature on the given forwarder. See
572 http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Disable-a-LocalControlHeader-feature</div>
573<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>header</code> - </dd>
574<dt><span class="strong">Throws:</span></dt>
575<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
576</li>
577</ul>
578<a name="register(net.named_data.jndn.Face, net.named_data.jndn.ControlParameters)">
579<!-- -->
580</a>
581<ul class="blockList">
582<li class="blockList">
583<h4>register</h4>
584<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;forwarder,
585 net.named_data.jndn.ControlParameters&nbsp;controlParameters)
586 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
587<div class="block">Register a route on the forwarder; see
588 http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
589 usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
590 protocol documentation. Ensure the forwarding face is on the local machine
591 (management requests are to /localhost/...) and that command signing has
592 been set up (e.g. forwarder.setCommandSigningInfo()).</div>
593<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd><dd><code>controlParameters</code> - </dd>
594<dt><span class="strong">Throws:</span></dt>
595<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
596</li>
597</ul>
598<a name="register(net.named_data.jndn.Face, java.lang.String, net.named_data.jndn.Name, int)">
599<!-- -->
600</a>
601<ul class="blockList">
602<li class="blockList">
603<h4>register</h4>
604<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;forwarder,
605 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri,
606 net.named_data.jndn.Name&nbsp;route,
607 int&nbsp;cost)
608 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
609<div class="block">Register a route on a forwarder; this will create a new face on the
610 forwarder to the given URI/route pair. See register(Face,
611 ControlParameters) for more details documentation.</div>
612<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd><dd><code>uri</code> - </dd><dd><code>cost</code> - </dd><dd><code>route</code> - </dd>
613<dt><span class="strong">Throws:</span></dt>
614<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
615</li>
616</ul>
617<a name="register(net.named_data.jndn.Face, int, net.named_data.jndn.Name, int)">
618<!-- -->
619</a>
620<ul class="blockList">
621<li class="blockList">
622<h4>register</h4>
623<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;forwarder,
624 int&nbsp;faceId,
625 net.named_data.jndn.Name&nbsp;route,
626 int&nbsp;cost)
627 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
628<div class="block">Register a route on a forwarder; this will not create a new face since it
629 is provided a faceId. See register(Face, ControlParameters) for full
630 documentation</div>
631<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd><dd><code>faceId</code> - </dd><dd><code>route</code> - </dd><dd><code>cost</code> - </dd>
632<dt><span class="strong">Throws:</span></dt>
633<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
634</li>
635</ul>
636<a name="unregister(net.named_data.jndn.Face, net.named_data.jndn.ControlParameters)">
637<!-- -->
638</a>
639<ul class="blockList">
640<li class="blockList">
641<h4>unregister</h4>
642<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;forwarder,
643 net.named_data.jndn.ControlParameters&nbsp;controlParameters)
644 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
645<div class="block">Unregister a route on a forwarder; see
646 http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
647 usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
648 protocol documentation. Ensure the forwarding face is on the local machine
649 (management requests are to /localhost/...) and that command signing has
650 been set up (e.g. forwarder.setCommandSigningInfo()</div>
651<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>controlParameters</code> - </dd>
652<dt><span class="strong">Throws:</span></dt>
653<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
654</li>
655</ul>
656<a name="unregister(net.named_data.jndn.Face, net.named_data.jndn.Name)">
657<!-- -->
658</a>
659<ul class="blockList">
660<li class="blockList">
661<h4>unregister</h4>
662<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;forwarder,
663 net.named_data.jndn.Name&nbsp;route)
664 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
665<div class="block">Unregister a route on a forwarder; see
666 http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
667 usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
668 protocol documentation. Ensure the forwarding face is on the local machine
669 (management requests are to /localhost/...) and that command signing has
670 been set up (e.g. forwarder.setCommandSigningInfo()</div>
671<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>route</code> - </dd>
672<dt><span class="strong">Throws:</span></dt>
673<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
674</li>
675</ul>
676<a name="unregister(net.named_data.jndn.Face, net.named_data.jndn.Name, int)">
677<!-- -->
678</a>
679<ul class="blockList">
680<li class="blockList">
681<h4>unregister</h4>
682<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;forwarder,
683 net.named_data.jndn.Name&nbsp;route,
684 int&nbsp;faceId)
685 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
686<div class="block">Unregister a route on a forwarder; see
687 http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
688 usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
689 protocol documentation. Ensure the forwarding face is on the local machine
690 (management requests are to /localhost/...) and that command signing has
691 been set up (e.g. forwarder.setCommandSigningInfo()</div>
692<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>route</code> - </dd><dd><code>faceId</code> - </dd>
693<dt><span class="strong">Throws:</span></dt>
694<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
695</li>
696</ul>
697<a name="unregister(net.named_data.jndn.Face, net.named_data.jndn.Name, java.lang.String)">
698<!-- -->
699</a>
700<ul class="blockList">
701<li class="blockList">
702<h4>unregister</h4>
703<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;forwarder,
704 net.named_data.jndn.Name&nbsp;route,
705 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri)
706 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
707<div class="block">Unregister a route on a forwarder; see
708 http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
709 usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
710 protocol documentation. Ensure the forwarding face is on the local machine
711 (management requests are to /localhost/...) and that command signing has
712 been set up (e.g. forwarder.setCommandSigningInfo()</div>
713<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>route</code> - </dd><dd><code>uri</code> - </dd>
714<dt><span class="strong">Throws:</span></dt>
715<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
716</li>
717</ul>
718<a name="setStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name, net.named_data.jndn.Name)">
719<!-- -->
720</a>
721<ul class="blockList">
722<li class="blockList">
723<h4>setStrategy</h4>
724<pre>public static&nbsp;void&nbsp;setStrategy(net.named_data.jndn.Face&nbsp;forwarder,
725 net.named_data.jndn.Name&nbsp;prefix,
726 net.named_data.jndn.Name&nbsp;strategy)
727 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
728<div class="block">Set a strategy on the forwarder; see
729 http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
730 usage and http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice
731 for protocol documentation. Ensure the forwarding face is on the local
732 machine (management requests are to /localhost/...) and that command
733 signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
734<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd><dd><code>prefix</code> - </dd><dd><code>strategy</code> - </dd>
735<dt><span class="strong">Throws:</span></dt>
736<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
737</li>
738</ul>
739<a name="retrieveDataSet(net.named_data.jndn.Face, net.named_data.jndn.Name)">
740<!-- -->
741</a>
742<ul class="blockList">
743<li class="blockList">
744<h4>retrieveDataSet</h4>
745<pre>public static&nbsp;net.named_data.jndn.Data&nbsp;retrieveDataSet(net.named_data.jndn.Face&nbsp;forwarder,
746 net.named_data.jndn.Name&nbsp;datasetName)
747 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
748 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
749<div class="block">Build an interest to retrieve a segmented data set from the NFD; for
750 details on the DataSet, see
751 http://redmine.named-data.net/projects/nfd/wiki/StatusDataset</div>
752<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>datasetName</code> - </dd>
753<dt><span class="strong">Returns:</span></dt><dd></dd>
754<dt><span class="strong">Throws:</span></dt>
755<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
756<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code></dd></dl>
757</li>
758</ul>
759<a name="sendCommand(net.named_data.jndn.Face, net.named_data.jndn.Interest)">
760<!-- -->
761</a>
762<ul class="blockListLast">
763<li class="blockList">
764<h4>sendCommand</h4>
765<pre>public static&nbsp;<a href="../../../../com/intel/jndn/management/types/ControlResponse.html" title="class in com.intel.jndn.management.types">ControlResponse</a>&nbsp;sendCommand(net.named_data.jndn.Face&nbsp;forwarder,
766 net.named_data.jndn.Interest&nbsp;interest)
767 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
768 net.named_data.jndn.encoding.EncodingException,
769 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
770<div class="block">Send an interest as a command to the forwarder; this method will convert
771 the interest to a command interest and block until a response is received
772 from the forwarder. Ensure the forwarding face is on the local machine
773 (management requests are to /localhost/...) and that command signing has
774 been set up (e.g. forwarder.setCommandSigningInfo()).</div>
775<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face, command signing info must be set</dd><dd><code>interest</code> - As described at
776 http://redmine.named-data.net/projects/nfd/wiki/ControlCommand, the
777 requested interest must have encoded ControlParameters appended to the
778 interest name</dd>
779<dt><span class="strong">Returns:</span></dt><dd></dd>
780<dt><span class="strong">Throws:</span></dt>
781<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
782<dd><code>net.named_data.jndn.encoding.EncodingException</code></dd>
783<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code></dd></dl>
784</li>
785</ul>
786</li>
787</ul>
788</li>
789</ul>
790</div>
791</div>
792<!-- ========= END OF CLASS DATA ========= -->
793<!-- ======= START OF BOTTOM NAVBAR ====== -->
794<div class="bottomNav"><a name="navbar_bottom">
795<!-- -->
796</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
797<!-- -->
798</a>
799<ul class="navList" title="Navigation">
800<li><a href="../../../../overview-summary.html">Overview</a></li>
801<li><a href="package-summary.html">Package</a></li>
802<li class="navBarCell1Rev">Class</li>
803<li><a href="class-use/NFD.html">Use</a></li>
804<li><a href="package-tree.html">Tree</a></li>
805<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
806<li><a href="../../../../index-all.html">Index</a></li>
807<li><a href="../../../../help-doc.html">Help</a></li>
808</ul>
809</div>
810<div class="subNav">
811<ul class="navList">
812<li><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management"><span class="strong">Prev Class</span></a></li>
813<li>Next Class</li>
814</ul>
815<ul class="navList">
816<li><a href="../../../../index.html?com/intel/jndn/management/NFD.html" target="_top">Frames</a></li>
817<li><a href="NFD.html" target="_top">No Frames</a></li>
818</ul>
819<ul class="navList" id="allclasses_navbar_bottom">
820<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
821</ul>
822<div>
823<script type="text/javascript"><!--
824 allClassesLink = document.getElementById("allclasses_navbar_bottom");
825 if(window==top) {
826 allClassesLink.style.display = "block";
827 }
828 else {
829 allClassesLink.style.display = "none";
830 }
831 //-->
832</script>
833</div>
834<div>
835<ul class="subNavList">
836<li>Summary:&nbsp;</li>
837<li>Nested&nbsp;|&nbsp;</li>
838<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
839<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
840<li><a href="#method_summary">Method</a></li>
841</ul>
842<ul class="subNavList">
843<li>Detail:&nbsp;</li>
844<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
845<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
846<li><a href="#method_detail">Method</a></li>
847</ul>
848</div>
849<a name="skip-navbar_bottom">
850<!-- -->
851</a></div>
852<!-- ======== END OF BOTTOM NAVBAR ======= -->
853<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
854</body>
855</html>