Gitiles
Code Review Sign In
gerrit.named-data.net / jndn-management / 7969d39c9f8286996d3077a2f82f361fe9b1819c / . / com / intel / jndn / management / NFD.html
blob: 59ffbddddd135d897be5a8dfff3be24b79205867 [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>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]5<!-- Generated by javadoc (version 1.7.0_51) on Wed Mar 25 10:57:01 PDT 2015 -->
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]7<title>NFD (jndn-management 0.9.7 API)</title>
8<meta name="date" content="2015-03-25">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]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) {
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]14 parent.document.title="NFD (jndn-management 0.9.7 API)";
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]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
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]103 <a href="http://redmine.named-data.net/projects/nfd/wiki/Management">http://redmine.named-data.net/projects/nfd/wiki/Management</a>
104 for explanations of the various protocols used.</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]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
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]171 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>,
172 this is more for debugging; use 'register' instead</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]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">
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]220<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>
221<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#getForwarderStatus(net.named_data.jndn.Face)">getForwarderStatus</a></strong>(net.named_data.jndn.Face&nbsp;forwarder)</code>
222<div class="block">Retrieve the status of the given forwarder; calls /localhost/nfd/status
223 which requires a local Face (all non-local packets are dropped)</div>
224</td>
225</tr>
226<tr class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]227<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>
228<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>
229<div class="block">Retrieve a list of routing entries from the RIB; calls
230 /localhost/nfd/rib/list which requires a local Face (all non-local packets
231 are dropped).</div>
232</td>
233</tr>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]234<tr class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]235<td class="colFirst"><code>static boolean</code></td>
236<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,
237 net.named_data.jndn.Name&nbsp;name)</code>
238<div class="block">Request a name on an existing face to verify the forwarder is working and
239 responding to requests.</div>
240</td>
241</tr>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]242<tr class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]243<td class="colFirst"><code>static boolean</code></td>
244<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>
245<div class="block">Ping a forwarder on an existing face to verify that the forwarder is
246 working and responding to requests; this version sends a discovery packet
247 to /localhost/nfd which should always respond if the requestor is on the
248 same machine as the NDN forwarding daemon.</div>
249</td>
250</tr>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]251<tr class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]252<td class="colFirst"><code>static void</code></td>
253<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,
254 net.named_data.jndn.ControlParameters&nbsp;controlParameters)</code>
255<div class="block">Register a route on the forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]256 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
257 for command-line usage and
258 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
259 for protocol documentation.</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]260</td>
261</tr>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]262<tr class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]263<td class="colFirst"><code>static void</code></td>
264<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,
265 int&nbsp;faceId,
266 net.named_data.jndn.Name&nbsp;route,
267 int&nbsp;cost)</code>
268<div class="block">Register a route on a forwarder; this will not create a new face since it
269 is provided a faceId.</div>
270</td>
271</tr>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]272<tr class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]273<td class="colFirst"><code>static void</code></td>
274<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,
275 <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,
276 net.named_data.jndn.Name&nbsp;route,
277 int&nbsp;cost)</code>
278<div class="block">Register a route on a forwarder; this will create a new face on the
279 forwarder to the given URI/route pair.</div>
280</td>
281</tr>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]282<tr class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]283<td class="colFirst"><code>static net.named_data.jndn.Data</code></td>
284<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,
285 net.named_data.jndn.Name&nbsp;datasetName)</code>
286<div class="block">Build an interest to retrieve a segmented data set from the NFD; for
287 details on the DataSet, see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]288 <a href="http://redmine.named-data.net/projects/nfd/wiki/StatusDataset">http://redmine.named-data.net/projects/nfd/wiki/StatusDataset</a></div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]289</td>
290</tr>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]291<tr class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]292<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>
293<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,
294 net.named_data.jndn.Interest&nbsp;interest)</code>
295<div class="block">Send an interest as a command to the forwarder; this method will convert
296 the interest to a command interest and block until a response is received
297 from the forwarder.</div>
298</td>
299</tr>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]300<tr class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]301<td class="colFirst"><code>static void</code></td>
302<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,
303 net.named_data.jndn.Name&nbsp;prefix,
304 net.named_data.jndn.Name&nbsp;strategy)</code>
305<div class="block">Set a strategy on the forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]306 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
307 for command-line usage and
308 <a href="http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice">http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice</a>
309 for protocol documentation.</div>
310</td>
311</tr>
312<tr class="rowColor">
313<td class="colFirst"><code>static void</code></td>
314<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,
315 net.named_data.jndn.ControlParameters&nbsp;controlParameters)</code>
316<div class="block">Unregister a route on a forwarder; see
317 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
318 for command-line usage and
319 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]320 for protocol documentation.</div>
321</td>
322</tr>
323<tr class="altColor">
324<td class="colFirst"><code>static void</code></td>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]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)">unregister</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
326 net.named_data.jndn.Name&nbsp;route)</code>
327<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]328 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
329 for command-line usage and
330 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
331 for protocol documentation.</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]332</td>
333</tr>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]334<tr class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]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, int)">unregister</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
337 net.named_data.jndn.Name&nbsp;route,
338 int&nbsp;faceId)</code>
339<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]340 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
341 for command-line usage and
342 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
343 for protocol documentation.</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]344</td>
345</tr>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]346<tr class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]347<td class="colFirst"><code>static void</code></td>
348<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,
349 net.named_data.jndn.Name&nbsp;route,
350 <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>
351<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]352 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
353 for command-line usage and
354 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
355 for protocol documentation.</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]356</td>
357</tr>
358</table>
359<ul class="blockList">
360<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
361<!-- -->
362</a>
363<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>
364<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>
365</ul>
366</li>
367</ul>
368</li>
369</ul>
370</div>
371<div class="details">
372<ul class="blockList">
373<li class="blockList">
374<!-- ============ FIELD DETAIL =========== -->
375<ul class="blockList">
376<li class="blockList"><a name="field_detail">
377<!-- -->
378</a>
379<h3>Field Detail</h3>
380<a name="DEFAULT_TIMEOUT">
381<!-- -->
382</a>
383<ul class="blockList">
384<li class="blockList">
385<h4>DEFAULT_TIMEOUT</h4>
386<pre>public static final&nbsp;long DEFAULT_TIMEOUT</pre>
387<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>
388</li>
389</ul>
390<a name="OK_STATUS">
391<!-- -->
392</a>
393<ul class="blockListLast">
394<li class="blockList">
395<h4>OK_STATUS</h4>
396<pre>public static final&nbsp;int OK_STATUS</pre>
397<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>
398</li>
399</ul>
400</li>
401</ul>
402<!-- ========= CONSTRUCTOR DETAIL ======== -->
403<ul class="blockList">
404<li class="blockList"><a name="constructor_detail">
405<!-- -->
406</a>
407<h3>Constructor Detail</h3>
408<a name="NFD()">
409<!-- -->
410</a>
411<ul class="blockListLast">
412<li class="blockList">
413<h4>NFD</h4>
414<pre>public&nbsp;NFD()</pre>
415</li>
416</ul>
417</li>
418</ul>
419<!-- ============ METHOD DETAIL ========== -->
420<ul class="blockList">
421<li class="blockList"><a name="method_detail">
422<!-- -->
423</a>
424<h3>Method Detail</h3>
425<a name="pingLocal(net.named_data.jndn.Face)">
426<!-- -->
427</a>
428<ul class="blockList">
429<li class="blockList">
430<h4>pingLocal</h4>
431<pre>public static&nbsp;boolean&nbsp;pingLocal(net.named_data.jndn.Face&nbsp;face)</pre>
432<div class="block">Ping a forwarder on an existing face to verify that the forwarder is
433 working and responding to requests; this version sends a discovery packet
434 to /localhost/nfd which should always respond if the requestor is on the
435 same machine as the NDN forwarding daemon.</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]436<dl><dt><span class="strong">Parameters:</span></dt><dd><code>face</code> - only a localhost Face</dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]437<dt><span class="strong">Returns:</span></dt><dd>true if successful, false otherwise</dd></dl>
438</li>
439</ul>
440<a name="ping(net.named_data.jndn.Face, net.named_data.jndn.Name)">
441<!-- -->
442</a>
443<ul class="blockList">
444<li class="blockList">
445<h4>ping</h4>
446<pre>public static&nbsp;boolean&nbsp;ping(net.named_data.jndn.Face&nbsp;face,
447 net.named_data.jndn.Name&nbsp;name)</pre>
448<div class="block">Request a name on an existing face to verify the forwarder is working and
449 responding to requests. Note that the name must be served or cached on the
450 forwarder for this to return true.</div>
451<dl><dt><span class="strong">Parameters:</span></dt><dd><code>face</code> - </dd><dd><code>name</code> - </dd>
452<dt><span class="strong">Returns:</span></dt><dd>true if successful, false otherwise</dd></dl>
453</li>
454</ul>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]455<a name="getForwarderStatus(net.named_data.jndn.Face)">
456<!-- -->
457</a>
458<ul class="blockList">
459<li class="blockList">
460<h4>getForwarderStatus</h4>
461<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;forwarder)
462 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>
463<div class="block">Retrieve the status of the given forwarder; calls /localhost/nfd/status
464 which requires a local Face (all non-local packets are dropped)</div>
465<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd>
466<dt><span class="strong">Returns:</span></dt><dd>the forwarder status object, see
467 <a href="http://redmine.named-data.net/projects/nfd/wiki/ForwarderStatus">
468 http://redmine.named-data.net/projects/nfd/wiki/ForwarderStatus</a>.</dd>
469<dt><span class="strong">Throws:</span></dt>
470<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>
471</li>
472</ul>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]473<a name="getFaceList(net.named_data.jndn.Face)">
474<!-- -->
475</a>
476<ul class="blockList">
477<li class="blockList">
478<h4>getFaceList</h4>
479<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)
480 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>
481<div class="block">Retrieve a list of faces and their status from the given forwarder; calls
482 /localhost/nfd/faces/list which requires a local Face (all non-local
483 packets are dropped)</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]484<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd>
485<dt><span class="strong">Returns:</span></dt><dd>a list of face status objects, see
486 http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt.</dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]487<dt><span class="strong">Throws:</span></dt>
488<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>
489</li>
490</ul>
491<a name="getFibList(net.named_data.jndn.Face)">
492<!-- -->
493</a>
494<ul class="blockList">
495<li class="blockList">
496<h4>getFibList</h4>
497<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)
498 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>
499<div class="block">Retrieve a list of FIB entries and their NextHopRecords from the given
500 forwarder; calls /localhost/nfd/fib/list which requires a local Face (all
501 non-local packets are dropped).</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]502<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd>
503<dt><span class="strong">Returns:</span></dt><dd>a list of FIB entries, see
504 http://redmine.named-data.net/projects/nfd/wiki/FibMgmt#FIB-Dataset.</dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]505<dt><span class="strong">Throws:</span></dt>
506<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>
507</li>
508</ul>
509<a name="getRouteList(net.named_data.jndn.Face)">
510<!-- -->
511</a>
512<ul class="blockList">
513<li class="blockList">
514<h4>getRouteList</h4>
515<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)
516 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>
517<div class="block">Retrieve a list of routing entries from the RIB; calls
518 /localhost/nfd/rib/list which requires a local Face (all non-local packets
519 are dropped).</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]520<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd>
521<dt><span class="strong">Returns:</span></dt><dd>a list of RIB entries, i.e. routes, see
522 http://redmine.named-data.net/projects/nfd/wiki/RibMgmt#RIB-Dataset.</dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]523<dt><span class="strong">Throws:</span></dt>
524<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>
525</li>
526</ul>
527<a name="addNextHop(net.named_data.jndn.Face, int, net.named_data.jndn.Name)">
528<!-- -->
529</a>
530<ul class="blockList">
531<li class="blockList">
532<h4>addNextHop</h4>
533<pre>public static&nbsp;void&nbsp;addNextHop(net.named_data.jndn.Face&nbsp;forwarder,
534 int&nbsp;faceId,
535 net.named_data.jndn.Name&nbsp;prefix)
536 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>
537<div class="block">Helper method to register a new face on the forwarder; as mentioned at
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]538 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>,
539 this is more for debugging; use 'register' instead</div>
540<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>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]541<dt><span class="strong">Throws:</span></dt>
542<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>
543</li>
544</ul>
545<a name="createFace(net.named_data.jndn.Face, java.lang.String)">
546<!-- -->
547</a>
548<ul class="blockList">
549<li class="blockList">
550<h4>createFace</h4>
551<pre>public static&nbsp;int&nbsp;createFace(net.named_data.jndn.Face&nbsp;forwarder,
552 <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)
553 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>
554<div class="block">Create a new face on the given forwarder. Ensure the forwarding face is on
555 the local machine (management requests are to /localhost/...) and that
556 command signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]557<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>uri</code> - </dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]558<dt><span class="strong">Returns:</span></dt><dd></dd>
559<dt><span class="strong">Throws:</span></dt>
560<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>
561</li>
562</ul>
563<a name="destroyFace(net.named_data.jndn.Face, int)">
564<!-- -->
565</a>
566<ul class="blockList">
567<li class="blockList">
568<h4>destroyFace</h4>
569<pre>public static&nbsp;void&nbsp;destroyFace(net.named_data.jndn.Face&nbsp;forwarder,
570 int&nbsp;faceId)
571 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>
572<div class="block">Destroy a face on given forwarder. Ensure the forwarding face is on the
573 local machine (management requests are to /localhost/...) and that command
574 signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]575<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>faceId</code> - </dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]576<dt><span class="strong">Throws:</span></dt>
577<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>
578</li>
579</ul>
580<a name="enableLocalControlHeader(net.named_data.jndn.Face, com.intel.jndn.management.types.LocalControlHeader)">
581<!-- -->
582</a>
583<ul class="blockList">
584<li class="blockList">
585<h4>enableLocalControlHeader</h4>
586<pre>public static&nbsp;void&nbsp;enableLocalControlHeader(net.named_data.jndn.Face&nbsp;forwarder,
587 <a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a>&nbsp;header)
588 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>
589<div class="block">Enable a local control feature on the given forwarder. See
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]590 <a href="http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Enable-a-LocalControlHeader-feature">http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Enable-a-LocalControlHeader-feature</a></div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]591<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>header</code> - </dd>
592<dt><span class="strong">Throws:</span></dt>
593<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>
594</li>
595</ul>
596<a name="disableLocalControlHeader(net.named_data.jndn.Face, com.intel.jndn.management.types.LocalControlHeader)">
597<!-- -->
598</a>
599<ul class="blockList">
600<li class="blockList">
601<h4>disableLocalControlHeader</h4>
602<pre>public static&nbsp;void&nbsp;disableLocalControlHeader(net.named_data.jndn.Face&nbsp;forwarder,
603 <a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a>&nbsp;header)
604 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>
605<div class="block">Disable a local control feature on the given forwarder. See
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]606 <a href="http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Disable-a-LocalControlHeader-feature">http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Disable-a-LocalControlHeader-feature</a></div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]607<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>header</code> - </dd>
608<dt><span class="strong">Throws:</span></dt>
609<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>
610</li>
611</ul>
612<a name="register(net.named_data.jndn.Face, net.named_data.jndn.ControlParameters)">
613<!-- -->
614</a>
615<ul class="blockList">
616<li class="blockList">
617<h4>register</h4>
618<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;forwarder,
619 net.named_data.jndn.ControlParameters&nbsp;controlParameters)
620 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>
621<div class="block">Register a route on the forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]622 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
623 for command-line usage and
624 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
625 for protocol documentation. Ensure the forwarding face is on the local
626 machine (management requests are to /localhost/...) and that command
627 signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
628<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>controlParameters</code> - </dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]629<dt><span class="strong">Throws:</span></dt>
630<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>
631</li>
632</ul>
633<a name="register(net.named_data.jndn.Face, java.lang.String, net.named_data.jndn.Name, int)">
634<!-- -->
635</a>
636<ul class="blockList">
637<li class="blockList">
638<h4>register</h4>
639<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;forwarder,
640 <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,
641 net.named_data.jndn.Name&nbsp;route,
642 int&nbsp;cost)
643 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>
644<div class="block">Register a route on a forwarder; this will create a new face on the
645 forwarder to the given URI/route pair. See register(Face,
646 ControlParameters) for more details documentation.</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]647<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>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]648<dt><span class="strong">Throws:</span></dt>
649<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>
650</li>
651</ul>
652<a name="register(net.named_data.jndn.Face, int, net.named_data.jndn.Name, int)">
653<!-- -->
654</a>
655<ul class="blockList">
656<li class="blockList">
657<h4>register</h4>
658<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;forwarder,
659 int&nbsp;faceId,
660 net.named_data.jndn.Name&nbsp;route,
661 int&nbsp;cost)
662 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>
663<div class="block">Register a route on a forwarder; this will not create a new face since it
664 is provided a faceId. See register(Face, ControlParameters) for full
665 documentation</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]666<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>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]667<dt><span class="strong">Throws:</span></dt>
668<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>
669</li>
670</ul>
671<a name="unregister(net.named_data.jndn.Face, net.named_data.jndn.ControlParameters)">
672<!-- -->
673</a>
674<ul class="blockList">
675<li class="blockList">
676<h4>unregister</h4>
677<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;forwarder,
678 net.named_data.jndn.ControlParameters&nbsp;controlParameters)
679 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>
680<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]681 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
682 for command-line usage and
683 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
684 for protocol documentation. Ensure the forwarding face is on the local
685 machine (management requests are to /localhost/...) and that command
686 signing has been set up (e.g. forwarder.setCommandSigningInfo()</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]687<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>controlParameters</code> - </dd>
688<dt><span class="strong">Throws:</span></dt>
689<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>
690</li>
691</ul>
692<a name="unregister(net.named_data.jndn.Face, net.named_data.jndn.Name)">
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;forwarder,
699 net.named_data.jndn.Name&nbsp;route)
700 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>
701<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]702 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
703 for command-line usage and
704 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
705 for protocol documentation. Ensure the forwarding face is on the local
706 machine (management requests are to /localhost/...) and that command
707 signing has been set up (e.g. forwarder.setCommandSigningInfo()</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]708<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>route</code> - </dd>
709<dt><span class="strong">Throws:</span></dt>
710<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>
711</li>
712</ul>
713<a name="unregister(net.named_data.jndn.Face, net.named_data.jndn.Name, int)">
714<!-- -->
715</a>
716<ul class="blockList">
717<li class="blockList">
718<h4>unregister</h4>
719<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;forwarder,
720 net.named_data.jndn.Name&nbsp;route,
721 int&nbsp;faceId)
722 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>
723<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]724 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
725 for command-line usage and
726 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
727 for protocol documentation. Ensure the forwarding face is on the local
728 machine (management requests are to /localhost/...) and that command
729 signing has been set up (e.g. forwarder.setCommandSigningInfo()</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]730<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>route</code> - </dd><dd><code>faceId</code> - </dd>
731<dt><span class="strong">Throws:</span></dt>
732<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>
733</li>
734</ul>
735<a name="unregister(net.named_data.jndn.Face, net.named_data.jndn.Name, java.lang.String)">
736<!-- -->
737</a>
738<ul class="blockList">
739<li class="blockList">
740<h4>unregister</h4>
741<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;forwarder,
742 net.named_data.jndn.Name&nbsp;route,
743 <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)
744 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>
745<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]746 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
747 for command-line usage and
748 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
749 for protocol documentation. Ensure the forwarding face is on the local
750 machine (management requests are to /localhost/...) and that command
751 signing has been set up (e.g. forwarder.setCommandSigningInfo()</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]752<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>route</code> - </dd><dd><code>uri</code> - </dd>
753<dt><span class="strong">Throws:</span></dt>
754<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>
755</li>
756</ul>
757<a name="setStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name, net.named_data.jndn.Name)">
758<!-- -->
759</a>
760<ul class="blockList">
761<li class="blockList">
762<h4>setStrategy</h4>
763<pre>public static&nbsp;void&nbsp;setStrategy(net.named_data.jndn.Face&nbsp;forwarder,
764 net.named_data.jndn.Name&nbsp;prefix,
765 net.named_data.jndn.Name&nbsp;strategy)
766 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>
767<div class="block">Set a strategy on the forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]768 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
769 for command-line usage and
770 <a href="http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice">http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice</a>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]771 for protocol documentation. Ensure the forwarding face is on the local
772 machine (management requests are to /localhost/...) and that command
773 signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]774<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>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]775<dt><span class="strong">Throws:</span></dt>
776<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>
777</li>
778</ul>
779<a name="retrieveDataSet(net.named_data.jndn.Face, net.named_data.jndn.Name)">
780<!-- -->
781</a>
782<ul class="blockList">
783<li class="blockList">
784<h4>retrieveDataSet</h4>
785<pre>public static&nbsp;net.named_data.jndn.Data&nbsp;retrieveDataSet(net.named_data.jndn.Face&nbsp;forwarder,
786 net.named_data.jndn.Name&nbsp;datasetName)
787 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>,
788 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
789<div class="block">Build an interest to retrieve a segmented data set from the NFD; for
790 details on the DataSet, see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]791 <a href="http://redmine.named-data.net/projects/nfd/wiki/StatusDataset">http://redmine.named-data.net/projects/nfd/wiki/StatusDataset</a></div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]792<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>datasetName</code> - </dd>
793<dt><span class="strong">Returns:</span></dt><dd></dd>
794<dt><span class="strong">Throws:</span></dt>
795<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>
796<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code></dd></dl>
797</li>
798</ul>
799<a name="sendCommand(net.named_data.jndn.Face, net.named_data.jndn.Interest)">
800<!-- -->
801</a>
802<ul class="blockListLast">
803<li class="blockList">
804<h4>sendCommand</h4>
805<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,
806 net.named_data.jndn.Interest&nbsp;interest)
807 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>,
808 net.named_data.jndn.encoding.EncodingException,
809 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
810<div class="block">Send an interest as a command to the forwarder; this method will convert
811 the interest to a command interest and block until a response is received
812 from the forwarder. Ensure the forwarding face is on the local machine
813 (management requests are to /localhost/...) and that command signing has
814 been set up (e.g. forwarder.setCommandSigningInfo()).</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame^]815<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
816 <a href="http://redmine.named-data.net/projects/nfd/wiki/ControlCommand,">http://redmine.named-data.net/projects/nfd/wiki/ControlCommand,</a>
817 the requested interest must have encoded ControlParameters appended to the
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]818 interest name</dd>
819<dt><span class="strong">Returns:</span></dt><dd></dd>
820<dt><span class="strong">Throws:</span></dt>
821<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>
822<dd><code>net.named_data.jndn.encoding.EncodingException</code></dd>
823<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code></dd></dl>
824</li>
825</ul>
826</li>
827</ul>
828</li>
829</ul>
830</div>
831</div>
832<!-- ========= END OF CLASS DATA ========= -->
833<!-- ======= START OF BOTTOM NAVBAR ====== -->
834<div class="bottomNav"><a name="navbar_bottom">
835<!-- -->
836</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
837<!-- -->
838</a>
839<ul class="navList" title="Navigation">
840<li><a href="../../../../overview-summary.html">Overview</a></li>
841<li><a href="package-summary.html">Package</a></li>
842<li class="navBarCell1Rev">Class</li>
843<li><a href="class-use/NFD.html">Use</a></li>
844<li><a href="package-tree.html">Tree</a></li>
845<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
846<li><a href="../../../../index-all.html">Index</a></li>
847<li><a href="../../../../help-doc.html">Help</a></li>
848</ul>
849</div>
850<div class="subNav">
851<ul class="navList">
852<li><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management"><span class="strong">Prev Class</span></a></li>
853<li>Next Class</li>
854</ul>
855<ul class="navList">
856<li><a href="../../../../index.html?com/intel/jndn/management/NFD.html" target="_top">Frames</a></li>
857<li><a href="NFD.html" target="_top">No Frames</a></li>
858</ul>
859<ul class="navList" id="allclasses_navbar_bottom">
860<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
861</ul>
862<div>
863<script type="text/javascript"><!--
864 allClassesLink = document.getElementById("allclasses_navbar_bottom");
865 if(window==top) {
866 allClassesLink.style.display = "block";
867 }
868 else {
869 allClassesLink.style.display = "none";
870 }
871 //-->
872</script>
873</div>
874<div>
875<ul class="subNavList">
876<li>Summary:&nbsp;</li>
877<li>Nested&nbsp;|&nbsp;</li>
878<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
879<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
880<li><a href="#method_summary">Method</a></li>
881</ul>
882<ul class="subNavList">
883<li>Detail:&nbsp;</li>
884<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
885<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
886<li><a href="#method_detail">Method</a></li>
887</ul>
888</div>
889<a name="skip-navbar_bottom">
890<!-- -->
891</a></div>
892<!-- ======== END OF BOTTOM NAVBAR ======= -->
893<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
894</body>
895</html>