source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.AntRExecClient.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 13.5 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.4.2_13) on Mon Oct 01 14:33:29 NZST 2007 -->
6<TITLE>
7RExecTask.AntRExecClient (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.net.RExecTask.AntRExecClient class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="RExecTask.AntRExecClient (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecRead.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="RExecTask.AntRExecClient.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.optional.net</FONT>
85<BR>
86Class RExecTask.AntRExecClient</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by">RExecClient
90 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.net.RExecTask.AntRExecClient</B>
91</PRE>
92<DL>
93<DT><B>Enclosing class:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.html" title="class in org.apache.tools.ant.taskdefs.optional.net">RExecTask</A></DD>
94</DL>
95<HR>
96<DL>
97<DT>public class <B>RExecTask.AntRExecClient</B><DT>extends RExecClient</DL>
98
99<P>
100This class handles the abstraction of the rexec protocol.
101 Currently it is a wrapper around <a
102 href="http://jakarta.apache.org/commons/net/index.html">Jakarta
103 Commons Net</a>.
104<P>
105
106<P>
107<DL>
108<DT><B>See Also:</B><DD><A HREF="../../../../../../../serialized-form.html#org.apache.tools.ant.taskdefs.optional.net.RExecTask.AntRExecClient">Serialized Form</A></DL>
109<HR>
110
111<P>
112<!-- ======== NESTED CLASS SUMMARY ======== -->
113
114
115<!-- =========== FIELD SUMMARY =========== -->
116
117
118<!-- ======== CONSTRUCTOR SUMMARY ======== -->
119
120<A NAME="constructor_summary"><!-- --></A>
121<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
122<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
123<TD COLSPAN=2><FONT SIZE="+2">
124<B>Constructor Summary</B></FONT></TD>
125</TR>
126<TR BGCOLOR="white" CLASS="TableRowColor">
127<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.AntRExecClient.html#RExecTask.AntRExecClient()">RExecTask.AntRExecClient</A></B>()</CODE>
128
129<BR>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
131</TR>
132</TABLE>
133&nbsp;
134<!-- ========== METHOD SUMMARY =========== -->
135
136<A NAME="method_summary"><!-- --></A>
137<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
138<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
139<TD COLSPAN=2><FONT SIZE="+2">
140<B>Method Summary</B></FONT></TD>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144<CODE>&nbsp;void</CODE></FONT></TD>
145<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.AntRExecClient.html#sendString(java.lang.String, boolean)">sendString</A></B>(java.lang.String&nbsp;s,
146 boolean&nbsp;echoString)</CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Write this string to the rexec session.</TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<CODE>&nbsp;void</CODE></FONT></TD>
154<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.AntRExecClient.html#waitForEOF(java.lang.Integer)">waitForEOF</A></B>(java.lang.Integer&nbsp;timeout)</CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read from the rexec session until the EOF is found or
158 the timeout has been reached</TD>
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/tools/ant/taskdefs/optional/net/RExecTask.AntRExecClient.html#waitForString(java.lang.String)">waitForString</A></B>(java.lang.String&nbsp;s)</CODE>
164
165<BR>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read from the rexec session until the string we are
167 waiting for is found</TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>&nbsp;void</CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.AntRExecClient.html#waitForString(java.lang.String, java.lang.Integer)">waitForString</A></B>(java.lang.String&nbsp;s,
173 java.lang.Integer&nbsp;timeout)</CODE>
174
175<BR>
176&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read from the rexec session until the string we are
177 waiting for is found or the timeout has been reached</TD>
178</TR>
179</TABLE>
180&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
181<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
182<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
183<TD><B>Methods inherited from class java.lang.Object</B></TD>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
187</TR>
188</TABLE>
189&nbsp;
190<P>
191
192<!-- ============ FIELD DETAIL =========== -->
193
194
195<!-- ========= CONSTRUCTOR DETAIL ======== -->
196
197<A NAME="constructor_detail"><!-- --></A>
198<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
199<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
200<TD COLSPAN=1><FONT SIZE="+2">
201<B>Constructor Detail</B></FONT></TD>
202</TR>
203</TABLE>
204
205<A NAME="RExecTask.AntRExecClient()"><!-- --></A><H3>
206RExecTask.AntRExecClient</H3>
207<PRE>
208public <B>RExecTask.AntRExecClient</B>()</PRE>
209<DL>
210</DL>
211
212<!-- ============ METHOD DETAIL ========== -->
213
214<A NAME="method_detail"><!-- --></A>
215<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
216<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
217<TD COLSPAN=1><FONT SIZE="+2">
218<B>Method Detail</B></FONT></TD>
219</TR>
220</TABLE>
221
222<A NAME="waitForString(java.lang.String)"><!-- --></A><H3>
223waitForString</H3>
224<PRE>
225public void <B>waitForString</B>(java.lang.String&nbsp;s)</PRE>
226<DL>
227<DD>Read from the rexec session until the string we are
228 waiting for is found
229<P>
230<DD><DL>
231<DT><B>Parameters:</B><DD><CODE>s</CODE> - The string to wait on</DL>
232</DD>
233</DL>
234<HR>
235
236<A NAME="waitForString(java.lang.String, java.lang.Integer)"><!-- --></A><H3>
237waitForString</H3>
238<PRE>
239public void <B>waitForString</B>(java.lang.String&nbsp;s,
240 java.lang.Integer&nbsp;timeout)</PRE>
241<DL>
242<DD>Read from the rexec session until the string we are
243 waiting for is found or the timeout has been reached
244<P>
245<DD><DL>
246<DT><B>Parameters:</B><DD><CODE>s</CODE> - The string to wait on<DD><CODE>timeout</CODE> - The maximum number of seconds to wait</DL>
247</DD>
248</DL>
249<HR>
250
251<A NAME="sendString(java.lang.String, boolean)"><!-- --></A><H3>
252sendString</H3>
253<PRE>
254public void <B>sendString</B>(java.lang.String&nbsp;s,
255 boolean&nbsp;echoString)</PRE>
256<DL>
257<DD>Write this string to the rexec session.
258<P>
259<DD><DL>
260<DT><B>Parameters:</B><DD><CODE>echoString</CODE> - Logs string sent</DL>
261</DD>
262</DL>
263<HR>
264
265<A NAME="waitForEOF(java.lang.Integer)"><!-- --></A><H3>
266waitForEOF</H3>
267<PRE>
268public void <B>waitForEOF</B>(java.lang.Integer&nbsp;timeout)</PRE>
269<DL>
270<DD>Read from the rexec session until the EOF is found or
271 the timeout has been reached
272<P>
273<DD><DL>
274<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - The maximum number of seconds to wait</DL>
275</DD>
276</DL>
277<!-- ========= END OF CLASS DATA ========= -->
278<HR>
279
280
281<!-- ======= START OF BOTTOM NAVBAR ====== -->
282<A NAME="navbar_bottom"><!-- --></A>
283<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
284<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
285<TR>
286<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
287<A NAME="navbar_bottom_firstrow"><!-- --></A>
288<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
289 <TR ALIGN="center" VALIGN="top">
290 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
291 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
292 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
293 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
294 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
295 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
296 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
297 </TR>
298</TABLE>
299</TD>
300<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
301</EM>
302</TD>
303</TR>
304
305<TR>
306<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
307&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>PREV CLASS</B></A>&nbsp;
308&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecRead.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>NEXT CLASS</B></A></FONT></TD>
309<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
310 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
311&nbsp;<A HREF="RExecTask.AntRExecClient.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
312&nbsp;<SCRIPT type="text/javascript">
313 <!--
314 if(window==top) {
315 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
316 }
317 //-->
318</SCRIPT>
319<NOSCRIPT>
320 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
321</NOSCRIPT>
322
323</FONT></TD>
324</TR>
325<TR>
326<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
327 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
328<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
329DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
330</TR>
331</TABLE>
332<A NAME="skip-navbar_bottom"></A>
333<!-- ======== END OF BOTTOM NAVBAR ======= -->
334
335<HR>
336Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
337</BODY>
338</HTML>
Note: See TracBrowser for help on using the repository browser.