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