mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-01 13:25:45 +02:00
Code Issues Wiki Activity

Bug 475519 - update javadoc to reflect JSch limitations.

Browse source 
Change-Id: I87609aad6f519211b0f44effbea382665e4b7778
Signed-off-by: Greg Watson <g.watson@computer.org>
This commit is contained in:
Greg Watson 2015-08-20 14:40:20 -04:00
parent 320eeb332e
commit 05775f80cc
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
bundles/org.eclipse.remote.core/src/org/eclipse/remote/core/IRemoteProcess.java
View file

@ -45,6 +45,9 @@ public interface IRemoteProcess {
/** /**
* Gets the error output stream of the process * Gets the error output stream of the process
* *
* Note: some implementations (e.g. JSch) will not work correctly if the remote process generates stdout or stderr but the
* calling thread does not read the corresponding output or error streams.
*
* @return the output stream connected to the standard * @return the output stream connected to the standard
* error of the process * error of the process
*/ */
@ -53,6 +56,9 @@ public interface IRemoteProcess {
/** /**
* Gets an InputStream which can be used to read the standard output stream of the process * Gets an InputStream which can be used to read the standard output stream of the process
* *
* Note: some implementations (e.g. JSch) will not work correctly if the remote process generates stdout or stderr but the
* calling thread does not read the corresponding input or error streams.
*
* @return the input stream connected to the standard * @return the input stream connected to the standard
* output of the process * output of the process
*/ */
@ -89,6 +95,9 @@ public interface IRemoteProcess {
/** /**
* Wait until the process has terminated * Wait until the process has terminated
* *
* Note: some implementations (e.g. JSch) will not work correctly if the remote process generates stdout or stderr but the
* calling thread does not read the corresponding input or error streams.
*
* @return the exit value of the process * @return the exit value of the process
* @throws InterruptedException * @throws InterruptedException
* if the current thread is * if the current thread is
@ -97,7 +106,10 @@ public interface IRemoteProcess {
int waitFor() throws InterruptedException; int waitFor() throws InterruptedException;
/** /**
* Check if the remote process has completed * Check if the remote process has completed.
*
* Note: some implementations (e.g. JSch) will not work correctly if the remote process generates stdout or stderr but the
* calling thread does not read the corresponding input or error streams.
* *
* @return true if remote process has completed * @return true if remote process has completed
*/ */