Gitiles
Code Review Sign In
gerrit.named-data.net / jndn-management / refs/heads/gh-pages / . / com / intel / jndn / management / NdnPingClient.html
blob: 59acb67675eaa725343d698609798cea100fa77d [file] [log] [blame]
Andrew Brownd4d0eda2016-02-22 16:41:07 -0800[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
5<!-- Generated by javadoc (1.8.0_66) on Mon Feb 22 16:40:14 PST 2016 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>NdnPingClient (jndn-management 1.1.0 API)</title>
8<meta name="date" content="2016-02-22">
9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
10<script type="text/javascript" src="../../../../script.js"></script>
11</head>
12<body>
13<script type="text/javascript"><!--
14 try {
15 if (location.href.indexOf('is-external=true') == -1) {
16 parent.document.title="NdnPingClient (jndn-management 1.1.0 API)";
17 }
18 }
19 catch(err) {
20 }
21//-->
22var methods = {"i0":9,"i1":9};
23var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
24var altColor = "altColor";
25var rowColor = "rowColor";
26var tableTab = "tableTab";
27var activeTableTab = "activeTableTab";
28</script>
29<noscript>
30<div>JavaScript is disabled on your browser.</div>
31</noscript>
32<!-- ========= START OF TOP NAVBAR ======= -->
33<div class="topNav"><a name="navbar.top">
34<!-- -->
35</a>
36<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
37<a name="navbar.top.firstrow">
38<!-- -->
39</a>
40<ul class="navList" title="Navigation">
41<li><a href="../../../../overview-summary.html">Overview</a></li>
42<li><a href="package-summary.html">Package</a></li>
43<li class="navBarCell1Rev">Class</li>
44<li><a href="class-use/NdnPingClient.html">Use</a></li>
45<li><a href="package-tree.html">Tree</a></li>
46<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
47<li><a href="../../../../index-all.html">Index</a></li>
48<li><a href="../../../../help-doc.html">Help</a></li>
49</ul>
50</div>
51<div class="subNav">
52<ul class="navList">
53<li><a href="../../../../com/intel/jndn/management/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/Nfdc.html" title="class in com.intel.jndn.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
55</ul>
56<ul class="navList">
57<li><a href="../../../../index.html?com/intel/jndn/management/NdnPingClient.html" target="_top">Frames</a></li>
58<li><a href="NdnPingClient.html" target="_top">No&nbsp;Frames</a></li>
59</ul>
60<ul class="navList" id="allclasses_navbar_top">
61<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
62</ul>
63<div>
64<script type="text/javascript"><!--
65 allClassesLink = document.getElementById("allclasses_navbar_top");
66 if(window==top) {
67 allClassesLink.style.display = "block";
68 }
69 else {
70 allClassesLink.style.display = "none";
71 }
72 //-->
73</script>
74</div>
75<div>
76<ul class="subNavList">
77<li>Summary:&nbsp;</li>
78<li>Nested&nbsp;|&nbsp;</li>
79<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
80<li>Constr&nbsp;|&nbsp;</li>
81<li><a href="#method.summary">Method</a></li>
82</ul>
83<ul class="subNavList">
84<li>Detail:&nbsp;</li>
85<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
86<li>Constr&nbsp;|&nbsp;</li>
87<li><a href="#method.detail">Method</a></li>
88</ul>
89</div>
90<a name="skip.navbar.top">
91<!-- -->
92</a></div>
93<!-- ========= END OF TOP NAVBAR ========= -->
94<!-- ======== START OF CLASS DATA ======== -->
95<div class="header">
96<div class="subTitle">com.intel.jndn.management</div>
97<h2 title="Class NdnPingClient" class="title">Class NdnPingClient</h2>
98</div>
99<div class="contentContainer">
100<ul class="inheritance">
101<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
102<li>
103<ul class="inheritance">
104<li>com.intel.jndn.management.NdnPingClient</li>
105</ul>
106</li>
107</ul>
108<div class="description">
109<ul class="blockList">
110<li class="blockList">
111<hr>
112<br>
113<pre>public final class <span class="typeNameLabel">NdnPingClient</span>
114extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
115<div class="block">Simplistic checker for live connection to NFD forwarder.</div>
116</li>
117</ul>
118</div>
119<div class="summary">
120<ul class="blockList">
121<li class="blockList">
122<!-- =========== FIELD SUMMARY =========== -->
123<ul class="blockList">
124<li class="blockList"><a name="field.summary">
125<!-- -->
126</a>
127<h3>Field Summary</h3>
128<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
129<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
130<tr>
131<th class="colFirst" scope="col">Modifier and Type</th>
132<th class="colLast" scope="col">Field and Description</th>
133</tr>
134<tr class="altColor">
135<td class="colFirst"><code>static long</code></td>
136<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NdnPingClient.html#DEFAULT_TIMEOUT">DEFAULT_TIMEOUT</a></span></code>&nbsp;</td>
137</tr>
138</table>
139</li>
140</ul>
141<!-- ========== METHOD SUMMARY =========== -->
142<ul class="blockList">
143<li class="blockList"><a name="method.summary">
144<!-- -->
145</a>
146<h3>Method Summary</h3>
147<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
148<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>
149<tr>
150<th class="colFirst" scope="col">Modifier and Type</th>
151<th class="colLast" scope="col">Method and Description</th>
152</tr>
153<tr id="i0" class="altColor">
154<td class="colFirst"><code>static boolean</code></td>
155<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NdnPingClient.html#ping-net.named_data.jndn.Face-net.named_data.jndn.Name-">ping</a></span>(net.named_data.jndn.Face&nbsp;face,
156 net.named_data.jndn.Name&nbsp;name)</code>
157<div class="block">Request a name on an existing face to verify the forwarder is working and
158 responding to requests.</div>
159</td>
160</tr>
161<tr id="i1" class="rowColor">
162<td class="colFirst"><code>static boolean</code></td>
163<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/NdnPingClient.html#pingLocal-net.named_data.jndn.Face-">pingLocal</a></span>(net.named_data.jndn.Face&nbsp;face)</code>
164<div class="block">Ping a forwarder on an existing face to verify that the forwarder is
165 working and responding to requests; this version sends a discovery packet
166 to /localhost/nfd which should always respond if the requestor is on the
167 same machine as the NDN forwarding daemon.</div>
168</td>
169</tr>
170</table>
171<ul class="blockList">
172<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
173<!-- -->
174</a>
175<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>
176<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>
177</ul>
178</li>
179</ul>
180</li>
181</ul>
182</div>
183<div class="details">
184<ul class="blockList">
185<li class="blockList">
186<!-- ============ FIELD DETAIL =========== -->
187<ul class="blockList">
188<li class="blockList"><a name="field.detail">
189<!-- -->
190</a>
191<h3>Field Detail</h3>
192<a name="DEFAULT_TIMEOUT">
193<!-- -->
194</a>
195<ul class="blockListLast">
196<li class="blockList">
197<h4>DEFAULT_TIMEOUT</h4>
198<pre>public static final&nbsp;long DEFAULT_TIMEOUT</pre>
199<dl>
200<dt><span class="seeLabel">See Also:</span></dt>
201<dd><a href="../../../../constant-values.html#com.intel.jndn.management.NdnPingClient.DEFAULT_TIMEOUT">Constant Field Values</a></dd>
202</dl>
203</li>
204</ul>
205</li>
206</ul>
207<!-- ============ METHOD DETAIL ========== -->
208<ul class="blockList">
209<li class="blockList"><a name="method.detail">
210<!-- -->
211</a>
212<h3>Method Detail</h3>
213<a name="pingLocal-net.named_data.jndn.Face-">
214<!-- -->
215</a>
216<ul class="blockList">
217<li class="blockList">
218<h4>pingLocal</h4>
219<pre>public static&nbsp;boolean&nbsp;pingLocal(net.named_data.jndn.Face&nbsp;face)</pre>
220<div class="block">Ping a forwarder on an existing face to verify that the forwarder is
221 working and responding to requests; this version sends a discovery packet
222 to /localhost/nfd which should always respond if the requestor is on the
223 same machine as the NDN forwarding daemon.</div>
224<dl>
225<dt><span class="paramLabel">Parameters:</span></dt>
226<dd><code>face</code> - only a localhost Face</dd>
227<dt><span class="returnLabel">Returns:</span></dt>
228<dd>true if successful, false otherwise</dd>
229</dl>
230</li>
231</ul>
232<a name="ping-net.named_data.jndn.Face-net.named_data.jndn.Name-">
233<!-- -->
234</a>
235<ul class="blockListLast">
236<li class="blockList">
237<h4>ping</h4>
238<pre>public static&nbsp;boolean&nbsp;ping(net.named_data.jndn.Face&nbsp;face,
239 net.named_data.jndn.Name&nbsp;name)</pre>
240<div class="block">Request a name on an existing face to verify the forwarder is working and
241 responding to requests. Note that the name must be served or cached on the
242 forwarder for this to return true.</div>
243<dl>
244<dt><span class="paramLabel">Parameters:</span></dt>
245<dd><code>face</code> - a <code>Face</code> to ping</dd>
246<dd><code>name</code> - a known <code>Name</code> that the remote node will answer to</dd>
247<dt><span class="returnLabel">Returns:</span></dt>
248<dd>true if successful, false otherwise</dd>
249</dl>
250</li>
251</ul>
252</li>
253</ul>
254</li>
255</ul>
256</div>
257</div>
258<!-- ========= END OF CLASS DATA ========= -->
259<!-- ======= START OF BOTTOM NAVBAR ====== -->
260<div class="bottomNav"><a name="navbar.bottom">
261<!-- -->
262</a>
263<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
264<a name="navbar.bottom.firstrow">
265<!-- -->
266</a>
267<ul class="navList" title="Navigation">
268<li><a href="../../../../overview-summary.html">Overview</a></li>
269<li><a href="package-summary.html">Package</a></li>
270<li class="navBarCell1Rev">Class</li>
271<li><a href="class-use/NdnPingClient.html">Use</a></li>
272<li><a href="package-tree.html">Tree</a></li>
273<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
274<li><a href="../../../../index-all.html">Index</a></li>
275<li><a href="../../../../help-doc.html">Help</a></li>
276</ul>
277</div>
278<div class="subNav">
279<ul class="navList">
280<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>
281<li><a href="../../../../com/intel/jndn/management/Nfdc.html" title="class in com.intel.jndn.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
282</ul>
283<ul class="navList">
284<li><a href="../../../../index.html?com/intel/jndn/management/NdnPingClient.html" target="_top">Frames</a></li>
285<li><a href="NdnPingClient.html" target="_top">No&nbsp;Frames</a></li>
286</ul>
287<ul class="navList" id="allclasses_navbar_bottom">
288<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
289</ul>
290<div>
291<script type="text/javascript"><!--
292 allClassesLink = document.getElementById("allclasses_navbar_bottom");
293 if(window==top) {
294 allClassesLink.style.display = "block";
295 }
296 else {
297 allClassesLink.style.display = "none";
298 }
299 //-->
300</script>
301</div>
302<div>
303<ul class="subNavList">
304<li>Summary:&nbsp;</li>
305<li>Nested&nbsp;|&nbsp;</li>
306<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
307<li>Constr&nbsp;|&nbsp;</li>
308<li><a href="#method.summary">Method</a></li>
309</ul>
310<ul class="subNavList">
311<li>Detail:&nbsp;</li>
312<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
313<li>Constr&nbsp;|&nbsp;</li>
314<li><a href="#method.detail">Method</a></li>
315</ul>
316</div>
317<a name="skip.navbar.bottom">
318<!-- -->
319</a></div>
320<!-- ======== END OF BOTTOM NAVBAR ======= -->
321<p class="legalCopy"><small>Copyright &#169; 2016. All rights reserved.</small></p>
322</body>
323</html>