The QCoapOption class holds data about CoAP options. More...
| Header: | #include <QCoapOption> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Coap) target_link_libraries(mytarget PRIVATE Qt6::Coap) |
| qmake: | QT += coap |
Note: All functions in this class are reentrant.
| enum | OptionName { Invalid, IfMatch, UriHost, Etag, IfNoneMatch, …, Size1 } |
| QCoapOption(QCoapOption &&other) | |
| QCoapOption(const QCoapOption &other) | |
| QCoapOption(QCoapOption::OptionName name, quint32 intValue) | |
| QCoapOption(QCoapOption::OptionName name, const QString &stringValue) | |
| QCoapOption(QCoapOption::OptionName name = Invalid, const QByteArray &opaqueValue = QByteArray()) | |
| QCoapOption & | operator=(QCoapOption &&other) |
| QCoapOption & | operator=(const QCoapOption &other) |
| ~QCoapOption() | |
| bool | isValid() const |
| int | length() const |
| QCoapOption::OptionName | name() const |
| QByteArray | opaqueValue() const |
| QString | stringValue() const |
| void | swap(QCoapOption &other) |
| quint32 | uintValue() const |
| bool | operator!=(const QCoapOption &other) const |
| bool | operator==(const QCoapOption &other) const |
CoAP defines a number of options that can be included in a message. Both requests and responses may include a list of one or more options. For example, the URI in a request is transported in several options, and metadata that would be carried in an HTTP header in HTTP is supplied as options as well.
An option contains a name, related to an option ID, and a value. The name is one of the values from the OptionName enumeration.
Indicates the name of an option. The value of each ID is as specified by the CoAP standard, with the exception of Invalid. You can refer to RFC 7252 and RFC 7959 for more details.
| Constant | Value | Description |
|---|---|---|
QCoapOption::Invalid |
0 |
An invalid option. |
QCoapOption::IfMatch |
1 |
If-Match option. |
QCoapOption::UriHost |
3 |
Uri-Host option. |
QCoapOption::Etag |
4 |
Etag option. |
QCoapOption::IfNoneMatch |
5 |
If-None-Match option. |
QCoapOption::Observe |
6 |
Observe option. |
QCoapOption::UriPort |
7 |
Uri-Port option. |
QCoapOption::LocationPath |
8 |
Location-path option. |
QCoapOption::UriPath |
11 |
Uri-Path option. |
QCoapOption::ContentFormat |
12 |
Content-Format option. |
QCoapOption::MaxAge |
14 |
Max-Age option. |
QCoapOption::UriQuery |
15 |
Uri-Query option. |
QCoapOption::Accept |
17 |
Accept option. |
QCoapOption::LocationQuery |
20 |
Location-Query option. |
QCoapOption::Block2 |
23 |
Block2 option. |
QCoapOption::Block1 |
27 |
Block1 option. |
QCoapOption::Size2 |
28 |
Size2 option. |
QCoapOption::ProxyUri |
35 |
Proxy-Uri option. |
QCoapOption::ProxyScheme |
39 |
Proxy-Scheme option. |
QCoapOption::Size1 |
60 |
Size1 option. |
Move-constructs a QCoapOption, making it point to the same object as other was pointing to.
Constructs a new CoAP option as a copy of other, making the two options identical.
See also isValid().
Constructs a new CoAP option with the given name and the unsigned integer intValue.
See also isValid().
Constructs a new CoAP option with the given name and the QString stringValue.
See also isValid().
Constructs a new CoAP option with the given name and QByteArray opaqueValue. If no parameters are passed, constructs an Invalid object.
See also isValid().
Move-assignment operator.
Copies other into this option, making the two options identical. Returns a reference to this QCoapOption.
Destroys the QCoapOption object.
Returns true if the option is valid.
Returns the length of the value of the option.
Returns the name of the option.
Returns the value of the option.
Returns the QString value of the option.
Swaps this option with other. This operation is very fast and never fails.
Returns the integer value of the option.
Returns true if this QCoapOption and other are different.
Returns true if this QCoapOption and other are equals.
