Doc: Include namespaces in TOC

The QMqtt namespace was missing from the TOC as the .qhp subproject
selected only classes and headers.

Pick-to: 6.12
Change-Id: I5692ae2e77b80d9b3c4361945891e84c1ef4ccf7
Reviewed-by: Alexei Cazacov <alexei.cazacov@qt.io>

.cmake.conf

@@ -1,5 +1,5 @@
-set(QT_REPO_MODULE_VERSION "6.5.0")
+set(QT_REPO_MODULE_VERSION "6.13.0")
 set(QT_REPO_MODULE_PRERELEASE_VERSION_SEGMENT "alpha1")
-set(QT_EXTRA_INTERNAL_TARGET_DEFINES "QT_NO_AS_CONST=1")
-# Use cpp-based syncqt
-set(QT_USE_SYNCQT_CPP TRUE)
+set(QT_EXTRA_INTERNAL_TARGET_DEFINES "QT_NO_QASCONST=1")
+list(APPEND QT_EXTRA_INTERNAL_TARGET_DEFINES "QT_NO_FOREACH=1")
+list(APPEND QT_EXTRA_INTERNAL_TARGET_DEFINES "QT_NO_SINGLE_ARGUMENT_QHASH_OVERLOAD=1")

.gitignore

@@ -68,6 +68,7 @@ Makefile*
 
 # QtCtreator CMake
 CMakeLists.txt.user*
+CMakeUserPresets.json
 
 ## Visual Studio
 # User-specific files

.gitreview

@@ -0,0 +1,4 @@
+[gerrit]
+host=codereview.qt-project.org
+project=qt/qtmqtt
+defaultbranch=dev

CMakeLists.txt

@@ -1,8 +1,6 @@
 # Copyright (C) 2022 The Qt Company Ltd.
 # SPDX-License-Identifier: BSD-3-Clause
 
-# Generated from qtmqtt.pro.
-
 cmake_minimum_required(VERSION 3.16)
 
 include(.cmake.conf)
@@ -13,7 +11,14 @@ project(QtMqtt
     LANGUAGES CXX C
 )
 
