qt-creator/src/libs/ssh/sshconnectionmanager.h

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/

#pragma once

#include "ssh_global.h"

#include <utils/launcherinterface.h>
#include <utils/singleton.h>

namespace QSsh {

class SshConnection;
class SshConnectionParameters;

namespace Internal { class SshConnectionManagerPrivate; }

class QSSH_EXPORT SshConnectionManager final
        : public Utils::SingletonWithOptionalDependencies<SshConnectionManager,
                                                          Utils::LauncherInterface>
{
public:
    static SshConnection *acquireConnection(const SshConnectionParameters &sshParams);
    static void releaseConnection(SshConnection *connection);
    // Make sure the next acquireConnection with the given parameters will return a new connection.
    static void forceNewConnection(const SshConnectionParameters &sshParams);

private:
    SshConnectionManager();
    ~SshConnectionManager();

    Internal::SshConnectionManagerPrivate *d;
    friend class Utils::SingletonWithOptionalDependencies<SshConnectionManager, Utils::LauncherInterface>;
};

} // namespace QSsh