QRemoteObjectNode Class
Un nodo de una red Qt Remote Objects. Más información...
| Encabezado: | #include <QRemoteObjectNode> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS RemoteObjects) target_link_libraries(mytarget PRIVATE Qt6::RemoteObjects) |
| qmake: | QT += remoteobjects |
| En QML: | Node |
| Heredado de: | QObject |
| Heredado por: |
Tipos públicos
| enum | ErrorCode { NoError, RegistryNotAcquired, RegistryAlreadyHosted, NodeIsNoServer, ServerAlreadyCreated, …, SocketAccessError } |
| RemoteObjectSchemaHandler |
Propiedades
- heartbeatInterval : int
- persistedStore : QRemoteObjectAbstractPersistedStore*
- registryUrl : QUrl
Funciones públicas
| QRemoteObjectNode(QObject *parent = nullptr) | |
| QRemoteObjectNode(const QUrl ®istryAddress, QObject *parent = nullptr) | |
| ObjectType * | acquire(const QString &name = QString()) |
| QRemoteObjectDynamicReplica * | acquireDynamic(const QString &name) |
| QAbstractItemModelReplica * | acquireModel(const QString &name, QtRemoteObjects::InitialAction action = QtRemoteObjects::FetchRootSize, const QList<int> &rolesHint = {}) |
| void | addClientSideConnection(QIODevice *ioDevice) |
| bool | connectToNode(const QUrl &address) |
| int | heartbeatInterval() const |
| QStringList | instances() const |
| QStringList | instances(QStringView typeName) const |
| QRemoteObjectNode::ErrorCode | lastError() const |
| QRemoteObjectAbstractPersistedStore * | persistedStore() const |
| void | registerExternalSchema(const QString &schema, QRemoteObjectNode::RemoteObjectSchemaHandler handler) |
| const QRemoteObjectRegistry * | registry() const |
| QUrl | registryUrl() const |
| void | setHeartbeatInterval(int interval) |
| virtual void | setName(const QString &name) |
| void | setPersistedStore(QRemoteObjectAbstractPersistedStore *persistedStore) |
| virtual bool | setRegistryUrl(const QUrl ®istryAddress) |
| bool | waitForRegistry(int timeout = 30000) |
Señales
| void | heartbeatIntervalChanged(int heartbeatInterval) |
(since 6.12) void | persistedStoreChanged(QRemoteObjectAbstractPersistedStore *persistedStore) |
(since 6.12) void | registryUrlChanged(const QUrl ®istryUrl) |
| void | remoteObjectAdded(const QRemoteObjectSourceLocation &loc) |
| void | remoteObjectRemoved(const QRemoteObjectSourceLocation &loc) |
Funciones protegidas reimplementadas
| virtual void | timerEvent(QTimerEvent *) override |
Descripción detallada
La clase QRemoteObjectNode proporciona un punto de entrada a una red QtRemoteObjects. Una red puede ser tan simple como dos nodos, o un conjunto arbitrariamente complejo de procesos y dispositivos.
Un QRemoteObjectNode no dispone de una URL a la que puedan conectarse otros nodos, por lo que solo puede adquirir réplicas. No puede compartir objetos fuente (solo los nodos de tipo « QRemoteObjectHost » y « QRemoteObjectRegistryHost » pueden hacerlo).
Los nodos pueden conectarse entre sí directamente utilizando connectToNode, o bien pueden utilizar QRemoteObjectRegistry para simplificar las conexiones.
El « QRemoteObjectRegistry » es una réplica especial disponible para todos los nodos que se conectan a la URL del Registro. Sabe cómo conectarse a todos los objetos «QRemoteObjectSource» de la red.
Véase también QRemoteObjectHost y QRemoteObjectRegistryHost.
Documentación sobre tipos de miembros
enum QRemoteObjectNode::ErrorCode
Este tipo de enumeración especifica los distintos códigos de error asociados a los errores de QRemoteObjectNode:
| Constante | Valor | Descripción |
|---|---|---|
QRemoteObjectNode::NoError | 0 | Sin error. |
QRemoteObjectNode::RegistryNotAcquired | 1 | No se ha podido obtener el registro. |
QRemoteObjectNode::RegistryAlreadyHosted | 2 | El registro ya está definido y aloja fuentes. |
QRemoteObjectNode::NodeIsNoServer | 3 | El QRemoteObjectNode indicado no es un nodo host. |
QRemoteObjectNode::ServerAlreadyCreated | 4 | El nodo de host ya se ha inicializado. |
QRemoteObjectNode::UnintendedRegistryHosting | 5 | Se ha intentado crear un nodo de host QRemoteObjectNode y conectarse a sí mismo como registro. |
QRemoteObjectNode::OperationNotValidOnClientNode | 6 | La operación intentada no es válida en un nodo cliente QRemoteObjectNode. |
QRemoteObjectNode::SourceNotRegistered | 7 | El QRemoteObjectSource indicado no está registrado en este nodo. |
QRemoteObjectNode::MissingObjectName | 8 | El QObject especificado no tiene objectName() establecido. |
QRemoteObjectNode::HostUrlInvalid | 9 | La URL indicada tiene un esquema no válido o no reconocido. |
QRemoteObjectNode::ProtocolMismatch | 10 | El cliente y el servidor tienen versiones de protocolo diferentes. |
QRemoteObjectNode::ListenFailed | 11 | No se puede escuchar en el puerto del host especificado. |
QRemoteObjectNode::SocketAccessError | 12 | El cliente no tiene permiso para conectarse al servidor. Asegúrate de que QRemoteObjectHost::setLocalServerOptions esté configurado correctamente. |
QRemoteObjectNode::RemoteObjectSchemaHandler
Definición de tipo para un método `std::function` que puede aceptar una entrada de tipo ` QUrl ` y se encarga de crear el canal de comunicación entre este nodo y el nodo que aloja la fuente deseada. Dado que algunos tipos de QIODevices (p. ej., QSslSocket) requieren pasos adicionales antes de que el dispositivo esté listo para su uso, el método se encarga de llamar a addClientSideConnection una vez que la conexión se haya establecido por completo.
Documentación de propiedades
heartbeatInterval : int
Intervalo de «heartbeat» en ms.
El «heartbeat» (útil únicamente para conexiones de socket) envía periódicamente un mensaje a los nodos conectados para detectar si la conexión se ha interrumpido. Qt Remote Objects intentará volver a conectarse automáticamente si detecta una pérdida de conexión. Esta función puede ayudar en dicha detección, ya que el cliente solo detectará que el servidor no está disponible cuando intente enviar datos.
Un valor de 0 (el predeterminado) desactivará el latido.
Funciones de acceso:
| int | heartbeatInterval() const |
| void | setHeartbeatInterval(int interval) |
Señal de notificación:
| void | heartbeatIntervalChanged(int heartbeatInterval) |
persistedStore : QRemoteObjectAbstractPersistedStore*
Permite configurar una instancia de « QRemoteObjectAbstractPersistedStore » para el nodo.
Permite que los miembros PROP de una réplica con el rasgo PERSISTED guarden su valor actual cuando se elimine la réplica y restauren un valor almacenado la próxima vez que se inicie la réplica.
Requiere una implementación de la clase ` QRemoteObjectAbstractPersistedStore ` para controlar dónde y cómo se gestiona la persistencia.
Funciones de acceso:
| QRemoteObjectAbstractPersistedStore * | persistedStore() const |
| void | setPersistedStore(QRemoteObjectAbstractPersistedStore *persistedStore) |
Señal de notificador:
| void | persistedStoreChanged(QRemoteObjectAbstractPersistedStore *persistedStore) |
registryUrl : QUrl
Esta propiedad contiene la dirección del Registry que utiliza este nodo.
Se trata de un « QUrl » vacío si no hay ningún registro en uso.
Funciones de acceso:
| QUrl | registryUrl() const |
| virtual bool | setRegistryUrl(const QUrl ®istryAddress) |
Señal de notificador:
| void | registryUrlChanged(const QUrl ®istryUrl) |
Documentación de las funciones de miembro
QRemoteObjectNode::QRemoteObjectNode(QObject *parent = nullptr)
Constructor por defecto para QRemoteObjectNode con el parent especificado. Un nodo construido de esta manera no puede conectarse y, por lo tanto, no puede exponer objetos «Source» en la red. Tampoco incluirá un QRemoteObjectRegistry, a menos que se establezca manualmente mediante setRegistryUrl.
Véanse también connectToNode y setRegistryUrl.
QRemoteObjectNode::QRemoteObjectNode(const QUrl ®istryAddress, QObject *parent = nullptr)
QRemoteObjectNode conectado a un {QRemoteObjectRegistry} {Registry}. Un nodo construido de esta manera no puede conectarse y, por lo tanto, no puede exponer objetos de origen en la red. La búsqueda y conexión con otros nodos (host) se gestiona mediante el QRemoteObjectRegistry especificado en registryAddress.
Véase también connectToNode, setRegistryUrl, QRemoteObjectHost y QRemoteObjectRegistryHost.
template <typename ObjectType> ObjectType *QRemoteObjectNode::acquire(const QString &name = QString())
Devuelve un puntero a una réplica de tipo `ObjectType` (que es un parámetro de plantilla y debe heredar de ` QRemoteObjectReplica`). Es decir, el parámetro de plantilla debe ser un tipo generado por repc. El parámetro ` name ` puede utilizarse para especificar el ` name ` asignado al objeto durante la llamada a ` QRemoteObjectHost::enableRemoting()`.
QRemoteObjectDynamicReplica *QRemoteObjectNode::acquireDynamic(const QString &name)
Devuelve un objeto ` QRemoteObjectDynamicReplica ` del `Source` ` name`.
QAbstractItemModelReplica *QRemoteObjectNode::acquireModel(const QString &name, QtRemoteObjects::InitialAction action = QtRemoteObjects::FetchRootSize, const QList<int> &rolesHint = {})
Devuelve un puntero a una réplica derivada específicamente de QAbstractItemModel. El name proporcionado debe coincidir con el nombre utilizado en el enableRemoting correspondiente que puso el modelo en la red. action especifica si el modelo debe obtener datos antes de que se emita la señal initialized. Si se establece en QtRemoteObjects::PrefetchData, se obtendrán previamente los datos de los roles en el rolesHint. Si rolesHint está vacío, se recogerán previamente los datos de todos los roles expuestos por Source.
El modelo devuelto estará vacío hasta que se inicialice con Source.
void QRemoteObjectNode::addClientSideConnection(QIODevice *ioDevice)
Para poder utilizar la función ` QRemoteObjectNode::acquire()` con objetos `Replica` a través de dispositivos QIO externos, ` Qt Remote Objects ` necesita acceder al canal de comunicación (un ` QIODevice`) entre los nodos correspondientes. Esto se habilita mediante la llamada a `addClientSideConnection()`, que toma como entrada el ` ioDevice `. Cualquier llamada a acquire() realizada sin llamar antes a addClientSideConnection seguirá funcionando, pero el nodo no podrá inicializar la réplica si no se le proporciona la conexión con el nodo host.
Véase también QRemoteObjectHostBase::addHostSideConnection.
[invokable] bool QRemoteObjectNode::connectToNode(const QUrl &address)
Conecta un nodo cliente al nodo host en address.
Las conexiones seguirán siendo válidas hasta que se elimine el nodo host o ya no sea accesible a través de la red.
Una vez que un cliente se conecta a un host, se pueden obtener réplicas válidas si se está transmitiendo de forma remota la fuente correspondiente.
Devuelve true si se realiza correctamente; en caso contrario, devuelve false (normalmente, una URL no reconocida o una conexión a una dirección a la que ya se está conectado).
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
template <typename T> QStringList QRemoteObjectNode::instances() const
Esta función basada en plantillas (que toma un tipo generado por repc como parámetro de plantilla) devolverá la lista de nombres de todas las instancias de ese tipo en la red de Remote Objects. Por ejemplo, si tienes una clase Shape definida en un archivo .rep, y las clases Circle y Square heredan de la definición Source, se pueden compartir en la red de Remote Objects utilizando enableRemoting.
Square square;
Circle circle;
myHost.enableRemoting(&square, "Square");
myHost.enableRemoting(&circle, "Circle");A continuación, se puede utilizar `instance` para encontrar las instancias disponibles de `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(QStringView typeName) const
Esta función de conveniencia ofrece el mismo resultado que la versión con plantilla, pero toma como parámetro el nombre de la clase «Source» (typeName) en lugar de derivarlo del tipo de clase.
Esta función sobrecarga QRemoteObjectNode::instances().
QRemoteObjectNode::ErrorCode QRemoteObjectNode::lastError() const
Devuelve el último conjunto de errores.
[signal, since 6.12] void QRemoteObjectNode::persistedStoreChanged(QRemoteObjectAbstractPersistedStore *persistedStore)
Esta señal se emite cuando la propiedad ` persistedStore ` cambia a ` persistedStore`.
Nota: Señalde notificación para la propiedad « persistedStore ».
Esta función se introdujo en Qt 6.12.
void QRemoteObjectNode::registerExternalSchema(const QString &schema, QRemoteObjectNode::RemoteObjectSchemaHandler handler)
Proporcionar un método personalizado para gestionar esquemas proporcionados externamente
Este método está vinculado al Registro y a los esquemas externos. Al registrar un controlador std::function para un esquema externo, el método registrado se llamará cuando el registro reciba una notificación de que una Fuente que hayas adquirido está disponible. Sin este registro, QtRO solo podría gestionar los esquemas «integrados».
El método proporcionado, handler, se invocará cuando el registro detecte un objeto «Source» en un nodo nuevo (aún no conectado) con un {QUrl::schema()} de schema. El método « handler », de tipo « QRemoteObjectNode::RemoteObjectSchemaHandler », recibirá como parámetro de entrada la « QUrl » del nodo que proporciona la «Source», y se encargará de establecer el canal de comunicación (algún tipo de « QIODevice ») y de llamar a « addClientSideConnection » con él.
Véase también RemoteObjectSchemaHandler.
const QRemoteObjectRegistry *QRemoteObjectNode::registry() const
Devuelve un puntero al ` QRemoteObjectRegistry` del nodo, si este utiliza la función «Registro»; en caso contrario, devuelve ` nullptr`.
[signal, since 6.12] void QRemoteObjectNode::registryUrlChanged(const QUrl ®istryUrl)
Esta señal se emite cuando la propiedad « registryUrl » cambia a « registryUrl ».
Nota: Señalde notificación para la propiedad ` registryUrl`.
Esta función se introdujo en Qt 6.12.
[signal] void QRemoteObjectNode::remoteObjectAdded(const QRemoteObjectSourceLocation &loc)
Esta señal se emite cada vez que se añade un nuevo objeto «Source» al Registro. La señal no se emitirá si no hay ningún Registro configurado (es decir, en el caso de «Sources» a través de conexiones establecidas directamente mediante connectToNode ). El parámetro « loc » contiene la información sobre el «Source» añadido, incluyendo el nombre, el tipo y la dirección QUrl del nodo que lo aloja.
Véase también remoteObjectRemoved() y instances().
[signal] void QRemoteObjectNode::remoteObjectRemoved(const QRemoteObjectSourceLocation &loc)
Esta señal se emite cada vez que se elimina un objeto «Source» conocido del Registro. La señal no se emitirá si no hay ningún conjunto de Registro (es decir, en el caso de «Sources» a través de conexiones establecidas directamente mediante connectToNode ). El parámetro « loc » contiene la información sobre el «Source» eliminado, incluyendo el nombre, el tipo y la dirección QUrl del nodo que lo aloja.
Véase también remoteObjectAdded y instances.
[virtual] void QRemoteObjectNode::setName(const QString &name)
Establece « name » como nombre interno de este nodo. Este nombre se muestra posteriormente en los registros (si están habilitados). Resulta especialmente útil si se fusionan datos de registro de varios nodos.
[override virtual protected] void QRemoteObjectNode::timerEvent(QTimerEvent *)
Reimplementa: ` QObject::timerEvent(QTimerEvent *event)`.
bool QRemoteObjectNode::waitForRegistry(int timeout = 30000)
Queda bloqueado hasta que se inicialice el Registro de este nodo o hasta que caduque el tiempo de espera de « timeout » (en milisegundos). Devuelve « true » si el Registro se ha inicializado correctamente en el momento de la devolución, o « false » en caso contrario.
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.