diff options
Diffstat (limited to 'src/libs/utils/ssh/sshremoteprocess.cpp')
| -rw-r--r-- | src/libs/utils/ssh/sshremoteprocess.cpp | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/src/libs/utils/ssh/sshremoteprocess.cpp b/src/libs/utils/ssh/sshremoteprocess.cpp index b6d71167a3..769d4ff56d 100644 --- a/src/libs/utils/ssh/sshremoteprocess.cpp +++ b/src/libs/utils/ssh/sshremoteprocess.cpp @@ -41,6 +41,26 @@ #include <QtCore/QTimer> +/*! + \class SshRemoteProcess + + \brief This class implements an SSH channel for running a remote process. + + Objects are created via SshConnection::createRemoteProcess. + The process is started via the start() member function. + A closeChannel() function is provided, but rarely useful, because + + \list + \i a) when the process ends, the channel is closed automatically, and + \i b) closing a channel will not necessarily kill the remote process. + \endlist + + Therefore, the only sensible use case for calling closeChannel() is to + get rid of an SshRemoteProces object before the process is actually started. + Note that the process does not have a terminal, so you can't use it + for applications that require one. + */ + namespace Utils { const QByteArray SshRemoteProcess::AbrtSignal("ABRT"); |