Files
qt-creator/src/libs/utils/ssh/sshremoteprocess.h
Christian Kandeler 57c0979012 SSH: Support different read channels in SshRemoteProcess.
This is part of the effort to support more QProcess concepts.

Change-Id: Idb888e733570a58d3810f371409b657b30bbd929
Reviewed-by: hjk <qthjk@ovi.com>
2011-11-29 14:00:39 +01:00

141 lines
4.1 KiB
C++

/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Lesser General Public License Usage
**
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**************************************************************************/
#ifndef SSHREMOTECOMMAND_H
#define SSHREMOTECOMMAND_H
#include <utils/utils_global.h>
#include <QtCore/QProcess>
#include <QtCore/QSharedPointer>
QT_BEGIN_NAMESPACE
class QByteArray;
QT_END_NAMESPACE
namespace Utils {
class SshPseudoTerminal;
namespace Internal {
class SshChannelManager;
class SshRemoteProcessPrivate;
class SshSendFacility;
} // namespace Internal
// TODO: ProcessChannel
class QTCREATOR_UTILS_EXPORT SshRemoteProcess : public QIODevice
{
Q_OBJECT
friend class Internal::SshChannelManager;
friend class Internal::SshRemoteProcessPrivate;
public:
typedef QSharedPointer<SshRemoteProcess> Ptr;
enum ExitStatus { FailedToStart, KilledBySignal, ExitedNormally };
static const QByteArray AbrtSignal;
static const QByteArray AlrmSignal;
static const QByteArray FpeSignal;
static const QByteArray HupSignal;
static const QByteArray IllSignal;
static const QByteArray IntSignal;
static const QByteArray KillSignal;
static const QByteArray PipeSignal;
static const QByteArray QuitSignal;
static const QByteArray SegvSignal;
static const QByteArray TermSignal;
static const QByteArray Usr1Signal;
static const QByteArray Usr2Signal;
~SshRemoteProcess();
// QIODevice stuff
bool atEnd() const;
qint64 bytesAvailable() const;
bool canReadLine() const;
void close();
bool isSequential() const { return true; }
QProcess::ProcessChannel readChannel() const;
void setReadChannel(QProcess::ProcessChannel channel);
/*
* Note that this is of limited value in practice, because servers are
* usually configured to ignore such requests for security reasons.
*/
void addToEnvironment(const QByteArray &var, const QByteArray &value);
void requestTerminal(const SshPseudoTerminal &terminal);
void start();
bool isRunning() const;
int exitCode() const;
QByteArray exitSignal() const;
QByteArray readAllStandardOutput();
QByteArray readAllStandardError();
// Note: This is ignored by the OpenSSH server.
void sendSignal(const QByteArray &signal);
void kill() { sendSignal(KillSignal); }
signals:
void started();
void readyReadStandardOutput();
void readyReadStandardError();
/*
* Parameter is of type ExitStatus, but we use int because of
* signal/slot awkwardness (full namespace required).
*/
void closed(int exitStatus);
private:
SshRemoteProcess(const QByteArray &command, quint32 channelId,
Internal::SshSendFacility &sendFacility);
SshRemoteProcess(quint32 channelId, Internal::SshSendFacility &sendFacility);
// QIODevice stuff
qint64 readData(char *data, qint64 maxlen);
qint64 writeData(const char *data, qint64 len);
void init();
QByteArray readAllFromChannel(QProcess::ProcessChannel channel);
Internal::SshRemoteProcessPrivate *d;
};
} // namespace Utils
#endif // SSHREMOTECOMMAND_H