source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/util/ProcfsBasedProcessTree.html @ 120

Last change on this file since 120 was 120, checked in by (none), 14 years ago

Added the mail files for the Hadoop JUNit Project
  • Property svn:executable set to *
File size: 22.1 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_07) on Tue Sep 01 20:56:55 UTC 2009 -->
6<TITLE>
7ProcfsBasedProcessTree (Hadoop 0.20.1 API)
8</TITLE>
9
10<META NAME="date" CONTENT="2009-09-01">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="ProcfsBasedProcessTree (Hadoop 0.20.1 API)";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ProcfsBasedProcessTree.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52</EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;<A HREF="../../../../org/apache/hadoop/util/PriorityQueue.html" title="class in org.apache.hadoop.util"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/hadoop/util/ProgramDriver.html" title="class in org.apache.hadoop.util"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../index.html?org/apache/hadoop/util/ProcfsBasedProcessTree.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="ProcfsBasedProcessTree.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77<TR>
78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82</TR>
83</TABLE>
84<A NAME="skip-navbar_top"></A>
85<!-- ========= END OF TOP NAVBAR ========= -->
86
87<HR>
88<!-- ======== START OF CLASS DATA ======== -->
89<H2>
90<FONT SIZE="-1">
91org.apache.hadoop.util</FONT>
92<BR>
93Class ProcfsBasedProcessTree</H2>
94<PRE>
95<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.hadoop.util.ProcfsBasedProcessTree</B>
97</PRE>
98<HR>
99<DL>
100<DT><PRE>public class <B>ProcfsBasedProcessTree</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
101</PRE>
102
103<P>
104A Proc file-system based ProcessTree. Works only on Linux.
105<P>
106
107<P>
108<HR>
109
110<P>
111<!-- =========== FIELD SUMMARY =========== -->
112
113<A NAME="field_summary"><!-- --></A>
114<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
115<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
116<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
117<B>Field Summary</B></FONT></TH>
118</TR>
119<TR BGCOLOR="white" CLASS="TableRowColor">
120<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
121<CODE>static&nbsp;long</CODE></FONT></TD>
122<TD><CODE><B><A HREF="../../../../org/apache/hadoop/util/ProcfsBasedProcessTree.html#DEFAULT_SLEEPTIME_BEFORE_SIGKILL">DEFAULT_SLEEPTIME_BEFORE_SIGKILL</A></B></CODE>
123
124<BR>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
126</TR>
127</TABLE>
128&nbsp;
129<!-- ======== CONSTRUCTOR SUMMARY ======== -->
130
131<A NAME="constructor_summary"><!-- --></A>
132<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
133<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
134<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
135<B>Constructor Summary</B></FONT></TH>
136</TR>
137<TR BGCOLOR="white" CLASS="TableRowColor">
138<TD><CODE><B><A HREF="../../../../org/apache/hadoop/util/ProcfsBasedProcessTree.html#ProcfsBasedProcessTree(java.lang.String)">ProcfsBasedProcessTree</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;pid)</CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD><CODE><B><A HREF="../../../../org/apache/hadoop/util/ProcfsBasedProcessTree.html#ProcfsBasedProcessTree(java.lang.String, java.lang.String)">ProcfsBasedProcessTree</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;pid,
145                       <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;procfsDir)</CODE>
146
147<BR>
148&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
149</TR>
150</TABLE>
151&nbsp;
152<!-- ========== METHOD SUMMARY =========== -->
153
154<A NAME="method_summary"><!-- --></A>
155<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
156<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
157<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
158<B>Method Summary</B></FONT></TH>
159</TR>
160<TR BGCOLOR="white" CLASS="TableRowColor">
161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162<CODE>&nbsp;void</CODE></FONT></TD>
163<TD><CODE><B><A HREF="../../../../org/apache/hadoop/util/ProcfsBasedProcessTree.html#destroy()">destroy</A></B>()</CODE>
164
165<BR>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Destroy the process-tree.</TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170<CODE>&nbsp;long</CODE></FONT></TD>
171<TD><CODE><B><A HREF="../../../../org/apache/hadoop/util/ProcfsBasedProcessTree.html#getCumulativeVmem()">getCumulativeVmem</A></B>()</CODE>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the cumulative virtual memory used by all the processes in the
175 process-tree.</TD>
176</TR>
177<TR BGCOLOR="white" CLASS="TableRowColor">
178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179<CODE>&nbsp;long</CODE></FONT></TD>
180<TD><CODE><B><A HREF="../../../../org/apache/hadoop/util/ProcfsBasedProcessTree.html#getCumulativeVmem(int)">getCumulativeVmem</A></B>(int&nbsp;olderThanAge)</CODE>
181
182<BR>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the cumulative virtual memory used by all the processes in the
184 process-tree that are older than the passed in age.</TD>
185</TR>
186<TR BGCOLOR="white" CLASS="TableRowColor">
187<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188<CODE>static&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
189<TD><CODE><B><A HREF="../../../../org/apache/hadoop/util/ProcfsBasedProcessTree.html#getPidFromPidFile(java.lang.String)">getPidFromPidFile</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;pidFileName)</CODE>
190
191<BR>
192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get PID from a pid-file.</TD>
193</TR>
194<TR BGCOLOR="white" CLASS="TableRowColor">
195<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196<CODE>&nbsp;<A HREF="../../../../org/apache/hadoop/util/ProcfsBasedProcessTree.html" title="class in org.apache.hadoop.util">ProcfsBasedProcessTree</A></CODE></FONT></TD>
197<TD><CODE><B><A HREF="../../../../org/apache/hadoop/util/ProcfsBasedProcessTree.html#getProcessTree()">getProcessTree</A></B>()</CODE>
198
199<BR>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the process-tree with latest state.</TD>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204<CODE>&nbsp;boolean</CODE></FONT></TD>
205<TD><CODE><B><A HREF="../../../../org/apache/hadoop/util/ProcfsBasedProcessTree.html#isAlive()">isAlive</A></B>()</CODE>
206
207<BR>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Is the process-tree alive? Currently we care only about the status of the
209 root-process.</TD>
210</TR>
211<TR BGCOLOR="white" CLASS="TableRowColor">
212<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
213<CODE>static&nbsp;boolean</CODE></FONT></TD>
214<TD><CODE><B><A HREF="../../../../org/apache/hadoop/util/ProcfsBasedProcessTree.html#isAvailable()">isAvailable</A></B>()</CODE>
215
216<BR>
217&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks if the ProcfsBasedProcessTree is available on this system.</TD>
218</TR>
219<TR BGCOLOR="white" CLASS="TableRowColor">
220<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
221<CODE>&nbsp;void</CODE></FONT></TD>
222<TD><CODE><B><A HREF="../../../../org/apache/hadoop/util/ProcfsBasedProcessTree.html#setSigKillInterval(long)">setSigKillInterval</A></B>(long&nbsp;interval)</CODE>
223
224<BR>
225&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
226</TR>
227<TR BGCOLOR="white" CLASS="TableRowColor">
228<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
229<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
230<TD><CODE><B><A HREF="../../../../org/apache/hadoop/util/ProcfsBasedProcessTree.html#toString()">toString</A></B>()</CODE>
231
232<BR>
233&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string printing PIDs of process present in the
234 ProcfsBasedProcessTree.</TD>
235</TR>
236</TABLE>
237&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
238<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
239<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
240<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
241</TR>
242<TR BGCOLOR="white" CLASS="TableRowColor">
243<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/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://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
244</TR>
245</TABLE>
246&nbsp;
247<P>
248
249<!-- ============ FIELD DETAIL =========== -->
250
251<A NAME="field_detail"><!-- --></A>
252<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
253<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
254<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
255<B>Field Detail</B></FONT></TH>
256</TR>
257</TABLE>
258
259<A NAME="DEFAULT_SLEEPTIME_BEFORE_SIGKILL"><!-- --></A><H3>
260DEFAULT_SLEEPTIME_BEFORE_SIGKILL</H3>
261<PRE>
262public static final long <B>DEFAULT_SLEEPTIME_BEFORE_SIGKILL</B></PRE>
263<DL>
264<DL>
265<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.hadoop.util.ProcfsBasedProcessTree.DEFAULT_SLEEPTIME_BEFORE_SIGKILL">Constant Field Values</A></DL>
266</DL>
267
268<!-- ========= CONSTRUCTOR DETAIL ======== -->
269
270<A NAME="constructor_detail"><!-- --></A>
271<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
272<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
273<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
274<B>Constructor Detail</B></FONT></TH>
275</TR>
276</TABLE>
277
278<A NAME="ProcfsBasedProcessTree(java.lang.String)"><!-- --></A><H3>
279ProcfsBasedProcessTree</H3>
280<PRE>
281public <B>ProcfsBasedProcessTree</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;pid)</PRE>
282<DL>
283</DL>
284<HR>
285
286<A NAME="ProcfsBasedProcessTree(java.lang.String, java.lang.String)"><!-- --></A><H3>
287ProcfsBasedProcessTree</H3>
288<PRE>
289public <B>ProcfsBasedProcessTree</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;pid,
290                              <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;procfsDir)</PRE>
291<DL>
292</DL>
293
294<!-- ============ METHOD DETAIL ========== -->
295
296<A NAME="method_detail"><!-- --></A>
297<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
298<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
299<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
300<B>Method Detail</B></FONT></TH>
301</TR>
302</TABLE>
303
304<A NAME="setSigKillInterval(long)"><!-- --></A><H3>
305setSigKillInterval</H3>
306<PRE>
307public void <B>setSigKillInterval</B>(long&nbsp;interval)</PRE>
308<DL>
309<DD><DL>
310</DL>
311</DD>
312</DL>
313<HR>
314
315<A NAME="isAvailable()"><!-- --></A><H3>
316isAvailable</H3>
317<PRE>
318public static boolean <B>isAvailable</B>()</PRE>
319<DL>
320<DD>Checks if the ProcfsBasedProcessTree is available on this system.
321<P>
322<DD><DL>
323
324<DT><B>Returns:</B><DD>true if ProcfsBasedProcessTree is available. False otherwise.</DL>
325</DD>
326</DL>
327<HR>
328
329<A NAME="getProcessTree()"><!-- --></A><H3>
330getProcessTree</H3>
331<PRE>
332public <A HREF="../../../../org/apache/hadoop/util/ProcfsBasedProcessTree.html" title="class in org.apache.hadoop.util">ProcfsBasedProcessTree</A> <B>getProcessTree</B>()</PRE>
333<DL>
334<DD>Get the process-tree with latest state. If the root-process is not alive,
335 an empty tree will be returned.
336<P>
337<DD><DL>
338
339<DT><B>Returns:</B><DD>the process-tree with latest state.</DL>
340</DD>
341</DL>
342<HR>
343
344<A NAME="isAlive()"><!-- --></A><H3>
345isAlive</H3>
346<PRE>
347public boolean <B>isAlive</B>()</PRE>
348<DL>
349<DD>Is the process-tree alive? Currently we care only about the status of the
350 root-process.
351<P>
352<DD><DL>
353
354<DT><B>Returns:</B><DD>true if the process-true is alive, false otherwise.</DL>
355</DD>
356</DL>
357<HR>
358
359<A NAME="destroy()"><!-- --></A><H3>
360destroy</H3>
361<PRE>
362public void <B>destroy</B>()</PRE>
363<DL>
364<DD>Destroy the process-tree. Currently we only make sure the root process is
365 gone. It is the responsibility of the root process to make sure that all
366 its descendants are cleaned up.
367<P>
368<DD><DL>
369</DL>
370</DD>
371</DL>
372<HR>
373
374<A NAME="getCumulativeVmem()"><!-- --></A><H3>
375getCumulativeVmem</H3>
376<PRE>
377public long <B>getCumulativeVmem</B>()</PRE>
378<DL>
379<DD>Get the cumulative virtual memory used by all the processes in the
380 process-tree.
381<P>
382<DD><DL>
383
384<DT><B>Returns:</B><DD>cumulative virtual memory used by the process-tree in bytes.</DL>
385</DD>
386</DL>
387<HR>
388
389<A NAME="getCumulativeVmem(int)"><!-- --></A><H3>
390getCumulativeVmem</H3>
391<PRE>
392public long <B>getCumulativeVmem</B>(int&nbsp;olderThanAge)</PRE>
393<DL>
394<DD>Get the cumulative virtual memory used by all the processes in the
395 process-tree that are older than the passed in age.
396<P>
397<DD><DL>
398<DT><B>Parameters:</B><DD><CODE>olderThanAge</CODE> - processes above this age are included in the
399                      memory addition
400<DT><B>Returns:</B><DD>cumulative virtual memory used by the process-tree in bytes,
401          for processes older than this age.</DL>
402</DD>
403</DL>
404<HR>
405
406<A NAME="getPidFromPidFile(java.lang.String)"><!-- --></A><H3>
407getPidFromPidFile</H3>
408<PRE>
409public static <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getPidFromPidFile</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;pidFileName)</PRE>
410<DL>
411<DD>Get PID from a pid-file.
412<P>
413<DD><DL>
414<DT><B>Parameters:</B><DD><CODE>pidFileName</CODE> - Name of the pid-file.
415<DT><B>Returns:</B><DD>the PID string read from the pid-file. Returns null if the
416         pidFileName points to a non-existing file or if read fails from the
417         file.</DL>
418</DD>
419</DL>
420<HR>
421
422<A NAME="toString()"><!-- --></A><H3>
423toString</H3>
424<PRE>
425public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
426<DL>
427<DD>Returns a string printing PIDs of process present in the
428 ProcfsBasedProcessTree. Output format : [pid pid ..]
429<P>
430<DD><DL>
431<DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
432</DD>
433<DD><DL>
434</DL>
435</DD>
436</DL>
437<!-- ========= END OF CLASS DATA ========= -->
438<HR>
439
440
441<!-- ======= START OF BOTTOM NAVBAR ====== -->
442<A NAME="navbar_bottom"><!-- --></A>
443<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
444<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
445<TR>
446<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
447<A NAME="navbar_bottom_firstrow"><!-- --></A>
448<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
449  <TR ALIGN="center" VALIGN="top">
450  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
451  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
452  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
453  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ProcfsBasedProcessTree.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
454  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
455  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
456  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
457  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
458  </TR>
459</TABLE>
460</TD>
461<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
462</EM>
463</TD>
464</TR>
465
466<TR>
467<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
468&nbsp;<A HREF="../../../../org/apache/hadoop/util/PriorityQueue.html" title="class in org.apache.hadoop.util"><B>PREV CLASS</B></A>&nbsp;
469&nbsp;<A HREF="../../../../org/apache/hadoop/util/ProgramDriver.html" title="class in org.apache.hadoop.util"><B>NEXT CLASS</B></A></FONT></TD>
470<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
471  <A HREF="../../../../index.html?org/apache/hadoop/util/ProcfsBasedProcessTree.html" target="_top"><B>FRAMES</B></A>  &nbsp;
472&nbsp;<A HREF="ProcfsBasedProcessTree.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
473&nbsp;<SCRIPT type="text/javascript">
474  <!--
475  if(window==top) {
476    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
477  }
478  //-->
479</SCRIPT>
480<NOSCRIPT>
481  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
482</NOSCRIPT>
483
484
485</FONT></TD>
486</TR>
487<TR>
488<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
489  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
490<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
491DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
492</TR>
493</TABLE>
494<A NAME="skip-navbar_bottom"></A>
495<!-- ======== END OF BOTTOM NAVBAR ======= -->
496
497<HR>
498Copyright &copy; 2009 The Apache Software Foundation
499</BODY>
500</HTML>
Note: See TracBrowser for help on using the repository browser.