Publishing javadoc for jndn-management:0.9.7
diff --git a/com/intel/jndn/management/NFD.html b/com/intel/jndn/management/NFD.html
index 612071f..59ffbdd 100644
--- a/com/intel/jndn/management/NFD.html
+++ b/com/intel/jndn/management/NFD.html
@@ -2,16 +2,16 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Tue Mar 24 09:26:48 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Wed Mar 25 10:57:01 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
-<title>NFD (jndn-management 0.9.6 API)</title>
-<meta name="date" content="2015-03-24">
+<title>NFD (jndn-management 0.9.7 API)</title>
+<meta name="date" content="2015-03-25">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="NFD (jndn-management 0.9.6 API)";
+ parent.document.title="NFD (jndn-management 0.9.7 API)";
}
//-->
</script>
@@ -100,8 +100,8 @@
<pre>public class <span class="strong">NFD</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Helper class for interacting with an NDN forwarder daemon; see
- http://redmine.named-data.net/projects/nfd/wiki/Management for explanations
- of the various protocols used.</div>
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/Management">http://redmine.named-data.net/projects/nfd/wiki/Management</a>
+ for explanations of the various protocols used.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Andrew Brown <andrew.brown@intel.com></dd></dl>
</li>
@@ -168,8 +168,8 @@
int faceId,
net.named_data.jndn.Name prefix)</code>
<div class="block">Helper method to register a new face on the forwarder; as mentioned at
- http://named-data.net/doc/NFD/current/manpages/nfdc.html, this is more for
- debugging; use 'register' instead</div>
+ <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>,
+ this is more for debugging; use 'register' instead</div>
</td>
</tr>
<tr class="rowColor">
@@ -217,6 +217,13 @@
</td>
</tr>
<tr class="rowColor">
+<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>
+<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#getForwarderStatus(net.named_data.jndn.Face)">getForwarderStatus</a></strong>(net.named_data.jndn.Face forwarder)</code>
+<div class="block">Retrieve the status of the given forwarder; calls /localhost/nfd/status
+ which requires a local Face (all non-local packets are dropped)</div>
+</td>
+</tr>
+<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../com/intel/jndn/management/types/RibEntry.html" title="class in com.intel.jndn.management.types">RibEntry</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#getRouteList(net.named_data.jndn.Face)">getRouteList</a></strong>(net.named_data.jndn.Face forwarder)</code>
<div class="block">Retrieve a list of routing entries from the RIB; calls
@@ -224,7 +231,7 @@
are dropped).</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#ping(net.named_data.jndn.Face, net.named_data.jndn.Name)">ping</a></strong>(net.named_data.jndn.Face face,
net.named_data.jndn.Name name)</code>
@@ -232,7 +239,7 @@
responding to requests.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#pingLocal(net.named_data.jndn.Face)">pingLocal</a></strong>(net.named_data.jndn.Face face)</code>
<div class="block">Ping a forwarder on an existing face to verify that the forwarder is
@@ -241,17 +248,18 @@
same machine as the NDN forwarding daemon.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#register(net.named_data.jndn.Face, net.named_data.jndn.ControlParameters)">register</a></strong>(net.named_data.jndn.Face forwarder,
net.named_data.jndn.ControlParameters controlParameters)</code>
<div class="block">Register a route on the forwarder; see
- http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
- usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
- protocol documentation.</div>
+ <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
+ for command-line usage and
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
+ for protocol documentation.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#register(net.named_data.jndn.Face, int, net.named_data.jndn.Name, int)">register</a></strong>(net.named_data.jndn.Face forwarder,
int faceId,
@@ -261,7 +269,7 @@
is provided a faceId.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#register(net.named_data.jndn.Face, java.lang.String, net.named_data.jndn.Name, int)">register</a></strong>(net.named_data.jndn.Face forwarder,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri,
@@ -271,16 +279,16 @@
forwarder to the given URI/route pair.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>static net.named_data.jndn.Data</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#retrieveDataSet(net.named_data.jndn.Face, net.named_data.jndn.Name)">retrieveDataSet</a></strong>(net.named_data.jndn.Face forwarder,
net.named_data.jndn.Name datasetName)</code>
<div class="block">Build an interest to retrieve a segmented data set from the NFD; for
details on the DataSet, see
- http://redmine.named-data.net/projects/nfd/wiki/StatusDataset</div>
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/StatusDataset">http://redmine.named-data.net/projects/nfd/wiki/StatusDataset</a></div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<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>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#sendCommand(net.named_data.jndn.Face, net.named_data.jndn.Interest)">sendCommand</a></strong>(net.named_data.jndn.Face forwarder,
net.named_data.jndn.Interest interest)</code>
@@ -289,57 +297,62 @@
from the forwarder.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#setStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name, net.named_data.jndn.Name)">setStrategy</a></strong>(net.named_data.jndn.Face forwarder,
net.named_data.jndn.Name prefix,
net.named_data.jndn.Name strategy)</code>
<div class="block">Set a strategy on the forwarder; see
- http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
- usage and http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice
+ <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
+ for command-line usage and
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice">http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice</a>
+ for protocol documentation.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#unregister(net.named_data.jndn.Face, net.named_data.jndn.ControlParameters)">unregister</a></strong>(net.named_data.jndn.Face forwarder,
+ net.named_data.jndn.ControlParameters controlParameters)</code>
+<div class="block">Unregister a route on a forwarder; see
+ <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
+ for command-line usage and
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
for protocol documentation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
-<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#unregister(net.named_data.jndn.Face, net.named_data.jndn.ControlParameters)">unregister</a></strong>(net.named_data.jndn.Face forwarder,
- net.named_data.jndn.ControlParameters controlParameters)</code>
-<div class="block">Unregister a route on a forwarder; see
- http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
- usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
- protocol documentation.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#unregister(net.named_data.jndn.Face, net.named_data.jndn.Name)">unregister</a></strong>(net.named_data.jndn.Face forwarder,
net.named_data.jndn.Name route)</code>
<div class="block">Unregister a route on a forwarder; see
- http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
- usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
- protocol documentation.</div>
+ <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
+ for command-line usage and
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
+ for protocol documentation.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#unregister(net.named_data.jndn.Face, net.named_data.jndn.Name, int)">unregister</a></strong>(net.named_data.jndn.Face forwarder,
net.named_data.jndn.Name route,
int faceId)</code>
<div class="block">Unregister a route on a forwarder; see
- http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
- usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
- protocol documentation.</div>
+ <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
+ for command-line usage and
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
+ for protocol documentation.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#unregister(net.named_data.jndn.Face, net.named_data.jndn.Name, java.lang.String)">unregister</a></strong>(net.named_data.jndn.Face forwarder,
net.named_data.jndn.Name route,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri)</code>
<div class="block">Unregister a route on a forwarder; see
- http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
- usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
- protocol documentation.</div>
+ <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
+ for command-line usage and
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
+ for protocol documentation.</div>
</td>
</tr>
</table>
@@ -420,7 +433,7 @@
working and responding to requests; this version sends a discovery packet
to /localhost/nfd which should always respond if the requestor is on the
same machine as the NDN forwarding daemon.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>face</code> - </dd>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>face</code> - only a localhost Face</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if successful, false otherwise</dd></dl>
</li>
</ul>
@@ -439,6 +452,24 @@
<dt><span class="strong">Returns:</span></dt><dd>true if successful, false otherwise</dd></dl>
</li>
</ul>
+<a name="getForwarderStatus(net.named_data.jndn.Face)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getForwarderStatus</h4>
+<pre>public static <a href="../../../../com/intel/jndn/management/types/ForwarderStatus.html" title="class in com.intel.jndn.management.types">ForwarderStatus</a> getForwarderStatus(net.named_data.jndn.Face forwarder)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">Retrieve the status of the given forwarder; calls /localhost/nfd/status
+ which requires a local Face (all non-local packets are dropped)</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the forwarder status object, see
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/ForwarderStatus">
+ http://redmine.named-data.net/projects/nfd/wiki/ForwarderStatus</a>.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
+</li>
+</ul>
<a name="getFaceList(net.named_data.jndn.Face)">
<!-- -->
</a>
@@ -450,8 +481,9 @@
<div class="block">Retrieve a list of faces and their status from the given forwarder; calls
/localhost/nfd/faces/list which requires a local Face (all non-local
packets are dropped)</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd>
-<dt><span class="strong">Returns:</span></dt><dd></dd>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd>
+<dt><span class="strong">Returns:</span></dt><dd>a list of face status objects, see
+ http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
@@ -467,8 +499,9 @@
<div class="block">Retrieve a list of FIB entries and their NextHopRecords from the given
forwarder; calls /localhost/nfd/fib/list which requires a local Face (all
non-local packets are dropped).</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd>
-<dt><span class="strong">Returns:</span></dt><dd></dd>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd>
+<dt><span class="strong">Returns:</span></dt><dd>a list of FIB entries, see
+ http://redmine.named-data.net/projects/nfd/wiki/FibMgmt#FIB-Dataset.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
@@ -484,8 +517,9 @@
<div class="block">Retrieve a list of routing entries from the RIB; calls
/localhost/nfd/rib/list which requires a local Face (all non-local packets
are dropped).</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd>
-<dt><span class="strong">Returns:</span></dt><dd></dd>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd>
+<dt><span class="strong">Returns:</span></dt><dd>a list of RIB entries, i.e. routes, see
+ http://redmine.named-data.net/projects/nfd/wiki/RibMgmt#RIB-Dataset.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
@@ -501,9 +535,9 @@
net.named_data.jndn.Name prefix)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Helper method to register a new face on the forwarder; as mentioned at
- http://named-data.net/doc/NFD/current/manpages/nfdc.html, this is more for
- debugging; use 'register' instead</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd><dd><code>faceId</code> - </dd><dd><code>prefix</code> - </dd>
+ <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>,
+ this is more for debugging; use 'register' instead</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>faceId</code> - </dd><dd><code>prefix</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
@@ -520,7 +554,7 @@
<div class="block">Create a new face on the given forwarder. Ensure the forwarding face is on
the local machine (management requests are to /localhost/...) and that
command signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd><dd><code>uri</code> - </dd>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>uri</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
@@ -538,7 +572,7 @@
<div class="block">Destroy a face on given forwarder. Ensure the forwarding face is on the
local machine (management requests are to /localhost/...) and that command
signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd><dd><code>faceId</code> - </dd>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>faceId</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
@@ -553,7 +587,7 @@
<a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a> header)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Enable a local control feature on the given forwarder. See
- http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Enable-a-LocalControlHeader-feature</div>
+ <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>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>header</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
@@ -569,7 +603,7 @@
<a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a> header)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Disable a local control feature on the given forwarder. See
- http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Disable-a-LocalControlHeader-feature</div>
+ <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>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>header</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
@@ -585,12 +619,13 @@
net.named_data.jndn.ControlParameters controlParameters)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Register a route on the forwarder; see
- http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
- usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
- protocol documentation. Ensure the forwarding face is on the local machine
- (management requests are to /localhost/...) and that command signing has
- been set up (e.g. forwarder.setCommandSigningInfo()).</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd><dd><code>controlParameters</code> - </dd>
+ <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
+ for command-line usage and
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
+ for protocol documentation. Ensure the forwarding face is on the local
+ machine (management requests are to /localhost/...) and that command
+ signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>controlParameters</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
@@ -609,7 +644,7 @@
<div class="block">Register a route on a forwarder; this will create a new face on the
forwarder to the given URI/route pair. See register(Face,
ControlParameters) for more details documentation.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd><dd><code>uri</code> - </dd><dd><code>cost</code> - </dd><dd><code>route</code> - </dd>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>uri</code> - </dd><dd><code>cost</code> - </dd><dd><code>route</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
@@ -628,7 +663,7 @@
<div class="block">Register a route on a forwarder; this will not create a new face since it
is provided a faceId. See register(Face, ControlParameters) for full
documentation</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd><dd><code>faceId</code> - </dd><dd><code>route</code> - </dd><dd><code>cost</code> - </dd>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>faceId</code> - </dd><dd><code>route</code> - </dd><dd><code>cost</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
@@ -643,11 +678,12 @@
net.named_data.jndn.ControlParameters controlParameters)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Unregister a route on a forwarder; see
- http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
- usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
- protocol documentation. Ensure the forwarding face is on the local machine
- (management requests are to /localhost/...) and that command signing has
- been set up (e.g. forwarder.setCommandSigningInfo()</div>
+ <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
+ for command-line usage and
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
+ for protocol documentation. Ensure the forwarding face is on the local
+ machine (management requests are to /localhost/...) and that command
+ signing has been set up (e.g. forwarder.setCommandSigningInfo()</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>controlParameters</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
@@ -663,11 +699,12 @@
net.named_data.jndn.Name route)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Unregister a route on a forwarder; see
- http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
- usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
- protocol documentation. Ensure the forwarding face is on the local machine
- (management requests are to /localhost/...) and that command signing has
- been set up (e.g. forwarder.setCommandSigningInfo()</div>
+ <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
+ for command-line usage and
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
+ for protocol documentation. Ensure the forwarding face is on the local
+ machine (management requests are to /localhost/...) and that command
+ signing has been set up (e.g. forwarder.setCommandSigningInfo()</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>route</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
@@ -684,11 +721,12 @@
int faceId)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Unregister a route on a forwarder; see
- http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
- usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
- protocol documentation. Ensure the forwarding face is on the local machine
- (management requests are to /localhost/...) and that command signing has
- been set up (e.g. forwarder.setCommandSigningInfo()</div>
+ <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
+ for command-line usage and
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
+ for protocol documentation. Ensure the forwarding face is on the local
+ machine (management requests are to /localhost/...) and that command
+ signing has been set up (e.g. forwarder.setCommandSigningInfo()</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>route</code> - </dd><dd><code>faceId</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
@@ -705,11 +743,12 @@
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Unregister a route on a forwarder; see
- http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
- usage and http://redmine.named-data.net/projects/nfd/wiki/RibMgmt for
- protocol documentation. Ensure the forwarding face is on the local machine
- (management requests are to /localhost/...) and that command signing has
- been set up (e.g. forwarder.setCommandSigningInfo()</div>
+ <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
+ for command-line usage and
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
+ for protocol documentation. Ensure the forwarding face is on the local
+ machine (management requests are to /localhost/...) and that command
+ signing has been set up (e.g. forwarder.setCommandSigningInfo()</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>route</code> - </dd><dd><code>uri</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
@@ -726,12 +765,13 @@
net.named_data.jndn.Name strategy)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Set a strategy on the forwarder; see
- http://named-data.net/doc/NFD/current/manpages/nfdc.html for command-line
- usage and http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice
+ <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
+ for command-line usage and
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice">http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice</a>
for protocol documentation. Ensure the forwarding face is on the local
machine (management requests are to /localhost/...) and that command
signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face</dd><dd><code>prefix</code> - </dd><dd><code>strategy</code> - </dd>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>prefix</code> - </dd><dd><code>strategy</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
@@ -748,7 +788,7 @@
<a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
<div class="block">Build an interest to retrieve a segmented data set from the NFD; for
details on the DataSet, see
- http://redmine.named-data.net/projects/nfd/wiki/StatusDataset</div>
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/StatusDataset">http://redmine.named-data.net/projects/nfd/wiki/StatusDataset</a></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>datasetName</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd></dd>
<dt><span class="strong">Throws:</span></dt>
@@ -772,9 +812,9 @@
from the forwarder. Ensure the forwarding face is on the local machine
(management requests are to /localhost/...) and that command signing has
been set up (e.g. forwarder.setCommandSigningInfo()).</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - Only a localhost Face, command signing info must be set</dd><dd><code>interest</code> - As described at
- http://redmine.named-data.net/projects/nfd/wiki/ControlCommand, the
- requested interest must have encoded ControlParameters appended to the
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face, command signing info must be set</dd><dd><code>interest</code> - As described at
+ <a href="http://redmine.named-data.net/projects/nfd/wiki/ControlCommand,">http://redmine.named-data.net/projects/nfd/wiki/ControlCommand,</a>
+ the requested interest must have encoded ControlParameters appended to the
interest name</dd>
<dt><span class="strong">Returns:</span></dt><dd></dd>
<dt><span class="strong">Throws:</span></dt>