blob: fd50391fbd83df5ffd9c2cd0b07b1642906282d4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\page qtmqtt-index.html
\title Qt MQTT
\brief Provides classes and functions to make MQTT programming simple and
portable.
\l{MQTT} is a machine-to-machine (M2M) protocol utilizing the
publish-and-subscribe paradigm. Its purpose is to provide a channel with
minimal communication overhead.
Generally, MQTT is used on top of a TCP connection. However, the base
requirement is defined as an ordered, lossless, bidirectional connection.
The Qt MQTT module provides a standard compliant implementation of the MQTT
protocol specification. It enables applications to act as telemetry displays
and devices to publish telemetry data. The supported versions are MQTT 3.1
and MQTT 3.1.1.
\note Qt MQTT is part of the Qt for Automation offering and not Qt. For further
details please see \l {Qt for Automation}.
\section1 Getting Started
To include the definitions of the module's classes, use the following
directive:
\code
#include <QtMqtt/QtMqtt>
\endcode
To link against the module, add this line to your \l qmake \c .pro file:
\code
QT += mqtt
\endcode
\section1 Articles and Guides
\list
\li \l{Qt MQTT Overview}{Overview}
\endlist
\section1 Examples
\list
\li \l{Qt MQTT Examples}
\endlist
\section1 Reference
\list
\li \l{Qt MQTT C++ Classes}{C++ Classes}
\endlist
\section1 Licenses and Attributions
Qt MQTT is available under commercial licenses from \l{The Qt Company}.
In addition, it is available under the
the \l{GNU General Public License, version 3}.
\generatelist{groupsbymodule attributions-qtmqtt}
*/
|
