Gitiles
Code Review Sign In
gerrit.named-data.net / jndn-management / refs/heads/gh-pages / . / com / intel / jndn / management / Nfdc.html
blob: be1997d043006aff35b1b779e481c1f0980bfb06 [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>Nfdc (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="Nfdc (jndn-management 1.1.0 API)";
17 }
18 }
19 catch(err) {
20 }
21//-->
22var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9};
23var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/Nfdc.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/NdnPingClient.html" title="class in com.intel.jndn.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
54<li>Next&nbsp;Class</li>
55</ul>
56<ul class="navList">
57<li><a href="../../../../index.html?com/intel/jndn/management/Nfdc.html" target="_top">Frames</a></li>
58<li><a href="Nfdc.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>Field&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>Field&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</div>
97<h2 title="Class Nfdc" class="title">Class Nfdc</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.Nfdc</li>
105</ul>
106</li>
107</ul>
108<div class="description">
109<ul class="blockList">
110<li class="blockList">
111<hr>
112<br>
113<pre>public final class <span class="typeNameLabel">Nfdc</span>
114extends <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></pre>
115<div class="block">Helper class for interacting with an NDN forwarder daemon; see
116 <a href="http://redmine.named-data.net/projects/nfd/wiki/Management">NFD Management</a>
117 for explanations of the various protocols used.</div>
118<dl>
119<dt><span class="simpleTagLabel">Author:</span></dt>
120<dd>Andrew Brown <andrew.brown@intel.com></dd>
121</dl>
122</li>
123</ul>
124</div>
125<div class="summary">
126<ul class="blockList">
127<li class="blockList">
128<!-- ========== METHOD SUMMARY =========== -->
129<ul class="blockList">
130<li class="blockList"><a name="method.summary">
131<!-- -->
132</a>
133<h3>Method Summary</h3>
134<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
135<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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
136<tr>
137<th class="colFirst" scope="col">Modifier and Type</th>
138<th class="colLast" scope="col">Method and Description</th>
139</tr>
140<tr id="i0" class="altColor">
141<td class="colFirst"><code>static int</code></td>
142<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#createFace-net.named_data.jndn.Face-java.lang.String-">createFace</a></span>(net.named_data.jndn.Face&nbsp;face,
143 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri)</code>
144<div class="block">Create a new face on the given forwarder.</div>
145</td>
146</tr>
147<tr id="i1" class="rowColor">
148<td class="colFirst"><code>static void</code></td>
149<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#destroyFace-net.named_data.jndn.Face-int-">destroyFace</a></span>(net.named_data.jndn.Face&nbsp;face,
150 int&nbsp;faceId)</code>
151<div class="block">Destroy a face on given forwarder.</div>
152</td>
153</tr>
154<tr id="i2" class="altColor">
155<td class="colFirst"><code>static void</code></td>
156<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#disableLocalControlHeader-net.named_data.jndn.Face-com.intel.jndn.management.enums.LocalControlHeader-">disableLocalControlHeader</a></span>(net.named_data.jndn.Face&nbsp;face,
157 <a href="../../../../com/intel/jndn/management/enums/LocalControlHeader.html" title="enum in com.intel.jndn.management.enums">LocalControlHeader</a>&nbsp;header)</code>
158<div class="block">Disable a local control feature on the given forwarder.</div>
159</td>
160</tr>
161<tr id="i3" class="rowColor">
162<td class="colFirst"><code>static void</code></td>
163<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#enableLocalControlHeader-net.named_data.jndn.Face-com.intel.jndn.management.enums.LocalControlHeader-">enableLocalControlHeader</a></span>(net.named_data.jndn.Face&nbsp;face,
164 <a href="../../../../com/intel/jndn/management/enums/LocalControlHeader.html" title="enum in com.intel.jndn.management.enums">LocalControlHeader</a>&nbsp;header)</code>
165<div class="block">Enable a local control feature on the given forwarder.</div>
166</td>
167</tr>
168<tr id="i4" class="altColor">
169<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;<a href="../../../../com/intel/jndn/management/types/ChannelStatus.html" title="class in com.intel.jndn.management.types">ChannelStatus</a>&gt;</code></td>
170<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#getChannelStatusList-net.named_data.jndn.Face-">getChannelStatusList</a></span>(net.named_data.jndn.Face&nbsp;face)</code>
171<div class="block">Retrieve the list of channel status entries from the NFD; calls
172 /localhost/nfd/faces/channels which requires a local Face (all non-local packets
173 are dropped).</div>
174</td>
175</tr>
176<tr id="i5" class="rowColor">
177<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;<a href="../../../../com/intel/jndn/management/types/FaceStatus.html" title="class in com.intel.jndn.management.types">FaceStatus</a>&gt;</code></td>
178<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#getFaceList-net.named_data.jndn.Face-">getFaceList</a></span>(net.named_data.jndn.Face&nbsp;face)</code>
179<div class="block">Retrieve a list of faces and their status from the given forwarder; calls
180 /localhost/nfd/faces/list which requires a local Face (all non-local
181 packets are dropped).</div>
182</td>
183</tr>
184<tr id="i6" class="altColor">
185<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;<a href="../../../../com/intel/jndn/management/types/FibEntry.html" title="class in com.intel.jndn.management.types">FibEntry</a>&gt;</code></td>
186<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#getFibList-net.named_data.jndn.Face-">getFibList</a></span>(net.named_data.jndn.Face&nbsp;face)</code>
187<div class="block">Retrieve a list of FIB entries and their NextHopRecords from the given
188 forwarder; calls /localhost/nfd/fib/list which requires a local Face (all
189 non-local packets are dropped).</div>
190</td>
191</tr>
192<tr id="i7" class="rowColor">
193<td class="colFirst"><code>static <a href="../../../../com/intel/jndn/management/types/ForwarderStatus.html" title="class in com.intel.jndn.management.types">ForwarderStatus</a></code></td>
194<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#getForwarderStatus-net.named_data.jndn.Face-">getForwarderStatus</a></span>(net.named_data.jndn.Face&nbsp;face)</code>
195<div class="block">Retrieve the status of the given forwarder; calls /localhost/nfd/status/general
196 which requires a local Face (all non-local packets are dropped).</div>
197</td>
198</tr>
199<tr id="i8" class="altColor">
200<td class="colFirst"><code>static net.named_data.jndn.KeyLocator</code></td>
201<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#getKeyLocator-net.named_data.jndn.Face-">getKeyLocator</a></span>(net.named_data.jndn.Face&nbsp;face)</code>
202<div class="block">Retrieve the <code>KeyLocator</code> for an NFD.</div>
203</td>
204</tr>
205<tr id="i9" class="rowColor">
206<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;<a href="../../../../com/intel/jndn/management/types/RibEntry.html" title="class in com.intel.jndn.management.types">RibEntry</a>&gt;</code></td>
207<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#getRouteList-net.named_data.jndn.Face-">getRouteList</a></span>(net.named_data.jndn.Face&nbsp;face)</code>
208<div class="block">Retrieve a list of routing entries from the RIB; calls
209 /localhost/nfd/rib/list which requires a local Face (all non-local packets
210 are dropped).</div>
211</td>
212</tr>
213<tr id="i10" class="altColor">
214<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;<a href="../../../../com/intel/jndn/management/types/StrategyChoice.html" title="class in com.intel.jndn.management.types">StrategyChoice</a>&gt;</code></td>
215<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#getStrategyList-net.named_data.jndn.Face-">getStrategyList</a></span>(net.named_data.jndn.Face&nbsp;face)</code>
216<div class="block">Retrieve the list of strategy choice entries from the NFD; calls
217 /localhost/nfd/rib/list which requires a local Face (all non-local packets
218 are dropped).</div>
219</td>
220</tr>
221<tr id="i11" class="rowColor">
222<td class="colFirst"><code>static void</code></td>
223<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#register-net.named_data.jndn.Face-net.named_data.jndn.ControlParameters-">register</a></span>(net.named_data.jndn.Face&nbsp;face,
224 net.named_data.jndn.ControlParameters&nbsp;controlParameters)</code>
225<div class="block">Register a route on the forwarder.</div>
226</td>
227</tr>
228<tr id="i12" class="altColor">
229<td class="colFirst"><code>static void</code></td>
230<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#register-net.named_data.jndn.Face-int-net.named_data.jndn.Name-int-">register</a></span>(net.named_data.jndn.Face&nbsp;forwarder,
231 int&nbsp;faceId,
232 net.named_data.jndn.Name&nbsp;route,
233 int&nbsp;cost)</code>
234<div class="block">Register a route on a forwarder; this will not create a new face since it
235 is provided a faceId.</div>
236</td>
237</tr>
238<tr id="i13" class="rowColor">
239<td class="colFirst"><code>static void</code></td>
240<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#register-net.named_data.jndn.Face-net.named_data.jndn.Name-int-">register</a></span>(net.named_data.jndn.Face&nbsp;face,
241 net.named_data.jndn.Name&nbsp;route,
242 int&nbsp;cost)</code>
243<div class="block">Register a route on a forwarder; this will create a new face on the
244 forwarder towards the face (e.g., self registration).</div>
245</td>
246</tr>
247<tr id="i14" class="altColor">
248<td class="colFirst"><code>static void</code></td>
249<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#register-net.named_data.jndn.Face-java.lang.String-net.named_data.jndn.Name-int-">register</a></span>(net.named_data.jndn.Face&nbsp;face,
250 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri,
251 net.named_data.jndn.Name&nbsp;route,
252 int&nbsp;cost)</code>
253<div class="block">Register a route on a forwarder; this will create a new face on the
254 forwarder to the given URI/route pair.</div>
255</td>
256</tr>
257<tr id="i15" class="rowColor">
258<td class="colFirst"><code>static void</code></td>
259<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#setStrategy-net.named_data.jndn.Face-net.named_data.jndn.Name-net.named_data.jndn.Name-">setStrategy</a></span>(net.named_data.jndn.Face&nbsp;face,
260 net.named_data.jndn.Name&nbsp;prefix,
261 net.named_data.jndn.Name&nbsp;strategy)</code>
262<div class="block">Set a strategy on the forwarder
263 <p/>
264 Ensure the forwarding face is on the local machine (management requests are to /localhost/...) and that command
265 signing has been set up using forwarder.setCommandSigningInfo().</div>
266</td>
267</tr>
268<tr id="i16" class="altColor">
269<td class="colFirst"><code>static void</code></td>
270<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#unregister-net.named_data.jndn.Face-net.named_data.jndn.ControlParameters-">unregister</a></span>(net.named_data.jndn.Face&nbsp;face,
271 net.named_data.jndn.ControlParameters&nbsp;controlParameters)</code>
272<div class="block">Unregister a route on a forwarder
273 <p/>
274 Ensure the forwarding face is on the local machine (management requests are to /localhost/...) and that command
275 signing has been set up (e.g.</div>
276</td>
277</tr>
278<tr id="i17" class="rowColor">
279<td class="colFirst"><code>static void</code></td>
280<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#unregister-net.named_data.jndn.Face-net.named_data.jndn.Name-">unregister</a></span>(net.named_data.jndn.Face&nbsp;face,
281 net.named_data.jndn.Name&nbsp;route)</code>
282<div class="block">Unregister a route on a forwarder.</div>
283</td>
284</tr>
285<tr id="i18" class="altColor">
286<td class="colFirst"><code>static void</code></td>
287<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#unregister-net.named_data.jndn.Face-net.named_data.jndn.Name-int-">unregister</a></span>(net.named_data.jndn.Face&nbsp;face,
288 net.named_data.jndn.Name&nbsp;route,
289 int&nbsp;faceId)</code>
290<div class="block">Unregister a route on a forwarder; see
291 <p/>
292 Ensure the forwarding face is on the local machine (management requests are to /localhost/...) and that command
293 signing has been set up (e.g.</div>
294</td>
295</tr>
296<tr id="i19" class="rowColor">
297<td class="colFirst"><code>static void</code></td>
298<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#unregister-net.named_data.jndn.Face-net.named_data.jndn.Name-java.lang.String-">unregister</a></span>(net.named_data.jndn.Face&nbsp;face,
299 net.named_data.jndn.Name&nbsp;route,
300 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri)</code>
301<div class="block">Unregister a route on a forwarder
302 <p/>
303 Ensure the forwarding face is on the local machine (management requests are to /localhost/...) and that command
304 signing has been set up using forwarder.setCommandSigningInfo().</div>
305</td>
306</tr>
307<tr id="i20" class="altColor">
308<td class="colFirst"><code>static void</code></td>
309<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/Nfdc.html#unsetStrategy-net.named_data.jndn.Face-net.named_data.jndn.Name-">unsetStrategy</a></span>(net.named_data.jndn.Face&nbsp;face,
310 net.named_data.jndn.Name&nbsp;prefix)</code>
311<div class="block">Set a strategy on the forwarder; see
312 <a href="../../../../com/intel/jndn/management/Nfdc.html#setStrategy-net.named_data.jndn.Face-net.named_data.jndn.Name-net.named_data.jndn.Name-"><code>setStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name, net.named_data.jndn.Name)</code></a>
313 for more information.</div>
314</td>
315</tr>
316</table>
317<ul class="blockList">
318<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
319<!-- -->
320</a>
321<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>
322<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>
323</ul>
324</li>
325</ul>
326</li>
327</ul>
328</div>
329<div class="details">
330<ul class="blockList">
331<li class="blockList">
332<!-- ============ METHOD DETAIL ========== -->
333<ul class="blockList">
334<li class="blockList"><a name="method.detail">
335<!-- -->
336</a>
337<h3>Method Detail</h3>
338<a name="getForwarderStatus-net.named_data.jndn.Face-">
339<!-- -->
340</a>
341<ul class="blockList">
342<li class="blockList">
343<h4>getForwarderStatus</h4>
344<pre>public static&nbsp;<a href="../../../../com/intel/jndn/management/types/ForwarderStatus.html" title="class in com.intel.jndn.management.types">ForwarderStatus</a>&nbsp;getForwarderStatus(net.named_data.jndn.Face&nbsp;face)
345 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
346<div class="block">Retrieve the status of the given forwarder; calls /localhost/nfd/status/general
347 which requires a local Face (all non-local packets are dropped).</div>
348<dl>
349<dt><span class="paramLabel">Parameters:</span></dt>
350<dd><code>face</code> - only a localhost Face</dd>
351<dt><span class="returnLabel">Returns:</span></dt>
352<dd>the forwarder status object</dd>
353<dt><span class="throwsLabel">Throws:</span></dt>
354<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed or the returned status could not be decoded</dd>
355<dt><span class="seeLabel">See Also:</span></dt>
356<dd><a href="http://redmine.named-data.net/projects/nfd/wiki/ForwarderStatus">ForwarderStatus</a></dd>
357</dl>
358</li>
359</ul>
360<a name="getFaceList-net.named_data.jndn.Face-">
361<!-- -->
362</a>
363<ul class="blockList">
364<li class="blockList">
365<h4>getFaceList</h4>
366<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;<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;face)
367 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
368<div class="block">Retrieve a list of faces and their status from the given forwarder; calls
369 /localhost/nfd/faces/list which requires a local Face (all non-local
370 packets are dropped).</div>
371<dl>
372<dt><span class="paramLabel">Parameters:</span></dt>
373<dd><code>face</code> - only a localhost Face</dd>
374<dt><span class="returnLabel">Returns:</span></dt>
375<dd>a list of face status objects</dd>
376<dt><span class="throwsLabel">Throws:</span></dt>
377<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed or if the NFD rejected the request</dd>
378<dt><span class="seeLabel">See Also:</span></dt>
379<dd><a href="http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt">FaceManagement</a></dd>
380</dl>
381</li>
382</ul>
383<a name="getFibList-net.named_data.jndn.Face-">
384<!-- -->
385</a>
386<ul class="blockList">
387<li class="blockList">
388<h4>getFibList</h4>
389<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;<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;face)
390 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
391<div class="block">Retrieve a list of FIB entries and their NextHopRecords from the given
392 forwarder; calls /localhost/nfd/fib/list which requires a local Face (all
393 non-local packets are dropped).</div>
394<dl>
395<dt><span class="paramLabel">Parameters:</span></dt>
396<dd><code>face</code> - only a localhost Face</dd>
397<dt><span class="returnLabel">Returns:</span></dt>
398<dd>a list of FIB entries</dd>
399<dt><span class="throwsLabel">Throws:</span></dt>
400<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed or if the NFD rejected the request</dd>
401<dt><span class="seeLabel">See Also:</span></dt>
402<dd><a href="http://redmine.named-data.net/projects/nfd/wiki/FibMgmt#FIB-Dataset">FIB Dataset</a></dd>
403</dl>
404</li>
405</ul>
406<a name="getRouteList-net.named_data.jndn.Face-">
407<!-- -->
408</a>
409<ul class="blockList">
410<li class="blockList">
411<h4>getRouteList</h4>
412<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;<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;face)
413 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
414<div class="block">Retrieve a list of routing entries from the RIB; calls
415 /localhost/nfd/rib/list which requires a local Face (all non-local packets
416 are dropped).</div>
417<dl>
418<dt><span class="paramLabel">Parameters:</span></dt>
419<dd><code>face</code> - only a localhost Face</dd>
420<dt><span class="returnLabel">Returns:</span></dt>
421<dd>a list of RIB entries, i.e. routes</dd>
422<dt><span class="throwsLabel">Throws:</span></dt>
423<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed or if the NFD rejected the request</dd>
424<dt><span class="seeLabel">See Also:</span></dt>
425<dd><a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt#RIB-Dataset">RIB Dataset</a></dd>
426</dl>
427</li>
428</ul>
429<a name="getStrategyList-net.named_data.jndn.Face-">
430<!-- -->
431</a>
432<ul class="blockList">
433<li class="blockList">
434<h4>getStrategyList</h4>
435<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;<a href="../../../../com/intel/jndn/management/types/StrategyChoice.html" title="class in com.intel.jndn.management.types">StrategyChoice</a>&gt;&nbsp;getStrategyList(net.named_data.jndn.Face&nbsp;face)
436 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
437<div class="block">Retrieve the list of strategy choice entries from the NFD; calls
438 /localhost/nfd/rib/list which requires a local Face (all non-local packets
439 are dropped).</div>
440<dl>
441<dt><span class="paramLabel">Parameters:</span></dt>
442<dd><code>face</code> - only a localhost Face</dd>
443<dt><span class="returnLabel">Returns:</span></dt>
444<dd>a list of strategy choice entries, i.e. routes</dd>
445<dt><span class="throwsLabel">Throws:</span></dt>
446<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
447 the NFD rejected the request</dd>
448<dt><span class="seeLabel">See Also:</span></dt>
449<dd><a href="http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice">StrategyChoice</a></dd>
450</dl>
451</li>
452</ul>
453<a name="getChannelStatusList-net.named_data.jndn.Face-">
454<!-- -->
455</a>
456<ul class="blockList">
457<li class="blockList">
458<h4>getChannelStatusList</h4>
459<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;<a href="../../../../com/intel/jndn/management/types/ChannelStatus.html" title="class in com.intel.jndn.management.types">ChannelStatus</a>&gt;&nbsp;getChannelStatusList(net.named_data.jndn.Face&nbsp;face)
460 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
461<div class="block">Retrieve the list of channel status entries from the NFD; calls
462 /localhost/nfd/faces/channels which requires a local Face (all non-local packets
463 are dropped).</div>
464<dl>
465<dt><span class="paramLabel">Parameters:</span></dt>
466<dd><code>face</code> - only a localhost Face</dd>
467<dt><span class="returnLabel">Returns:</span></dt>
468<dd>a list of channel status entries</dd>
469<dt><span class="throwsLabel">Throws:</span></dt>
470<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
471 the NFD rejected the request</dd>
472<dt><span class="seeLabel">See Also:</span></dt>
473<dd><a href="http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Channel-Dataset">Face Management</a></dd>
474</dl>
475</li>
476</ul>
477<a name="getKeyLocator-net.named_data.jndn.Face-">
478<!-- -->
479</a>
480<ul class="blockList">
481<li class="blockList">
482<h4>getKeyLocator</h4>
483<pre>public static&nbsp;net.named_data.jndn.KeyLocator&nbsp;getKeyLocator(net.named_data.jndn.Face&nbsp;face)
484 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
485<div class="block">Retrieve the <code>KeyLocator</code> for an NFD.</div>
486<dl>
487<dt><span class="paramLabel">Parameters:</span></dt>
488<dd><code>face</code> - only a localhost <code>Face</code></dd>
489<dt><span class="returnLabel">Returns:</span></dt>
490<dd>the <code>KeyLocator</code> of the NFD's key</dd>
491<dt><span class="throwsLabel">Throws:</span></dt>
492<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, if the NFD rejected the request, or no
493 KeyLocator was found</dd>
494</dl>
495</li>
496</ul>
497<a name="createFace-net.named_data.jndn.Face-java.lang.String-">
498<!-- -->
499</a>
500<ul class="blockList">
501<li class="blockList">
502<h4>createFace</h4>
503<pre>public static&nbsp;int&nbsp;createFace(net.named_data.jndn.Face&nbsp;face,
504 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri)
505 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
506<div class="block">Create a new face on the given forwarder. Ensure the forwarding face is on
507 the local machine (management requests are to /localhost/...) and that
508 command signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
509<dl>
510<dt><span class="paramLabel">Parameters:</span></dt>
511<dd><code>face</code> - only a localhost <code>Face</code></dd>
512<dd><code>uri</code> - a string like "tcp4://host.name.com" (see nfd-status channels
513 for more protocol options)</dd>
514<dt><span class="returnLabel">Returns:</span></dt>
515<dd>the newly created face ID</dd>
516<dt><span class="throwsLabel">Throws:</span></dt>
517<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
518 the NFD rejected the request</dd>
519</dl>
520</li>
521</ul>
522<a name="destroyFace-net.named_data.jndn.Face-int-">
523<!-- -->
524</a>
525<ul class="blockList">
526<li class="blockList">
527<h4>destroyFace</h4>
528<pre>public static&nbsp;void&nbsp;destroyFace(net.named_data.jndn.Face&nbsp;face,
529 int&nbsp;faceId)
530 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
531<div class="block">Destroy a face on given forwarder. Ensure the forwarding face is on the
532 local machine (management requests are to /localhost/...) and that command
533 signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
534<dl>
535<dt><span class="paramLabel">Parameters:</span></dt>
536<dd><code>face</code> - only a localhost <code>Face</code></dd>
537<dd><code>faceId</code> - the ID of the face to destroy</dd>
538<dt><span class="throwsLabel">Throws:</span></dt>
539<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
540 the NFD rejected the request</dd>
541</dl>
542</li>
543</ul>
544<a name="enableLocalControlHeader-net.named_data.jndn.Face-com.intel.jndn.management.enums.LocalControlHeader-">
545<!-- -->
546</a>
547<ul class="blockList">
548<li class="blockList">
549<h4>enableLocalControlHeader</h4>
550<pre>public static&nbsp;void&nbsp;enableLocalControlHeader(net.named_data.jndn.Face&nbsp;face,
551 <a href="../../../../com/intel/jndn/management/enums/LocalControlHeader.html" title="enum in com.intel.jndn.management.enums">LocalControlHeader</a>&nbsp;header)
552 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
553<div class="block">Enable a local control feature on the given forwarder.</div>
554<dl>
555<dt><span class="paramLabel">Parameters:</span></dt>
556<dd><code>face</code> - only a localhost <code>Face</code></dd>
557<dd><code>header</code> - the control feature to enable</dd>
558<dt><span class="throwsLabel">Throws:</span></dt>
559<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
560 the NFD rejected the request</dd>
561<dt><span class="seeLabel">See Also:</span></dt>
562<dd><a href="http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt">Face Management</a></dd>
563</dl>
564</li>
565</ul>
566<a name="disableLocalControlHeader-net.named_data.jndn.Face-com.intel.jndn.management.enums.LocalControlHeader-">
567<!-- -->
568</a>
569<ul class="blockList">
570<li class="blockList">
571<h4>disableLocalControlHeader</h4>
572<pre>public static&nbsp;void&nbsp;disableLocalControlHeader(net.named_data.jndn.Face&nbsp;face,
573 <a href="../../../../com/intel/jndn/management/enums/LocalControlHeader.html" title="enum in com.intel.jndn.management.enums">LocalControlHeader</a>&nbsp;header)
574 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
575<div class="block">Disable a local control feature on the given forwarder.</div>
576<dl>
577<dt><span class="paramLabel">Parameters:</span></dt>
578<dd><code>face</code> - only a localhost <code>Face</code></dd>
579<dd><code>header</code> - the control feature to disable</dd>
580<dt><span class="throwsLabel">Throws:</span></dt>
581<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
582 the NFD rejected the request</dd>
583<dt><span class="seeLabel">See Also:</span></dt>
584<dd><a href="http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt">Face Management</a></dd>
585</dl>
586</li>
587</ul>
588<a name="register-net.named_data.jndn.Face-net.named_data.jndn.ControlParameters-">
589<!-- -->
590</a>
591<ul class="blockList">
592<li class="blockList">
593<h4>register</h4>
594<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;face,
595 net.named_data.jndn.ControlParameters&nbsp;controlParameters)
596 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
597<div class="block">Register a route on the forwarder.
598 <p/>
599 Ensure the forwarding face is on the local machine (management requests are to /localhost/...) and that command
600 signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
601<dl>
602<dt><span class="paramLabel">Parameters:</span></dt>
603<dd><code>face</code> - only a localhost <code>Face</code></dd>
604<dd><code>controlParameters</code> - the <code>ControlParameters</code> command options</dd>
605<dt><span class="throwsLabel">Throws:</span></dt>
606<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
607 the NFD rejected the request</dd>
608<dt><span class="seeLabel">See Also:</span></dt>
609<dd><a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">nfdc</a>,
610<a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">RIB Management</a></dd>
611</dl>
612</li>
613</ul>
614<a name="register-net.named_data.jndn.Face-net.named_data.jndn.Name-int-">
615<!-- -->
616</a>
617<ul class="blockList">
618<li class="blockList">
619<h4>register</h4>
620<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;face,
621 net.named_data.jndn.Name&nbsp;route,
622 int&nbsp;cost)
623 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
624<div class="block">Register a route on a forwarder; this will create a new face on the
625 forwarder towards the face (e.g., self registration).</div>
626<dl>
627<dt><span class="paramLabel">Parameters:</span></dt>
628<dd><code>face</code> - only a localhost <code>Face</code></dd>
629<dd><code>route</code> - the <code>Name</code> prefix of the route</dd>
630<dd><code>cost</code> - the numeric cost of forwarding along the route</dd>
631<dt><span class="throwsLabel">Throws:</span></dt>
632<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
633 the NFD rejected the request</dd>
634</dl>
635</li>
636</ul>
637<a name="register-net.named_data.jndn.Face-java.lang.String-net.named_data.jndn.Name-int-">
638<!-- -->
639</a>
640<ul class="blockList">
641<li class="blockList">
642<h4>register</h4>
643<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;face,
644 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri,
645 net.named_data.jndn.Name&nbsp;route,
646 int&nbsp;cost)
647 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
648<div class="block">Register a route on a forwarder; this will create a new face on the
649 forwarder to the given URI/route pair. See register(Face,
650 ControlParameters) for more detailed documentation.</div>
651<dl>
652<dt><span class="paramLabel">Parameters:</span></dt>
653<dd><code>face</code> - only a localhost <code>Face</code></dd>
654<dd><code>uri</code> - the URI (e.g. "tcp4://10.10.2.2:6363") of the remote node; note
655 that this must be one of the canonical forms described in the wiki
656 (http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#TCP) for NFD to
657 accept the registration--otherwise you will see 400 errors</dd>
658<dd><code>route</code> - the <code>Name</code> prefix of the route</dd>
659<dd><code>cost</code> - the numeric cost of forwarding along the route</dd>
660<dt><span class="throwsLabel">Throws:</span></dt>
661<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
662 the NFD rejected the request</dd>
663</dl>
664</li>
665</ul>
666<a name="register-net.named_data.jndn.Face-int-net.named_data.jndn.Name-int-">
667<!-- -->
668</a>
669<ul class="blockList">
670<li class="blockList">
671<h4>register</h4>
672<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;forwarder,
673 int&nbsp;faceId,
674 net.named_data.jndn.Name&nbsp;route,
675 int&nbsp;cost)
676 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
677<div class="block">Register a route on a forwarder; this will not create a new face since it
678 is provided a faceId. See register(Face, ControlParameters) for full
679 documentation.</div>
680<dl>
681<dt><span class="paramLabel">Parameters:</span></dt>
682<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
683<dd><code>faceId</code> - the ID of the <code>Face</code> to assign to the route</dd>
684<dd><code>route</code> - the <code>Name</code> prefix of the route</dd>
685<dd><code>cost</code> - the numeric cost of forwarding along the route</dd>
686<dt><span class="throwsLabel">Throws:</span></dt>
687<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
688 the NFD rejected the request</dd>
689</dl>
690</li>
691</ul>
692<a name="unregister-net.named_data.jndn.Face-net.named_data.jndn.ControlParameters-">
693<!-- -->
694</a>
695<ul class="blockList">
696<li class="blockList">
697<h4>unregister</h4>
698<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;face,
699 net.named_data.jndn.ControlParameters&nbsp;controlParameters)
700 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
701<div class="block">Unregister a route on a forwarder
702 <p/>
703 Ensure the forwarding face is on the local machine (management requests are to /localhost/...) and that command
704 signing has been set up (e.g. forwarder.setCommandSigningInfo().</div>
705<dl>
706<dt><span class="paramLabel">Parameters:</span></dt>
707<dd><code>face</code> - only a localhost <code>Face</code></dd>
708<dd><code>controlParameters</code> - the <code>ControlParameters</code> command options</dd>
709<dt><span class="throwsLabel">Throws:</span></dt>
710<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
711 the NFD rejected the request</dd>
712<dt><span class="seeLabel">See Also:</span></dt>
713<dd><a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">nfdc</a>,
714<a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">RIB Management</a></dd>
715</dl>
716</li>
717</ul>
718<a name="unregister-net.named_data.jndn.Face-net.named_data.jndn.Name-">
719<!-- -->
720</a>
721<ul class="blockList">
722<li class="blockList">
723<h4>unregister</h4>
724<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;face,
725 net.named_data.jndn.Name&nbsp;route)
726 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
727<div class="block">Unregister a route on a forwarder.
728 <p/>
729 Ensure the forwarding face is on the local machine (management requests are to /localhost/...) and that command
730 signing has been set up (e.g. forwarder.setCommandSigningInfo().</div>
731<dl>
732<dt><span class="paramLabel">Parameters:</span></dt>
733<dd><code>face</code> - only a localhost <code>Face</code></dd>
734<dd><code>route</code> - the <code>Name</code> prefix of the route</dd>
735<dt><span class="throwsLabel">Throws:</span></dt>
736<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
737 the NFD rejected the request</dd>
738<dt><span class="seeLabel">See Also:</span></dt>
739<dd><a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">nfdc</a>,
740<a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">RIB Management</a></dd>
741</dl>
742</li>
743</ul>
744<a name="unregister-net.named_data.jndn.Face-net.named_data.jndn.Name-int-">
745<!-- -->
746</a>
747<ul class="blockList">
748<li class="blockList">
749<h4>unregister</h4>
750<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;face,
751 net.named_data.jndn.Name&nbsp;route,
752 int&nbsp;faceId)
753 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
754<div class="block">Unregister a route on a forwarder; see
755 <p/>
756 Ensure the forwarding face is on the local machine (management requests are to /localhost/...) and that command
757 signing has been set up (e.g. forwarder.setCommandSigningInfo().</div>
758<dl>
759<dt><span class="paramLabel">Parameters:</span></dt>
760<dd><code>face</code> - only a localhost <code>Face</code></dd>
761<dd><code>route</code> - the <code>Name</code> prefix of the route</dd>
762<dd><code>faceId</code> - the specific ID of the face to remove (more than one face can
763 be registered to a route)</dd>
764<dt><span class="throwsLabel">Throws:</span></dt>
765<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
766 the NFD rejected the request</dd>
767<dt><span class="seeLabel">See Also:</span></dt>
768<dd><a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">nfdc</a>,
769<a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">RIB Management</a></dd>
770</dl>
771</li>
772</ul>
773<a name="unregister-net.named_data.jndn.Face-net.named_data.jndn.Name-java.lang.String-">
774<!-- -->
775</a>
776<ul class="blockList">
777<li class="blockList">
778<h4>unregister</h4>
779<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;face,
780 net.named_data.jndn.Name&nbsp;route,
781 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri)
782 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
783<div class="block">Unregister a route on a forwarder
784 <p/>
785 Ensure the forwarding face is on the local machine (management requests are to /localhost/...) and that command
786 signing has been set up using forwarder.setCommandSigningInfo().</div>
787<dl>
788<dt><span class="paramLabel">Parameters:</span></dt>
789<dd><code>face</code> - only a localhost <code>Face</code></dd>
790<dd><code>route</code> - the <code>Name</code> prefix of the route</dd>
791<dd><code>uri</code> - the URI (e.g. "tcp4://some.host.com") of the remote node (more
792 than one face can be registered to a route)</dd>
793<dt><span class="throwsLabel">Throws:</span></dt>
794<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
795 the NFD rejected the request</dd>
796<dt><span class="seeLabel">See Also:</span></dt>
797<dd><a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">nfdc command-line usage</a>,
798<a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">RibMgmt</a></dd>
799</dl>
800</li>
801</ul>
802<a name="setStrategy-net.named_data.jndn.Face-net.named_data.jndn.Name-net.named_data.jndn.Name-">
803<!-- -->
804</a>
805<ul class="blockList">
806<li class="blockList">
807<h4>setStrategy</h4>
808<pre>public static&nbsp;void&nbsp;setStrategy(net.named_data.jndn.Face&nbsp;face,
809 net.named_data.jndn.Name&nbsp;prefix,
810 net.named_data.jndn.Name&nbsp;strategy)
811 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
812<div class="block">Set a strategy on the forwarder
813 <p/>
814 Ensure the forwarding face is on the local machine (management requests are to /localhost/...) and that command
815 signing has been set up using forwarder.setCommandSigningInfo().</div>
816<dl>
817<dt><span class="paramLabel">Parameters:</span></dt>
818<dd><code>face</code> - only a localhost <code>Face</code></dd>
819<dd><code>prefix</code> - the <code>Name</code> prefix</dd>
820<dd><code>strategy</code> - the <code>Name</code> of the strategy to set, e.g.
821 /localhost/nfd/strategy/broadcast</dd>
822<dt><span class="throwsLabel">Throws:</span></dt>
823<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
824 the NFD rejected the request</dd>
825<dt><span class="seeLabel">See Also:</span></dt>
826<dd><a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">nfdc command-line usage</a>,
827<a href="http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice">StrategyChoice</a></dd>
828</dl>
829</li>
830</ul>
831<a name="unsetStrategy-net.named_data.jndn.Face-net.named_data.jndn.Name-">
832<!-- -->
833</a>
834<ul class="blockListLast">
835<li class="blockList">
836<h4>unsetStrategy</h4>
837<pre>public static&nbsp;void&nbsp;unsetStrategy(net.named_data.jndn.Face&nbsp;face,
838 net.named_data.jndn.Name&nbsp;prefix)
839 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
840<div class="block">Set a strategy on the forwarder; see
841 <a href="../../../../com/intel/jndn/management/Nfdc.html#setStrategy-net.named_data.jndn.Face-net.named_data.jndn.Name-net.named_data.jndn.Name-"><code>setStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name, net.named_data.jndn.Name)</code></a>
842 for more information. Ensure the forwarding face is on the local machine
843 (management requests are to /localhost/...) and that command signing has
844 been set up (e.g. forwarder.setCommandSigningInfo()).</div>
845<dl>
846<dt><span class="paramLabel">Parameters:</span></dt>
847<dd><code>face</code> - only a localhost <code>Face</code></dd>
848<dd><code>prefix</code> - the <code>Name</code> prefix</dd>
849<dt><span class="throwsLabel">Throws:</span></dt>
850<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the network request failed, the NFD response could not be decoded, or
851 the NFD rejected the request</dd>
852</dl>
853</li>
854</ul>
855</li>
856</ul>
857</li>
858</ul>
859</div>
860</div>
861<!-- ========= END OF CLASS DATA ========= -->
862<!-- ======= START OF BOTTOM NAVBAR ====== -->
863<div class="bottomNav"><a name="navbar.bottom">
864<!-- -->
865</a>
866<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
867<a name="navbar.bottom.firstrow">
868<!-- -->
869</a>
870<ul class="navList" title="Navigation">
871<li><a href="../../../../overview-summary.html">Overview</a></li>
872<li><a href="package-summary.html">Package</a></li>
873<li class="navBarCell1Rev">Class</li>
874<li><a href="class-use/Nfdc.html">Use</a></li>
875<li><a href="package-tree.html">Tree</a></li>
876<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
877<li><a href="../../../../index-all.html">Index</a></li>
878<li><a href="../../../../help-doc.html">Help</a></li>
879</ul>
880</div>
881<div class="subNav">
882<ul class="navList">
883<li><a href="../../../../com/intel/jndn/management/NdnPingClient.html" title="class in com.intel.jndn.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
884<li>Next&nbsp;Class</li>
885</ul>
886<ul class="navList">
887<li><a href="../../../../index.html?com/intel/jndn/management/Nfdc.html" target="_top">Frames</a></li>
888<li><a href="Nfdc.html" target="_top">No&nbsp;Frames</a></li>
889</ul>
890<ul class="navList" id="allclasses_navbar_bottom">
891<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
892</ul>
893<div>
894<script type="text/javascript"><!--
895 allClassesLink = document.getElementById("allclasses_navbar_bottom");
896 if(window==top) {
897 allClassesLink.style.display = "block";
898 }
899 else {
900 allClassesLink.style.display = "none";
901 }
902 //-->
903</script>
904</div>
905<div>
906<ul class="subNavList">
907<li>Summary:&nbsp;</li>
908<li>Nested&nbsp;|&nbsp;</li>
909<li>Field&nbsp;|&nbsp;</li>
910<li>Constr&nbsp;|&nbsp;</li>
911<li><a href="#method.summary">Method</a></li>
912</ul>
913<ul class="subNavList">
914<li>Detail:&nbsp;</li>
915<li>Field&nbsp;|&nbsp;</li>
916<li>Constr&nbsp;|&nbsp;</li>
917<li><a href="#method.detail">Method</a></li>
918</ul>
919</div>
920<a name="skip.navbar.bottom">
921<!-- -->
922</a></div>
923<!-- ======== END OF BOTTOM NAVBAR ======= -->
924<p class="legalCopy"><small>Copyright &#169; 2016. All rights reserved.</small></p>
925</body>
926</html>