blob: 3e0dc15c567ac3041242e80fc16c0d4ee493df20 (
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
/****************************************************************************
**
** Copyright (C) 2017 Witekio.
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtCoap 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 "qcoapresource_p.h"
QT_BEGIN_NAMESPACE
/*!
\class QCoapResource
\inmodule QtCoap
\brief The QCoapResource class holds information about a discovered
resource.
\reentrant
The QCoapRequest contains data as the path and title of the resource
and other ancillary information.
\sa QCoapResourceDiscoveryReply
*/
/*!
Constructs a new QCoapResource.
*/
QCoapResource::QCoapResource() :
d(new QCoapResourcePrivate)
{
}
/*!
Constructs a new CoAP resource as a copy of \a other, making the two
resources identical.
*/
QCoapResource::QCoapResource(const QCoapResource &other) :
d(other.d)
{
}
/*!
Destroy the QCoapResource.
*/
QCoapResource::~QCoapResource()
{
}
/*!
Copies \a other into this resource, making the two resources identical.
Returns a reference to this QCoapResource.
*/
QCoapResource &QCoapResource::operator=(const QCoapResource &other)
{
d = other.d;
return *this;
}
/*!
Swaps this resource with \a other. This operation is very fast and never fails.
*/
void QCoapResource::swap(QCoapResource &other) noexcept
{
d.swap(other.d);
}
/*!
Returns the host of the resource.
\sa setHost()
*/
QHostAddress QCoapResource::host() const
{
return d->host;
}
/*!
Returns the path of the resource.
\sa setPath()
*/
QString QCoapResource::path() const
{
return d->path;
}
/*!
Returns the title of the resource.
\sa setTitle()
*/
QString QCoapResource::title() const
{
return d->title;
}
/*!
Returns \c true if the resource is observable
\sa setObservable()
*/
bool QCoapResource::observable() const
{
return d->observable;
}
/*!
Returns the type of the resource.
\sa setResourceType()
*/
QString QCoapResource::resourceType() const
{
return d->resourceType;
}
/*!
Returns the interface description of the resource.
The Interface Description 'if' attribute is an opaque string used to
provide a name or URI indicating a specific interface definition used
to interact with the target resource. It is specified in
\l{https://tools.ietf.org/html/rfc6690#section-3.2}{RFC 6690}.
\sa setInterface()
*/
QString QCoapResource::interface() const
{
return d->interface;
}
/*!
Returns the maximum size of the resource.
The maximum size estimate attribute 'sz' gives an indication of the
maximum size of the resource representation returned by performing a
GET on the target URI. It is specified in
\l{https://tools.ietf.org/html/rfc6690#section-3.3}{RFC 6690}.
\sa setMaximumSize()
*/
int QCoapResource::maximumSize() const
{
return d->maximumSize;
}
/*!
Returns the Content-Format code of the resource.
The Content-Format code corresponds to the 'ct' attribute and provides a
hint about the Content-Formats this resource returns. It is specified
in \l{https://tools.ietf.org/html/rfc7252#section-7.2.1}{RFC 7252}.
\sa setContentFormat()
*/
uint QCoapResource::contentFormat() const
{
return d->contentFormat;
}
/*!
Sets the host of the resource to \a host.
\sa host()
*/
void QCoapResource::setHost(const QHostAddress &host)
{
d->host = host;
}
/*!
Sets the path of the resource to \a path.
\sa path()
*/
void QCoapResource::setPath(const QString &path)
{
d->path = path;
}
/*!
Sets the title of the resource to \a title.
\sa title()
*/
void QCoapResource::setTitle(const QString &title)
{
d->title = title;
}
/*!
Makes the resource observable if the \a observable
parameter is \c true.
\sa observable()
*/
void QCoapResource::setObservable(bool observable)
{
d->observable = observable;
}
/*!
Sets the resource type to \a resourceType.
\sa resourceType()
*/
void QCoapResource::setResourceType(const QString &resourceType)
{
d->resourceType = resourceType;
}
/*!
Sets the interface of the resource to \a interface.
\sa interface()
*/
void QCoapResource::setInterface(const QString &interface)
{
d->interface = interface;
}
/*!
Sets the maximum size of the resource to \a maximumSize.
\sa maximumSize()
*/
void QCoapResource::setMaximumSize(int maximumSize)
{
d->maximumSize = maximumSize;
}
/*!
Sets the content format of the resource to \a contentFormat. The content
format can be one of the content formats defined in \l {CoAP Content-Formats Registry}.
\note CoAP supports common content formats such as XML, JSON, and so on, but
these are text based and consequently heavy both in payload and in processing.
One of the recommended content formats to use with CoAP is CBOR, which is
designed to be used in such contexts.
\sa contentFormat(), QCborStreamWriter, QCborStreamReader
*/
void QCoapResource::setContentFormat(uint contentFormat)
{
d->contentFormat = contentFormat;
}
QT_END_NAMESPACE
|
