qremoteobjectnode.h

// Copyright (C) 2017 Ford Motor Company

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

// Qt-Security score:significant reason:default

#ifndef QREMOTEOBJECTNODE_H

#define QREMOTEOBJECTNODE_H

#include <QtCore/qsharedpointer.h>

#include <QtCore/qmetaobject.h>

#include <QtNetwork/qlocalserver.h>

#include <QtRemoteObjects/qtremoteobjectglobal.h>

#include <QtRemoteObjects/qremoteobjectregistry.h>

#include <QtRemoteObjects/qremoteobjectdynamicreplica.h>

#include <functional>

QT_BEGIN_NAMESPACE

class QRemoteObjectReplica;

class SourceApiMap;

class QAbstractItemModel;

class QAbstractItemModelReplica;

class QItemSelectionModel;

class QRemoteObjectAbstractPersistedStorePrivate;

class QRemoteObjectNodePrivate;

class QRemoteObjectHostBasePrivate;

class QRemoteObjectHostPrivate;

class QRemoteObjectRegistryHostPrivate;

class Q_REMOTEOBJECTS_EXPORT QRemoteObjectAbstractPersistedStore : public QObject

    Q_OBJECT

public:

    QRemoteObjectAbstractPersistedStore (QObject *parent = nullptr);

    virtual ~QRemoteObjectAbstractPersistedStore();

    virtual void saveProperties(const QString &repName, const QByteArray &repSig, const QVariantList &values) = 0;

    virtual QVariantList restoreProperties(const QString &repName, const QByteArray &repSig) = 0;

protected:

    QRemoteObjectAbstractPersistedStore(QRemoteObjectAbstractPersistedStorePrivate &, QObject *parent);

    Q_DECLARE_PRIVATE(QRemoteObjectAbstractPersistedStore)

};

class Q_REMOTEOBJECTS_EXPORT QRemoteObjectNode : public QObject

    Q_OBJECT

    Q_PROPERTY(QUrl registryUrl READ registryUrl WRITE setRegistryUrl NOTIFY registryUrlChanged)

    Q_PROPERTY(QRemoteObjectAbstractPersistedStore *persistedStore READ persistedStore WRITE

                       setPersistedStore NOTIFY persistedStoreChanged)

    Q_PROPERTY(int heartbeatInterval READ heartbeatInterval WRITE setHeartbeatInterval NOTIFY heartbeatIntervalChanged)

public:

    enum ErrorCode{

        NoError,

        RegistryNotAcquired,

        RegistryAlreadyHosted,

        NodeIsNoServer,

        ServerAlreadyCreated,

        UnintendedRegistryHosting,

        OperationNotValidOnClientNode,

        SourceNotRegistered,

        MissingObjectName,

        HostUrlInvalid,

        ProtocolMismatch,

        ListenFailed,

        SocketAccessError

};

    Q_ENUM(ErrorCode)

    QRemoteObjectNode(QObject *parent = nullptr);

    QRemoteObjectNode(const QUrl &registryAddress, QObject *parent = nullptr);

    ~QRemoteObjectNode() override;

    Q_INVOKABLE bool connectToNode(const QUrl &address);

    void addClientSideConnection(QIODevice *ioDevice);

    virtual void setName(const QString &name);

    template < class ObjectType >

    ObjectType *acquire(const QString &name = QString())

        return new ObjectType(this, name);

    template<typename T>

    QStringList instances() const

        const QMetaObject *mobj = &T::staticMetaObject;

        const int index = mobj->indexOfClassInfo(QCLASSINFO_REMOTEOBJECT_TYPE);

        if (index == -1)

            return QStringList();

        const QString typeName = QString::fromLatin1(mobj->classInfo(index).value());

        return instances(typeName);

    QStringList instances(QStringView typeName) const;

    QRemoteObjectDynamicReplica *acquireDynamic(const QString &name);

    QAbstractItemModelReplica *acquireModel(const QString &name, QtRemoteObjects::InitialAction action = QtRemoteObjects::FetchRootSize, const QList<int> &rolesHint = {});

    QUrl registryUrl() const;

    virtual bool setRegistryUrl(const QUrl &registryAddress);

    bool waitForRegistry(int timeout = 30000);

    const QRemoteObjectRegistry *registry() const;

    QRemoteObjectAbstractPersistedStore *persistedStore() const;

    void setPersistedStore(QRemoteObjectAbstractPersistedStore *persistedStore);

    ErrorCode lastError() const;

    int heartbeatInterval() const;

    void setHeartbeatInterval(int interval);

    typedef std::function<void (QUrl)> RemoteObjectSchemaHandler;

    void registerExternalSchema(const QString &schema, RemoteObjectSchemaHandler handler);

