Member Function Documentation

QRemoteObjectNode::QRemoteObjectNode(QObject *parent = nullptr)

Default constructor for QRemoteObjectNode with the given parent. A Node constructed in this manner can not be connected to, and thus can not expose Source objects on the network. It also will not include a QRemoteObjectRegistry, unless set manually using setRegistryUrl.

See also connectToNode and setRegistryUrl.

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

QRemoteObjectNode connected to a {QRemoteObjectRegistry} {Registry}. A Node constructed in this manner can not be connected to, and thus can not expose Source objects on the network. Finding and connecting to other (Host) Nodes is handled by the QRemoteObjectRegistry specified by registryAddress.

See also connectToNode, setRegistryUrl, QRemoteObjectHost, and QRemoteObjectRegistryHost.

[protected] QRemoteObjectNode::QRemoteObjectNode(QRemoteObjectNodePrivate &, QObject *parent)

Default constructs an instance of QRemoteObjectNode.

[override virtual] QRemoteObjectNode::~QRemoteObjectNode()

Destroys the instance of QRemoteObjectNode. The destructor is virtual.

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

Returns a pointer to a Replica of type ObjectType (which is a template parameter and must inherit from QRemoteObjectReplica). That is, the template parameter must be a repc generated type. The name parameter can be used to specify the name given to the object during the QRemoteObjectHost::enableRemoting() call.

QRemoteObjectDynamicReplica *QRemoteObjectNode::acquireDynamic(const QString &name)

Returns a QRemoteObjectDynamicReplica of the Source name.

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

Returns a pointer to a Replica which is specifically derived from QAbstractItemModel. The name provided must match the name used with the matching enableRemoting that put the Model on the network. The returned model will be empty until it is initialized with the Source.

bool QRemoteObjectNode::connectToNode(const QUrl &address)

Connects a client node to the host node at address.

Connections will remain valid until the host node is deleted or no longer accessible over a network.

Once a client is connected to a host, valid Replicas can then be acquired if the corresponding Source is being remoted.

Return true on success, false otherwise (usually an unrecognized url, or connecting to already connected address).

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[signal] void QRemoteObjectNode::error(QRemoteObjectNode::ErrorCode errorCode)

QStringList QRemoteObjectNode::instances() const

This templated function (taking a repc generated type as the template parameter) will return the list of names of every instance of that type on the Remote Objects network. For example, if you have a Shape class defined in a .rep file, and Circle and Square classes inherit from the Source definition, they can be shared on the Remote Objects network using enableRemoting.

Square square;
Circle circle;
myHost.enableRemoting(&square, "Square");
myHost.enableRemoting(&circle, "Circle");

Then instance can be used to find the available instances of Shape.

QStringList instances = clientNode.instances<Shape>();
// will return a QStringList containing "Circle" and "Square"
auto instance1 = clientNode.acquire<Shape>("Circle");
auto instance2 = clientNode.acquire<Shape>("Square");
...

QStringList QRemoteObjectNode::instances(const QString &typeName) const

This function overloads instances().

This convenience function provides the same result as the templated version, but takes the name of the Source class as a parameter (typeName) rather than deriving it from the class type.

QRemoteObjectNode::ErrorCode QRemoteObjectNode::lastError() const

Returns the last error set.

const QRemoteObjectRegistry *QRemoteObjectNode::registry() const

Returns a pointer to the Node's QRemoteObjectRegistry, if the Node is using the Registry feature; otherwise it returns 0.

[signal] void QRemoteObjectNode::remoteObjectAdded(const QRemoteObjectSourceLocation &loc)

This signal is emitted whenever a new Source object is added to the Registry. The signal will not be emitted if there is no Registry set (i.e., Sources over connections made via connectToNode directly). The loc parameter contains the information about the added Source, including name, type and the QUrl of the hosting Node.

See also remoteObjectRemoved and instances.

[signal] void QRemoteObjectNode::remoteObjectRemoved(const QRemoteObjectSourceLocation &)

[virtual] void QRemoteObjectNode::setName(const QString &name)

Sets name as the internal name for this Node. This is then output as part of the logging (if enabled). This is primarily useful if you merge log data from multiple nodes.

[override virtual protected] void QRemoteObjectNode::timerEvent(QTimerEvent *)

Reimplemented from QObject::timerEvent().

bool QRemoteObjectNode::waitForRegistry(int timeout = 30000)

Blocks until this Node's Registry is initialized or timeout (in milliseconds) expires. Returns true if the Registry is successfully initialized upon return, or false otherwise.