src/libs/utils/ssh/sshremoteprocessrunner.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef SSHREMOTEPROCESSRUNNER_H
  34 #define SSHREMOTEPROCESSRUNNER_H
  35
  36 #include "sshconnection.h"
  37 #include "sshremoteprocess.h"
  38
  39 namespace Utils {
  40 class SshRemoteProcessRunnerPrivate;
  41
  42 class QTCREATOR_UTILS_EXPORT SshRemoteProcessRunner : public QObject
  43 {
  44     Q_OBJECT
  45     Q_DISABLE_COPY(SshRemoteProcessRunner)
  46 public:
  47     typedef QSharedPointer<SshRemoteProcessRunner> Ptr;
  48
  49     static Ptr create(const SshConnectionParameters &params);
  50     static Ptr create(const SshConnection::Ptr &connection);
  51
  52     void run(const QByteArray &command);
  53     QByteArray command() const;
  54
  55     SshConnection::Ptr connection() const;
  56     SshRemoteProcess::Ptr process() const;
  57
  58 signals:
  59     void connectionError(Utils::SshError);
  60     void processStarted();
  61     void processOutputAvailable(const QByteArray &output);
  62     void processErrorOutputAvailable(const QByteArray &output);
  63     void processClosed(int exitStatus); // values are of type SshRemoteProcess::ExitStatus
  64
  65 private:
  66     SshRemoteProcessRunner(const SshConnectionParameters &params);
  67     SshRemoteProcessRunner(const SshConnection::Ptr &connection);
  68     void init();
  69
  70     SshRemoteProcessRunnerPrivate *d;
  71 };
  72
  73 } // namespace Utils
  74
  75 #endif // SSHREMOTEPROCESSRUNNER_H