LoginManager.h

Go to the documentation of this file.

/*****************************************************************************
 *
 * Copyright (C) 2009-2023  Bjarne von Horn <vh@igh.de>
 *
 * This file is part of the QtPdCom library.
 *
 * The QtPdCom library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * The QtPdCom library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with the QtPdCom Library. If not, see <http://www.gnu.org/licenses/>.
 *
 ****************************************************************************/
 
#ifndef QTPDCOM_LOGINMANAGER_H
#define QTPDCOM_LOGINMANAGER_H
 
#include "Export.h"
 
#include <QObject>
#include <QScopedPointer>
#include <QString>
 
namespace QtPdCom {
 
class LoginManagerPrivate;
class Process;

class QTPDCOM_PUBLIC LoginManager: public QObject
{
    Q_OBJECT
 
  public:
    explicit LoginManager(QString server_name = QString(), QObject *parent = nullptr);
    ~LoginManager();

    Q_INVOKABLE void setAuthName(QString name);
    Q_INVOKABLE void setPassword(QString password);

    Q_INVOKABLE void clearCredentials();

    Q_INVOKABLE void login();
    Q_INVOKABLE void logout();
 
    /* Retrieve reason for login failure.
     */
    Q_INVOKABLE QString getErrorMessage();

    static void InitLibrary(const char *plugin_path = nullptr);
    static void FinalizeLibrary();
 
  signals:

    void needCredentials();
    void loginSuccessful();
    void loginFailed();
 
  private:
    Q_DECLARE_PRIVATE(LoginManager);
    Q_DISABLE_COPY(LoginManager);
    LoginManager& operator=(LoginManager&&) = delete;
    LoginManager(LoginManager&&) = delete;
 
    QScopedPointer<LoginManagerPrivate> d_ptr;
    friend Process;
};
 
}  // namespace QtPdCom
 
#endif  // QTPDCOM_LOGINMANAGER_H