Q_SIGNALS:

    void remoteObjectAdded(const QRemoteObjectSourceLocation &);

    void remoteObjectRemoved(const QRemoteObjectSourceLocation &);

    Q_REVISION(6, 12) void registryUrlChanged(const QUrl &registryUrl);

    Q_REVISION(6, 12)

    void persistedStoreChanged(QRemoteObjectAbstractPersistedStore *persistedStore);

    void error(QRemoteObjectNode::ErrorCode errorCode);

    void heartbeatIntervalChanged(int heartbeatInterval);

protected:

    QRemoteObjectNode(QRemoteObjectNodePrivate &, QObject *parent);

    void timerEvent(QTimerEvent*) override;

private:

    void initializeReplica(QRemoteObjectReplica *instance, const QString &name = QString());

    void persistProperties(const QString &repName, const QByteArray &repSig, const QVariantList &props);

    QVariantList retrieveProperties(const QString &repName, const QByteArray &repSig);

    Q_DECLARE_PRIVATE(QRemoteObjectNode)

    friend class QRemoteObjectReplica;

    friend class QConnectedReplicaImplementation;

};

class Q_REMOTEOBJECTS_EXPORT QRemoteObjectHostBase : public QRemoteObjectNode

    Q_OBJECT

public:

    enum AllowedSchemas { BuiltInSchemasOnly, AllowExternalRegistration };

    Q_ENUM(AllowedSchemas)

    ~QRemoteObjectHostBase() override;

    void setName(const QString &name) override;

    template <template <typename> class ApiDefinition, typename ObjectType>

    bool enableRemoting(ObjectType *object)

        ApiDefinition<ObjectType> *api = new ApiDefinition<ObjectType>(object);

        return enableRemoting(object, api);

    Q_INVOKABLE bool enableRemoting(QObject *object, const QString &name = QString());

    bool enableRemoting(QAbstractItemModel *model, const QString &name, const QList<int> roles, QItemSelectionModel *selectionModel = nullptr);

    Q_INVOKABLE bool disableRemoting(QObject *remoteObject);

    void addHostSideConnection(QIODevice *ioDevice);

    typedef std::function<bool(QStringView, QStringView)> RemoteObjectNameFilter;

    bool proxy(const QUrl &registryUrl, const QUrl &hostUrl={},

               RemoteObjectNameFilter filter=[](QStringView, QStringView) {return true; });

    // TODO: Currently the reverse aspect requires the registry, so this is supported only for

    // QRemoteObjectRegistryHost for now. Consider enabling it also for QRemoteObjectHost.

    bool reverseProxy(RemoteObjectNameFilter filter=[](QStringView, QStringView) {return true; });

protected:

    virtual QUrl hostUrl() const;

    virtual bool setHostUrl(const QUrl &hostAddress, AllowedSchemas allowedSchemas=BuiltInSchemasOnly);

    QRemoteObjectHostBase(QRemoteObjectHostBasePrivate &, QObject *);

private:

    bool enableRemoting(QObject *object, const SourceApiMap *, QObject *adapter = nullptr);

    Q_DECLARE_PRIVATE(QRemoteObjectHostBase)

};

class Q_REMOTEOBJECTS_EXPORT QRemoteObjectHost : public QRemoteObjectHostBase

    Q_OBJECT

    Q_PROPERTY(QUrl hostUrl READ hostUrl WRITE setHostUrl NOTIFY hostUrlChanged)

public:

    QRemoteObjectHost(QObject *parent = nullptr);

    QRemoteObjectHost(const QUrl &address, const QUrl &registryAddress = QUrl(),

                      AllowedSchemas allowedSchemas=BuiltInSchemasOnly, QObject *parent = nullptr);

    QRemoteObjectHost(const QUrl &address, QObject *parent);

    ~QRemoteObjectHost() override;

    QUrl hostUrl() const override;

    bool setHostUrl(const QUrl &hostAddress, AllowedSchemas allowedSchemas=BuiltInSchemasOnly) override;

    static void setLocalServerOptions(QLocalServer::SocketOptions options);

Q_SIGNALS:

    void hostUrlChanged();

protected:

    QRemoteObjectHost(QRemoteObjectHostPrivate &, QObject *);

private:

    Q_DECLARE_PRIVATE(QRemoteObjectHost)

};

class Q_REMOTEOBJECTS_EXPORT QRemoteObjectRegistryHost : public QRemoteObjectHostBase

    Q_OBJECT

public:

    QRemoteObjectRegistryHost(const QUrl &registryAddress = QUrl(), QObject *parent = nullptr);

    ~QRemoteObjectRegistryHost() override;

    bool setRegistryUrl(const QUrl &registryUrl) override;

protected:

    QRemoteObjectRegistryHost(QRemoteObjectRegistryHostPrivate &, QObject *);

private:

    Q_DECLARE_PRIVATE(QRemoteObjectRegistryHost)

};

QT_END_NAMESPACE

#endif

Revision control

Copy as Markdown