QRemoteObjectRegistry Class

A class holding information about Source objects available on the Qt Remote Objects network. More...

Header: #include <QRemoteObjectRegistry>
Inherits: QRemoteObjectReplica

Properties

Public Functions

virtual ~QRemoteObjectRegistry() override
QBindable<QRemoteObjectSourceLocations> bindableSourceLocations() const
QRemoteObjectSourceLocations sourceLocations() const

Signals

void remoteObjectAdded(const QRemoteObjectSourceLocation &entry)
void remoteObjectRemoved(const QRemoteObjectSourceLocation &entry)

Protected Slots

void addSource(const QRemoteObjectSourceLocation &entry)
void pushToRegistryIfNeeded()
void removeSource(const QRemoteObjectSourceLocation &entry)

Detailed Description

\inmoduleQtRemoteObjects

The Registry is a special Source/Replica pair held by a node itself. It knows about all other Sources available on the network, and simplifies the process of connecting to other nodes.

Property Documentation

[bindable read-only] sourceLocations : QRemoteObjectSourceLocations

Note: This property supports QProperty bindings.

This property holds the set of sources known to the registry.

This property is a QRemoteObjectSourceLocations, which is a typedef for QHash<QString, QUrl>. Each known Source is the QString key, while the url for the host node is the corresponding value for that key in the hash.

Member Function Documentation

[override virtual noexcept] QRemoteObjectRegistry::~QRemoteObjectRegistry()

Destructor for QRemoteObjectRegistry.

[protected slot] void QRemoteObjectRegistry::addSource(const QRemoteObjectSourceLocation &entry)

\internal

[protected slot] void QRemoteObjectRegistry::pushToRegistryIfNeeded()

\internalThis internal function supports the edge case where the Registry is connected after Source objects are added to this Node, or the connection to the Registry is lost. When connected/reconnected, this function synchronizes local Source objects with the Registry.

[signal] void QRemoteObjectRegistry::remoteObjectAdded(const QRemoteObjectSourceLocation &entry)

This signal is emitted whenever a new source location is added to the registry.

entry is a QRemoteObjectSourceLocation, a typedef for QPair<QString, QUrl>.

See also remoteObjectRemoved().

[signal] void QRemoteObjectRegistry::remoteObjectRemoved(const QRemoteObjectSourceLocation &entry)

This signal is emitted whenever a Source location is removed from the Registry.

entry is a QRemoteObjectSourceLocation, a typedef for QPair<QString, QUrl>.

See also remoteObjectAdded().

[protected slot] void QRemoteObjectRegistry::removeSource(const QRemoteObjectSourceLocation &entry)

\internal

QRemoteObjectSourceLocations QRemoteObjectRegistry::sourceLocations() const

Returns a QRemoteObjectSourceLocations object, which includes the name and additional information of all sources known to the registry.

Note: Getter function for property sourceLocations.