summaryrefslogtreecommitdiffstats
path: root/src/mqtt/qmqttauthenticationproperties.cpp
blob: 0425939f142d0216899fe5f4fd5ee871b7df33b9 (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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/******************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtMqtt module.
**
** $QT_BEGIN_LICENSE:GPL$
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
******************************************************************************/

#include "qmqttauthenticationproperties.h"

QT_BEGIN_NAMESPACE

/*!
    \class QMqttAuthenticationProperties

    \inmodule QtMqtt
    \since 5.12

    \brief The QMqttAuthenticationProperties class represents configuration
    options during the authentication process.

    \note Authentication properties are part of the MQTT 5.0 specification and
    cannot be used when connecting with a lower protocol level. See
    QMqttClient::ProtocolVersion for more information.
*/

class QMqttAuthenticationPropertiesData : public QSharedData
{
public:
    QString authenticationMethod;
    QByteArray authenticationData;
    QString reason;
    QMqttUserProperties userProperties;
};

/*!
    \internal
*/
QMqttAuthenticationProperties::QMqttAuthenticationProperties() : data(new QMqttAuthenticationPropertiesData)
{

}

/*!
    \internal
*/
QMqttAuthenticationProperties::QMqttAuthenticationProperties(const QMqttAuthenticationProperties &) = default;

QMqttAuthenticationProperties &QMqttAuthenticationProperties::operator=(const QMqttAuthenticationProperties &rhs)
{
    if (this != &rhs)
        data.operator=(rhs.data);
    return *this;
}

QMqttAuthenticationProperties::~QMqttAuthenticationProperties() = default;

/*!
    Returns the authentication method.
*/
QString QMqttAuthenticationProperties::authenticationMethod() const
{
    return data->authenticationMethod;
}

/*!
    Sets the authentication method to \a method.
*/
void QMqttAuthenticationProperties::setAuthenticationMethod(const QString &method)
{
    data->authenticationMethod = method;
}

/*!
  Returns the authentication data
*/
QByteArray QMqttAuthenticationProperties::authenticationData() const
{
    return data->authenticationData;
}

/*!
    Sets the authentication data to \a adata.

    Authentication data can only be used if an authentication method has
    been specified.

    \sa authenticationMethod()
*/
void QMqttAuthenticationProperties::setAuthenticationData(const QByteArray &adata)
{
    data->authenticationData = adata;
}

/*!
    Returns the reason string. The reason string specifies the reason for
    a disconnect.
*/
QString QMqttAuthenticationProperties::reason() const
{
    return data->reason;
}

/*!
    Sets the reason string to \a r.
*/
void QMqttAuthenticationProperties::setReason(const QString &r)
{
    data->reason = r;
}

/*!
    Returns the user properties.
*/
QMqttUserProperties QMqttAuthenticationProperties::userProperties() const
{
    return data->userProperties;
}

/*!
    Sets the user properties to \a user.
*/
void QMqttAuthenticationProperties::setUserProperties(const QMqttUserProperties &user)
{
    data->userProperties = user;
}

QT_END_NAMESPACE