Revision control
Copy as Markdown
// Copyright (C) 2019 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
#include <private/opcuaserverdiscovery_p.h>
QT_BEGIN_NAMESPACE
/*!
\qmltype ServerDiscovery
\inqmlmodule QtOpcUa
\brief Provides information about available servers.
\since QtOpcUa 5.13
\deprecated [6.9]
Allows to fetch and access information about servers known to a server or discovery server.
\snippet ../../src/declarative_opcua/doc/snippets/basic/basic.qml Basic discovery
*/
/*!
\qmlproperty string ServerDiscovery::discoveryUrl
URL of the server to retrieve the list of servers from.
Every time the URL is changed, a request to the given server is started.
When starting the request, the list of available servers is cleared
and the status is set to \l {Status::Status}{Status.GoodCompletesAsynchronously}.
Once the request is finished, \l status changes.
Make sure to check the \l status before accessing the list of servers.
\code
onServersChanged: {
if (status.isGood) {
if (status.status == QtOpcUa.Status.GoodCompletesAsynchronusly)
return; // wait until finished
if (count > 0) {
var serverUrl = at(0).serverUrl();
console.log(serverUrl);
}
} else {
// handle error
}
}
\endcode
\sa ApplicationDescription status at count Status
*/
/*!
\qmlproperty int ServerDiscovery::count
Current number of servers in this element.
Before using any data from this server discovery, you should check \l status if retrieval of the
information was successful.
\sa status Status
*/
/*!
\qmlproperty Status ServerDiscovery::status
The current status of this element.
In case the last retrieval of servers was successful, the status
should be \c Status.Good.
\code
if (status.isGood) {
// Choose endpoint to connect to
} else {
// handle error
}
\endcode
\sa Status
*/
/*!
\qmlsignal ServerDiscovery::serversChanged()
Emitted when a retrieval request started, finished or failed.
In a called function, you should first the the \l status of the object.
In case the status is \l {Status::Status}{Status.GoodCompletesAsynchronously}, the request is still running.
In case the status is \l {Status::Status}{Status.Good}, the request has finished and the application descriptions
can be read. In case the status is not good, an error happened and \l status contains the
returned error code.
\code
onServersChanged: {
if (status.isGood) {
if (status.status == QtOpcUa.Status.GoodCompletesAsynchronusly)
return; // wait until finished
if (count > 0) {
var serverUrl = at(0).endpointUrl();
console.log(serverUrl);
}
} else {
// handle error
}
}
\endcode
\sa status count at Status ApplicationDescription
*/
OpcUaServerDiscovery::OpcUaServerDiscovery(QObject *parent)
: QStandardItemModel(parent)
{
insertColumn(0);
}
OpcUaServerDiscovery::~OpcUaServerDiscovery() = default;
const QString &OpcUaServerDiscovery::discoveryUrl() const
{
return m_discoveryUrl;
}
void OpcUaServerDiscovery::setDiscoveryUrl(const QString &discoveryUrl)
{
if (discoveryUrl == m_discoveryUrl)
return;
m_discoveryUrl = discoveryUrl;
startFindServers();
emit discoveryUrlChanged();
}
int OpcUaServerDiscovery::count() const
{
return rowCount();
}
/*!
\qmlmethod ApplicationDescription ServerDiscovery::at(index)
Returns the application description at given \a index.
In case there are no servers available or the index is invalid, an invalid
application description is returned.
Before using any returned data, you should check \l status if retrieval of the
information was successful.
\code
if (servers.status.isGood) {
if (servers.count > 0)
var serverUrl = at(0).serverUrl();
console.log(serverUrl);
// Choose endpoint to connect to
} else {
// handle error
}
\endcode
\sa count status ApplicationDescription
*/
/*!
\qmlproperty Connection ServerDiscovery::connection
The connection to be used for requesting information.
If this property is not set, the default connection will be used, if any.
\sa Connection, Connection::defaultConnection
*/
QOpcUaApplicationDescription OpcUaServerDiscovery::at(int row) const
{
return index(row, 0).data(Qt::UserRole).value<QOpcUaApplicationDescription>();
}
const OpcUaStatus &OpcUaServerDiscovery::status() const
{
return m_status;
}
void OpcUaServerDiscovery::connectSignals()
{
auto conn = connection();
if (!conn || !conn->m_client)
return;
connect(conn->m_client, &QOpcUaClient::findServersFinished, this, &OpcUaServerDiscovery::handleServers, Qt::UniqueConnection);
startFindServers();
}
void OpcUaServerDiscovery::handleServers(const QList<QOpcUaApplicationDescription> &servers, QOpcUa::UaStatusCode statusCode, const QUrl &requestUrl)
{
if (requestUrl != QUrl{m_discoveryUrl})
return; // response is not for last request
m_status = OpcUaStatus(statusCode);
if (m_status.isBad()) {
emit statusChanged();
return;
}
clearData();
for (const auto &i : std::as_const(servers)) {
const int newRow = QStandardItemModel::rowCount();
QStandardItemModel::insertRow(newRow);
QStandardItemModel::setData(index(newRow, 0), QString(i.applicationUri() + u'\n' + i.productUri()), Qt::DisplayRole);
QStandardItemModel::setData(index(newRow, 0), QVariant::fromValue(i), Qt::UserRole);
}
emit countChanged();
emit serversChanged();
emit statusChanged();
}
void OpcUaServerDiscovery::startFindServers()
{
if (m_discoveryUrl.isEmpty())
return;
if (!m_connection) {
// In case no connection is set the default connection will be
// used, which fill trigger this function afterwards.
connection();
return;
}
clearData();
auto conn = connection();
if (!conn || !conn->m_client) {
m_status = OpcUaStatus(QOpcUa::BadNotConnected);
} else if (m_discoveryUrl.isEmpty()) {
m_status = OpcUaStatus(QOpcUa::BadInvalidArgument);
} else {
m_status = OpcUaStatus(QOpcUa::GoodCompletesAsynchronously);
conn->m_client->findServers(QUrl{m_discoveryUrl});
}
emit serversChanged();
emit statusChanged();
}
void OpcUaServerDiscovery::clearData()
{
QStandardItemModel::removeRows(0, QStandardItemModel::rowCount());
}
void OpcUaServerDiscovery::setConnection(OpcUaConnection *connection)
{
if (connection == m_connection || !connection)
return;
if (m_connection)
disconnect(m_connection, &OpcUaConnection::backendChanged, this, &OpcUaServerDiscovery::connectSignals);
m_connection = connection;
connect(m_connection, &OpcUaConnection::backendChanged, this, &OpcUaServerDiscovery::connectSignals);
connectSignals();
emit connectionChanged(connection);
}
OpcUaConnection *OpcUaServerDiscovery::connection()
{
if (!m_connection)
setConnection(OpcUaConnection::defaultConnection());
return m_connection;
}
QT_END_NAMESPACE