QOpcUaGdsClient Class
Se encarga de la comunicación con el servidor GDS. Más información...
| Encabezado: | #include <QOpcUaGdsClient> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS OpcUa) target_link_libraries(mytarget PRIVATE Qt6::OpcUa) |
| qmake: | QT += opcua |
| Heredado de: | QObject |
Tipos públicos
| enum class | Error { NoError, InvalidBackend, InvalidEndpoint, ConnectionError, DirectoryNodeNotFound, …, FailedToGetCertificate } |
| enum class | State { Idle, BackendInstantiated, Connecting, Connected, RegisteringApplication, …, Error } |
Funciones públicas
| QOpcUaGdsClient(QObject *parent = nullptr) | |
| virtual | ~QOpcUaGdsClient() |
| QString | applicationId() const |
| const QOpcUaApplicationIdentity & | applicationIdentity() const |
| const QOpcUaApplicationRecordDataType & | applicationRecord() const |
| const QString & | backend() const |
| int | certificateCheckInterval() const |
| const QOpcUaX509DistinguishedName & | distinguishedNameCertificateSigningRequestPreset() const |
| const QString & | dnsCertificateSigningRequestPreset() const |
| const QOpcUaEndpointDescription & | endpoint() const |
| QOpcUaGdsClient::Error | error() const |
| const QOpcUaPkiConfiguration & | pkiConfiguration() const |
| void | setApplicationIdentity(const QOpcUaApplicationIdentity &appIdentity) |
| void | setApplicationRecord(const QOpcUaApplicationRecordDataType &appRecord) |
| void | setBackend(const QString &backend) |
| void | setCertificateCheckInterval(int interval) |
| void | setCertificateSigningRequestPresets(const QOpcUaX509DistinguishedName &dn, const QString &dns) |
| void | setEndpoint(const QOpcUaEndpointDescription &endpoint) |
| void | setPkiConfiguration(const QOpcUaPkiConfiguration &pkiConfig) |
| void | setTrustListUpdateInterval(int interval) |
| void | start() |
| QOpcUaGdsClient::State | state() const |
| int | trustListUpdateInterval() const |
| void | unregisterApplication() |
Señales
| void | applicationRegistered() |
| void | authenticationRequired(QOpcUaAuthenticationInformation &authInfo) |
| void | certificateGroupsReceived(QStringList certificateGroups) |
| void | certificateUpdateRequired() |
| void | certificateUpdated() |
| void | errorChanged(QOpcUaGdsClient::Error error) |
| void | stateChanged(QOpcUaGdsClient::State state) |
| void | trustListUpdated() |
| void | unregistered() |
Descripción detallada
Esta clase está disponible actualmente como «Technology Preview» (vista previa tecnológica) y, por lo tanto, la API y la funcionalidad que ofrece la clase pueden estar sujetas a cambios en cualquier momento sin previo aviso.
Esta clase gestiona todos los pasos necesarios para la comunicación con un servidor GDS. Una vez que dispone de la información sobre la aplicación, se encarga de registrarse en el servidor y de gestionar las claves y los certificados.
Solo es necesario conocer unos pocos detalles para participar en una red segura.
El registro inicial requiere privilegios de administrador mediante un nombre de usuario y una contraseña para la autenticación. Todas las autenticaciones posteriores se realizan a través de la aplicación, utilizando el certificado recibido inicialmente.
Si todo el proceso se completa con éxito, deberá esperar a que aparezca la señal « applicationRegistered ».
La mayoría de las estructuras de configuración deben ser las mismas que para la conexión posterior con QOpcUaClient y pueden compartirse.
Configuración de un cliente GDS:
QOpcUaGdsClient c;
// En caso de que se necesiten credenciales
QObject::connect(&c, &QOpcUaGdsClient::authenticationRequired, [&](QOpcUaAuthenticationInformation&authInfo) {
authInfo.setUsernameAuthentication("root", "secret");
});
// Esperar a que se complete con éxito
QObject::connect(&c, &QOpcUaGdsClient::applicationRegistered, [&]() {
qDebug() << "Application" << c.applicationId() << "registered";
});
c.setBackend(...);
c.setEndpoint(...);
c.setApplicationIdentity(...);
c.setPkiConfiguration(...);
c.setApplicationRecord(...);
c.setCertificateSigningRequestPresets(...);
c.start();Documentación sobre los tipos de miembro
enum class QOpcUaGdsClient::Error
Esta enumeración se utiliza para especificar los errores que podrían producirse durante el proceso de registro.
| Constante | Valor | Descripción |
|---|---|---|
QOpcUaGdsClient::Error::NoError | 0 | Todo va bien |
QOpcUaGdsClient::Error::InvalidBackend | 1 | No se ha podido instanciar el backend. La cadena de backend proporcionada no coincide con ningún backend o ha fallado la carga del complemento. |
QOpcUaGdsClient::Error::InvalidEndpoint | 2 | El punto final indicado no es válido. |
QOpcUaGdsClient::Error::ConnectionError | 3 | Ha fallado la conexión con el punto final del servidor. |
QOpcUaGdsClient::Error::DirectoryNodeNotFound | 4 | No se ha podido resolver el nodo de directorio en el servidor |
QOpcUaGdsClient::Error::FailedToRegisterApplication | 5 | El registro de la aplicación no se ha realizado correctamente. |
QOpcUaGdsClient::Error::FailedToUnregisterApplication | 6 | No se ha podido dar de baja la aplicación. |
QOpcUaGdsClient::Error::FailedToGetCertificateStatus | 7 | No se ha podido recuperar el estado del certificado actual. |
QOpcUaGdsClient::Error::FailedToGetCertificate | 8 | No se ha podido recuperar un certificado del servidor. |
enum class QOpcUaGdsClient::State
Esta enumeración se utiliza para especificar el estado actual del registro del cliente GDS.
| Constante | Valor | Descripción |
|---|---|---|
QOpcUaGdsClient::State::Idle | 0 | El cliente aún no se ha iniciado. |
QOpcUaGdsClient::State::BackendInstantiated | 1 | Se ha instanciado el backend |
QOpcUaGdsClient::State::Connecting | 2 | Se está estableciendo una conexión con el servidor |
QOpcUaGdsClient::State::Connected | 3 | La conexión con el punto final del servidor se ha realizado correctamente. |
QOpcUaGdsClient::State::RegisteringApplication | 4 | La aplicación se está registrando en el servidor. |
QOpcUaGdsClient::State::ApplicationRegistered | 5 | El registro de la aplicación en el servidor se ha realizado correctamente. |
QOpcUaGdsClient::State::Error | 6 | Se ha producido un error. Consulta el valor de retorno de ` error()` y la salida del terminal para obtener más detalles. |
Documentación de funciones miembro
QOpcUaGdsClient::QOpcUaGdsClient(QObject *parent = nullptr)
Crea un cliente GDS con « parent » como objeto padre.
[virtual noexcept] QOpcUaGdsClient::~QOpcUaGdsClient()
Elimina un cliente de GDS.
QString QOpcUaGdsClient::applicationId() const
Devuelve el identificador de la aplicación asignado por el servidor.
Es un atajo para obtener el identificador de la aplicación a partir de los datos del registro de la aplicación.
Véase también ` applicationRecord()`.
const QOpcUaApplicationIdentity &QOpcUaGdsClient::applicationIdentity() const
Devuelve la «applicationIdentity» actual.
Véase también setApplicationIdentity().
const QOpcUaApplicationRecordDataType &QOpcUaGdsClient::applicationRecord() const
Devuelve los datos del registro de la aplicación que utiliza el cliente.
Véase también ` setApplicationRecord()`.
[signal] void QOpcUaGdsClient::applicationRegistered()
Esta señal se emite cuando una aplicación se ha registrado correctamente.
[signal] void QOpcUaGdsClient::authenticationRequired(QOpcUaAuthenticationInformation &authInfo)
Esta señal se emite cuando el cliente GDS intenta realizar una autenticación inicial con un servidor que requiere privilegios administrativos.
authInfo Debe rellenarse con información de autenticación válida. Este campo no debe utilizarse al cruzar los límites de los hilos.
const QString &QOpcUaGdsClient::backend() const
Devuelve la configuración actual del backend.
Si se ha cambiado el backend tras iniciar el cliente, devolverá la configuración modificada, pero no la instancia que se está utilizando realmente.
Véase también setBackend().
int QOpcUaGdsClient::certificateCheckInterval() const
Devuelve el intervalo, en milisegundos, para comprobar la validez del certificado del cliente.
Véase también setCertificateCheckInterval().
[signal] void QOpcUaGdsClient::certificateGroupsReceived(QStringList certificateGroups)
Esta señal se emite cuando el cliente GDS recibe una nueva lista de certificateGroups para esta aplicación.
[signal] void QOpcUaGdsClient::certificateUpdateRequired()
Esta señal se emite cuando el cliente GDS detecta que es necesaria una actualización del certificado que se está utilizando actualmente.
Esto podría deberse a que el servidor solicite al cliente que actualice el certificado cuando haya vencido su fecha de validez o si se trata de un certificado autofirmado.
La actualización del certificado se gestiona automáticamente. Esta señal tiene únicamente fines informativos para indicar que se va a producir una actualización.
[signal] void QOpcUaGdsClient::certificateUpdated()
Esta señal se emite cuando el cliente GDS recibe un nuevo certificado que estaba almacenado en el disco.
const QOpcUaX509DistinguishedName &QOpcUaGdsClient::distinguishedNameCertificateSigningRequestPreset() const
Devuelve el nombre distinguido preestablecido para las solicitudes de firma de certificados.
const QString &QOpcUaGdsClient::dnsCertificateSigningRequestPreset() const
Devuelve la configuración predeterminada de DNS para las solicitudes de firma de certificados.
const QOpcUaEndpointDescription &QOpcUaGdsClient::endpoint() const
Devuelve la configuración actual del punto final.
Si el punto final se ha modificado tras iniciar el cliente, devolverá la configuración modificada, pero no el punto final realmente utilizado.
Véase también setEndpoint().
QOpcUaGdsClient::Error QOpcUaGdsClient::error() const
Devuelve el estado de error actual.
[signal] void QOpcUaGdsClient::errorChanged(QOpcUaGdsClient::Error error)
Esta señal se emite cuando se produce un error de « error ».
const QOpcUaPkiConfiguration &QOpcUaGdsClient::pkiConfiguration() const
Devuelve la pkiConfiguration actual.
Véase también setPkiConfiguration().
void QOpcUaGdsClient::setApplicationIdentity(const QOpcUaApplicationIdentity &appIdentity)
Establece la identidad de la aplicación appIdentity que utilizará el cliente.
Esta identidad se utiliza para registrarse en el servidor GDS. Esta función debe llamarse antes de iniciar el cliente GDS. Cambiar esta configuración posteriormente no tiene ningún efecto.
Véase también applicationIdentity().
void QOpcUaGdsClient::setApplicationRecord(const QOpcUaApplicationRecordDataType &appRecord)
Establece los datos del registro de la aplicación appRecord que utilizará el cliente.
Estos datos se utilizan para registrarse en el servidor GDS. Esta función debe llamarse antes de iniciar el cliente GDS.
La mayor parte de los datos coinciden con los de la identidad de la aplicación. Tras el registro, se puede recuperar el identificador de aplicación asignado.
Véase también applicationRecord() y setApplicationIdentity.
void QOpcUaGdsClient::setBackend(const QString &backend)
Establece el backend que utilizará el cliente para comunicarse con el servidor de backend.
Esta función debe llamarse antes de iniciar el cliente GDS. Cambiar esta configuración posteriormente no tiene ningún efecto.
Véase también backend(), QOpcUaProvider::availableBackends() y start().
void QOpcUaGdsClient::setCertificateCheckInterval(int interval)
Establece el intervalo, en milisegundos, para comprobar la validez del certificado de cliente en interval.
Véase también ` certificateCheckInterval()`.
void QOpcUaGdsClient::setCertificateSigningRequestPresets(const QOpcUaX509DistinguishedName &dn, const QString &dns)
Establece los valores predeterminados para las solicitudes de firma de certificados: el nombre distinguido dn y la cadena DNS dns.
Al crear una solicitud de firma de certificado se necesita cierta información adicional que no proporciona la identidad de la aplicación.
Esta función debe llamarse antes de iniciar el cliente GDS.
Véase también setApplicationIdentity().
void QOpcUaGdsClient::setEndpoint(const QOpcUaEndpointDescription &endpoint)
Establece el punto final que utilizará el cliente para comunicarse con el servidor en endpoint.
Esta función debe invocarse antes de iniciar el cliente GDS. Cambiar esta configuración posteriormente no tiene ningún efecto.
La comunicación con un servidor GDS solo es posible a través de un punto final cifrado. El uso de un punto final no cifrado dará lugar a un error.
Véase también endpoint().
void QOpcUaGdsClient::setPkiConfiguration(const QOpcUaPkiConfiguration &pkiConfig)
Establece la configuración de la PKI pkiConfig que utilizará el cliente.
Todos los certificados, claves y listas de confianza se utilizarán o se almacenarán en las ubicaciones indicadas. Para poder utilizar el certificado recibido del GDS, debe utilizarse la misma configuración con QOpcUaClient.
Esta función debe llamarse antes de iniciar el cliente GDS. Cambiar esta configuración posteriormente no surtirá efecto.
Véase también pkiConfiguration().
void QOpcUaGdsClient::setTrustListUpdateInterval(int interval)
Establece el intervalo, en milisegundos, para actualizar la lista de confianza desde el servidor en interval.
Véase también trustListUpdateInterval().
void QOpcUaGdsClient::start()
Inicia el proceso del cliente.
Una vez configurada toda la información, se puede iniciar el cliente.
- setBackend
- setEndpoint
- setApplicationIdentity
- setPkiConfiguration
- setApplicationRecord
- setCertificateSigningRequestPresets
QOpcUaGdsClient::State QOpcUaGdsClient::state() const
Devuelve el estado actual del cliente.
[signal] void QOpcUaGdsClient::stateChanged(QOpcUaGdsClient::State state)
Esta señal se emite cuando cambia el estado interno del cliente. El valor de « state » indica el nuevo estado.
int QOpcUaGdsClient::trustListUpdateInterval() const
Devuelve el intervalo, en milisegundos, para actualizar la lista de confianza desde el servidor.
Véase también setTrustListUpdateInterval().
[signal] void QOpcUaGdsClient::trustListUpdated()
Esta señal se emite cuando el cliente GDS ha recibido una nueva lista de confianza del servidor y la ha guardado en el disco.
void QOpcUaGdsClient::unregisterApplication()
Da de baja una aplicación del servidor.
Esta función se puede utilizar cuando es necesario eliminar definitivamente una aplicación de la red. No es necesario llamarla al reiniciar o apagar el sistema.
[signal] void QOpcUaGdsClient::unregistered()
Esta señal se emite cuando el cliente GDS ha dado de baja la aplicación.
© 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.