QXmppClient.h

/*
 * Copyright (C) 2008-2020 The QXmpp developers
 *
 * Author:
 *  Manjeet Dahiya
 *
 * Source:
 *  https://github.com/qxmpp-project/qxmpp
 *
 * This file is a part of QXmpp library.
 *
 * This 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 2.1 of the License, or (at your option) any later version.
 *
 * This 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.
 *
 */
 
#ifndef QXMPPCLIENT_H
#define QXMPPCLIENT_H
 
#include "QXmppConfiguration.h"
#include "QXmppLogger.h"
#include "QXmppPresence.h"
 
#include <QAbstractSocket>
#include <QObject>
 
class QSslError;
 
class QXmppClientExtension;
class QXmppClientPrivate;
class QXmppPresence;
class QXmppMessage;
class QXmppIq;
class QXmppStream;
class QXmppInternalClientExtension;
 
// managers
class QXmppDiscoveryIq;
class QXmppRosterManager;
class QXmppVCardManager;
class QXmppVersionManager;
 
 
 
 
class QXMPP_EXPORT QXmppClient : public QXmppLoggable
{
    Q_OBJECT
 
    Q_PROPERTY(QXmppLogger *logger READ logger WRITE setLogger NOTIFY loggerChanged)
    Q_PROPERTY(State state READ state NOTIFY stateChanged)
 
public:
    enum Error {
        NoError,          
        SocketError,      
        KeepAliveError,   
        XmppStreamError,  
    };
    Q_ENUM(Error)
 
    
    enum State {
        DisconnectedState,  
        ConnectingState,    
        ConnectedState      
    };
    Q_ENUM(State)
 
    QXmppClient(QObject *parent = nullptr);
    ~QXmppClient() override;
 
    bool addExtension(QXmppClientExtension *extension);
    bool insertExtension(int index, QXmppClientExtension *extension);
    bool removeExtension(QXmppClientExtension *extension);
 
    QList<QXmppClientExtension *> extensions();
 
    template<typename T>
    T *findExtension()
    {
        const QList<QXmppClientExtension *> list = extensions();
        for (auto ext : list) {
            T *extension = qobject_cast<T *>(ext);
            if (extension)
                return extension;
        }
        return nullptr;
    }
 
    template<typename T>
    int indexOfExtension()
    {
        auto list = extensions();
        for (int i = 0; i < list.size(); ++i) {
            if (qobject_cast<T *>(list.at(i)) != nullptr)
                return i;
        }
        return -1;
    }
 
    bool isAuthenticated() const;
    bool isConnected() const;
 
    bool isActive() const;
    void setActive(bool active);
 
    QXmppPresence clientPresence() const;
    void setClientPresence(const QXmppPresence &presence);
 
    QXmppConfiguration &configuration();
 
    // documentation needs to be here, see https://stackoverflow.com/questions/49192523/
    QXmppLogger *logger() const;
    void setLogger(QXmppLogger *logger);
 
    QAbstractSocket::SocketError socketError();
    QString socketErrorString() const;
 
    // documentation needs to be here, see https://stackoverflow.com/questions/49192523/
    State state() const;
    QXmppStanza::Error::Condition xmppStreamError();
 
#if QXMPP_DEPRECATED_SINCE(1, 1)
    QT_DEPRECATED_X("Use QXmppClient::findExtension<QXmppRosterManager>() instead")
    QXmppRosterManager &rosterManager();
 
    QT_DEPRECATED_X("Use QXmppClient::findExtension<QXmppVCardManager>() instead")
    QXmppVCardManager &vCardManager();
 
    QT_DEPRECATED_X("Use QXmppClient::findExtension<QXmppVersionManager>() instead")
    QXmppVersionManager &versionManager();
#endif
 
Q_SIGNALS:
 
    void connected();
 
    void disconnected();
 
    void error(QXmppClient::Error);
 
    void loggerChanged(QXmppLogger *logger);
 
    void messageReceived(const QXmppMessage &message);
 
    void presenceReceived(const QXmppPresence &presence);
 
    void iqReceived(const QXmppIq &iq);
 
    void sslErrors(const QList<QSslError> &errors);
 
    void stateChanged(QXmppClient::State state);
 
public Q_SLOTS:
    void connectToServer(const QXmppConfiguration &,
                         const QXmppPresence &initialPresence =
                             QXmppPresence());
    void connectToServer(const QString &jid,
                         const QString &password);
    void disconnectFromServer();
    bool sendPacket(const QXmppStanza &);
    void sendMessage(const QString &bareJid, const QString &message);
 
private Q_SLOTS:
    void _q_elementReceived(const QDomElement &element, bool &handled);
    void _q_reconnect();
    void _q_socketStateChanged(QAbstractSocket::SocketState state);
    void _q_streamConnected();
    void _q_streamDisconnected();
    void _q_streamError(QXmppClient::Error error);
 
private:
    QXmppClientPrivate *const d;
 
    friend class QXmppInternalClientExtension;
};
 
#endif  // QXMPPCLIENT_H