Qt Remote Objects Nodes | Qt Remote Objects 5.12.9

- Qt 5.12
- Qt Remote Objects
- Qt Remote Objects Nodes
- Qt 5.12.9 Reference Documentation

# Qt Remote Objects Nodes

## Nodes

QRemoteObjectNodes (Nodes) are what enable the passing of information between processes. All QtRO functionality is enabled by a small number of distinct packets passing the necessary data between nodes.

Each process that participates in QtRO's IPC will instantiate a Node-based type (QRemoteObjectNode, QRemoteObjectHost, or QRemoteObjectRegistryHost). The host types of Nodes provide additional functionality. Both QRemoteObjectHost and QRemoteObjectRegistryHost support the enableRemoting() (and the corresponding disableRemoting()) methods, which are the key methods to expose Source objects to the network. In order to use the Registry functionality, there should be a QRemoteObjectRegistryHost on the network. All other nodes can then pass the RegistryHost's URL to the Node's registryAddress constructor parameter, or pass the URL to the setRegistryUrl() method.

QtRO works as a peer-to-peer network. That is, in order to acquire() a valid Replica, the Replica's node needs a connection to the node that hosts its Source. A host node is a node that allows other nodes to connect to it, which is accomplished by giving hosts unique addresses (the address is provided to the QRemoteObjectHost constructor or set by the setHostUrl method). The node that a Replica is requested from must establish the connection to the host node in order to initialize the Replica and keep it up to date.

## Connecting Nodes using QtRO URLs

Host Nodes use custom URLs to simplify connections. While the list will likely be extended, QtRO currently supports two types of connections. A "tcp" connection (using the standard tcp/ip protocol) supports connections between devices as well as between processes on the same device. A "local" connection (which can have less overhead, depending on the underlying OS features) only supports connections between processes on the same device.

When using a local connection, a unique name must be used. For tcp connections, a unique address and port number combination much be used.

There is currently no zeroconf facility included in QtRO. All processes or devices must therefore know beforehand how to connect to each other. A QRemoteObjectRegistry (see below) can be used to simplify the connection process for a network with multiple Host Nodes.

Connection types are summarized in the following table.

URL | Host Node | Connecting Node
--- | --- | ---
QUrl("local:service") | QLocalServer("service") | QLocalSocket("service")
QUrl("tcp://192.168.1.1:9999") | QTcpServer("192.168.1.1",9999) | QTcpSocket("192.168.1.1",9999)

Nodes have a couple of enableRemoting() methods that are used to share objects on the network (this will produce an error if the Node is not a Host Node however). Other processes/devices that want to interact with a shared object use one of the node's acquire() methods to instantiate a replica.