-find_package(Qt6 ${PROJECT_VERSION} CONFIG REQUIRED COMPONENTS BuildInternals Core Network) # special case
-find_package(Qt6 ${PROJECT_VERSION} CONFIG OPTIONAL_COMPONENTS Quick WebSockets # For tests # special case
-                                                               Gui Widgets) # For examples # special case
+find_package(Qt6 ${PROJECT_VERSION} CONFIG REQUIRED COMPONENTS BuildInternals)
+
+# This should be called as early as possible, just after find_package(BuildInternals) where it is
+# defined.
+qt_internal_project_setup()
+
+find_package(Qt6 ${PROJECT_VERSION} CONFIG REQUIRED COMPONENTS Core Network)
+find_package(Qt6 ${PROJECT_VERSION} CONFIG OPTIONAL_COMPONENTS Quick  # For tests
+                                                               Gui Widgets WebSockets) # For examples
+
 qt_build_repo()

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+## Qt contribution guidelines
+
+We welcome contributions to Qt!
+
+Note that we cannot accept pull requests on GitHub. All contributions
+to the Qt project are exclusively handled through the
+[Gerrit code review system](https://codereview.qt-project.org).
+
+See
+[contribute.qt-project.org](https://contribute.qt-project.org/) to learn
+more.

LICENSES/Qt-GPL-exception-1.0.txt

@@ -1,22 +0,0 @@
-The Qt Company GPL Exception 1.0
-
-Exception 1:
-
-As a special exception you may create a larger work which contains the
-output of this application and distribute that work under terms of your
-choice, so long as the work is not otherwise derived from or based on
-this application and so long as the work does not in itself generate
-output that contains the output from this application in its original
-or modified form.
-
-Exception 2:
-
-As a special exception, you have permission to combine this application
-with Plugins licensed under the terms of your choice, to produce an
-executable, and to copy and distribute the resulting executable under
-the terms of your choice. However, the executable must be accompanied
-by a prominent notice offering all users of the executable the entire
-source code to this application, excluding the source code of the
-independent modules, but including any changes you have made to this
-application, under the terms of this license.
-

REUSE.toml

@@ -0,0 +1,44 @@
+version = 1
+
+[[annotations]]
+path = [".cmake.conf", "**.yaml", "**/ci_config_linux.json", "**.pro", ".tag"]
+precedence = "closest"
+comment = "build system"
+SPDX-FileCopyrightText = "Copyright (C) The Qt Company Ltd."
+SPDX-License-Identifier = "BSD-3-Clause"
+
+[[annotations]]
+path = ["**/.gitattributes", "**.gitignore", "**.gitreview"]
+precedence = "closest"
+comment = "version control system. Infrastructure"
+SPDX-FileCopyrightText = "Copyright (C) The Qt Company Ltd."
+SPDX-License-Identifier = "LicenseRef-Qt-Commercial OR BSD-3-Clause"
+
+[[annotations]]
+path = ["**/doc/images/**", "examples/**"]
+comment = "this must be after the build system table because example and snippets take precedence over build system"
+precedence = "closest"
+SPDX-FileCopyrightText = "Copyright (C) The Qt Company Ltd."
+SPDX-License-Identifier = "LicenseRef-Qt-Commercial OR BSD-3-Clause"
+
+[[annotations]]
+path = ["**.qdocconf",  "src/mqtt/doc/style/style.css",
+        "tests/README.txt", "CONTRIBUTING.md"]
+comment = "documentation"
+precedence = "closest"
+SPDX-FileCopyrightText = "Copyright (C) The Qt Company Ltd."
+SPDX-License-Identifier = "LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only"
+
+[[annotations]]
+path = ["**.toml", "licenseRule.json"]
+comment = "infrastructure"
+precedence = "override"
+SPDX-FileCopyrightText = "Copyright (C) The Qt Company Ltd."
+SPDX-License-Identifier = "LicenseRef-Qt-Commercial OR BSD-3-Clause"
+
+[[annotations]]
+path = ["**/qt_attribution.json"]
+comment = "currently not needed, but ready if such file is added. documentation."
+precedence = "override"
+SPDX-FileCopyrightText = "Copyright (C) The Qt Company Ltd."
+SPDX-License-Identifier = "LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only"

coin/axivion/ci_config_linux.json

@@ -0,0 +1,40 @@
+{
+    "Project": {
+        "BuildSystemIntegration": {
+            "child_order": [
+                "GCCSetup",
+                "CMake",
+                "LinkLibraries"
+            ]
+        },
+        "CMake": {
+            "_active": true,
+            "_copy_from": "CMakeIntegration",
+            "build_environment": {},
+            "build_options": "-j4",
+            "generate_options": "--fresh",
+            "generator": "Ninja"
+        },
+        "GCCSetup": {
+            "_active": true,
+            "_copy_from": "Command",
+            "build_command": "gccsetup --cc gcc --cxx g++ --config ../../../axivion/"
+        },
+        "LinkLibraries": {
+            "_active": true,
+            "_copy_from": "AxivionLinker",
+            "input_files": [
+                "build/lib/lib*.so*.ir"
+            ],
+            "ir": "build/$(env:TESTED_MODULE_COIN).ir"
+        }
+    },
+    "_Format": "1.0",
+    "_Version": "7.6.2",
+    "_VersionNum": [
+        7,
+        6,
+        2,
+        12725
+    ]
+}

coin/module_config.yaml

@@ -6,7 +6,23 @@ accept_configuration:
 
 instructions:
   Build:
+    - type: EnvironmentVariable
+      variableName: VERIFY_SOURCE_SBOM
+      variableValue: "ON"
+    - type: EnvironmentVariable
+      variableName: COIN_NO_MOSQUITTO
+      variableValue: "1"
+      enable_if:
+        condition: and
+        conditions:
+          - condition: property
+            property: host.os
+            equals_value: Windows
+          - condition: property
+            property: target.arch
+            in_values: ["AARCH64", "ARM64"]
     - !include "{{qt/qtbase}}/coin_module_build_template_v2.yaml"
 
   Test:
-    - !include "{{qt/qtbase}}/coin_module_test_template_v2.yaml"
+    - !include "{{qt/qtbase}}/coin_module_test_template_v3.yaml"
+    - !include "{{qt/qtbase}}/coin_module_test_docs.yaml"

conanfile.py

@@ -1,34 +0,0 @@
-# Copyright (C) 2021 The Qt Company Ltd.
-# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
-
-from conans import ConanFile
-import re
-from pathlib import Path
-
-
-def _parse_qt_version_by_key(key: str) -> str:
-    with open(Path(__file__).parent.resolve() / ".cmake.conf") as f:
-        m = re.search(fr'{key} .*"(.*)"', f.read())
-    return m.group(1) if m else ""
-
-
-def _get_qt_minor_version() -> str:
-    return ".".join(_parse_qt_version_by_key("QT_REPO_MODULE_VERSION").split(".")[:2])
-
-
-class QtMqtt(ConanFile):
-    name = "qtmqtt"
-    license = "GPL-3.0+, Commercial Qt License Agreement"
-    author = "The Qt Company <https://www.qt.io/contact-us>"
-    url = "https://code.qt.io/cgit/qt/qtmqtt.git"
-    description = (
-        "Qt MQTT is a machine-to-machine (M2M) protocol utilizing the "
-        "publish-and-subscribe paradigm."
-    )
-    topics = "qt", "qt6", "MQTT", "M2M"
-    settings = "os", "compiler", "arch", "build_type"
-    # for referencing the version number and prerelease tag and dependencies info
-    exports = ".cmake.conf", "dependencies.yaml"
-    exports_sources = "*", "!conan*.*"
-    python_requires = f"qt-conan-common/{_get_qt_minor_version()}@qt/everywhere"
-    python_requires_extend = "qt-conan-common.QtLeafModule"

dependencies.yaml

@@ -1,7 +1,10 @@
 dependencies:
   ../qtbase:
-    ref: fa2153bd10057d7adbc5f5ededa1fd97c4a68161
+    ref: 537c0040b0c1a1b3bae99e9edca827c9e3a16ee7
     required: true
   ../qtdeclarative:
-    ref: a39dc2807c22c6819647bab1259ba8f7532e7f32
+    ref: 3c20488ac4a676c612cef9539144194a4fb86801
     required: true
+  ../qtwebsockets:
+    ref: 217120e4e991ed2de51cac910cccfbf51f912e65
+    required: false

dist/REUSE.toml

@@ -0,0 +1,8 @@
+version = 1
+
+[[annotations]]
+path = ["*"]
+precedence = "override"
+comment = "Licensed as documentation."
+SPDX-FileCopyrightText = "Copyright (C) The Qt Company Ltd."
+SPDX-License-Identifier = "LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only"

examples/CMakeLists.txt

@@ -1,5 +1,5 @@
 # Copyright (C) 2022 The Qt Company Ltd.
-# SPDX-License-Identifier: BSD-3-Clause
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
 qt_examples_build_begin(EXTERNAL_BUILD)
 

examples/mqtt/CMakeLists.txt

@@ -1,7 +1,6 @@
-# Copyright (C) 2022 The Qt Company Ltd.
-# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (C) 2023 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
-qt_internal_add_example(consolepubsub)
 if(TARGET Qt::Gui AND TARGET Qt::Widgets)
     qt_internal_add_example(simpleclient)
     qt_internal_add_example(subscriptions)

examples/mqtt/consolepubsub/consolepubsub.pro

@@ -1,8 +0,0 @@
-TEMPLATE = subdirs
-
-SUBDIRS = \
-    qtmqtt_pub.pro \
-    qtmqtt_sub.pro
-
-CONFIG += ordered
-

examples/mqtt/consolepubsub/qtmqtt_pub.pro

@@ -1,25 +0,0 @@
-QT -= gui
-QT += mqtt
-
-CONFIG += c++11 console
-CONFIG -= app_bundle
-
-# The following define makes your compiler emit warnings if you use
-# any Qt feature that has been marked deprecated (the exact warnings
-# depend on your compiler). Please consult the documentation of the
-# deprecated API in order to know how to port your code away from it.
-DEFINES += QT_DEPRECATED_WARNINGS
-
-# You can also make your code fail to compile if it uses deprecated APIs.
-# In order to do so, uncomment the following line.
-# You can also select to disable deprecated APIs only up to a certain version of Qt.
-#DEFINES += QT_DISABLE_DEPRECATED_UP_TO=0x060000 # disables all APIs deprecated in Qt 6.0.0 and earlier
-
-SOURCES += \
-        main_pub.cpp
-
-HEADERS += \
-        configuration.h
-
-target.path = $$[QT_INSTALL_EXAMPLES]/mqtt/consolepubsub
-INSTALLS += target

examples/mqtt/consolepubsub/qtmqtt_sub.pro

@@ -1,25 +0,0 @@
-QT -= gui
-QT += mqtt
-
-CONFIG += c++11 console
-CONFIG -= app_bundle
-
-# The following define makes your compiler emit warnings if you use
-# any Qt feature that has been marked deprecated (the exact warnings
-# depend on your compiler). Please consult the documentation of the
-# deprecated API in order to know how to port your code away from it.
-DEFINES += QT_DEPRECATED_WARNINGS
-
-# You can also make your code fail to compile if it uses deprecated APIs.
-# In order to do so, uncomment the following line.
-# You can also select to disable deprecated APIs only up to a certain version of Qt.
-#DEFINES += QT_DISABLE_DEPRECATED_UP_TO=0x060000 # disables all APIs deprecated in Qt 6.0.0 and earlier
-
-SOURCES += \
-        main_sub.cpp
-
-HEADERS += \
-        configuration.h
-
-target.path = $$[QT_INSTALL_EXAMPLES]/mqtt/consolepubsub
-INSTALLS += target

examples/mqtt/doc/quickpublication.qdoc

@@ -0,0 +1,62 @@
+// Copyright (C) 2023 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+    \example quickpublication
+    \title Qt Quick Publication
+    \examplecategory {Connectivity}
+    \ingroup qtmqtt-examples
+    \brief Use Qt Quick Controls to create an application that can publish on MQTT
+    topics.
+
+    \image quickpublication.png
+           {MQTT publishing interface with Hostname, Port, Topic, Message, QoS,
+           and Retain fields}
+
+    \e {Qt Quick Publication} demonstrates how to register QMqttClient as a QML type and
+    use it in a Qt Quick application.
+
+    \l {Qt MQTT} does not provide a QML API in its current version. However,
+    you can make the C++ classes of the module available to QML.
+
+    \section1 Creating a Client
+
+    Create the wrapper class \c QmlMqttClient that has QMqttClient as a member:
+    \quotefromfile quickpublication/qmlmqttclient.h
+    \skipto private
+    \printuntil }
+
+    Connect the wrapper methods to the methods of QMqttClient in the constructor:
+    \quotefromfile quickpublication/qmlmqttclient.cpp
+    \skipto QmlMqttClient
+    \printuntil }
+
+    A wrapper method has the same name as the wrapped method. In the simplest case,
+    it is just a single method call:
+
+    \skipto connectToHost
+    \printuntil }
+
+    It is also possible to customize a wrapper method by extending it with some additional
+    functionality:
+
+    \skipto setPort
+    \printuntil );
+
+    \section1 Registering Classes in QML
+
+    In the \c main.cpp file, load the QML type Main from the module
+    publication:
+
+    \quotefromfile quickpublication/main.cpp
+    \skipto (argc
+    \printuntil loadFromModule
+
+
+    Now use the MqttClient type in the \c Main.qml file to create an
+    MQTT client:
+
+    \quotefromfile quickpublication/Main.qml
+    \skipto MqttClient {
+    \printuntil }
+*/

examples/mqtt/doc/quicksubscription.qdoc

@@ -3,14 +3,17 @@
 
 /*!
     \example quicksubscription
-    \title Quick MQTT Example
+    \title Qt Quick Subscription
+    \examplecategory {Connectivity}
     \ingroup qtmqtt-examples
-    \brief Registering QMqttClient to QML and using it in a Qt Quick user
-    interface.
+    \brief Use Qt Quick Controls to create an application that can subscribe to MQTT
+    topics.
 
     \image quicksubscription.png
+           {MQTT subscription interface with Hostname, Port, Topic fields, Connect
+           and Subscribe buttons}
 
-    \e {Quick MQTT} demonstrates how to register QMqttClient as a QML type and
+    \e {Qt Quick Subscription} demonstrates how to register QMqttClient as a QML type and
     use it in a Qt Quick application.
 
     \l {Qt MQTT} does not provide a QML API in its current version. However,
@@ -18,23 +21,24 @@
 
     \section1 Creating a Client
 
-    We create a \c QmlMqttClient class with the QMqttClient class as a base
-    class:
+    Connect to QMqttSubscription::messageReceived( ) to receive all messages
+    sent to the broker:
 
     \quotefromfile quicksubscription/qmlmqttclient.cpp
+    \skipto QmlMqttSubscription
+    \printuntil }
+
+    Create a \c QmlMqttClient class with the QMqttClient class as a base
+    class:
+
     \skipto QmlMqttClient(
     \printuntil }
 
-    We use the \c subscribe() function to create a subscription object:
-
+    Use the \c subscribe() function to create a subscription object:
+    \skipto subscribe
     \printuntil }
 
-    We connect to QMqttSubscription::messageReceived( ) to receive all messages
-    sent to the broker:
-
-    \printuntil }
-
-    We use an QMqttMessage object to store the payload of a received
+    Use a QMqttMessage object to store the payload of a received
     message:
 
     \skipto handleMessage
@@ -42,22 +46,17 @@
 
     \section1 Registering Classes in QML
 
-    In the \c main.cpp file, we register the \c QmlMqttClient class as a
-    QML type, MqttClient:
+    In the \c main.cpp file, load the QML type Main from the module
+    subscription:
 
     \quotefromfile quicksubscription/main.cpp
-    \skipto main(int
-    \printuntil qmlRegisterType
+    \skipto (argc
+    \printuntil loadFromModule
 
-    In addition, we register the \c QmlMqttSubscription class as an uncreatable
-    type:
-
-    \printuntil qmlRegisterUncreatableType
-
-    We can now use the MqttClient type in the \c main.qml file to create an
+    Now use the MqttClient type in the \c Main.qml file to create an
     MQTT client:
 
-    \quotefromfile quicksubscription/main.qml
+    \quotefromfile quicksubscription/Main.qml
     \skipto MqttClient {
     \printuntil }
 */

examples/mqtt/doc/simpleclient.qdoc

@@ -3,23 +3,67 @@
 
 /*!
     \example simpleclient
-    \title Simple MQTT Client Example
+    \examplecategory {Connectivity}
+    \title Simple MQTT Client
     \ingroup qtmqtt-examples
     \brief Creating a minimalistic telemetry application.
 
     \image simpleclient.png
+           {MQTT client with Host, Port, Protocol fields, WebSockets and Secure
+           options, Topic and Message inputs, and log showing state changes}
 
     \e {Simple MQTT Client} demonstrates how to create a minimalistic client
     application.
 
-    To use the application, you first specify a broker, such as
-    \e test.mosquitto.org or \e broker.hivemq.com and the port number 1883, and
-    connect to it. You can then subscribe to a topic and send a message, which
-    you will also receive.
+    To use the application, you first specify a Host, a Port, Secure on/off,
+    WebSockets on/off, and Protocol. Then click on connect. Afterward you can
+    subscribe to a topic and send a message, which you will also receive.
+    You may also run the application twice. Publish in one and Subscribe in
+    the other, and the messages shall be transmitted.
 
-    \note Port number 1883 is not encrypted, and therefore it is suitable only
-    for development and testing purposes. In production, always use encrypted
-    connections.
+    \section1 simpleclient Options
+    \list
+        \li Host - you may use test.mosquitto.org or broker.hivemq.com
+        \li Port - port to connect to, will depend on WebSockets selection and Secure selection
+        \li WebSockets - you may specify: selected (enabled) or not selected (disabled)
+        \li Secure - you may specify: selected (enabled) or not selected (disabled)
+        \li Protocol - you may specify
+        \list
+             \li mqtt 3.1
+             \li mqtt 3.1.1
+             \li mqtt 5.0
+        \endlist
+        \li Topic - A topic to publish or subscribe to
+        \li Message - A message to send on the topic if you are publishing
+    \endlist
+
+    \section1 Connection Settings
+    These are the usual combinations, and will work with test.mosquitto.org.
+    For broker.hivemq.com check the information in the links. Note that if
+    Secure is enabled it might be necessary to install certificates on the
+    computer. It might also be necessary to add the certificate to the mqtt
+    client in code.
+
+    \section1
+    \list
+        \li Port 1883, Secure=disabled, WebSockets=disabled - mqtt over tcp
+        \li Port 8883, Secure=enabled,  WebSockets=disabled - mqtt over ssl
+        \li Port 8080, Secure=disabled, WebSockets=enabled  - mqtt over websockets
+        \li Port 8081, Secure=enabled,  WebSockets=enabled  - mqtt over secure websockets
+    \endlist
+
+    For more information about the brokers see:
+    \list
+        \li \l {https://test.mosquitto.org}
+        \li \l {https://broker.hivemq.com}
+        \li \l {https://www.hivemq.com/mqtt/public-mqtt-broker}
+    \endlist
+
+    \note Port numbers 1883 and 8080 are not encrypted, and therefore they are
+    suitable only for development and testing purposes. In production, always
+    use encrypted connections.
+
+    \note WebAssembly only supports WebSockets enabled.
 
     \section1 Creating a Client
 
@@ -47,9 +91,9 @@
     \printuntil }
 
     In this example, we subscribe to all topics. For more information about
-    how to receive messages on particular topics, see
-    \l {MQTT Subscriptions Example}.
+    how to receive messages on particular topics, see the
+    \l {MQTT Subscriptions} example.
 
     For an example of how to use the QMqttClient class in a Qt Quick
-    application, see \l {Quick MQTT Example}.
+    application, see \l {Qt Quick Subscription}.
 */

examples/mqtt/doc/subscriptions.qdoc

@@ -3,11 +3,14 @@
 
 /*!
     \example subscriptions
-    \title MQTT Subscriptions Example
+    \examplecategory {Connectivity}
+    \title MQTT Subscriptions
     \ingroup qtmqtt-examples
     \brief Creating a application that communicates with an MQTT broker.
 
     \image subscriptions.png
+           {Main window with connection and publishing controls, and two
+           subscription windows showing received messages on qtmqtt/topic1}
 
     \e {MQTT Subscriptions} shows how to create an application that communicates
     with an MQTT broker. A new dialog opens for each subscription, where you can

examples/mqtt/doc/websocketsubscription.qdoc

@@ -3,7 +3,8 @@
 
 /*!
     \example websocketsubscription
-    \title WebSockets MQTT Subscription Example
+    \examplecategory {Connectivity}
+    \title WebSockets MQTT Subscription
     \ingroup qtmqtt-examples
     \brief Combining an MQTT client with a web socket connection.
 
@@ -11,4 +12,40 @@
     QIODevice to combine a \l {Qt WebSockets}{web socket} connection with
     QMqttClient.
 
+    \note Since Qt 6.10, WebSockets are supported natively by Qt MQTT.
+    This example is retained to demonstrate how to implement a custom transport.
+
+    \section1 Creating a Custom QIODevice
+
+    The new custom device, \c WebSocketIODevice, has to be a subclass of
+    \l QIODevice:
+
+    \quotefromfile websocketsubscription/websocketiodevice.h
+    \skipto WebSocketIODevice
+    \printuntil }
+
+    \section1 Designing a Class to Manage the Connection and Subscription
+
+    \c WebSocketIODevice will be a private member of the \c ClientSubscription
+    class alongside the QMqttClient and the QMqttSubscription:
+
+    \quotefromfile websocketsubscription/clientsubscription.h
+    \skipto private
+    \printuntil m_version
+
+    \section1 Subscribing to and Receiving Messages
+
+    The main logic is implemented in the \c connectAndSubscribe() method of the
+    \c ClientSubscription class. You need to verify that the web socket has
+    successfully connected before you can initialize an MQTT connection over
+    it. After the MQTT connection has been established, the QMqttClient can
+    subscribe to the topic. If the subscription is successful, the
+    QMqttSubscription can be used to receive messages from the subscribed topic
+    that will be handled by the \c handleMessage() method of the
+    \c ClientSubscription class.
+
+    \quotefromfile websocketsubscription/clientsubscription.cpp
+    \skipto connectAndSubscribe
+    \printuntil Could
+    \printuntil }
 */

examples/mqtt/mqtt.pro

@@ -1,6 +1,5 @@
 TEMPLATE = subdirs
-SUBDIRS += \
-           consolepubsub
+
 qtHaveModule(gui):qtHaveModule(widgets): SUBDIRS += \
            simpleclient \
            subscriptions

examples/mqtt/quickpublication/CMakeLists.txt

@@ -1,11 +1,9 @@
 # Copyright (C) 2022 The Qt Company Ltd.
-# SPDX-License-Identifier: BSD-3-Clause
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
 cmake_minimum_required(VERSION 3.16)
 project(quickpublication LANGUAGES CXX)
 
-set(CMAKE_AUTOMOC ON)
-
 if(NOT DEFINED INSTALL_EXAMPLESDIR)
     set(INSTALL_EXAMPLESDIR "examples")
 endif()
@@ -14,9 +12,12 @@ set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/mqtt/quickpublication")
 
 find_package(Qt6 REQUIRED COMPONENTS Core Gui Mqtt Qml Quick)
 
+qt_standard_project_setup(REQUIRES 6.5)
+
 qt_add_executable(quickpublication
+    WIN32
+    MACOSX_BUNDLE
     main.cpp
-    qmlmqttclient.cpp qmlmqttclient.h
 )
 
 set_target_properties(quickpublication PROPERTIES
@@ -28,7 +29,7 @@ target_compile_definitions(quickpublication PUBLIC
     QT_DEPRECATED_WARNINGS
 )
 
-target_link_libraries(quickpublication PUBLIC
+target_link_libraries(quickpublication PRIVATE
     Qt::Core
     Qt::Gui
     Qt::Mqtt
@@ -36,16 +37,12 @@ target_link_libraries(quickpublication PUBLIC
     Qt::Quick
 )
 
-# Resources:
-set(qml_resource_files
-    "main.qml"
-)
-
-qt6_add_resources(quickpublication "qml"
-    PREFIX
-        "/"
-    FILES
-        ${qml_resource_files}
+qt_add_qml_module(quickpublication
+    URI publication
+    QML_FILES
+        "Main.qml"
+    SOURCES
+        qmlmqttclient.cpp qmlmqttclient.h
 )
 
 install(TARGETS quickpublication

examples/mqtt/quickpublication/Main.qml

@@ -1,17 +1,16 @@
 // Copyright (C) 2018 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
-import QtQuick 2.8
-import QtQuick.Window 2.2
-import QtQuick.Controls 2.1
-import QtQuick.Layouts 1.1
-import MqttClient 1.0
+import QtQuick
+import QtQuick.Window
+import QtQuick.Controls
+import QtQuick.Layouts
 
 Window {
     visible: true
     width: 640
     height: 480
-    title: qsTr("Qt Quick MQTT Publish Example")
+    title: qsTr("Qt Quick Publication")
     id: root
 
     MqttClient {
@@ -131,7 +130,7 @@ Window {
                         return
                     }
                     client.publish(pubField.text, msgField.text, qosItems.currentText, retain.checked)
-                    addMessage(msgField.text)
+                    root.addMessage(msgField.text)
                 }
             }
         }
@@ -139,19 +138,22 @@ Window {
         ListView {
             id: messageView
             model: messageModel
-            height: 300
-            width: 200
+            implicitHeight: 300
+            implicitWidth: 200
             Layout.fillHeight: true
             Layout.fillWidth: true
             Layout.columnSpan: 2
             clip: true
             delegate: Rectangle {
-                width: messageView.width
+                id: delegatedRectangle
+                required property int index
+                required property string payload
+                width: ListView.view.width
                 height: 30
                 color: index % 2 ? "#DDDDDD" : "#888888"
                 radius: 5
                 Text {
-                    text: payload
+                    text: delegatedRectangle.payload
                     anchors.centerIn: parent
                 }
             }

examples/mqtt/quickpublication/main.cpp

@@ -1,23 +1,21 @@
 // Copyright (C) 2018 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
-#include "qmlmqttclient.h"
+#include <QtQml/qqmlapplicationengine.h>
+#include <QtGui/qguiapplication.h>
 
-#include <QGuiApplication>
-#include <QQmlApplicationEngine>
-#include <QLoggingCategory>
+using namespace Qt::StringLiterals;
 
 int main(int argc, char *argv[])
 {
     QGuiApplication app(argc, argv);
-
     QQmlApplicationEngine engine;
 
-    qmlRegisterType<QmlMqttClient>("MqttClient", 1, 0, "MqttClient");
+    QObject::connect(
+            &engine, &QQmlApplicationEngine::objectCreationFailed, &app,
+            []() { QCoreApplication::exit(EXIT_FAILURE); }, Qt::QueuedConnection);
 
-    engine.load(QUrl(QStringLiteral("qrc:/main.qml")));
-    if (engine.rootObjects().isEmpty())
-        return -1;
+    engine.loadFromModule(u"publication"_s, u"Main"_s);
 
-    return app.exec();
+    return QGuiApplication::exec();
 }

examples/mqtt/quickpublication/qml.qrc

@@ -1,5 +0,0 @@
-<RCC>
-    <qresource prefix="/">
-        <file>main.qml</file>
-    </qresource>
-</RCC>

examples/mqtt/quickpublication/qmldir

@@ -0,0 +1,4 @@
+module publication
+
+prefer :/qt/qml/publication/
+Main 1.0 Main.qml

examples/mqtt/quickpublication/qmlmqttclient.cpp

@@ -45,8 +45,6 @@ void QmlMqttClient::setPort(int newPort)
         return;
     }
     m_client.setPort(static_cast<quint16>(newPort));
-
-    m_client.state();
 }
 
 const QMqttClient::ClientState QmlMqttClient::state() const

examples/mqtt/quickpublication/qmlmqttclient.h

@@ -7,12 +7,16 @@
 #include <QtCore/QMap>
 #include <QtMqtt/QMqttClient>
 
+#include <QtQml/qqml.h>
+
 class QmlMqttClient : public QObject
 {
     Q_OBJECT
     Q_PROPERTY(QString hostname READ hostname WRITE setHostname NOTIFY hostnameChanged)
     Q_PROPERTY(int port READ port WRITE setPort NOTIFY portChanged)
     Q_PROPERTY(QMqttClient::ClientState state READ state WRITE setState NOTIFY stateChanged)
+    QML_NAMED_ELEMENT(MqttClient)
+    QML_EXTENDED_NAMESPACE(QMqttClient)
 public:
 
     QmlMqttClient(QObject *parent = nullptr);

examples/mqtt/quickpublication/quickpublication.pro

@@ -1,7 +1,8 @@
 TEMPLATE = app
+TARGET = quickpublication
 
 QT += qml quick mqtt
-CONFIG += c++11
+CONFIG += qmltypes
 
 SOURCES += main.cpp \
     qmlmqttclient.cpp
@@ -9,10 +10,15 @@ SOURCES += main.cpp \
 HEADERS += \
     qmlmqttclient.h
 
-RESOURCES += qml.qrc
+qml_resources.files = Main.qml qmldir
+qml_resources.prefix = /qt/qml/publication
+
+RESOURCES += qml_resources
 
 # Additional import path used to resolve QML modules in Qt Creator's code model
-QML_IMPORT_PATH =
+QML_IMPORT_PATH = $$pwd/.
+QML_IMPORT_NAME = publication
+QML_IMPORT_MAJOR_VERSION = 1
 
 # Additional import path used to resolve QML modules just for Qt Quick Designer
 QML_DESIGNER_IMPORT_PATH =

examples/mqtt/quicksubscription/CMakeLists.txt

@@ -1,11 +1,9 @@
 # Copyright (C) 2022 The Qt Company Ltd.
-# SPDX-License-Identifier: BSD-3-Clause
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
 cmake_minimum_required(VERSION 3.16)
 project(quicksubscription LANGUAGES CXX)
 
-set(CMAKE_AUTOMOC ON)
-
 if(NOT DEFINED INSTALL_EXAMPLESDIR)
     set(INSTALL_EXAMPLESDIR "examples")
 endif()
@@ -14,21 +12,19 @@ set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/mqtt/quicksubscription")
 
 find_package(Qt6 REQUIRED COMPONENTS Core Gui Mqtt Qml Quick)
 
-qt_add_executable(quicksubscription
-    main.cpp
-    qmlmqttclient.cpp qmlmqttclient.h
-)
+qt_standard_project_setup(REQUIRES 6.5)
 
-set_target_properties(quicksubscription PROPERTIES
-    WIN32_EXECUTABLE TRUE
-    MACOSX_BUNDLE TRUE
+qt_add_executable(quicksubscription
+    WIN32
+    MACOSX_BUNDLE
+    main.cpp
 )
 
 target_compile_definitions(quicksubscription PUBLIC
     QT_DEPRECATED_WARNINGS
 )
 
-target_link_libraries(quicksubscription PUBLIC
+target_link_libraries(quicksubscription PRIVATE
     Qt::Core
     Qt::Gui
     Qt::Mqtt
@@ -36,16 +32,12 @@ target_link_libraries(quicksubscription PUBLIC
     Qt::Quick
 )
 
-# Resources:
-set(qml_resource_files
-    "main.qml"
-)
-
-qt6_add_resources(quicksubscription "qml"
-    PREFIX
-        "/"
-    FILES
-        ${qml_resource_files}
+qt_add_qml_module(quicksubscription
+    URI subscription
+    QML_FILES
+        "Main.qml"
+    SOURCES
+        qmlmqttclient.cpp qmlmqttclient.h
 )
 
 install(TARGETS quicksubscription

examples/mqtt/quicksubscription/Main.qml

@@ -1,17 +1,16 @@
 // Copyright (C) 2017 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
-import QtQuick 2.8
-import QtQuick.Window 2.2
-import QtQuick.Controls 2.1
-import QtQuick.Layouts 1.1
-import MqttClient 1.0
+import QtQuick
+import QtQuick.Window
+import QtQuick.Controls
+import QtQuick.Layouts
 
 Window {
     visible: true
     width: 640
     height: 480
-    title: qsTr("Qt Quick MQTT Subscription Example")
+    title: qsTr("Qt Quick Subscription")
     id: root
 
     property var tempSubscription: 0
@@ -75,8 +74,8 @@ Window {
                 if (client.state === MqttClient.Connected) {
                     client.disconnectFromHost()
                     messageModel.clear()
-                    tempSubscription.destroy()
-                    tempSubscription = 0
+                    root.tempSubscription.destroy()
+                    root.tempSubscription = 0
                 } else
                     client.connectToHost()
             }
@@ -95,13 +94,13 @@ Window {
                 id: subField
                 placeholderText: "<Subscription topic>"
                 Layout.fillWidth: true
-                enabled: tempSubscription === 0
+                enabled: root.tempSubscription === 0
             }
 
             Button {
                 id: subButton
                 text: "Subscribe"
-                visible: tempSubscription === 0
+                visible: root.tempSubscription === 0
                 onClicked: {
                     if (subField.text.length === 0) {
                         console.log("No topic specified to subscribe to.")
@@ -116,19 +115,22 @@ Window {
         ListView {
             id: messageView
             model: messageModel
-            height: 300
-            width: 200
+            implicitHeight: 300
+            implicitWidth: 200
             Layout.columnSpan: 2
             Layout.fillHeight: true
             Layout.fillWidth: true
             clip: true
             delegate: Rectangle {
-                width: messageView.width
+                id: delegatedRectangle
+                required property int index
+                required property string payload
+                width: ListView.view.width
                 height: 30
                 color: index % 2 ? "#DDDDDD" : "#888888"
                 radius: 5
                 Text {
-                    text: payload
+                    text: delegatedRectangle.payload
                     anchors.centerIn: parent
                 }
             }

examples/mqtt/quicksubscription/main.cpp

@@ -1,24 +1,21 @@
 // Copyright (C) 2017 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
-#include "qmlmqttclient.h"
+#include <QtQml/qqmlapplicationengine.h>
+#include <QtGui/qguiapplication.h>
 
-#include <QGuiApplication>
-#include <QQmlApplicationEngine>
-#include <QLoggingCategory>
+using namespace Qt::StringLiterals;
 
 int main(int argc, char *argv[])
 {
     QGuiApplication app(argc, argv);
-
     QQmlApplicationEngine engine;
 
-    qmlRegisterType<QmlMqttClient>("MqttClient", 1, 0, "MqttClient");
-    qmlRegisterUncreatableType<QmlMqttSubscription>("MqttClient", 1, 0, "MqttSubscription", QLatin1String("Subscriptions are read-only"));
+    QObject::connect(
+            &engine, &QQmlApplicationEngine::objectCreationFailed, &app,
+            []() { QCoreApplication::exit(EXIT_FAILURE); }, Qt::QueuedConnection);
 
-    engine.load(QUrl(QStringLiteral("qrc:/main.qml")));
-    if (engine.rootObjects().isEmpty())
-        return -1;
+    engine.loadFromModule(u"subscription"_s, u"Main"_s);
 
-    return app.exec();
+    return QGuiApplication::exec();
 }

examples/mqtt/quicksubscription/qml.qrc

@@ -1,5 +0,0 @@
-<RCC>
-    <qresource prefix="/">
-        <file>main.qml</file>
-    </qresource>
-</RCC>

examples/mqtt/quicksubscription/qmldir

@@ -0,0 +1,4 @@
+module subscription
+
+prefer :/qt/qml/subscription/
+Main 1.0 Main.qml

examples/mqtt/quicksubscription/qmlmqttclient.cpp

@@ -9,7 +9,6 @@ QmlMqttSubscription::QmlMqttSubscription(QMqttSubscription *s, QmlMqttClient *c)
     , client(c)
 {
     connect(sub, &QMqttSubscription::messageReceived, this, &QmlMqttSubscription::handleMessage);
-    m_topic = sub->topic();
 }
 
 QmlMqttSubscription::~QmlMqttSubscription()
@@ -68,11 +67,9 @@ void QmlMqttClient::setPort(int newPort)
         return;
     }
     m_client.setPort(static_cast<quint16>(newPort));
-
-    m_client.state();
 }
 
-const QMqttClient::ClientState QmlMqttClient::state() const
+QMqttClient::ClientState QmlMqttClient::state() const
 {
     return m_client.state();
 }

examples/mqtt/quicksubscription/qmlmqttclient.h

@@ -8,18 +8,19 @@
 #include <QtMqtt/QMqttClient>
 #include <QtMqtt/QMqttSubscription>
 
+#include <QtQml/qqml.h>
+
 class QmlMqttClient;
 
 class QmlMqttSubscription : public QObject
 {
     Q_OBJECT
-    Q_PROPERTY(QMqttTopicFilter topic MEMBER m_topic NOTIFY topicChanged)
+    QML_UNCREATABLE("Not intended to be creatable")
 public:
     QmlMqttSubscription(QMqttSubscription *s, QmlMqttClient *c);
     ~QmlMqttSubscription();
 
 Q_SIGNALS:
-    void topicChanged(QString);
     void messageReceived(const QString &msg);
 
 public slots:
@@ -29,7 +30,6 @@ private:
     Q_DISABLE_COPY(QmlMqttSubscription)
     QMqttSubscription *sub;
     QmlMqttClient *client;
-    QMqttTopicFilter m_topic;
 };
 
 class QmlMqttClient : public QObject
@@ -38,6 +38,8 @@ class QmlMqttClient : public QObject
     Q_PROPERTY(QString hostname READ hostname WRITE setHostname NOTIFY hostnameChanged)
     Q_PROPERTY(int port READ port WRITE setPort NOTIFY portChanged)
     Q_PROPERTY(QMqttClient::ClientState state READ state WRITE setState NOTIFY stateChanged)
+    QML_NAMED_ELEMENT(MqttClient)
+    QML_EXTENDED_NAMESPACE(QMqttClient)
 public:
 
     QmlMqttClient(QObject *parent = nullptr);
@@ -52,7 +54,7 @@ public:
     int port() const;
     void setPort(int newPort);
 
-    const QMqttClient::ClientState state() const;
+    QMqttClient::ClientState state() const;
     void setState(const QMqttClient::ClientState &newState);
 
 signals:

examples/mqtt/quicksubscription/quicksubscription.pro

@@ -1,7 +1,8 @@
 TEMPLATE = app
+TARGET = quicksubscription
 
 QT += qml quick mqtt
-CONFIG += c++11
+CONFIG += qmltypes
 
 SOURCES += main.cpp \
     qmlmqttclient.cpp
@@ -9,10 +10,15 @@ SOURCES += main.cpp \
 HEADERS += \
     qmlmqttclient.h
 
-RESOURCES += qml.qrc
+qml_resources.files = Main.qml qmldir
+qml_resources.prefix = /qt/qml/subscription
+
+RESOURCES += qml_resources
 
 # Additional import path used to resolve QML modules in Qt Creator's code model
-QML_IMPORT_PATH =
+QML_IMPORT_PATH = $$pwd/.
+QML_IMPORT_NAME = subscription
+QML_IMPORT_MAJOR_VERSION = 1
 
 # Additional import path used to resolve QML modules just for Qt Quick Designer
 QML_DESIGNER_IMPORT_PATH =

examples/mqtt/simpleclient/CMakeLists.txt

@@ -1,5 +1,5 @@
 # Copyright (C) 2022 The Qt Company Ltd.
-# SPDX-License-Identifier: BSD-3-Clause
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
 cmake_minimum_required(VERSION 3.16)
 project(simplemqttclient LANGUAGES CXX)

examples/mqtt/simpleclient/mainwindow.cpp

@@ -8,6 +8,8 @@
 #include <QtMqtt/QMqttClient>
 #include <QtWidgets/QMessageBox>
 
+using namespace Qt::StringLiterals;
+
 MainWindow::MainWindow(QWidget *parent) :
     QMainWindow(parent),
     ui(new Ui::MainWindow)
@@ -16,30 +18,32 @@ MainWindow::MainWindow(QWidget *parent) :
 
     m_client = new QMqttClient(this);
     m_client->setHostname(ui->lineEditHost->text());
-    m_client->setPort(ui->spinBoxPort->value());
+    m_client->setPort(static_cast<quint16>(ui->spinBoxPort->value()));
 
     connect(m_client, &QMqttClient::stateChanged, this, &MainWindow::updateLogStateChange);
     connect(m_client, &QMqttClient::disconnected, this, &MainWindow::brokerDisconnected);
 
     connect(m_client, &QMqttClient::messageReceived, this, [this](const QByteArray &message, const QMqttTopicName &topic) {
         const QString content = QDateTime::currentDateTime().toString()
-                    + QLatin1String(" Received Topic: ")
+                    + " Received Topic: "_L1
                     + topic.name()
-                    + QLatin1String(" Message: ")
+                    + " Message: "_L1
                     + message
-                    + QLatin1Char('\n');
+                    + u'\n';
         ui->editLog->insertPlainText(content);
     });
 
     connect(m_client, &QMqttClient::pingResponseReceived, this, [this]() {
         const QString content = QDateTime::currentDateTime().toString()
-                    + QLatin1String(" PingResponse")
-                    + QLatin1Char('\n');
+                    + "PingResponse\n"_L1;
         ui->editLog->insertPlainText(content);
     });
 
     connect(ui->lineEditHost, &QLineEdit::textChanged, m_client, &QMqttClient::setHostname);
     connect(ui->spinBoxPort, QOverload<int>::of(&QSpinBox::valueChanged), this, &MainWindow::setClientPort);
+    connect(ui->checkBoxWebSockets, &QCheckBox::checkStateChanged, this, [this](int ws) { setWebSockets(ws != 0); });
+    connect(ui->checkBoxSecure, &QCheckBox::checkStateChanged, this, [this](int s) { setSecure(s != 0); } );
+    connect(ui->comboBoxProtocol, &QComboBox::currentIndexChanged, this, [this](int p) { setProtocol(static_cast<QMqttClient::ProtocolVersion>(p + 3)); });
     updateLogStateChange();
 }
 
@@ -54,7 +58,27 @@ void MainWindow::on_buttonConnect_clicked()
         ui->lineEditHost->setEnabled(false);
         ui->spinBoxPort->setEnabled(false);
         ui->buttonConnect->setText(tr("Disconnect"));
-        m_client->connectToHost();
+
+        m_client->setProtocolVersion(m_protocol);
+
+        if (m_secure && m_webSockets)
+            m_client->connectToHostWebSocketEncrypted();
+#if !defined(QT_NO_SSL) && !defined(Q_OS_WASM)
+        if (m_secure && !m_webSockets)
+            m_client->connectToHostEncrypted({});
+#endif
+        if (!m_secure && m_webSockets)
+            m_client->connectToHostWebSocket();
+#if !defined(Q_OS_WASM)
+        if (!m_secure && !m_webSockets)
+            m_client->connectToHost();
+#endif
+        if (m_client->state() == QMqttClient::Disconnected) {
+            ui->lineEditHost->setEnabled(true);
+            ui->spinBoxPort->setEnabled(true);
+            ui->buttonConnect->setText(tr("Connect"));
+            m_client->disconnectFromHost();
+        }
     } else {
         ui->lineEditHost->setEnabled(true);
         ui->spinBoxPort->setEnabled(true);
@@ -71,9 +95,9 @@ void MainWindow::on_buttonQuit_clicked()
 void MainWindow::updateLogStateChange()
 {
     const QString content = QDateTime::currentDateTime().toString()
-                    + QLatin1String(": State Change")
+                    + ": State Change"_L1
                     + QString::number(m_client->state())
-                    + QLatin1Char('\n');
+                    + u'\n';
     ui->editLog->insertPlainText(content);
 }
 
@@ -86,20 +110,36 @@ void MainWindow::brokerDisconnected()
 
 void MainWindow::setClientPort(int p)
 {
-    m_client->setPort(p);
+    m_client->setPort(static_cast<quint16>(p));
+}
+
+void MainWindow::setSecure(bool s)
+{
+    m_secure = s;
+}
+
+void MainWindow::setWebSockets(bool ws)
+{
+    m_webSockets = ws;
+}
+
+void MainWindow::setProtocol(QMqttClient::ProtocolVersion p)
+{
+    m_protocol = p;
 }
 
 void MainWindow::on_buttonPublish_clicked()
 {
     if (m_client->publish(ui->lineEditTopic->text(), ui->lineEditMessage->text().toUtf8()) == -1)
-        QMessageBox::critical(this, QLatin1String("Error"), QLatin1String("Could not publish message"));
+        QMessageBox::critical(this, u"Error"_s, u"Could not publish message"_s);
 }
 
 void MainWindow::on_buttonSubscribe_clicked()
 {
     auto subscription = m_client->subscribe(ui->lineEditTopic->text());
     if (!subscription) {
-        QMessageBox::critical(this, QLatin1String("Error"), QLatin1String("Could not subscribe. Is there a valid connection?"));
+        QMessageBox::critical(this, u"Error"_s,
+                              u"Could not subscribe. Is there a valid connection?"_s);
         return;
     }
 }

examples/mqtt/simpleclient/mainwindow.h

@@ -23,7 +23,9 @@ public:
 
 public slots:
     void setClientPort(int p);
-
+    void setSecure(bool s);
+    void setWebSockets(bool ws);
+    void setProtocol(QMqttClient::ProtocolVersion p);
 private slots:
     void on_buttonConnect_clicked();
     void on_buttonQuit_clicked();
@@ -36,8 +38,11 @@ private slots:
     void on_buttonSubscribe_clicked();
 
 private:
-    Ui::MainWindow *ui;
-    QMqttClient *m_client;
+    Ui::MainWindow *ui = nullptr;
+    QMqttClient *m_client = nullptr;
+    bool m_secure = false;
+    bool m_webSockets = false;
+    QMqttClient::ProtocolVersion m_protocol = QMqttClient::ProtocolVersion::MQTT_3_1_1;
 };
 
 #endif // MAINWINDOW_H

examples/mqtt/simpleclient/mainwindow.ui

@@ -18,9 +18,9 @@
     <item>
      <layout class="QHBoxLayout" name="horizontalLayout">
       <item>
-       <layout class="QFormLayout" name="formLayout">
+       <layout class="QGridLayout" name="gridLayout">
         <item row="0" column="0">
-         <widget class="QLabel" name="label">
+         <widget class="QLabel" name="labelHost">
           <property name="text">
            <string>Host:</string>
           </property>
@@ -33,8 +33,15 @@
           </property>
          </widget>
         </item>
+        <item row="0" column="2" rowspan="3">
+         <widget class="QPushButton" name="buttonConnect">
+          <property name="text">
+           <string>Connect</string>
+          </property>
+         </widget>
+        </item>
         <item row="2" column="0">
-         <widget class="QLabel" name="label_2">
+         <widget class="QLabel" name="labelPort">
           <property name="text">
            <string>Port:</string>
           </property>
@@ -43,51 +50,69 @@
         <item row="2" column="1">
          <widget class="QSpinBox" name="spinBoxPort">
           <property name="maximum">
-           <number>99999</number>
+           <number>65535</number>
           </property>
           <property name="value">
            <number>1883</number>
           </property>
          </widget>
         </item>
+        <item row="3" column="0">
+         <widget class="QLabel" name="labelWebSockets">
+          <property name="text">
+           <string>WebSockets:</string>
+          </property>
+         </widget>
+        </item>
+        <item row="3" column="1">
+         <widget class="QCheckBox" name="checkBoxWebSockets" />
+        </item>
+        <item row="4" column="0">
+         <widget class="QLabel" name="labelSecure">
+          <property name="text">
+           <string>Secure:</string>
+          </property>
+         </widget>
+        </item>
+        <item row="4" column="1">
+         <widget class="QCheckBox" name="checkBoxSecure" />
+        </item>
+        <item row="5" column="0">
+         <widget class="QLabel" name="labelProtocol">
+          <property name="text">
+           <string>Protocol:</string>
+          </property>
+         </widget>
+        </item>
+        <item row="5" column="1">
+         <widget class="QComboBox" name="comboBoxProtocol">
+            <item>
+                <property name="text">
+                    <string>mqtt 3.1</string>
+                </property>
+            </item>
+            <item>
+                <property name="text">
+                    <string>mqtt 3.1.1</string>
+                </property>
+            </item>
+            <item>
+                <property name="text">
+                    <string>mqtt 5.0</string>
+                </property>
+            </item>
+         </widget>
+        </item>
        </layout>
       </item>
-      <item>
-       <widget class="QPushButton" name="buttonConnect">
-        <property name="text">
-         <string>Connect</string>
-        </property>
-       </widget>
-      </item>
      </layout>
     </item>
     <item>
-     <layout class="QGridLayout" name="gridLayout">
-      <item row="1" column="1">
-       <widget class="QLineEdit" name="lineEditMessage">
+     <layout class="QGridLayout" name="gridLayout2">
+      <item row="0" column="0">
+       <widget class="QLabel" name="labelTopic">
         <property name="text">
-         <string>This is a test message</string>
-        </property>
-       </widget>
-      </item>
-      <item row="1" column="0">
-       <widget class="QLabel" name="label_4">
-        <property name="text">
-         <string>Message:</string>
-        </property>
-       </widget>
-      </item>
-      <item row="0" column="2">
-       <widget class="QPushButton" name="buttonSubscribe">
-        <property name="text">
-         <string>Subscribe</string>
-        </property>
-       </widget>
-      </item>
-      <item row="1" column="2">
-       <widget class="QPushButton" name="buttonPublish">
-        <property name="text">
-         <string>Publish</string>
+         <string>Topic:</string>
         </property>
        </widget>
       </item>
@@ -98,10 +123,31 @@
         </property>
        </widget>
       </item>
-      <item row="0" column="0">
-       <widget class="QLabel" name="label_3">
+      <item row="0" column="2">
+       <widget class="QPushButton" name="buttonSubscribe">
         <property name="text">
-         <string>Topic:</string>
+         <string>Subscribe</string>
+        </property>
+       </widget>
+      </item>
+      <item row="1" column="0">
+       <widget class="QLabel" name="labelMessage">
+        <property name="text">
+         <string>Message:</string>
+        </property>
+       </widget>
+      </item>
+      <item row="1" column="1">
+       <widget class="QLineEdit" name="lineEditMessage">
+        <property name="text">
+         <string>This is a test message</string>
+        </property>
+       </widget>
+      </item>
+      <item row="1" column="2">
+       <widget class="QPushButton" name="buttonPublish">
+        <property name="text">
+         <string>Publish</string>
         </property>
        </widget>
       </item>
@@ -114,7 +160,11 @@
       </property>
       <layout class="QHBoxLayout" name="horizontalLayout_2">
        <item>
-        <widget class="QPlainTextEdit" name="editLog"/>
+        <widget class="QPlainTextEdit" name="editLog">
+         <property name="readOnly">
+          <bool>true</bool>
+         </property>
+        </widget>
        </item>
       </layout>
      </widget>
@@ -145,37 +195,6 @@
     </item>
    </layout>
   </widget>
-  <widget class="QMenuBar" name="menuBar">
-   <property name="geometry">
-    <rect>
-     <x>0</x>
-     <y>0</y>
-     <width>1024</width>
-     <height>20</height>
-    </rect>
-   </property>
-   <widget class="QMenu" name="menuFile">
-    <property name="title">
-     <string>File</string>
-    </property>
-    <addaction name="actionQuit"/>
-   </widget>
-   <addaction name="menuFile"/>
-  </widget>
-  <widget class="QToolBar" name="mainToolBar">
-   <attribute name="toolBarArea">
-    <enum>TopToolBarArea</enum>
-   </attribute>
-   <attribute name="toolBarBreak">
-    <bool>false</bool>
-   </attribute>
-  </widget>
-  <widget class="QStatusBar" name="statusBar"/>
-  <action name="actionQuit">
-   <property name="text">
-    <string>Quit</string>
-   </property>
-  </action>
  </widget>
  <layoutdefault spacing="6" margin="11"/>
  <resources/>

examples/mqtt/subscriptions/CMakeLists.txt

@@ -1,5 +1,5 @@
 # Copyright (C) 2022 The Qt Company Ltd.
-# SPDX-License-Identifier: BSD-3-Clause
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
 cmake_minimum_required(VERSION 3.16)
 project(mqttsubscriptions LANGUAGES CXX)

examples/mqtt/subscriptions/mainwindow.cpp

@@ -9,6 +9,8 @@
 #include <QtMqtt/QMqttClient>
 #include <QtWidgets/QMessageBox>
 
+using namespace Qt::StringLiterals;
+
 MainWindow::MainWindow(QWidget *parent) :
     QMainWindow(parent),
     ui(new Ui::MainWindow)
@@ -17,25 +19,24 @@ MainWindow::MainWindow(QWidget *parent) :
 
     m_client = new QMqttClient(this);
     m_client->setHostname(ui->lineEditHost->text());
-    m_client->setPort(ui->spinBoxPort->value());
+    m_client->setPort(static_cast<quint16>(ui->spinBoxPort->value()));
 
     connect(m_client, &QMqttClient::stateChanged, this, &MainWindow::updateLogStateChange);
     connect(m_client, &QMqttClient::disconnected, this, &MainWindow::brokerDisconnected);
 
     connect(m_client, &QMqttClient::messageReceived, this, [this](const QByteArray &message, const QMqttTopicName &topic) {
         const QString content = QDateTime::currentDateTime().toString()
-                    + QLatin1String(" Received Topic: ")
+                    + " Received Topic: "_L1
                     + topic.name()
-                    + QLatin1String(" Message: ")
+                    + " Message: "_L1
                     + message
-                    + QLatin1Char('\n');
+                    + u'\n';
         ui->editLog->insertPlainText(content);
     });
 
     connect(m_client, &QMqttClient::pingResponseReceived, this, [this]() {
         const QString content = QDateTime::currentDateTime().toString()
-                    + QLatin1String(" PingResponse")
-                    + QLatin1Char('\n');
+                    + " PingResponse\n"_L1;
         ui->editLog->insertPlainText(content);
     });
 
@@ -79,9 +80,9 @@ void MainWindow::on_buttonQuit_clicked()
 void MainWindow::updateLogStateChange()
 {
     const QString content = QDateTime::currentDateTime().toString()
-                    + QLatin1String(": State Change")
+                    + ": State Change"_L1
                     + QString::number(m_client->state())
-                    + QLatin1Char('\n');
+                    + u'\n';
     ui->editLog->insertPlainText(content);
 }
 
@@ -96,23 +97,25 @@ void MainWindow::brokerDisconnected()
 
 void MainWindow::setClientPort(int p)
 {
-    m_client->setPort(p);
+    m_client->setPort(static_cast<quint16>(p));
 }
 
 void MainWindow::on_buttonPublish_clicked()
 {
-    if (m_client->publish(ui->lineEditTopic->text(),
-                          ui->lineEditMessage->text().toUtf8(),
-                          ui->spinQoS_2->text().toUInt(),
-                          ui->checkBoxRetain->isChecked()) == -1)
-        QMessageBox::critical(this, QLatin1String("Error"), QLatin1String("Could not publish message"));
+    if (m_client->publish(ui->lineEditTopic->text(), ui->lineEditMessage->text().toUtf8(),
+                          static_cast<quint8>(ui->spinQoS_2->text().toUInt()),
+                          ui->checkBoxRetain->isChecked())
+        == -1)
+        QMessageBox::critical(this, u"Error"_s, u"Could not publish message"_s);
 }
 
 void MainWindow::on_buttonSubscribe_clicked()
 {
-    auto subscription = m_client->subscribe(ui->lineEditTopic->text(), ui->spinQoS->text().toUInt());
+    auto subscription = m_client->subscribe(ui->lineEditTopic->text(),
+                                            static_cast<quint8>(ui->spinQoS->text().toUInt()));
     if (!subscription) {
-        QMessageBox::critical(this, QLatin1String("Error"), QLatin1String("Could not subscribe. Is there a valid connection?"));
+        QMessageBox::critical(this, u"Error"_s,
+                              u"Could not subscribe. Is there a valid connection?"_s);
         return;
     }
     auto subWindow = new SubscriptionWindow(subscription);

examples/mqtt/subscriptions/subscriptionwindow.cpp

@@ -4,6 +4,8 @@
 #include "subscriptionwindow.h"
 #include "ui_subscriptionwindow.h"
 
+using namespace Qt::StringLiterals;
+
 SubscriptionWindow::SubscriptionWindow(QMqttSubscription *sub, QWidget *parent) :
     QWidget(parent),
     ui(new Ui::SubscriptionWindow),
@@ -37,19 +39,22 @@ void SubscriptionWindow::updateStatus(QMqttSubscription::SubscriptionState state
 {
     switch (state) {
     case QMqttSubscription::Unsubscribed:
-        ui->labelStatus->setText(QLatin1String("Unsubscribed"));
+        ui->labelStatus->setText(u"Unsubscribed"_s);
         break;
     case QMqttSubscription::SubscriptionPending:
-        ui->labelStatus->setText(QLatin1String("Pending"));
+        ui->labelStatus->setText(u"Pending"_s);
         break;
     case QMqttSubscription::Subscribed:
-        ui->labelStatus->setText(QLatin1String("Subscribed"));
+        ui->labelStatus->setText(u"Subscribed"_s);
         break;
     case QMqttSubscription::Error:
-        ui->labelStatus->setText(QLatin1String("Error"));
+        ui->labelStatus->setText(u"Error"_s);
+        break;
+    case QMqttSubscription::UnsubscriptionPending:
+        ui->labelStatus->setText(u"Pending Unsubscription"_s);
         break;
     default:
-        ui->labelStatus->setText(QLatin1String("--Unknown--"));
+        ui->labelStatus->setText(u"--Unknown--"_s);
         break;
     }
 }

examples/mqtt/websocketsubscription/CMakeLists.txt

@@ -1,5 +1,5 @@
 # Copyright (C) 2022 The Qt Company Ltd.
-# SPDX-License-Identifier: BSD-3-Clause
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
 cmake_minimum_required(VERSION 3.16)
 project(websocketsubscription LANGUAGES CXX)

examples/mqtt/websocketsubscription/main.cpp

@@ -7,32 +7,33 @@
 #include <QtCore/QCommandLineParser>
 #include <QtCore/QLoggingCategory>
 
+using namespace Qt::StringLiterals;
+
 int main(int argc, char *argv[])
 {
     QCoreApplication a(argc, argv);
     QCoreApplication::setApplicationVersion("1.0");
 
     QCommandLineParser parser;
-    parser.setApplicationDescription(QLatin1String("Websocket MQTT subscription tool"));
+    parser.setApplicationDescription(u"Websocket MQTT subscription tool"_s);
     auto help = parser.addHelpOption();
 
     // Use http://www.hivemq.com/demos/websocket-client/ in browser to publish
-    QCommandLineOption urlOption(QStringList() << "host" << "url" << "broker",
-                                 QStringLiteral("Host to connect to, eg ws://broker.hivemq.com:8000/mqtt"),
-                                 "host");
+    QCommandLineOption urlOption(QStringList{ u"host"_s, u"url"_s, u"broker"_s },
+                                 u"Host to connect to, eg ws://broker.hivemq.com:8000/mqtt"_s,
+                                 u"host"_s);
     parser.addOption(urlOption);
 
-    QCommandLineOption subscriptionOption(QStringList() << "t" << "topic",
-                                          QStringLiteral("Topic to subscribe to"), "topic");
+    QCommandLineOption subscriptionOption(QStringList{ u"t"_s, u"topic"_s },
+                                          u"Topic to subscribe to"_s, u"topic"_s);
     parser.addOption(subscriptionOption);
 
-    QCommandLineOption debugOption(QStringList() << "d" << "debug",
-                                   QStringLiteral("Enable Debug mode"));
+    QCommandLineOption debugOption(QStringList{ u"d"_s, u"debug"_s }, u"Enable Debug mode"_s);
     parser.addOption(debugOption);
 
-    QCommandLineOption versionOption(QStringList() << "v" << "version",
-                                     QStringLiteral("MQTT protocol version.\n3: MQTT 3.1\n4: MQTT 3.1.1"),
-                                     "version", "3");
+    QCommandLineOption versionOption(QStringList{ u"v"_s, u"version"_s },
+                                     u"MQTT protocol version.\n3: MQTT 3.1\n4: MQTT 3.1.1"_s,
+                                     u"version"_s, u"3"_s);
     parser.addOption(versionOption);
 
     parser.process(a.arguments());

examples/mqtt/websocketsubscription/websocketiodevice.cpp

@@ -14,10 +14,20 @@ WebSocketIODevice::WebSocketIODevice(QObject *parent)
     connect(&m_socket, &QWebSocket::binaryMessageReceived, this, &WebSocketIODevice::handleBinaryMessage);
 }
 
+bool WebSocketIODevice::isSequential() const
+{
+    return true;
+}
+
+qint64 WebSocketIODevice::bytesAvailable() const
+{
+    return static_cast<qint64>(m_buffer.size()) + QIODevice::bytesAvailable();
+}
+
 bool WebSocketIODevice::open(QIODevice::OpenMode mode)
 {
     QWebSocketHandshakeOptions options;
-    options.setSubprotocols({m_protocol});
+    options.setSubprotocols(QStringList{ QString::fromUtf8(m_protocol) });
 
     m_socket.open(m_url, options);
 
@@ -33,7 +43,7 @@ void WebSocketIODevice::close()
 qint64 WebSocketIODevice::readData(char *data, qint64 maxlen)
 {
     qint64 bytesToRead = qMin(maxlen, (qint64)m_buffer.size());
-    memcpy(data, m_buffer.constData(), bytesToRead);
+    memcpy(data, m_buffer.constData(), static_cast<size_t>(bytesToRead));
     m_buffer = m_buffer.right(m_buffer.size() - bytesToRead);
     return bytesToRead;
 }

examples/mqtt/websocketsubscription/websocketiodevice.h

@@ -13,6 +13,9 @@ class WebSocketIODevice : public QIODevice
 public:
     WebSocketIODevice(QObject *parent = nullptr);
 
+    bool isSequential() const override;
+    qint64 bytesAvailable() const override;
+
     bool open(OpenMode mode) override;
     void close() override;
 

licenseRule.json

@@ -0,0 +1,109 @@
+[
+    {
+        "comment": ["file_pattern_ending: strings matched against the end of a file name.",
+                     "location keys: regular expression matched against the beginning of",
+                     "the file path (relative to the git submodule root).",
+                     "spdx: list of SPDX-License-Expression's allowed in the matching files.",
+                     "-------------------------------------------------------",
+                     "Files with the following endings are Build System licensed,",
+                     "unless they are examples",
+                     "Files with other endings can also be build system files"
+                     ],
+        "file_pattern_ending": ["CMakeLists.txt", ".cmake", ".pro", ".pri", ".prf",
+                     "configure", "configure.bat", "cmake.in", "plist.in", "CMakeLists.txt.in",
+                     ".cmake.conf", ".tag", "ci_config_linux.json", ".yaml"],
+        "location": {
+            "": {
+                "comment": "Default",
+                "file type": "build system",
+                "spdx": ["BSD-3-Clause"]
+            },
+            "(.*)(examples/|snippets/)": {
+                "comment": "Example takes precedence",
+                "file type": "examples and snippets",
+                "spdx": ["LicenseRef-Qt-Commercial OR BSD-3-Clause"]
+            }
+        }
+    },
+    {
+        "comments": ["Files with the following endings are infrastructure licensed"],
+        "file_pattern_ending": [".gitattributes", ".gitignore", ".gitmodules", ".gitreview",
+                                "_clang-format", "licenseRule.json", "REUSE.toml"],
+        "location":{
+            "": {
+                "comment": "Default",
+                "file type": "infrastructure",
+                "spdx": ["LicenseRef-Qt-Commercial OR BSD-3-Clause"]
+            }
+        }
+    },
+    {
+        "comments": ["Files with the following endings are Tool licensed,",
+                      "unless they are examples.",
+                      "Files with other endings can also be tool files."],
+        "file_pattern_ending": [".sh", ".py", ".pl", ".bat", ".ps1"],
+        "location":{
+            "": {
+                "comment": "Default",
+                "file type": "tools and utils",
+                "spdx": ["LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0"]
+            },
+            "(.*)(examples/|snippets/)": {
+                "comment": "Example takes precedence",
+                "file type": "examples and snippets",
+                "spdx": ["LicenseRef-Qt-Commercial OR BSD-3-Clause"]
+            }
+        }
+    },
+    {
+        "comment": "Files with the following endings are documentation licensed.",
+        "file_pattern_ending": [".qdoc", ".qdocinc" , ".qdocconf", ".css",
+                                "README.txt", "CONTRIBUTING.md",
+                                "qt_attribution.json"],
+        "location":{
+            "": {
+                "comment": "",
+                "file type": "documentation",
+                "spdx": ["LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only"]
+            }
+        }
+    },
+    {
+        "comment": ["All other files",
+                     "The licensing is defined only by the file location in the Qt module repository.",
+                     "NO <file_pattern_ending> key for this case!",
+                     "This needs to be the last entry of the file."],
+        "location": {
+            "": {
+                "comment": "Default",
+                "file type": "module and plugin",
+                "spdx": ["LicenseRef-Qt-Commercial OR GPL-3.0-only"]
+            },
+            "dist/": {
+                "comment": "Default",
+                "file type": "documentation",
+                "spdx": ["LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only"]
+            },
+            "src/": {
+                "comment": "Default",
+                "file type": "module and plugin",
+                "spdx": ["LicenseRef-Qt-Commercial OR GPL-3.0-only"]
+            },
+            "tests/": {
+                "comment": "Default",
+                "file type": "test",
+                "spdx": ["LicenseRef-Qt-Commercial OR GPL-3.0-only"]
+            },
+            "(.*)(examples/|snippets/)": {
+                "comment": "Default",
+                "file type": "examples and snippets",
+                "spdx": ["LicenseRef-Qt-Commercial OR BSD-3-Clause"]
+            },
+            ".*/doc/images": {
+                "comment": "Default",
+                "file type": "examples and snippets",
+                "spdx": ["LicenseRef-Qt-Commercial OR BSD-3-Clause"]
+            }
+        }
+    }
+]

src/CMakeLists.txt

@@ -1,6 +1,6 @@
 # Copyright (C) 2022 The Qt Company Ltd.
 # SPDX-License-Identifier: BSD-3-Clause
 
-# Generated from src.pro.
+set(QT_SBOM_DEFAULT_QT_LICENSE_ID_LIBRARIES "QT_COMMERCIAL_OR_GPL3")
 
 add_subdirectory(mqtt)

src/mqtt/CMakeLists.txt

@@ -1,8 +1,6 @@
 # Copyright (C) 2022 The Qt Company Ltd.
 # SPDX-License-Identifier: BSD-3-Clause
 
-# Generated from mqtt.pro.
-
 #####################################################################
 ## Mqtt Module:
 #####################################################################
@@ -14,7 +12,7 @@ qt_internal_add_module(Mqtt
         qmqttconnection.cpp qmqttconnection_p.h
         qmqttconnectionproperties.cpp qmqttconnectionproperties.h qmqttconnectionproperties_p.h
         qmqttcontrolpacket.cpp qmqttcontrolpacket_p.h
-        qmqttglobal.h
+        qmqttglobal.h qmqttglobal_p.h
         qmqttmessage.cpp qmqttmessage.h qmqttmessage_p.h
         qmqttpublishproperties.cpp qmqttpublishproperties.h qmqttpublishproperties_p.h
         qmqttsubscription.cpp qmqttsubscription.h qmqttsubscription_p.h
@@ -29,8 +27,24 @@ qt_internal_add_module(Mqtt
         Qt::Network
     PRIVATE_MODULE_INTERFACE
         Qt::CorePrivate
-    GENERATE_CPP_EXPORTS
 )
+
+qt_internal_extend_target(Mqtt
+    CONDITION
+        TARGET Qt::WebSockets
+    DEFINES
+        QT_MQTT_WITH_WEBSOCKETS
+    PUBLIC_LIBRARIES
+        Qt::WebSockets
+    SOURCES
+        transportLayers/mqtt_websocket_io_base.cpp
+        transportLayers/mqtt_websocket_io_base_p.h
+        transportLayers/mqtt_websocket_io.cpp
+        transportLayers/mqtt_websocket_io_p.h
+        transportLayers/mqtt_secure_websocket_io.cpp
+        transportLayers/mqtt_secure_websocket_io_p.h
+)
+
 qt_internal_add_docs(Mqtt
     doc/qtmqtt.qdocconf
 )

src/mqtt/doc/qtmqtt.qdocconf

@@ -14,15 +14,20 @@ qhp.QtMqtt.virtualFolder       = qtmqtt
 qhp.QtMqtt.indexTitle          = Qt MQTT
 qhp.QtMqtt.indexRoot           =
 
-qhp.QtMqtt.subprojects         = classes examples
+qhp.QtMqtt.subprojects         = overview classes examples
+
+qhp.QtMqtt.subprojects.overview.title         = Overview
+qhp.QtMqtt.subprojects.overview.indexTitle    = Qt MQTT Overview
+qhp.QtMqtt.subprojects.overview.selectors     = group:none
+
 qhp.QtMqtt.subprojects.classes.title = C++ Classes
 qhp.QtMqtt.subprojects.classes.indexTitle = Qt MQTT C++ Classes
-qhp.QtMqtt.subprojects.classes.selectors = class fake:headerfile
+qhp.QtMqtt.subprojects.classes.selectors = class namespace headerfile
 qhp.QtMqtt.subprojects.classes.sortPages = true
 
 qhp.QtMqtt.subprojects.examples.title         = Examples
 qhp.QtMqtt.subprojects.examples.indexTitle    = Qt MQTT Examples
-qhp.QtMqtt.subprojects.examples.selectors     = fake:example
+qhp.QtMqtt.subprojects.examples.selectors     = example
 qhp.QtMqtt.subprojects.examples.sortPages     = true
 
 headerdirs  += ..
@@ -40,3 +45,6 @@ manifestmeta.thumbnail.names  += "QtMqtt/WebSockets MQTT Subscription*"
 
 navigation.landingpage = "Qt MQTT"
 navigation.cppclassespage = "Qt MQTT C++ Classes"
+
+# Allow zero warnings when testing documentation in CI
+warninglimit = 0

src/mqtt/doc/src/index.qdoc

@@ -59,5 +59,5 @@
     In addition, it is available under the
     \l{GNU General Public License, version 3}.
 
-    \generatelist{groupsbymodule attributions-qtmqtt}
+    \annotatedlist attributions-qtmqtt
 */

src/mqtt/doc/src/overview.qdoc

@@ -6,6 +6,7 @@
     \page qtmqtt-overview.html
     \title Qt MQTT Overview
     \brief Provides insight into the MQTT protocol and the Qt MQTT module.
+    \ingroup explanations-networkingandconnectivity
 
     Qt MQTT enables you to create applications and devices that can communicate
     over the MQ telemetry transport (MQTT) protocol. It fully complies to the
@@ -20,7 +21,8 @@
     broker. The other clients can subscribe to notifications on particular
     topics sent by the client.
 
-    \image mqtt.png
+    \image mqtt.png {Broker distributing messages from Client 1 to Client 2
+           (Topic A) and Client 3 (Topics A and B)}
 
     For example, if \e {Client 2} subscribes to messages on \e {Topic A}, it
     receives a notification when \e {Client 1} sends a message on that topic.
@@ -177,4 +179,18 @@
     discarded. The broker \e{should} store the last message, but \e{may}
     also discard it. This depends on the implementation of the broker.
 
+    \section1 Threading and Blocking Operations
+
+    Consider running \l QMqttClient and its related classes in a thread
+    separate from the UI thread.\l QMqttClient uses a \l QIODevice as
+    its transport, and some transport operations may block. For example,
+    QMqttClient::disconnectFromHost() may wait synchronously for pending
+    data to be written, with a timeout of up to 30 seconds. Calling it from
+    the UI thread can therefore block the UI event loop and make the
+    application unresponsive. Keeping the MQTT client and its transport in
+    a dedicated thread helps prevent potentially blocking I/O from affecting
+    UI responsiveness. Use signals and slots or other mechanisms that queue
+    work to the target thread to communicate between the MQTT thread and
+    the UI thread.
+
 */

src/mqtt/qmqttauthenticationproperties.cpp

@@ -1,5 +1,6 @@
 // Copyright (C) 2018 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #include "qmqttauthenticationproperties.h"
 

src/mqtt/qmqttauthenticationproperties.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2018 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QMQTTAUTHENTICATIONPROPERTIES_H
 #define QMQTTAUTHENTICATIONPROPERTIES_H

src/mqtt/qmqttclient.cpp

@@ -1,9 +1,15 @@
 // Copyright (C) 2017 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:critical reason:network-protocol
 
 #include "qmqttclient.h"
 #include "qmqttclient_p.h"
 
+#ifdef QT_MQTT_WITH_WEBSOCKETS
+#include "transportLayers/mqtt_websocket_io_p.h"
+#include "transportLayers/mqtt_secure_websocket_io_p.h"
+#endif // QT_MQTT_WITH_WEBSOCKETS
+
 #include <QtCore/QLoggingCategory>
 #include <QtCore/QUuid>
 #include <QtCore/QtEndian>
@@ -82,6 +88,7 @@ Q_LOGGING_CATEGORY(lcMqttClient, "qt.mqtt.client")
     \list
         \li 3: MQTT standard version 3.1.
         \li 4: MQTT standard version 3.1.1, often referred to MQTT 4.
+        \li 5: MQTT Standard 5.0.
     \endlist
 */
 
@@ -150,6 +157,21 @@ Q_LOGGING_CATEGORY(lcMqttClient, "qt.mqtt.client")
     \sa keepAlive(), requestPing(), serverConnectionProperties(), pingResponseReceived()
 */
 
+/*!
+    \property QMqttClient::readBufferSize
+    \since 6.13
+    \brief This property holds the size of the internal read buffer.
+
+    The property limits the amount of data that the client can receive
+    before you call read() or readAll().
+
+    A read buffer size of 0 (the default) means that the buffer has no size
+    limit, ensuring that no data is lost.
+
+    \note The limit is not applicable for a plain \c TransportType::IODevice
+    transport type.
+*/
+
 /*!
     \enum QMqttClient::TransportType
 
@@ -162,6 +184,12 @@ Q_LOGGING_CATEGORY(lcMqttClient, "qt.mqtt.client")
            The transport uses a class based on a QAbstractSocket.
     \value SecureSocket
            The transport uses a class based on a QSslSocket.
+    \value [since 6.10] WebSocket
+           The transport uses a class based on a QIODevice,
+           which uses a QWebSocket internally.
+    \value [since 6.10] SecureWebSocket
+           The transport uses a class based on a QIODevice,
+           which uses a secure QWebSocket internally.
 */
 
 /*!
@@ -311,6 +339,15 @@ Q_LOGGING_CATEGORY(lcMqttClient, "qt.mqtt.client")
     \sa authenticationRequested(), authenticate()
 */
 
+/*!
+    \since 6.13
+    \fn QMqttClient::readBufferSizeChanged(qint64 size)
+
+    This signal is emitted when the \a size of internal read buffer is changed.
+
+    \sa readBufferSize()
+*/
+
 /*!
     Creates a new MQTT client instance with the specified \a parent.
  */
@@ -323,10 +360,16 @@ QMqttClient::QMqttClient(QObject *parent) : QObject(*(new QMqttClientPrivate(thi
 /*!
     Deletes a MQTT client. If the MQTT client was not already disconnected from the MQTT broker,
     it will be disconnected from automatically.
+    \note If a transport is specified with setTransport it must be valid at this point
 */
 QMqttClient::~QMqttClient()
 {
-    disconnectFromHost();
+    Q_D(QMqttClient);
+    if (d->m_connection.internalState() == QMqttConnection::BrokerConnected) {
+        d->m_connection.setClientDestruction();
+        disconnectFromHost();
+    }
+    d->m_connection.disconnectAndResetTransport();
 }
 
 /*!
@@ -337,7 +380,7 @@ QMqttClient::~QMqttClient()
     \l Disconnected state.
 
     \note Setting a custom transport for a client does not pass over responsibility
-    on connection management. The transport has to be opened for QIODevice based
+    on connection management or ownership. The transport has to be opened for QIODevice based
     transports or connected for socket type transports before calling QMqttClient::connectToHost().
  */
 void QMqttClient::setTransport(QIODevice *device, QMqttClient::TransportType transport)
@@ -349,6 +392,8 @@ void QMqttClient::setTransport(QIODevice *device, QMqttClient::TransportType tra
         return;
     }
     d->m_connection.setTransport(device, transport);
+    // Set the currently active buffer size for a new transport.
+    d->m_connection.setReadBufferSize(d->m_readBufferSize);
 }
 
 /*!
@@ -360,6 +405,74 @@ QIODevice *QMqttClient::transport() const
     return d->m_connection.transport();
 }
 
+/*!
+    \since 6.13
+
+    Limits the read buffer of the transport used by this client to
+    \a size bytes. Triggers warning message if the limit could not
+    be applied.
+
+    The transport does not buffer more than \a size bytes: it stops
+    reading from the network until the client has taken the data out of
+    the buffer. Use this function to protect the application against a
+    broker that sends more data than the application can handle, which
+    could make it run out of memory. A size of \c 0 means that the buffer
+    has no size limit, which is the default of the underlying transport.
+
+    \code
+    QMqttClient client;
+    client.setHostname(QStringLiteral("broker.example.com"));
+    client.setPort(1883);
+    client.setReadBufferSize(64 * 1024);
+    client.connectToHost();
+    \endcode
+
+    The size can be set before connecting. It is applied to the transport
+    when connectToHost() creates it, or when setTransport() sets it. The size
+    has no effect if the transport is a plain \l QMqttClient::IODevice.
+
+    Before Qt 6.13, the \c QMqttClient class provided no way to limit the
+    amount of incoming data. However, applications using older versions of
+    \c QMqttClient with certain types of transport, such as transports derived
+    from \c AbstractSocket, can protect themselves against memory exhaustion
+    caused by a broker, as shown in the example below:
+    \code
+    QMqttClient client;
+    client.setHostname(QStringLiteral("broker.example.com"));
+    client.setPort(1883);
+    QObject::connect(&client, &QMqttClient::connected, &client, [&client]() {
+        QAbstractSocket *socket = dynamic_cast<QAbstractSocket *>(client.transport());
+        if (socket)
+            socket->setReadBufferSize(64 * 1024);
+    });
+    client.connectToHost();
+    \endcode
+
+    \note If you use a custom QIODevice-based transport, implement
+    support for a read buffer limit in the device and configure it
+    before calling setTransport(). Some devices already support it.
+    For example, \l QSerialPort provides QSerialPort::setReadBufferSize().
+
+    \note This limit and the MQTT 5 maximum packet size protect against
+    different things. The maximum packet size limits the size of an
+    individual packet, not the total size of a buffer.
+
+    \sa setTransport(), QMqttConnectionProperties::setMaximumPacketSize()
+ */
+void QMqttClient::setReadBufferSize(qint64 size)
+{
+    Q_D(QMqttClient);
+
+    if (d->m_readBufferSize == size)
+        return;
+
+    // Store the size even if there is no transport yet. setTransport() and
+    // connectToHost() apply it to the transport they set or create.
+    d->m_readBufferSize = size;
+    d->m_connection.setReadBufferSize(size);
+    emit readBufferSizeChanged(d->m_readBufferSize);
+}
+
 /*!
     Adds a new subscription to receive notifications on \a topic. The parameter
     \a qos specifies the level at which security messages are received. For more
@@ -507,6 +620,56 @@ quint16 QMqttClient::port() const
     return d->m_port;
 }
 
+/*!
+    \since 6.10
+
+    Set a web socket transport type and initiates a connection to the MQTT broker.
+    Earlier transport type is replaced.
+    If \a webSocket is given, hostname and port is ignored, and connection is done
+    with that websocket. webSocket is owned by the calling code, and must be valid
+    for the lifetime of the QMqttClient object.
+ */
+void QMqttClient::connectToHostWebSocket(QWebSocket *webSocket)
+{
+#ifndef QT_MQTT_WITH_WEBSOCKETS
+    Q_UNUSED(webSocket);
+    qWarning() << " Qt built without websocket support, connect skipped";
+#else
+    Q_D(QMqttClient);
+
+    d->m_connection.connectTransport(
+        TransportType::WebSocket,
+        std::make_shared<QMqttWebSocketIO>(nullptr, webSocket));
+    connectToHost();
+    d->m_connection.m_transportIsSet = false;
+#endif // QT_MQTT_WITH_WEBSOCKETS
+}
+
+/*!
+    \since 6.10
+
+    Set a secure websocket transport type and initiates a connection to the MQTT broker.
+    Earlier transport type is replaced.
+    If \a webSocket is given, hostname and port is ignored, and connection is done
+    with that websocket. webSocket is owned by the calling code, and must be valid
+    for the lifetime of the QMqttClient object.
+ */
+void QMqttClient::connectToHostWebSocketEncrypted(QWebSocket *webSocket)
+{
+#ifndef QT_MQTT_WITH_WEBSOCKETS
+    Q_UNUSED(webSocket);
+    qWarning() << " Qt built without websocket support, connect skipped";
+#else
+    Q_D(QMqttClient);
+
+    d->m_connection.connectTransport(
+        TransportType::SecureWebSocket,
+        std::make_shared<QMqttSecureWebSocketIO>(nullptr, webSocket));
+    connectToHost();
+    d->m_connection.m_transportIsSet = false;
+#endif // QT_MQTT_WITH_WEBSOCKETS
+}
+
 /*!
     Initiates a connection to the MQTT broker.
  */
@@ -561,6 +724,11 @@ void QMqttClient::connectToHost(bool encrypted, const QString &sslPeerName)
         return;
     }
 
+    // We can safely set the active buffer size for the new transport here,
+    // as the transport type has been determined by ensureTransport() or
+    // connectToHostWebSocket()/connectToHostWebSocketEncrypted() at this point.
+    d->m_connection.setReadBufferSize(d->m_readBufferSize);
+
     // Once transport has connected, it will invoke
     // QMqttConnection::sendControlConnect to
     // handshake with the broker
@@ -568,6 +736,11 @@ void QMqttClient::connectToHost(bool encrypted, const QString &sslPeerName)
 
 /*!
     Disconnects from the MQTT broker.
+
+    \note This function may block while waiting for pending data
+    to be written to the transport.
+    See \l {Threading and Blocking Operations} for recommended approaches
+    on handling it.
  */
 void QMqttClient::disconnectFromHost()
 {
@@ -575,6 +748,7 @@ void QMqttClient::disconnectFromHost()
 
     switch (d->m_connection.internalState()) {
     case QMqttConnection::BrokerConnected:
+    case QMqttConnection::ClientDestruction:
         d->m_connection.sendControlDisconnect();
         break;
     case QMqttConnection::BrokerDisconnected:
@@ -640,6 +814,12 @@ bool QMqttClient::autoKeepAlive() const
     return d->m_autoKeepAlive;
 }
 
+qint64 QMqttClient::readBufferSize() const
+{
+    Q_D(const QMqttClient);
+    return d->m_readBufferSize;
+}
+
 /*!
     \since 5.12
 
@@ -1013,10 +1193,7 @@ QMqttClientPrivate::QMqttClientPrivate(QMqttClient *c)
     : QObjectPrivate()
 {
     m_client = c;
-    m_clientId = QUuid::createUuid().toString();
-    m_clientId.remove(QLatin1Char('{'));
-    m_clientId.remove(QLatin1Char('}'));
-    m_clientId.remove(QLatin1Char('-'));
+    m_clientId = QUuid::createUuid().toString(QUuid::Id128);
     m_clientId.resize(23);
 #ifdef QT_BUILD_INTERNAL
     // Some test servers require a username token

src/mqtt/qmqttclient.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2017 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QTMQTTCLIENT_H
 #define QTMQTTCLIENT_H
@@ -22,6 +23,7 @@
 
 QT_BEGIN_NAMESPACE
 
+class QWebSocket;
 class QMqttClientPrivate;
 
 class Q_MQTT_EXPORT QMqttClient : public QObject
@@ -30,13 +32,15 @@ public:
     enum TransportType {
         IODevice = 0,
         AbstractSocket,
-        SecureSocket
+        SecureSocket,
+        WebSocket,
+        SecureWebSocket,
     };
 
     enum ClientState {
         Disconnected = 0,
         Connecting,
-        Connected
+        Connected,
     };
     Q_ENUM(ClientState)
 
@@ -52,22 +56,19 @@ public:
         TransportInvalid       = 256,
         ProtocolViolation,
         UnknownError,
-        Mqtt5SpecificError
+        Mqtt5SpecificError,
     };
     Q_ENUM(ClientError)
 
     enum ProtocolVersion {
         MQTT_3_1 = 3,
         MQTT_3_1_1 = 4,
-        MQTT_5_0 = 5
+        MQTT_5_0 = 5,
     };
     Q_ENUM(ProtocolVersion)
 
 private:
     Q_OBJECT
-    Q_ENUMS(ClientState)
-    Q_ENUMS(ClientError)
-    Q_ENUMS(ProtocolVersion)
     Q_PROPERTY(QString clientId READ clientId WRITE setClientId NOTIFY clientIdChanged)
     Q_PROPERTY(QString hostname READ hostname WRITE setHostname NOTIFY hostnameChanged)
     Q_PROPERTY(quint16 port READ port WRITE setPort NOTIFY portChanged)
@@ -83,12 +84,15 @@ private:
     Q_PROPERTY(quint8 willQoS READ willQoS WRITE setWillQoS NOTIFY willQoSChanged)
     Q_PROPERTY(bool willRetain READ willRetain WRITE setWillRetain NOTIFY willRetainChanged)
     Q_PROPERTY(bool autoKeepAlive READ autoKeepAlive WRITE setAutoKeepAlive NOTIFY autoKeepAliveChanged)
+    Q_PROPERTY(qint64 readBufferSize READ readBufferSize WRITE setReadBufferSize NOTIFY readBufferSizeChanged)
+
 public:
     explicit QMqttClient(QObject *parent = nullptr);
     ~QMqttClient() override;
 
     void setTransport(QIODevice *device, TransportType transport);
     QIODevice *transport() const;
+    void setReadBufferSize(qint64 size);
 
     QMqttSubscription *subscribe(const QMqttTopicFilter &topic, quint8 qos = 0);
     QMqttSubscription *subscribe(const QMqttTopicFilter &topic,
@@ -115,6 +119,8 @@ public:
 #ifndef QT_NO_SSL
     void connectToHostEncrypted(const QSslConfiguration &conf);
 #endif
+    Q_INVOKABLE void connectToHostWebSocket(QWebSocket *webSocket = nullptr);
+    Q_INVOKABLE void connectToHostWebSocketEncrypted(QWebSocket *webSocket = nullptr);
     Q_INVOKABLE void disconnectFromHost();
 
     ClientState state() const;
@@ -129,6 +135,7 @@ public:
     QByteArray willMessage() const;
     bool willRetain() const;
     bool autoKeepAlive() const;
+    qint64 readBufferSize() const;
 
     void setConnectionProperties(const QMqttConnectionProperties &prop);
     QMqttConnectionProperties connectionProperties() const;
@@ -164,6 +171,7 @@ Q_SIGNALS:
     void willMessageChanged(QByteArray willMessage);
     void willRetainChanged(bool willRetain);
     void autoKeepAliveChanged(bool autoKeepAlive);
+    void readBufferSizeChanged(qint64 size);
 
     void authenticationRequested(const QMqttAuthenticationProperties &p);
     void authenticationFinished(const QMqttAuthenticationProperties &p);

src/mqtt/qmqttclient_p.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2017 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QMQTTCLIENT_P_H
 #define QMQTTCLIENT_P_H
@@ -15,6 +16,7 @@
 // We mean it.
 //
 
+#include "qmqttglobal_p.h"
 #include "qmqttclient.h"
 #include "qmqttconnection_p.h"
 
@@ -46,6 +48,7 @@ public:
     quint8 m_willQoS{0};
     bool m_willRetain{false};
     bool m_autoKeepAlive{true};
+    qint64 m_readBufferSize{0};
     QString m_username;
     QString m_password;
     bool m_cleanSession{true};

src/mqtt/qmqttconnection_p.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2017 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QMQTTCONNECTION_P_H
 #define QMQTTCONNECTION_P_H
@@ -26,6 +27,9 @@
 #include <QtCore/QSharedPointer>
 #include <QtCore/QtEndian>
 
+#include <memory>
+#include <optional>
+
 QT_BEGIN_NAMESPACE
 
 class QMqttClientPrivate;
@@ -38,13 +42,16 @@ public:
         BrokerDisconnected = 0,
         BrokerConnecting,
         BrokerWaitForConnectAck,
-        BrokerConnected
+        BrokerConnected,
+        ClientDestruction
     };
 
     explicit QMqttConnection(QObject *parent = nullptr);
     ~QMqttConnection() override;
 
+    void disconnectAndResetTransport();
     void setTransport(QIODevice *device, QMqttClient::TransportType transport);
+    void connectTransport(QMqttClient::TransportType transport, const std::shared_ptr<QIODevice> &device);
     QIODevice *transport() const;
 
     bool ensureTransport(bool createSecureIfNeeded = false);
@@ -61,12 +68,13 @@ public:
     QMqttSubscription *sendControlSubscribe(const QMqttTopicFilter &topic, quint8 qos, const QMqttSubscriptionProperties &properties);
     bool sendControlUnsubscribe(const QMqttTopicFilter &topic, const QMqttUnsubscriptionProperties &properties);
     bool sendControlPingRequest(bool isAuto = true);
-    bool sendControlDisconnect();
-
+    bool sendControlDisconnect(std::optional<QMqtt::ReasonCode> reasonCode = std::nullopt);
+    void setReadBufferSize(qint64 size);
     void setClientPrivate(QMqttClientPrivate *clientPrivate);
 
     inline quint16 unusedPacketIdentifier() const;
     inline InternalConnectionState internalState() const { return m_internalState; }
+    inline void setClientDestruction() { m_internalState = ClientDestruction; }
 
     void cleanSubscriptions();
 
@@ -80,9 +88,10 @@ protected:
     void timerEvent(QTimerEvent *event) override;
 
 public:
-    QIODevice *m_transport{nullptr};
+    std::shared_ptr<QIODevice> m_transport;
     QMqttClient::TransportType m_transportType{QMqttClient::IODevice};
-    bool m_ownTransport{false};
+    bool m_transportIsSet{false}; // connectTo* does not reset m_transport;
+    bool m_connectedTransport{false}; // We have connected the signals for m_transport if true
     QMqttClientPrivate *m_clientPrivate{nullptr};
 #ifndef QT_NO_SSL
     QSslConfiguration m_sslConfiguration;
@@ -100,11 +109,11 @@ private:
     bool processDataHelper();
     bool readBuffer(char *data, quint64 size);
     qint32 readVariableByteInteger(qint64 *dataSize = nullptr);
-    void readAuthProperties(QMqttAuthenticationProperties &properties);
-    void readConnackProperties(QMqttServerConnectionProperties &properties);
-    void readMessageStatusProperties(QMqttMessageStatusProperties &properties);
-    void readPublishProperties(QMqttPublishProperties &properties);
-    void readSubscriptionProperties(QMqttSubscription *sub);
+    bool readAuthProperties(QMqttAuthenticationProperties &properties);
+    bool readConnackProperties(QMqttServerConnectionProperties &properties);
+    bool readMessageStatusProperties(QMqttMessageStatusProperties &properties);
+    bool readPublishProperties(QMqttPublishProperties &properties);
+    bool readSubscriptionProperties(QMqttSubscription *sub);
     QByteArray writeConnectProperties();
     QByteArray writeLastWillProperties() const;
     QByteArray writePublishProperties(const QMqttPublishProperties &properties);
@@ -112,8 +121,18 @@ private:
     QByteArray writeUnsubscriptionProperties(const QMqttUnsubscriptionProperties &properties);
     QByteArray writeAuthenticationProperties(const QMqttAuthenticationProperties &properties);
     void closeConnection(QMqttClient::ClientError error);
+    void closeOnMalformedPacket();
     QByteArray readBuffer(quint64 size);
-    template<typename T> T readBufferTyped(qint64 *dataSize = nullptr);
+    template<typename T> std::optional<T> readBufferTyped(qint64 *dataSize = nullptr);
+    bool isPendingUnsubscribe(QMqttSubscription *) const;
+    QMqttSubscription *findActiveSubscription(const QMqttTopicFilter &topic) const;
+    template <typename T>
+    void setSocketBufferSize(qint64 size) {
+        auto *socket = qobject_cast<T *>(m_transport.get());
+        Q_ASSERT(socket);
+        socket->setReadBufferSize(size);
+    }
+
     QByteArray m_readBuffer;
     int m_readPosition{0};
     qint64 m_missingData{0};
@@ -126,9 +145,13 @@ private:
     QMqttControlPacket::PacketType m_currentPacket{QMqttControlPacket::UNKNOWN};
 
     bool writePacketToTransport(const QMqttControlPacket &p);
+
+    // I: There can be many occurences of different QMqttSubscription * with
+    //    the same QMqttTopicFilter, but only one that is not in
+    //    m_pendingUnsubscriptions.
     QHash<quint16, QMqttSubscription *> m_pendingSubscriptionAck;
     QHash<quint16, QMqttSubscription *> m_pendingUnsubscriptions;
-    QHash<QMqttTopicFilter, QMqttSubscription *> m_activeSubscriptions;
+    QMultiHash<QMqttTopicFilter, QMqttSubscription *> m_activeSubscriptions;
     QHash<quint16, QSharedPointer<QMqttControlPacket>> m_pendingMessages;
     QHash<quint16, QSharedPointer<QMqttControlPacket>> m_pendingReleaseMessages;
     InternalConnectionState m_internalState{BrokerDisconnected};

src/mqtt/qmqttconnectionproperties.cpp

@@ -1,18 +1,15 @@
 // Copyright (C) 2018 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #include "qmqttconnectionproperties.h"
 
 #include "qmqttconnectionproperties_p.h"
 
-#include <QtCore/QLoggingCategory>
-
 #include <limits>
 
 QT_BEGIN_NAMESPACE
 
-Q_DECLARE_LOGGING_CATEGORY(lcMqttConnection)
-
 /*!
     \class QMqttConnectionProperties
 
@@ -307,6 +304,11 @@ void QMqttConnectionProperties::setMaximumReceive(quint16 maximumReceive)
 
     If no maximum packet size is specified, no limit is imposed beyond the
     limitations of the protocol itself.
+
+    \note Since Qt 6.13, this limit can be applied to incoming packets
+    when using MQTT 3.1 or MQTT 3.1.1. These protocol versions cannot announce
+    the limit to the broker, but the client closes the connection with
+    \l QMqttClient::ProtocolViolation when it receives a larger packet.
 */
 void QMqttConnectionProperties::setMaximumPacketSize(quint32 packetSize)
 {

src/mqtt/qmqttconnectionproperties.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2018 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QMQTTCONNECTIONPROPERTIES_H
 #define QMQTTCONNECTIONPROPERTIES_H

src/mqtt/qmqttconnectionproperties_p.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2018 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QMQTTCONNECTIONPROPERTIES_P_H
 #define QMQTTCONNECTIONPROPERTIES_P_H
@@ -18,8 +19,12 @@
 #include "qmqttconnectionproperties.h"
 #include "private/qglobal_p.h"
 
+#include <QtCore/QLoggingCategory>
+
 QT_BEGIN_NAMESPACE
 
+Q_DECLARE_LOGGING_CATEGORY(lcMqttConnection)
+
 class QMqttLastWillPropertiesData : public QSharedData
 {
 public:

src/mqtt/qmqttcontrolpacket.cpp

@@ -1,5 +1,6 @@
 // Copyright (C) 2017 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:critical reason:network-protocol
 
 #include "qmqttcontrolpacket_p.h"
 
@@ -8,8 +9,6 @@
 
 QT_BEGIN_NAMESPACE
 
-Q_DECLARE_LOGGING_CATEGORY(lcMqttClient)
-
 QMqttControlPacket::QMqttControlPacket()
 {
 

src/mqtt/qmqttcontrolpacket_p.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2017 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QMQTTCONTROLPACKET_P_H
 #define QMQTTCONTROLPACKET_P_H
@@ -14,7 +15,7 @@
 //
 // We mean it.
 //
-#include "qmqttglobal.h"
+#include "qmqttglobal_p.h"
 
 #include <QtCore/QByteArray>
 #include <QtCore/QtGlobal>

src/mqtt/qmqttglobal.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2017 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QTQMQTTGLOBAL_H
 #define QTQMQTTGLOBAL_H

src/mqtt/qmqttglobal_p.h

@@ -0,0 +1,28 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
+
+#ifndef QTQMQTTGLOBAL_P_H
+#define QTQMQTTGLOBAL_P_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include <QtMqtt/qmqttglobal.h>
+#include <QtCore/qloggingcategory.h>
+
+QT_BEGIN_NAMESPACE
+
+Q_DECLARE_LOGGING_CATEGORY(lcMqttClient)
+
+QT_END_NAMESPACE
+
+#endif // QTQMQTTGLOBAL_P_H

src/mqtt/qmqttmessage.cpp

@@ -1,5 +1,6 @@
 // Copyright (C) 2017 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #include "qmqttmessage.h"
 #include "qmqttmessage_p.h"

src/mqtt/qmqttmessage.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2017 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QMQTTMESSAGE_H
 #define QMQTTMESSAGE_H

src/mqtt/qmqttmessage_p.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2018 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QMQTTMESSAGE_P_H
 #define QMQTTMESSAGE_P_H

src/mqtt/qmqttpublishproperties.cpp

@@ -1,5 +1,6 @@
 // Copyright (C) 2018 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #include "qmqttpublishproperties.h"
 #include "qmqttpublishproperties_p.h"
@@ -9,8 +10,6 @@
 
 QT_BEGIN_NAMESPACE
 
-Q_DECLARE_LOGGING_CATEGORY(lcMqttClient)
-
 /*!
     \class QMqttPublishProperties
 

src/mqtt/qmqttpublishproperties.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2018 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 #ifndef QMQTTPUBLISHPROPERTIES_H
 #define QMQTTPUBLISHPROPERTIES_H
 

src/mqtt/qmqttpublishproperties_p.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2018 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QMQTTPUBLISHPROPERTIES_P_H
 #define QMQTTPUBLISHPROPERTIES_P_H
@@ -15,7 +16,7 @@
 // We mean it.
 //
 
-#include "qmqttglobal.h"
+#include "qmqttglobal_p.h"
 #include "qmqttpublishproperties.h"
 
 #include <QtCore/QSharedData>

src/mqtt/qmqttsubscription.cpp

@@ -1,5 +1,6 @@
 // Copyright (C) 2017 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #include "qmqttsubscription.h"
 #include "qmqttsubscription_p.h"

src/mqtt/qmqttsubscription.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2017 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QMQTTSUBSCRIPTION_H
 #define QMQTTSUBSCRIPTION_H
@@ -18,7 +19,6 @@ class QMqttSubscriptionPrivate;
 class Q_MQTT_EXPORT QMqttSubscription : public QObject
 {
     Q_OBJECT
-    Q_ENUMS(SubscriptionState)
     Q_PROPERTY(SubscriptionState state READ state NOTIFY stateChanged)
     Q_PROPERTY(quint8 qos READ qos NOTIFY qosChanged)
     Q_PROPERTY(QMqttTopicFilter topic READ topic)
@@ -35,6 +35,7 @@ public:
         UnsubscriptionPending,
         Error
     };
+    Q_ENUM(SubscriptionState)
 
     SubscriptionState state() const;
     QMqttTopicFilter topic() const;

src/mqtt/qmqttsubscription_p.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2017 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QMQTTSUBSCRIPTION_P_H
 #define QMQTTSUBSCRIPTION_P_H

src/mqtt/qmqttsubscriptionproperties.cpp

@@ -1,5 +1,6 @@
 // Copyright (C) 2018 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #include "qmqttsubscriptionproperties.h"
 

src/mqtt/qmqttsubscriptionproperties.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2018 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QMQTTSUBSCRIPTIONPROPERTIES_H
 #define QMQTTSUBSCRIPTIONPROPERTIES_H

src/mqtt/qmqtttopicfilter.cpp

@@ -1,5 +1,6 @@
 // Copyright (C) 2017 Lorenz Haas
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:critical reason:data-parser
 
 #include "qmqtttopicfilter.h"
 
@@ -173,7 +174,7 @@ bool QMqttTopicFilter::isValid() const
             || (singleLevelPosition < size - 1 && d->filter.at(singleLevelPosition + 1) != QLatin1Char('/'))) {
             return false;
         }
-        singleLevelPosition = d->filter.indexOf(QLatin1Char('#'), singleLevelPosition + 1);
+        singleLevelPosition = d->filter.indexOf(QLatin1Char('+'), singleLevelPosition + 1);
     }
 
     // Shared Subscription syntax
@@ -223,7 +224,7 @@ bool QMqttTopicFilter::match(const QMqttTopicName &name, MatchOptions matchOptio
             return false;
 
         for (int i = 0; i < filterLevels.size(); ++i) {
-            if (filterLevels.at(i) != topicLevels.at(i))
+            if (filterLevels.at(i) != topicLevels.at(i) && filterLevels.at(i) != QLatin1Char('+'))
                 return false;
         }
         return true;

src/mqtt/qmqtttopicfilter.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2017 Lorenz Haas
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QMQTTTOPICFILTER_H
 #define QMQTTTOPICFILTER_H

src/mqtt/qmqtttopicname.cpp

@@ -1,5 +1,6 @@
 // Copyright (C) 2017 Lorenz Haas
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:critical reason:data-parser
 
 #include "qmqtttopicname.h"
 

src/mqtt/qmqtttopicname.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2017 Lorenz Haas
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QMQTTTOPICNAME_H
 #define QMQTTTOPICNAME_H

src/mqtt/qmqtttype.cpp

@@ -1,5 +1,6 @@
 // Copyright (C) 2018 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #include "qmqtttype.h"
 

src/mqtt/qmqtttype.h

@@ -1,5 +1,6 @@
 // Copyright (C) 2018 The Qt Company Ltd.
 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
 
 #ifndef QMQTTTYPE_H
 #define QMQTTTYPE_H

src/mqtt/transportLayers/mqtt_secure_websocket_io.cpp

@@ -0,0 +1,45 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
+#include "mqtt_secure_websocket_io_p.h"
+
+#ifdef QT_MQTT_WITH_WEBSOCKETS
+
+QMqttSecureWebSocketIO::~QMqttSecureWebSocketIO()
+{
+    disconnect(m_socket.get(), &QWebSocket::connected, this, &QMqttSecureWebSocketIO::doSocketEncrypted);
+}
+
+QMqttSecureWebSocketIO::QMqttSecureWebSocketIO(QObject *parent, QWebSocket *webSocket)
+    :
+    QMqttWebSocketIOBase(parent, webSocket)
+{
+    connect(m_socket.get(), &QWebSocket::connected, this, &QMqttSecureWebSocketIO::doSocketEncrypted);
+}
+
+void QMqttSecureWebSocketIO::connectToHostEncrypted(const QString &hostname, quint16 port, QMqttClient::ProtocolVersion version)
+{
+    setProtocol(version);
+    if (!isExternalSocket()) {
+        QUrl url(QString(u"wss://") + hostname + u":" + QString().setNum(port));
+        QWebSocketHandshakeOptions options;
+        options.setSubprotocols(QStringList{ QString::fromUtf8(m_protocol) });
+        m_socket->open(url, options);
+    }
+    open(QIODevice::ReadWrite);
+}
+
+void QMqttSecureWebSocketIO::close()
+{
+    m_socket->close();
+    QMqttWebSocketIOBase::close();
+}
+
+void QMqttSecureWebSocketIO::doSocketEncrypted()
+{
+    emit encrypted();
+}
+
+#include "moc_mqtt_secure_websocket_io_p.cpp"
+
+#endif /* QT_MQTT_WITH_WEBSOCKETS */

src/mqtt/transportLayers/mqtt_secure_websocket_io_p.h

@@ -0,0 +1,53 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
+
+#ifndef QTMQTTCLIENT_SECURE_WEBSOCKET_IODEVICE_H
+#define QTMQTTCLIENT_SECURE_WEBSOCKET_IODEVICE_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+#ifdef QT_MQTT_WITH_WEBSOCKETS
+
+#include <QtWebSockets/QWebSocketHandshakeOptions>
+#include <QtWebSockets/QWebSocket>
+#include <QtCore/QIODevice>
+#include "transportLayers/mqtt_websocket_io_base_p.h"
+#include "qmqttclient.h"
+
+QT_BEGIN_NAMESPACE
+
+class QMqttSecureWebSocketIO : public QMqttWebSocketIOBase
+{
+    Q_OBJECT
+
+public:
+    Q_DISABLE_COPY_MOVE(QMqttSecureWebSocketIO)
+
+    ~QMqttSecureWebSocketIO() override;
+    QMqttSecureWebSocketIO(QObject *parent = nullptr, QWebSocket *webSocket = nullptr);
+
+    void close() override;
+
+    void connectToHostEncrypted(const QString &hostname, quint16 port, QMqttClient::ProtocolVersion version);
+
+Q_SIGNALS:
+    void encrypted();
+
+public slots:
+    void doSocketEncrypted();
+};
+
+QT_END_NAMESPACE
+
+#endif /* QT_MQTT_WITH_WEBSOCKETS */
+
+#endif /* QTMQTTCLIENT_SECURE_WEBSOCKET_IODEVICE_H */

src/mqtt/transportLayers/mqtt_websocket_io.cpp

@@ -0,0 +1,45 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
+#include "mqtt_websocket_io_p.h"
+
+#ifdef QT_MQTT_WITH_WEBSOCKETS
+
+QMqttWebSocketIO::~QMqttWebSocketIO()
+{
+    disconnect(m_socket.get(), &QWebSocket::connected, this, &QMqttWebSocketIO::doSocketConnected);
+}
+
+QMqttWebSocketIO::QMqttWebSocketIO(QObject *parent, QWebSocket *webSocket)
+    :
+    QMqttWebSocketIOBase(parent, webSocket)
+{
+    connect(m_socket.get(), &QWebSocket::connected, this, &QMqttWebSocketIO::doSocketConnected);
+}
+
+void QMqttWebSocketIO::connectToHost(const QString &hostname, quint16 port, QMqttClient::ProtocolVersion version)
+{
+    setProtocol(version);
+    if (!isExternalSocket()) {
+        QUrl url(QString(u"ws://") + hostname + u":" + QString().setNum(port));
+        QWebSocketHandshakeOptions options;
+        options.setSubprotocols(QStringList{ QString::fromUtf8(m_protocol) });
+        m_socket->open(url, options);
+    }
+    open(QIODevice::ReadWrite);
+}
+
+void QMqttWebSocketIO::close()
+{
+    m_socket->close();
+    QMqttWebSocketIOBase::close();
+}
+
+void QMqttWebSocketIO::doSocketConnected()
+{
+    emit connected();
+}
+
+#include "moc_mqtt_websocket_io_p.cpp"
+
+#endif /* QT_MQTT_WITH_WEBSOCKETS */

src/mqtt/transportLayers/mqtt_websocket_io_base.cpp

@@ -0,0 +1,103 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
+#include "mqtt_websocket_io_base_p.h"
+
+#ifdef QT_MQTT_WITH_WEBSOCKETS
+
+QMqttWebSocketIOBase::~QMqttWebSocketIOBase()
+{
+    disconnect(m_socket.get(), &QWebSocket::disconnected, this, &QMqttWebSocketIOBase::doSocketDisconnected);
+    disconnect(m_socket.get(), &QWebSocket::errorOccurred, this, &QMqttWebSocketIOBase::doSocketErrorOccured);
+    disconnect(m_socket.get(), &QWebSocket::binaryMessageReceived, this, &QMqttWebSocketIOBase::doSocketHandleBinaryMessage);
+}
+
+QMqttWebSocketIOBase::QMqttWebSocketIOBase(QObject *parent, QWebSocket *webSocket)
+    :
+    QIODevice(parent)
+{
+    m_externalSocket = (webSocket != nullptr);
+
+    if (webSocket)
+        m_socket = std::shared_ptr<QWebSocket>(webSocket, [](QWebSocket *) { ; }); // skip deleter
+    else
+        m_socket = std::make_shared<QWebSocket>();
+
+    connect(m_socket.get(), &QWebSocket::disconnected, this, &QMqttWebSocketIOBase::doSocketDisconnected);
+    connect(m_socket.get(), &QWebSocket::errorOccurred, this, &QMqttWebSocketIOBase::doSocketErrorOccured);
+    connect(m_socket.get(), &QWebSocket::binaryMessageReceived, this, &QMqttWebSocketIOBase::doSocketHandleBinaryMessage);
+
+    setProtocol(QMqttClient::ProtocolVersion::MQTT_3_1);
+}
+
+bool QMqttWebSocketIOBase::open(QIODevice::OpenMode mode)
+{
+    if (!QIODevice::open(mode))
+    {
+        close();
+        emit errorOccurred(QAbstractSocket::SocketResourceError);
+    }
+    // Will emit onConnectionEstablished or onConnectionError
+    return false;
+}
+
+void QMqttWebSocketIOBase::close()
+{
+    QIODevice::close();
+}
+
+qint64 QMqttWebSocketIOBase::readData(char *data, qint64 maxlen)
+{
+    qint64 bytesToRead = qMin(maxlen, (qint64)m_buffer.size());
+    memcpy(data, m_buffer.constData(), bytesToRead);
+    m_buffer = m_buffer.right(m_buffer.size() - bytesToRead);
+    return bytesToRead;
+}
+
+qint64 QMqttWebSocketIOBase::writeData(const char *data, qint64 len)
+{
+    QByteArray msg(data, len);
+    const int length = m_socket->sendBinaryMessage(msg);
+    emit bytesWritten(length);
+    return length;
+}
+
+void QMqttWebSocketIOBase::setProtocol(QMqttClient::ProtocolVersion version)
+{
+    switch (version) {
+    case QMqttClient::ProtocolVersion::MQTT_3_1:
+        setProtocol("mqttv3.1");
+        break;
+    case QMqttClient::ProtocolVersion::MQTT_3_1_1:
+        setProtocol("mqtt");
+        break;
+    case QMqttClient::ProtocolVersion::MQTT_5_0:
+        setProtocol("mqtt");
+        break;
+    } /* end-switch */
+}
+
+void QMqttWebSocketIOBase::setProtocol(const QByteArray &data)
+{
+    m_protocol = data;
+}
+
+void QMqttWebSocketIOBase::doSocketHandleBinaryMessage(const QByteArray &msg)
+{
+    m_buffer.append(msg);
+    emit readyRead();
+}
+
+void QMqttWebSocketIOBase::doSocketDisconnected()
+{
+    emit disconnected();
+}
+
+void QMqttWebSocketIOBase::doSocketErrorOccured(QAbstractSocket::SocketError error)
+{
+    emit errorOccurred(error);
+}
+
+#include "moc_mqtt_websocket_io_base_p.cpp"
+
+#endif /* QT_MQTT_WITH_WEBSOCKETS */

src/mqtt/transportLayers/mqtt_websocket_io_base_p.h

@@ -0,0 +1,105 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
+
+#ifndef QTMQTTCLIENT_WEBSOCKET_IODEVICE_BASE_H
+#define QTMQTTCLIENT_WEBSOCKET_IODEVICE_BASE_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#ifdef QT_MQTT_WITH_WEBSOCKETS
+
+#include <QtWebSockets/QWebSocketHandshakeOptions>
+#include <QtWebSockets/QWebSocket>
+#include <QtCore/QIODevice>
+
+#include "qmqttclient.h"
+
+QT_BEGIN_NAMESPACE
+
+class QMqttWebSocketIOBase : public QIODevice
+{
+    Q_OBJECT
+protected:
+    QMqttWebSocketIOBase(QObject *parent = nullptr, QWebSocket *webSocket = nullptr);
+
+public:
+    Q_DISABLE_COPY_MOVE(QMqttWebSocketIOBase)
+
+    ~QMqttWebSocketIOBase() override;
+
+    bool open(OpenMode mode) override;
+    void close() override;
+
+    qint64 readData(char *data, qint64 maxlen) override;
+    qint64 writeData(const char *data, qint64 len) override;
+
+    void setProtocol(QMqttClient::ProtocolVersion version);
+    void setProtocol(const QByteArray &data);
+
+    bool isSequential() const override
+    {
+        return true;
+    }
+
+    qint64 bytesAvailable() const override
+    {
+        return static_cast<qint64>(m_buffer.size()) + QIODevice::bytesAvailable();
+    }
+
+    bool waitForBytesWritten(int msecs) override
+    {
+        Q_UNUSED(msecs);
+        m_socket->flush();
+        return true;
+    }
+
+    bool isConnected() const
+    {
+        return (m_socket->state() == QAbstractSocket::ConnectedState);
+    }
+
+    QAbstractSocket::SocketState state() const
+    {
+        return m_socket->state();
+    }
+
+    bool isExternalSocket() const
+    {
+        return m_externalSocket;
+    }
+
+    void setReadBufferSize(qint64 size)
+    {
+        m_socket->setReadBufferSize(size);
+    }
+Q_SIGNALS:
+    void disconnected();
+    void errorOccurred(QAbstractSocket::SocketError error);
+
+public slots:
+    void doSocketHandleBinaryMessage(const QByteArray &msg);
+    void doSocketDisconnected();
+    void doSocketErrorOccured(QAbstractSocket::SocketError error);
+
+protected:
+    std::shared_ptr<QWebSocket> m_socket;
+    bool m_externalSocket = false;
+    QByteArray m_protocol;
+    QByteArray m_buffer;
+};
+
+QT_END_NAMESPACE
+
+#endif /* QT_MQTT_WITH_WEBSOCKETS */
+
+#endif /* QTMQTTCLIENT_WEBSOCKET_IODEVICE_BASE_H */

src/mqtt/transportLayers/mqtt_websocket_io_p.h

@@ -0,0 +1,54 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+// Qt-Security score:significant reason:default
+
+#ifndef QTMQTTCLIENT_WEBSOCKET_IODEVICE_H
+#define QTMQTTCLIENT_WEBSOCKET_IODEVICE_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#ifdef QT_MQTT_WITH_WEBSOCKETS
+
+#include <QtWebSockets/QWebSocketHandshakeOptions>
+#include <QtWebSockets/QWebSocket>
+#include <QtCore/QIODevice>
+
+#include "transportLayers/mqtt_websocket_io_base_p.h"
+#include "qmqttclient.h"
+
+QT_BEGIN_NAMESPACE
+
+class QMqttWebSocketIO : public QMqttWebSocketIOBase
+{
+    Q_OBJECT
+public:
+    Q_DISABLE_COPY_MOVE(QMqttWebSocketIO)
+
+    ~QMqttWebSocketIO() override;
+    QMqttWebSocketIO(QObject *parent = nullptr, QWebSocket *webSocket = nullptr);
+
+    void close() override;
+
+    void connectToHost(const QString &hostname, quint16 port, QMqttClient::ProtocolVersion version);
+
+Q_SIGNALS:
+    void connected();
+
+public slots:
+    void doSocketConnected();
+};
+
+QT_END_NAMESPACE
+
+#endif /* QT_MQTT_WITH_WEBSOCKETS */
+
+#endif /* QTMQTTCLIENT_WEBSOCKET_IODEVICE_H */

sync.profile

@@ -1,7 +0,0 @@
-%modules = (
-    "QtMqtt" => "$basedir/src/mqtt",
-);
-
-%dependencies = (
-        "qtbase" => "",
-);

tests/CMakeLists.txt

@@ -1,7 +1,121 @@
-# Copyright (C) 2022 The Qt Company Ltd.
+# Copyright (C) 2025 The Qt Company Ltd.
 # SPDX-License-Identifier: BSD-3-Clause
 
-# Generated from tests.pro.
+# This function adds the test 12 times if run on a computer where the
+# mosquitto broker has been provisioned by running the corresponding
+# script located qt6/coin/provisioning/*/*mosquitto*
+#
+# The script adds the file /etc/mosquitto/conf.d/mqtt.conf on unix-like
+# systems, and the file C:\\Program Files\\mosquitto\\conf.d\\mqtt.conf
+# on windows like systems. So this is what we test for.
+#
+# If we are on a provisioned system as detected by the two files above
+# we define these variables which the test use
+#   MQTT_TEST_TYPE= selection from; 3, 4, 5
+#     3 -> Vers 3.1
+#     4 -> Vers 3.1.1
+#     5 -> Vers 5.0
+#   MQTT_TEST_PROTOCOL= selection from; Tcp,Ssl,Ws,Wss
+#   MQTT_TEST_BROKER="localhost"
+#
+# If neither of these files are present, we use the existing
+# design which is to run for tcp,3.1.1 by default.
+# In this case set the environment variable MQTT_TEST_BROKER
+# to localhost
+#
+# Finally, we allow the test to override for individual test
+# cases, if wanted. This is mostly used for MQTT_TEST_TYPE
+#
+
+function(qtmqtt_is_mosquitto_installed result)
+    set(skip $ENV{COIN_NO_MOSQUITTO})
+    if(skip)
+       set(${result} FALSE PARENT_SCOPE)
+     elseif(EXISTS "/etc/mosquitto/conf.d/mqtt.conf" OR
+       EXISTS "C:\\Program Files\\mosquitto\\conf.d\\mqtt.conf")
+       set(${result} ON PARENT_SCOPE)
+    else()
+       set(${result} FALSE PARENT_SCOPE)
+    endif()
+endfunction()
+
+function(qtmqtt_add_test)
+
+    set(options)
+    set(oneValueArgs TARGET)
+    set(multiValueArgs SOURCES DEFINES INCLUDE_DIRECTORIES LIBRARIES)
+
+    cmake_parse_arguments(
+        arg_mqtt
+        "${options}"
+        "${oneValueArgs}"
+        "${multiValueArgs}"
+        ${ARGN}
+    )
+
+    set(TYPES)
+    set(PROTOCOLS)
+
+    qtmqtt_is_mosquitto_installed(is_installed)
+
+    if(${is_installed})
+        if(WASM)
+            if(TARGET Qt::WebSockets)
+                set(TYPES Ws Wss)
+                set(PROTOCOLS 3 4 5)
+            endif()
+        elseif(QT_FEATURE_ssl)
+            if(TARGET Qt::WebSockets)
+                set(TYPES Tcp Ssl Ws Wss)
+            else()
+                set(TYPES Tcp Ssl)
+            endif()
+            set(PROTOCOLS 3 4 5)
+        else()
+            if(TARGET Qt::WebSockets)
+                set(TYPES Tcp Ws)
+            else()
+                set(TYPES Tcp)
+            endif()
+            set(PROTOCOLS 3 4 5)
+        endif()
+    elseif(NOT WASM)
+        set(TYPES Tcp)
+        set(PROTOCOLS 4)
+    endif()
+
+    foreach(TYPE ${TYPES})
+        foreach(PROTOCOL ${PROTOCOLS})
+            set(EXTRA_DEFINES)
+            set(EXTRA_LIBS)
+            if(${is_installed})
+                set(EXTRA_DEFINES MQTT_TEST_TYPE="${TYPE}" MQTT_TEST_PROTOCOL=${PROTOCOL} MQTT_TEST_BROKER="localhost")
+            endif()
+
+            if(TARGET Qt::WebSockets)
+                set(EXTRA_DEFINES ${EXTRA_DEFINES} QT_MQTT_WITH_WEBSOCKETS)
+                set(EXTRA_LIBS Qt::WebSockets)
+            endif()
+
+            qt_internal_add_test(
+                    ${arg_mqtt_TARGET}_${TYPE}_${PROTOCOL}
+                SOURCES
+                    ${arg_mqtt_SOURCES}
+                DEFINES
+                    ${arg_mqtt_DEFINES} ${EXTRA_DEFINES}
+                INCLUDE_DIRECTORIES
+                    ${arg_mqtt_INCLUDE_DIRECTORIES}
+                LIBRARIES
+                    ${arg_mqtt_LIBRARIES} ${EXTRA_LIBS}
+                TESTDATA
+                    "../../certificate/cert.crt"
+                    "../../certificate/cert.key"
+                BUILTIN_TESTDATA
+            )
+
+        endforeach()
+    endforeach()
+endfunction()
 
 if(QT_BUILD_STANDALONE_TESTS)
     # Add qt_find_package calls for extra dependencies that need to be found when building

tests/auto/CMakeLists.txt

@@ -1,12 +1,8 @@
 # Copyright (C) 2022 The Qt Company Ltd.
 # SPDX-License-Identifier: BSD-3-Clause
 
-# Generated from auto.pro.
-
 if(WIN32 OR (LINUX AND NOT CMAKE_CROSSCOMPILING))
-# special case begin
-#   add_subdirectory(cmake)
-# special case end
+    add_subdirectory(cmake)
     add_subdirectory(conformance)
     add_subdirectory(qmqttconnectionproperties)
     add_subdirectory(qmqttcontrolpacket)