sshconnection.h 3.19 KB
Newer Older
ck's avatar
ck committed
1
2
3
4
/**************************************************************************
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
6
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.nokia.com)
8
9
10
**
**
** GNU Lesser General Public License Usage
ck's avatar
ck committed
11
**
hjk's avatar
hjk committed
12
13
14
15
16
17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21
22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23
24
25
26
27
** 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.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
Tobias Hunger's avatar
Tobias Hunger committed
29
** Nokia at info@qt.nokia.com.
30
**
ck's avatar
ck committed
31
**************************************************************************/
32
33
34
35

#ifndef SSHCONNECTION_H
#define SSHCONNECTION_H

ck's avatar
ck committed
36
37
#include "ssherrors.h"

38
#include <utils/utils_global.h>
39
40
41
42
43
44

#include <QtCore/QByteArray>
#include <QtCore/QObject>
#include <QtCore/QSharedPointer>
#include <QtCore/QString>

45
namespace Utils {
ck's avatar
ck committed
46
47
class SftpChannel;
class SshRemoteProcess;
48
49

namespace Internal {
ck's avatar
ck committed
50
51
class SshConnectionPrivate;
} // namespace Internal
52

53
class QTCREATOR_UTILS_EXPORT SshConnectionParameters
54
{
55
public:
56
    enum ProxyType { DefaultProxy, NoProxy };
Christian Kandeler's avatar
Christian Kandeler committed
57
    enum AuthenticationType { AuthenticationByPassword, AuthenticationByKey };
58
    SshConnectionParameters(ProxyType proxyType);
59

60
    QString host;
61
62
    QString userName;
    QString password;
63
    QString privateKeyFile;
64
    int timeout; // In seconds.
Christian Kandeler's avatar
Christian Kandeler committed
65
    AuthenticationType authenticationType;
66
    quint16 port;
67
    ProxyType proxyType;
68
69
};

70
71
QTCREATOR_UTILS_EXPORT bool operator==(const SshConnectionParameters &p1, const SshConnectionParameters &p2);
QTCREATOR_UTILS_EXPORT bool operator!=(const SshConnectionParameters &p1, const SshConnectionParameters &p2);
72

73
class QTCREATOR_UTILS_EXPORT SshConnection : public QObject
74
75
{
    Q_OBJECT
ck's avatar
ck committed
76
    Q_DISABLE_COPY(SshConnection)
77
public:
ck's avatar
ck committed
78
79
    enum State { Unconnected, Connecting, Connected };
    typedef QSharedPointer<SshConnection> Ptr;
80

81
    static Ptr create(const SshConnectionParameters &serverInfo);
82

83
    void connectToHost();
ck's avatar
ck committed
84
85
86
87
88
89
    void disconnectFromHost();
    State state() const;
    SshError errorState() const;
    QString errorString() const;
    SshConnectionParameters connectionParameters() const;
    ~SshConnection();
90

ck's avatar
ck committed
91
92
    QSharedPointer<SshRemoteProcess> createRemoteProcess(const QByteArray &command);
    QSharedPointer<SftpChannel> createSftpChannel();
93
94

signals:
ck's avatar
ck committed
95
96
97
    void connected();
    void disconnected();
    void dataAvailable(const QString &message);
98
    void error(Utils::SshError);
99
100

private:
101
    SshConnection(const SshConnectionParameters &serverInfo);
102

ck's avatar
ck committed
103
    Internal::SshConnectionPrivate *d;
104
105
};

106
} // namespace Utils
107
108

#endif // SSHCONNECTION_H