Gitiles
Code Review Sign In
gerrit.named-data.net / jndn-management / d4d0eda4f2c0268332fcadd6a9f10bb192ceb794 / . / com / intel / jndn / management / NFD.html
blob: 1bbe779845abb5545b1f922bcf7d6eedf9cf6fad [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 Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]5<!-- Generated by javadoc (1.8.0_60-ea) on Fri Sep 04 15:17:00 PDT 2015 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>NFD (jndn-management 1.0.0 API)</title>
8<meta name="date" content="2015-09-04">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]10<script type="text/javascript" src="../../../../script.js"></script>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]11</head>
12<body>
13<script type="text/javascript"><!--
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]14 try {
15 if (location.href.indexOf('is-external=true') == -1) {
16 parent.document.title="NFD (jndn-management 1.0.0 API)";
17 }
18 }
19 catch(err) {
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]20 }
21//-->
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]22var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9,"i21":9,"i22":9,"i23":9};
23var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
24var altColor = "altColor";
25var rowColor = "rowColor";
26var tableTab = "tableTab";
27var activeTableTab = "activeTableTab";
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]28</script>
29<noscript>
30<div>JavaScript is disabled on your browser.</div>
31</noscript>
32<!-- ========= START OF TOP NAVBAR ======= -->
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]33<div class="topNav"><a name="navbar.top">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]34<!-- -->
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]35</a>
36<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
37<a name="navbar.top.firstrow">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]38<!-- -->
39</a>
40<ul class="navList" title="Navigation">
41<li><a href="../../../../overview-summary.html">Overview</a></li>
42<li><a href="package-summary.html">Package</a></li>
43<li class="navBarCell1Rev">Class</li>
44<li><a href="class-use/NFD.html">Use</a></li>
45<li><a href="package-tree.html">Tree</a></li>
46<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
47<li><a href="../../../../index-all.html">Index</a></li>
48<li><a href="../../../../help-doc.html">Help</a></li>
49</ul>
50</div>
51<div class="subNav">
52<ul class="navList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]53<li><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
54<li><a href="../../../../com/intel/jndn/management/Strategies.html" title="class in com.intel.jndn.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]55</ul>
56<ul class="navList">
57<li><a href="../../../../index.html?com/intel/jndn/management/NFD.html" target="_top">Frames</a></li>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]58<li><a href="NFD.html" target="_top">No&nbsp;Frames</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]59</ul>
60<ul class="navList" id="allclasses_navbar_top">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]61<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]62</ul>
63<div>
64<script type="text/javascript"><!--
65 allClassesLink = document.getElementById("allclasses_navbar_top");
66 if(window==top) {
67 allClassesLink.style.display = "block";
68 }
69 else {
70 allClassesLink.style.display = "none";
71 }
72 //-->
73</script>
74</div>
75<div>
76<ul class="subNavList">
77<li>Summary:&nbsp;</li>
78<li>Nested&nbsp;|&nbsp;</li>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]79<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
80<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
81<li><a href="#method.summary">Method</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]82</ul>
83<ul class="subNavList">
84<li>Detail:&nbsp;</li>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]85<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
86<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
87<li><a href="#method.detail">Method</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]88</ul>
89</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]90<a name="skip.navbar.top">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]91<!-- -->
92</a></div>
93<!-- ========= END OF TOP NAVBAR ========= -->
94<!-- ======== START OF CLASS DATA ======== -->
95<div class="header">
96<div class="subTitle">com.intel.jndn.management</div>
97<h2 title="Class NFD" class="title">Class NFD</h2>
98</div>
99<div class="contentContainer">
100<ul class="inheritance">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]101<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]102<li>
103<ul class="inheritance">
104<li>com.intel.jndn.management.NFD</li>
105</ul>
106</li>
107</ul>
108<div class="description">
109<ul class="blockList">
110<li class="blockList">
111<hr>
112<br>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]113<pre>public class <span class="typeNameLabel">NFD</span>
114extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]115<div class="block">Helper class for interacting with an NDN forwarder daemon; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]116 <a href="http://redmine.named-data.net/projects/nfd/wiki/Management">http://redmine.named-data.net/projects/nfd/wiki/Management</a>
117 for explanations of the various protocols used.</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]118<dl>
119<dt><span class="simpleTagLabel">Author:</span></dt>
120<dd>Andrew Brown <andrew.brown@intel.com></dd>
121</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]122</li>
123</ul>
124</div>
125<div class="summary">
126<ul class="blockList">
127<li class="blockList">
128<!-- =========== FIELD SUMMARY =========== -->
129<ul class="blockList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]130<li class="blockList"><a name="field.summary">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]131<!-- -->
132</a>
133<h3>Field Summary</h3>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]134<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]135<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
136<tr>
137<th class="colFirst" scope="col">Modifier and Type</th>
138<th class="colLast" scope="col">Field and Description</th>
139</tr>
140<tr class="altColor">
141<td class="colFirst"><code>static long</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]142<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#DEFAULT_TIMEOUT">DEFAULT_TIMEOUT</a></span></code>&nbsp;</td>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]143</tr>
144<tr class="rowColor">
145<td class="colFirst"><code>static int</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]146<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#OK_STATUS">OK_STATUS</a></span></code>&nbsp;</td>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]147</tr>
148</table>
149</li>
150</ul>
151<!-- ======== CONSTRUCTOR SUMMARY ======== -->
152<ul class="blockList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]153<li class="blockList"><a name="constructor.summary">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]154<!-- -->
155</a>
156<h3>Constructor Summary</h3>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]157<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]158<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
159<tr>
160<th class="colOne" scope="col">Constructor and Description</th>
161</tr>
162<tr class="altColor">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]163<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#NFD--">NFD</a></span>()</code>&nbsp;</td>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]164</tr>
165</table>
166</li>
167</ul>
168<!-- ========== METHOD SUMMARY =========== -->
169<ul class="blockList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]170<li class="blockList"><a name="method.summary">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]171<!-- -->
172</a>
173<h3>Method Summary</h3>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]174<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
175<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]176<tr>
177<th class="colFirst" scope="col">Modifier and Type</th>
178<th class="colLast" scope="col">Method and Description</th>
179</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]180<tr id="i0" class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]181<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]182<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#addNextHop-net.named_data.jndn.Face-int-net.named_data.jndn.Name-">addNextHop</a></span>(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]183 int&nbsp;faceId,
184 net.named_data.jndn.Name&nbsp;prefix)</code>
185<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]186 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>,
187 this is more for debugging; use 'register' instead</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]188</td>
189</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]190<tr id="i1" class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]191<td class="colFirst"><code>static int</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]192<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#createFace-net.named_data.jndn.Face-java.lang.String-">createFace</a></span>(net.named_data.jndn.Face&nbsp;forwarder,
193 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri)</code>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]194<div class="block">Create a new face on the given forwarder.</div>
195</td>
196</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]197<tr id="i2" class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]198<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]199<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#destroyFace-net.named_data.jndn.Face-int-">destroyFace</a></span>(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]200 int&nbsp;faceId)</code>
201<div class="block">Destroy a face on given forwarder.</div>
202</td>
203</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]204<tr id="i3" class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]205<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]206<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#disableLocalControlHeader-net.named_data.jndn.Face-com.intel.jndn.management.types.LocalControlHeader-">disableLocalControlHeader</a></span>(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]207 <a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a>&nbsp;header)</code>
208<div class="block">Disable a local control feature on the given forwarder.</div>
209</td>
210</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]211<tr id="i4" class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]212<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]213<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#enableLocalControlHeader-net.named_data.jndn.Face-com.intel.jndn.management.types.LocalControlHeader-">enableLocalControlHeader</a></span>(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]214 <a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a>&nbsp;header)</code>
215<div class="block">Enable a local control feature on the given forwarder.</div>
216</td>
217</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]218<tr id="i5" class="rowColor">
219<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/intel/jndn/management/types/FaceStatus.html" title="class in com.intel.jndn.management.types">FaceStatus</a>&gt;</code></td>
220<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#getFaceList-net.named_data.jndn.Face-">getFaceList</a></span>(net.named_data.jndn.Face&nbsp;forwarder)</code>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]221<div class="block">Retrieve a list of faces and their status from the given forwarder; calls
222 /localhost/nfd/faces/list which requires a local Face (all non-local
223 packets are dropped)</div>
224</td>
225</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]226<tr id="i6" class="altColor">
227<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/intel/jndn/management/types/FibEntry.html" title="class in com.intel.jndn.management.types">FibEntry</a>&gt;</code></td>
228<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#getFibList-net.named_data.jndn.Face-">getFibList</a></span>(net.named_data.jndn.Face&nbsp;forwarder)</code>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]229<div class="block">Retrieve a list of FIB entries and their NextHopRecords from the given
230 forwarder; calls /localhost/nfd/fib/list which requires a local Face (all
231 non-local packets are dropped).</div>
232</td>
233</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]234<tr id="i7" class="rowColor">
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]235<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>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]236<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#getForwarderStatus-net.named_data.jndn.Face-">getForwarderStatus</a></span>(net.named_data.jndn.Face&nbsp;forwarder)</code>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]237<div class="block">Retrieve the status of the given forwarder; calls /localhost/nfd/status
238 which requires a local Face (all non-local packets are dropped)</div>
239</td>
240</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]241<tr id="i8" class="altColor">
Andrew Brown3a3cd4e2015-04-13 09:44:12 -0700[diff] [blame]242<td class="colFirst"><code>static net.named_data.jndn.KeyLocator</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]243<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#getKeyLocator-net.named_data.jndn.Face-">getKeyLocator</a></span>(net.named_data.jndn.Face&nbsp;forwarder)</code>
Andrew Brown3a3cd4e2015-04-13 09:44:12 -0700[diff] [blame]244<div class="block">Retrieve the <code>KeyLocator</code> for an NFD.</div>
245</td>
246</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]247<tr id="i9" class="rowColor">
248<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/intel/jndn/management/types/RibEntry.html" title="class in com.intel.jndn.management.types">RibEntry</a>&gt;</code></td>
249<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#getRouteList-net.named_data.jndn.Face-">getRouteList</a></span>(net.named_data.jndn.Face&nbsp;forwarder)</code>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]250<div class="block">Retrieve a list of routing entries from the RIB; calls
251 /localhost/nfd/rib/list which requires a local Face (all non-local packets
252 are dropped).</div>
253</td>
254</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]255<tr id="i10" class="altColor">
256<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/intel/jndn/management/types/StrategyChoice.html" title="class in com.intel.jndn.management.types">StrategyChoice</a>&gt;</code></td>
257<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#getStrategyList-net.named_data.jndn.Face-">getStrategyList</a></span>(net.named_data.jndn.Face&nbsp;forwarder)</code>
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]258<div class="block">Retrieve the list of strategy choice entries from the NFD; calls
259 /localhost/nfd/rib/list which requires a local Face (all non-local packets
260 are dropped).</div>
261</td>
262</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]263<tr id="i11" class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]264<td class="colFirst"><code>static boolean</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]265<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#ping-net.named_data.jndn.Face-net.named_data.jndn.Name-">ping</a></span>(net.named_data.jndn.Face&nbsp;face,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]266 net.named_data.jndn.Name&nbsp;name)</code>
267<div class="block">Request a name on an existing face to verify the forwarder is working and
268 responding to requests.</div>
269</td>
270</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]271<tr id="i12" class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]272<td class="colFirst"><code>static boolean</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]273<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#pingLocal-net.named_data.jndn.Face-">pingLocal</a></span>(net.named_data.jndn.Face&nbsp;face)</code>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]274<div class="block">Ping a forwarder on an existing face to verify that the forwarder is
275 working and responding to requests; this version sends a discovery packet
276 to /localhost/nfd which should always respond if the requestor is on the
277 same machine as the NDN forwarding daemon.</div>
278</td>
279</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]280<tr id="i13" class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]281<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]282<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#register-net.named_data.jndn.Face-net.named_data.jndn.ControlParameters-">register</a></span>(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]283 net.named_data.jndn.ControlParameters&nbsp;controlParameters)</code>
284<div class="block">Register a route on the forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]285 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
286 for command-line usage and
287 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
288 for protocol documentation.</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]289</td>
290</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]291<tr id="i14" class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]292<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]293<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#register-net.named_data.jndn.Face-int-net.named_data.jndn.Name-int-">register</a></span>(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]294 int&nbsp;faceId,
295 net.named_data.jndn.Name&nbsp;route,
296 int&nbsp;cost)</code>
297<div class="block">Register a route on a forwarder; this will not create a new face since it
298 is provided a faceId.</div>
299</td>
300</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]301<tr id="i15" class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]302<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]303<td class="colLast"><code><span class="memberNameLink"><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></span>(net.named_data.jndn.Face&nbsp;forwarder,
304 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]305 net.named_data.jndn.Name&nbsp;route,
306 int&nbsp;cost)</code>
307<div class="block">Register a route on a forwarder; this will create a new face on the
308 forwarder to the given URI/route pair.</div>
309</td>
310</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]311<tr id="i16" class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]312<td class="colFirst"><code>static net.named_data.jndn.Data</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]313<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#retrieveDataSet-net.named_data.jndn.Face-net.named_data.jndn.Name-">retrieveDataSet</a></span>(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]314 net.named_data.jndn.Name&nbsp;datasetName)</code>
315<div class="block">Build an interest to retrieve a segmented data set from the NFD; for
316 details on the DataSet, see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]317 <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]318</td>
319</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]320<tr id="i17" class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]321<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>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]322<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#sendCommand-net.named_data.jndn.Face-net.named_data.jndn.Interest-">sendCommand</a></span>(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]323 net.named_data.jndn.Interest&nbsp;interest)</code>
324<div class="block">Send an interest as a command to the forwarder; this method will convert
325 the interest to a command interest and block until a response is received
326 from the forwarder.</div>
327</td>
328</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]329<tr id="i18" class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]330<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]331<td class="colLast"><code><span class="memberNameLink"><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></span>(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]332 net.named_data.jndn.Name&nbsp;prefix,
333 net.named_data.jndn.Name&nbsp;strategy)</code>
334<div class="block">Set a strategy on the forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]335 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
336 for command-line usage and
337 <a href="http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice">http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice</a>
338 for protocol documentation.</div>
339</td>
340</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]341<tr id="i19" class="rowColor">
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]342<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]343<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#unregister-net.named_data.jndn.Face-net.named_data.jndn.ControlParameters-">unregister</a></span>(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]344 net.named_data.jndn.ControlParameters&nbsp;controlParameters)</code>
345<div class="block">Unregister a route on a forwarder; see
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>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]349 for protocol documentation.</div>
350</td>
351</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]352<tr id="i20" class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]353<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]354<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#unregister-net.named_data.jndn.Face-net.named_data.jndn.Name-">unregister</a></span>(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]355 net.named_data.jndn.Name&nbsp;route)</code>
356<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]357 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
358 for command-line usage and
359 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
360 for protocol documentation.</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]361</td>
362</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]363<tr id="i21" class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]364<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]365<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#unregister-net.named_data.jndn.Face-net.named_data.jndn.Name-int-">unregister</a></span>(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]366 net.named_data.jndn.Name&nbsp;route,
367 int&nbsp;faceId)</code>
368<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]369 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
370 for command-line usage and
371 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
372 for protocol documentation.</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]373</td>
374</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]375<tr id="i22" class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]376<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]377<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#unregister-net.named_data.jndn.Face-net.named_data.jndn.Name-java.lang.String-">unregister</a></span>(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]378 net.named_data.jndn.Name&nbsp;route,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]379 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri)</code>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]380<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]381 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
382 for command-line usage and
383 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
384 for protocol documentation.</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]385</td>
386</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]387<tr id="i23" class="rowColor">
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]388<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]389<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NFD.html#unsetStrategy-net.named_data.jndn.Face-net.named_data.jndn.Name-">unsetStrategy</a></span>(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]390 net.named_data.jndn.Name&nbsp;prefix)</code>
391<div class="block">Set a strategy on the forwarder; see
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]392 <a href="../../../../com/intel/jndn/management/NFD.html#setStrategy-net.named_data.jndn.Face-net.named_data.jndn.Name-net.named_data.jndn.Name-"><code>setStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name, net.named_data.jndn.Name)</code></a>
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]393 for more information.</div>
394</td>
395</tr>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]396</table>
397<ul class="blockList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]398<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]399<!-- -->
400</a>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]401<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
402<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]403</ul>
404</li>
405</ul>
406</li>
407</ul>
408</div>
409<div class="details">
410<ul class="blockList">
411<li class="blockList">
412<!-- ============ FIELD DETAIL =========== -->
413<ul class="blockList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]414<li class="blockList"><a name="field.detail">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]415<!-- -->
416</a>
417<h3>Field Detail</h3>
418<a name="DEFAULT_TIMEOUT">
419<!-- -->
420</a>
421<ul class="blockList">
422<li class="blockList">
423<h4>DEFAULT_TIMEOUT</h4>
424<pre>public static final&nbsp;long DEFAULT_TIMEOUT</pre>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]425<dl>
426<dt><span class="seeLabel">See Also:</span></dt>
427<dd><a href="../../../../constant-values.html#com.intel.jndn.management.NFD.DEFAULT_TIMEOUT">Constant Field Values</a></dd>
428</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]429</li>
430</ul>
431<a name="OK_STATUS">
432<!-- -->
433</a>
434<ul class="blockListLast">
435<li class="blockList">
436<h4>OK_STATUS</h4>
437<pre>public static final&nbsp;int OK_STATUS</pre>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]438<dl>
439<dt><span class="seeLabel">See Also:</span></dt>
440<dd><a href="../../../../constant-values.html#com.intel.jndn.management.NFD.OK_STATUS">Constant Field Values</a></dd>
441</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]442</li>
443</ul>
444</li>
445</ul>
446<!-- ========= CONSTRUCTOR DETAIL ======== -->
447<ul class="blockList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]448<li class="blockList"><a name="constructor.detail">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]449<!-- -->
450</a>
451<h3>Constructor Detail</h3>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]452<a name="NFD--">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]453<!-- -->
454</a>
455<ul class="blockListLast">
456<li class="blockList">
457<h4>NFD</h4>
458<pre>public&nbsp;NFD()</pre>
459</li>
460</ul>
461</li>
462</ul>
463<!-- ============ METHOD DETAIL ========== -->
464<ul class="blockList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]465<li class="blockList"><a name="method.detail">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]466<!-- -->
467</a>
468<h3>Method Detail</h3>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]469<a name="pingLocal-net.named_data.jndn.Face-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]470<!-- -->
471</a>
472<ul class="blockList">
473<li class="blockList">
474<h4>pingLocal</h4>
475<pre>public static&nbsp;boolean&nbsp;pingLocal(net.named_data.jndn.Face&nbsp;face)</pre>
476<div class="block">Ping a forwarder on an existing face to verify that the forwarder is
477 working and responding to requests; this version sends a discovery packet
478 to /localhost/nfd which should always respond if the requestor is on the
479 same machine as the NDN forwarding daemon.</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]480<dl>
481<dt><span class="paramLabel">Parameters:</span></dt>
482<dd><code>face</code> - only a localhost Face</dd>
483<dt><span class="returnLabel">Returns:</span></dt>
484<dd>true if successful, false otherwise</dd>
485</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]486</li>
487</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]488<a name="ping-net.named_data.jndn.Face-net.named_data.jndn.Name-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]489<!-- -->
490</a>
491<ul class="blockList">
492<li class="blockList">
493<h4>ping</h4>
494<pre>public static&nbsp;boolean&nbsp;ping(net.named_data.jndn.Face&nbsp;face,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]495 net.named_data.jndn.Name&nbsp;name)</pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]496<div class="block">Request a name on an existing face to verify the forwarder is working and
497 responding to requests. Note that the name must be served or cached on the
498 forwarder for this to return true.</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]499<dl>
500<dt><span class="paramLabel">Parameters:</span></dt>
501<dd><code>face</code> - a <code>Face</code> to ping</dd>
502<dd><code>name</code> - a known <code>Name</code> that the remote node will answer to</dd>
503<dt><span class="returnLabel">Returns:</span></dt>
504<dd>true if successful, false otherwise</dd>
505</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]506</li>
507</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]508<a name="getForwarderStatus-net.named_data.jndn.Face-">
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]509<!-- -->
510</a>
511<ul class="blockList">
512<li class="blockList">
513<h4>getForwarderStatus</h4>
514<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)
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]515 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
516 net.named_data.jndn.encoding.EncodingException</pre>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]517<div class="block">Retrieve the status of the given forwarder; calls /localhost/nfd/status
518 which requires a local Face (all non-local packets are dropped)</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]519<dl>
520<dt><span class="paramLabel">Parameters:</span></dt>
521<dd><code>forwarder</code> - only a localhost Face</dd>
522<dt><span class="returnLabel">Returns:</span></dt>
523<dd>the forwarder status object, see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]524 <a href="http://redmine.named-data.net/projects/nfd/wiki/ForwarderStatus">
525 http://redmine.named-data.net/projects/nfd/wiki/ForwarderStatus</a>.</dd>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]526<dt><span class="throwsLabel">Throws:</span></dt>
527<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
528<dd><code>net.named_data.jndn.encoding.EncodingException</code> - if the returned status could not be decoded</dd>
529</dl>
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]530</li>
531</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]532<a name="getFaceList-net.named_data.jndn.Face-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]533<!-- -->
534</a>
535<ul class="blockList">
536<li class="blockList">
537<h4>getFaceList</h4>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]538<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/intel/jndn/management/types/FaceStatus.html" title="class in com.intel.jndn.management.types">FaceStatus</a>&gt;&nbsp;getFaceList(net.named_data.jndn.Face&nbsp;forwarder)
539 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
540 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]541<div class="block">Retrieve a list of faces and their status from the given forwarder; calls
542 /localhost/nfd/faces/list which requires a local Face (all non-local
543 packets are dropped)</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]544<dl>
545<dt><span class="paramLabel">Parameters:</span></dt>
546<dd><code>forwarder</code> - only a localhost Face</dd>
547<dt><span class="returnLabel">Returns:</span></dt>
548<dd>a list of face status objects, see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]549 http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt.</dd>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]550<dt><span class="throwsLabel">Throws:</span></dt>
551<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
552<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
553</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]554</li>
555</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]556<a name="getFibList-net.named_data.jndn.Face-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]557<!-- -->
558</a>
559<ul class="blockList">
560<li class="blockList">
561<h4>getFibList</h4>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]562<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/intel/jndn/management/types/FibEntry.html" title="class in com.intel.jndn.management.types">FibEntry</a>&gt;&nbsp;getFibList(net.named_data.jndn.Face&nbsp;forwarder)
563 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
564 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]565<div class="block">Retrieve a list of FIB entries and their NextHopRecords from the given
566 forwarder; calls /localhost/nfd/fib/list which requires a local Face (all
567 non-local packets are dropped).</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]568<dl>
569<dt><span class="paramLabel">Parameters:</span></dt>
570<dd><code>forwarder</code> - only a localhost Face</dd>
571<dt><span class="returnLabel">Returns:</span></dt>
572<dd>a list of FIB entries, see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]573 http://redmine.named-data.net/projects/nfd/wiki/FibMgmt#FIB-Dataset.</dd>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]574<dt><span class="throwsLabel">Throws:</span></dt>
575<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
576<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
577</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]578</li>
579</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]580<a name="getRouteList-net.named_data.jndn.Face-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]581<!-- -->
582</a>
583<ul class="blockList">
584<li class="blockList">
585<h4>getRouteList</h4>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]586<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/intel/jndn/management/types/RibEntry.html" title="class in com.intel.jndn.management.types">RibEntry</a>&gt;&nbsp;getRouteList(net.named_data.jndn.Face&nbsp;forwarder)
587 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
588 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]589<div class="block">Retrieve a list of routing entries from the RIB; calls
590 /localhost/nfd/rib/list which requires a local Face (all non-local packets
591 are dropped).</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]592<dl>
593<dt><span class="paramLabel">Parameters:</span></dt>
594<dd><code>forwarder</code> - only a localhost Face</dd>
595<dt><span class="returnLabel">Returns:</span></dt>
596<dd>a list of RIB entries, i.e. routes, see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]597 http://redmine.named-data.net/projects/nfd/wiki/RibMgmt#RIB-Dataset.</dd>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]598<dt><span class="throwsLabel">Throws:</span></dt>
599<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
600<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
601</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]602</li>
603</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]604<a name="getStrategyList-net.named_data.jndn.Face-">
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]605<!-- -->
606</a>
607<ul class="blockList">
608<li class="blockList">
609<h4>getStrategyList</h4>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]610<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/intel/jndn/management/types/StrategyChoice.html" title="class in com.intel.jndn.management.types">StrategyChoice</a>&gt;&nbsp;getStrategyList(net.named_data.jndn.Face&nbsp;forwarder)
611 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
612 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]613<div class="block">Retrieve the list of strategy choice entries from the NFD; calls
614 /localhost/nfd/rib/list which requires a local Face (all non-local packets
615 are dropped).</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]616<dl>
617<dt><span class="paramLabel">Parameters:</span></dt>
618<dd><code>forwarder</code> - only a localhost Face</dd>
619<dt><span class="returnLabel">Returns:</span></dt>
620<dd>a list of strategy choice entries, i.e. routes, see
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]621 http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice.</dd>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]622<dt><span class="throwsLabel">Throws:</span></dt>
623<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
624<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
625</dl>
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]626</li>
627</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]628<a name="getKeyLocator-net.named_data.jndn.Face-">
Andrew Brown3a3cd4e2015-04-13 09:44:12 -0700[diff] [blame]629<!-- -->
630</a>
631<ul class="blockList">
632<li class="blockList">
633<h4>getKeyLocator</h4>
634<pre>public static&nbsp;net.named_data.jndn.KeyLocator&nbsp;getKeyLocator(net.named_data.jndn.Face&nbsp;forwarder)
635 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a>,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]636 <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
Andrew Brown3a3cd4e2015-04-13 09:44:12 -0700[diff] [blame]637<div class="block">Retrieve the <code>KeyLocator</code> for an NFD.</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]638<dl>
639<dt><span class="paramLabel">Parameters:</span></dt>
640<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
641<dt><span class="returnLabel">Returns:</span></dt>
642<dd>the <code>KeyLocator</code> of the NFD's key</dd>
643<dt><span class="throwsLabel">Throws:</span></dt>
644<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
645<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request or no
646 KeyLocator was found</dd>
647</dl>
Andrew Brown3a3cd4e2015-04-13 09:44:12 -0700[diff] [blame]648</li>
649</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]650<a name="addNextHop-net.named_data.jndn.Face-int-net.named_data.jndn.Name-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]651<!-- -->
652</a>
653<ul class="blockList">
654<li class="blockList">
655<h4>addNextHop</h4>
656<pre>public static&nbsp;void&nbsp;addNextHop(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]657 int&nbsp;faceId,
658 net.named_data.jndn.Name&nbsp;prefix)
659 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
660 net.named_data.jndn.encoding.EncodingException,
661 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]662<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]663 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>,
664 this is more for debugging; use 'register' instead</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]665<dl>
666<dt><span class="paramLabel">Parameters:</span></dt>
667<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
668<dd><code>faceId</code> - the ID of the face to add, see
669 <a href="../../../../com/intel/jndn/management/NFD.html#createFace-net.named_data.jndn.Face-java.lang.String-"><code>createFace(net.named_data.jndn.Face, java.lang.String)</code></a> for
670 creating this</dd>
671<dd><code>prefix</code> - the <code>Name</code> of the next-hop prefix</dd>
672<dt><span class="throwsLabel">Throws:</span></dt>
673<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
674<dd><code>net.named_data.jndn.encoding.EncodingException</code> - if the NFD response could not be decoded</dd>
675<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
676</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]677</li>
678</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]679<a name="createFace-net.named_data.jndn.Face-java.lang.String-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]680<!-- -->
681</a>
682<ul class="blockList">
683<li class="blockList">
684<h4>createFace</h4>
685<pre>public static&nbsp;int&nbsp;createFace(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]686 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri)
687 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
688 net.named_data.jndn.encoding.EncodingException,
689 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]690<div class="block">Create a new face on the given forwarder. Ensure the forwarding face is on
691 the local machine (management requests are to /localhost/...) and that
692 command signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]693<dl>
694<dt><span class="paramLabel">Parameters:</span></dt>
695<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
696<dd><code>uri</code> - a string like "tcp4://host.name.com" (see nfd-status channels
697 for more protocol options)</dd>
698<dt><span class="returnLabel">Returns:</span></dt>
699<dd>the newly created face ID</dd>
700<dt><span class="throwsLabel">Throws:</span></dt>
701<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
702<dd><code>net.named_data.jndn.encoding.EncodingException</code> - if the NFD response could not be decoded</dd>
703<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
704</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]705</li>
706</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]707<a name="destroyFace-net.named_data.jndn.Face-int-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]708<!-- -->
709</a>
710<ul class="blockList">
711<li class="blockList">
712<h4>destroyFace</h4>
713<pre>public static&nbsp;void&nbsp;destroyFace(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]714 int&nbsp;faceId)
715 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
716 net.named_data.jndn.encoding.EncodingException,
717 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]718<div class="block">Destroy a face on given forwarder. Ensure the forwarding face is on the
719 local machine (management requests are to /localhost/...) and that command
720 signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]721<dl>
722<dt><span class="paramLabel">Parameters:</span></dt>
723<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
724<dd><code>faceId</code> - the ID of the face to destroy</dd>
725<dt><span class="throwsLabel">Throws:</span></dt>
726<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
727<dd><code>net.named_data.jndn.encoding.EncodingException</code> - if the NFD response could not be decoded</dd>
728<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
729</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]730</li>
731</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]732<a name="enableLocalControlHeader-net.named_data.jndn.Face-com.intel.jndn.management.types.LocalControlHeader-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]733<!-- -->
734</a>
735<ul class="blockList">
736<li class="blockList">
737<h4>enableLocalControlHeader</h4>
738<pre>public static&nbsp;void&nbsp;enableLocalControlHeader(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]739 <a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a>&nbsp;header)
740 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
741 net.named_data.jndn.encoding.EncodingException,
742 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]743<div class="block">Enable a local control feature on the given forwarder. See
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]744 <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 Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]745<dl>
746<dt><span class="paramLabel">Parameters:</span></dt>
747<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
748<dd><code>header</code> - the control feature to enable</dd>
749<dt><span class="throwsLabel">Throws:</span></dt>
750<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
751<dd><code>net.named_data.jndn.encoding.EncodingException</code> - if the NFD response could not be decoded</dd>
752<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
753</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]754</li>
755</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]756<a name="disableLocalControlHeader-net.named_data.jndn.Face-com.intel.jndn.management.types.LocalControlHeader-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]757<!-- -->
758</a>
759<ul class="blockList">
760<li class="blockList">
761<h4>disableLocalControlHeader</h4>
762<pre>public static&nbsp;void&nbsp;disableLocalControlHeader(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]763 <a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a>&nbsp;header)
764 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
765 net.named_data.jndn.encoding.EncodingException,
766 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]767<div class="block">Disable a local control feature on the given forwarder. See
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]768 <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 Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]769<dl>
770<dt><span class="paramLabel">Parameters:</span></dt>
771<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
772<dd><code>header</code> - the control feature to disable</dd>
773<dt><span class="throwsLabel">Throws:</span></dt>
774<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
775<dd><code>net.named_data.jndn.encoding.EncodingException</code> - if the NFD response could not be decoded</dd>
776<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
777</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]778</li>
779</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]780<a name="register-net.named_data.jndn.Face-net.named_data.jndn.ControlParameters-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]781<!-- -->
782</a>
783<ul class="blockList">
784<li class="blockList">
785<h4>register</h4>
786<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]787 net.named_data.jndn.ControlParameters&nbsp;controlParameters)
788 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
789 net.named_data.jndn.encoding.EncodingException,
790 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]791<div class="block">Register a route on the forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]792 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
793 for command-line usage and
794 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
795 for protocol documentation. Ensure the forwarding face is on the local
796 machine (management requests are to /localhost/...) and that command
797 signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]798<dl>
799<dt><span class="paramLabel">Parameters:</span></dt>
800<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
801<dd><code>controlParameters</code> - the <code>ControlParameters</code> command options</dd>
802<dt><span class="throwsLabel">Throws:</span></dt>
803<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
804<dd><code>net.named_data.jndn.encoding.EncodingException</code> - if the NFD response could not be decoded</dd>
805<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
806</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]807</li>
808</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]809<a name="register-net.named_data.jndn.Face-java.lang.String-net.named_data.jndn.Name-int-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]810<!-- -->
811</a>
812<ul class="blockList">
813<li class="blockList">
814<h4>register</h4>
815<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]816 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri,
817 net.named_data.jndn.Name&nbsp;route,
818 int&nbsp;cost)
819 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
820 net.named_data.jndn.encoding.EncodingException,
821 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]822<div class="block">Register a route on a forwarder; this will create a new face on the
823 forwarder to the given URI/route pair. See register(Face,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]824 ControlParameters) for more detailed documentation.</div>
825<dl>
826<dt><span class="paramLabel">Parameters:</span></dt>
827<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
828<dd><code>uri</code> - the URI (e.g. "tcp4://10.10.2.2:6363") of the remote node; note
829 that this must be one of the canonical forms described in the wiki
830 (http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#TCP) for NFD to
831 accept the registration--otherwise you will see 400 errors</dd>
832<dd><code>route</code> - the <code>Name</code> prefix of the route</dd>
833<dd><code>cost</code> - the numeric cost of forwarding along the route</dd>
834<dt><span class="throwsLabel">Throws:</span></dt>
835<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
836<dd><code>net.named_data.jndn.encoding.EncodingException</code> - if the NFD response could not be decoded</dd>
837<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
838</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]839</li>
840</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]841<a name="register-net.named_data.jndn.Face-int-net.named_data.jndn.Name-int-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]842<!-- -->
843</a>
844<ul class="blockList">
845<li class="blockList">
846<h4>register</h4>
847<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]848 int&nbsp;faceId,
849 net.named_data.jndn.Name&nbsp;route,
850 int&nbsp;cost)
851 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
852 net.named_data.jndn.encoding.EncodingException,
853 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]854<div class="block">Register a route on a forwarder; this will not create a new face since it
855 is provided a faceId. See register(Face, ControlParameters) for full
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]856 documentation.</div>
857<dl>
858<dt><span class="paramLabel">Parameters:</span></dt>
859<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
860<dd><code>faceId</code> - the ID of the <code>Face</code> to assign to the route</dd>
861<dd><code>route</code> - the <code>Name</code> prefix of the route</dd>
862<dd><code>cost</code> - the numeric cost of forwarding along the route</dd>
863<dt><span class="throwsLabel">Throws:</span></dt>
864<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
865<dd><code>net.named_data.jndn.encoding.EncodingException</code> - if the NFD response could not be decoded</dd>
866<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
867</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]868</li>
869</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]870<a name="unregister-net.named_data.jndn.Face-net.named_data.jndn.ControlParameters-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]871<!-- -->
872</a>
873<ul class="blockList">
874<li class="blockList">
875<h4>unregister</h4>
876<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]877 net.named_data.jndn.ControlParameters&nbsp;controlParameters)
878 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
879 net.named_data.jndn.encoding.EncodingException,
880 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]881<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]882 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
883 for command-line usage and
884 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
885 for protocol documentation. Ensure the forwarding face is on the local
886 machine (management requests are to /localhost/...) and that command
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]887 signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
888<dl>
889<dt><span class="paramLabel">Parameters:</span></dt>
890<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
891<dd><code>controlParameters</code> - the <code>ControlParameters</code> command options</dd>
892<dt><span class="throwsLabel">Throws:</span></dt>
893<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
894<dd><code>net.named_data.jndn.encoding.EncodingException</code> - if the NFD response could not be decoded</dd>
895<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
896</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]897</li>
898</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]899<a name="unregister-net.named_data.jndn.Face-net.named_data.jndn.Name-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]900<!-- -->
901</a>
902<ul class="blockList">
903<li class="blockList">
904<h4>unregister</h4>
905<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]906 net.named_data.jndn.Name&nbsp;route)
907 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
908 net.named_data.jndn.encoding.EncodingException,
909 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]910<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]911 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
912 for command-line usage and
913 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
914 for protocol documentation. Ensure the forwarding face is on the local
915 machine (management requests are to /localhost/...) and that command
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]916 signing has been set up (e.g. forwarder.setCommandSigningInfo().</div>
917<dl>
918<dt><span class="paramLabel">Parameters:</span></dt>
919<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
920<dd><code>route</code> - the <code>Name</code> prefix of the route</dd>
921<dt><span class="throwsLabel">Throws:</span></dt>
922<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
923<dd><code>net.named_data.jndn.encoding.EncodingException</code> - if the NFD response could not be decoded</dd>
924<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
925</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]926</li>
927</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]928<a name="unregister-net.named_data.jndn.Face-net.named_data.jndn.Name-int-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]929<!-- -->
930</a>
931<ul class="blockList">
932<li class="blockList">
933<h4>unregister</h4>
934<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]935 net.named_data.jndn.Name&nbsp;route,
936 int&nbsp;faceId)
937 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
938 net.named_data.jndn.encoding.EncodingException,
939 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]940<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]941 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
942 for command-line usage and
943 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
944 for protocol documentation. Ensure the forwarding face is on the local
945 machine (management requests are to /localhost/...) and that command
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]946 signing has been set up (e.g. forwarder.setCommandSigningInfo().</div>
947<dl>
948<dt><span class="paramLabel">Parameters:</span></dt>
949<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
950<dd><code>route</code> - the <code>Name</code> prefix of the route</dd>
951<dd><code>faceId</code> - the specific ID of the face to remove (more than one face can
952 be registered to a route)</dd>
953<dt><span class="throwsLabel">Throws:</span></dt>
954<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
955<dd><code>net.named_data.jndn.encoding.EncodingException</code> - if the NFD response could not be decoded</dd>
956<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
957</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]958</li>
959</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]960<a name="unregister-net.named_data.jndn.Face-net.named_data.jndn.Name-java.lang.String-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]961<!-- -->
962</a>
963<ul class="blockList">
964<li class="blockList">
965<h4>unregister</h4>
966<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]967 net.named_data.jndn.Name&nbsp;route,
968 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri)
969 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
970 net.named_data.jndn.encoding.EncodingException,
971 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]972<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]973 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
974 for command-line usage and
975 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
976 for protocol documentation. Ensure the forwarding face is on the local
977 machine (management requests are to /localhost/...) and that command
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]978 signing has been set up (e.g. forwarder.setCommandSigningInfo().</div>
979<dl>
980<dt><span class="paramLabel">Parameters:</span></dt>
981<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
982<dd><code>route</code> - the <code>Name</code> prefix of the route</dd>
983<dd><code>uri</code> - the URI (e.g. "tcp4://some.host.com") of the remote node (more
984 than one face can be registered to a route)</dd>
985<dt><span class="throwsLabel">Throws:</span></dt>
986<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
987<dd><code>net.named_data.jndn.encoding.EncodingException</code> - if the NFD response could not be decoded</dd>
988<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
989</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]990</li>
991</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]992<a name="setStrategy-net.named_data.jndn.Face-net.named_data.jndn.Name-net.named_data.jndn.Name-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]993<!-- -->
994</a>
995<ul class="blockList">
996<li class="blockList">
997<h4>setStrategy</h4>
998<pre>public static&nbsp;void&nbsp;setStrategy(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]999 net.named_data.jndn.Name&nbsp;prefix,
1000 net.named_data.jndn.Name&nbsp;strategy)
1001 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
1002 net.named_data.jndn.encoding.EncodingException,
1003 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1004<div class="block">Set a strategy on the forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]1005 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
1006 for command-line usage and
1007 <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]1008 for protocol documentation. Ensure the forwarding face is on the local
1009 machine (management requests are to /localhost/...) and that command
1010 signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1011<dl>
1012<dt><span class="paramLabel">Parameters:</span></dt>
1013<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
1014<dd><code>prefix</code> - the <code>Name</code> prefix</dd>
1015<dd><code>strategy</code> - the <code>Name</code> of the strategy to set, e.g.
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]1016 /localhost/nfd/strategy/broadcast</dd>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1017<dt><span class="throwsLabel">Throws:</span></dt>
1018<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
1019<dd><code>net.named_data.jndn.encoding.EncodingException</code> - if the NFD response could not be decoded</dd>
1020<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
1021</dl>
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]1022</li>
1023</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1024<a name="unsetStrategy-net.named_data.jndn.Face-net.named_data.jndn.Name-">
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]1025<!-- -->
1026</a>
1027<ul class="blockList">
1028<li class="blockList">
1029<h4>unsetStrategy</h4>
1030<pre>public static&nbsp;void&nbsp;unsetStrategy(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1031 net.named_data.jndn.Name&nbsp;prefix)
1032 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
1033 net.named_data.jndn.encoding.EncodingException,
1034 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]1035<div class="block">Set a strategy on the forwarder; see
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1036 <a href="../../../../com/intel/jndn/management/NFD.html#setStrategy-net.named_data.jndn.Face-net.named_data.jndn.Name-net.named_data.jndn.Name-"><code>setStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name, net.named_data.jndn.Name)</code></a>
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]1037 for more information. Ensure the forwarding face is on the local machine
1038 (management requests are to /localhost/...) and that command signing has
1039 been set up (e.g. forwarder.setCommandSigningInfo()).</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1040<dl>
1041<dt><span class="paramLabel">Parameters:</span></dt>
1042<dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
1043<dd><code>prefix</code> - the <code>Name</code> prefix</dd>
1044<dt><span class="throwsLabel">Throws:</span></dt>
1045<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the network request failed</dd>
1046<dd><code>net.named_data.jndn.encoding.EncodingException</code> - if the NFD response could not be decoded</dd>
1047<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the NFD rejected the request</dd>
1048</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1049</li>
1050</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1051<a name="retrieveDataSet-net.named_data.jndn.Face-net.named_data.jndn.Name-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1052<!-- -->
1053</a>
1054<ul class="blockList">
1055<li class="blockList">
1056<h4>retrieveDataSet</h4>
1057<pre>public static&nbsp;net.named_data.jndn.Data&nbsp;retrieveDataSet(net.named_data.jndn.Face&nbsp;forwarder,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1058 net.named_data.jndn.Name&nbsp;datasetName)
1059 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1060 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
1061<div class="block">Build an interest to retrieve a segmented data set from the NFD; for
1062 details on the DataSet, see
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]1063 <a href="http://redmine.named-data.net/projects/nfd/wiki/StatusDataset">http://redmine.named-data.net/projects/nfd/wiki/StatusDataset</a></div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1064<dl>
1065<dt><span class="paramLabel">Parameters:</span></dt>
1066<dd><code>forwarder</code> - the <code>Face</code> to an NFD</dd>
1067<dd><code>datasetName</code> - the <code>Name</code> of the dataset to retrieve</dd>
1068<dt><span class="returnLabel">Returns:</span></dt>
1069<dd>the re-assembled <code>Data</code> packet</dd>
1070<dt><span class="throwsLabel">Throws:</span></dt>
1071<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the request fails</dd>
1072<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>
1073</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1074</li>
1075</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1076<a name="sendCommand-net.named_data.jndn.Face-net.named_data.jndn.Interest-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1077<!-- -->
1078</a>
1079<ul class="blockListLast">
1080<li class="blockList">
1081<h4>sendCommand</h4>
1082<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,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1083 net.named_data.jndn.Interest&nbsp;interest)
1084 throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1085 net.named_data.jndn.encoding.EncodingException,
1086 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
1087<div class="block">Send an interest as a command to the forwarder; this method will convert
1088 the interest to a command interest and block until a response is received
1089 from the forwarder. Ensure the forwarding face is on the local machine
1090 (management requests are to /localhost/...) and that command signing has
1091 been set up (e.g. forwarder.setCommandSigningInfo()).</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1092<dl>
1093<dt><span class="paramLabel">Parameters:</span></dt>
1094<dd><code>forwarder</code> - only a localhost Face, command signing info must be set</dd>
1095<dd><code>interest</code> - As described at
Andrew Brown7969d392015-03-25 12:08:09 -0700[diff] [blame]1096 <a href="http://redmine.named-data.net/projects/nfd/wiki/ControlCommand,">http://redmine.named-data.net/projects/nfd/wiki/ControlCommand,</a>
1097 the requested interest must have encoded ControlParameters appended to the
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1098 interest name</dd>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1099<dt><span class="returnLabel">Returns:</span></dt>
1100<dd>a <a href="../../../../com/intel/jndn/management/types/ControlResponse.html" title="class in com.intel.jndn.management.types"><code>ControlResponse</code></a></dd>
1101<dt><span class="throwsLabel">Throws:</span></dt>
1102<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1103<dd><code>net.named_data.jndn.encoding.EncodingException</code></dd>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1104<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code></dd>
1105</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1106</li>
1107</ul>
1108</li>
1109</ul>
1110</li>
1111</ul>
1112</div>
1113</div>
1114<!-- ========= END OF CLASS DATA ========= -->
1115<!-- ======= START OF BOTTOM NAVBAR ====== -->
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1116<div class="bottomNav"><a name="navbar.bottom">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1117<!-- -->
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1118</a>
1119<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
1120<a name="navbar.bottom.firstrow">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1121<!-- -->
1122</a>
1123<ul class="navList" title="Navigation">
1124<li><a href="../../../../overview-summary.html">Overview</a></li>
1125<li><a href="package-summary.html">Package</a></li>
1126<li class="navBarCell1Rev">Class</li>
1127<li><a href="class-use/NFD.html">Use</a></li>
1128<li><a href="package-tree.html">Tree</a></li>
1129<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
1130<li><a href="../../../../index-all.html">Index</a></li>
1131<li><a href="../../../../help-doc.html">Help</a></li>
1132</ul>
1133</div>
1134<div class="subNav">
1135<ul class="navList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1136<li><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
1137<li><a href="../../../../com/intel/jndn/management/Strategies.html" title="class in com.intel.jndn.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1138</ul>
1139<ul class="navList">
1140<li><a href="../../../../index.html?com/intel/jndn/management/NFD.html" target="_top">Frames</a></li>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1141<li><a href="NFD.html" target="_top">No&nbsp;Frames</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1142</ul>
1143<ul class="navList" id="allclasses_navbar_bottom">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1144<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1145</ul>
1146<div>
1147<script type="text/javascript"><!--
1148 allClassesLink = document.getElementById("allclasses_navbar_bottom");
1149 if(window==top) {
1150 allClassesLink.style.display = "block";
1151 }
1152 else {
1153 allClassesLink.style.display = "none";
1154 }
1155 //-->
1156</script>
1157</div>
1158<div>
1159<ul class="subNavList">
1160<li>Summary:&nbsp;</li>
1161<li>Nested&nbsp;|&nbsp;</li>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1162<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
1163<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
1164<li><a href="#method.summary">Method</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1165</ul>
1166<ul class="subNavList">
1167<li>Detail:&nbsp;</li>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1168<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
1169<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
1170<li><a href="#method.detail">Method</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1171</ul>
1172</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]1173<a name="skip.navbar.bottom">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1174<!-- -->
1175</a></div>
1176<!-- ======== END OF BOTTOM NAVBAR ======= -->
1177<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
1178</body>
1179</html>