summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKarsten Heimrich <karsten.heimrich@qt.io>2018-12-04 14:08:03 +0100
committerKarsten Heimrich <karsten.heimrich@qt.io>2018-12-10 09:16:07 +0000
commit0d47c57c536091103cefd9f8fe8438669a8dba23 (patch)
tree77013e1e3eed3d2680bbe13ae54be068bbd55384
parentefcd1b706af1f66a31b56b82a2d806538dd29e15 (diff)
Deprecate enum value with typo, add some minor documentation
Change-Id: I84029901352a490b1976338c0ce16c2236273fa9 Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io> Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
-rw-r--r--src/knx/netip/qknxnetip.cpp8
-rw-r--r--src/knx/netip/qknxnetip.h3
2 files changed, 8 insertions, 3 deletions
diff --git a/src/knx/netip/qknxnetip.cpp b/src/knx/netip/qknxnetip.cpp
index 34c69ba..335c4a8 100644
--- a/src/knx/netip/qknxnetip.cpp
+++ b/src/knx/netip/qknxnetip.cpp
@@ -656,16 +656,20 @@ bool QKnxNetIp::isCapability(Capability capability)
\omitvalue Unknown
\value Invalid
The extended search request parameter contains an invalid value.
+ Usually the invalid value is used to test the behavior of a KNXnet/IP
+ router or server for unknown SRPs.
\value SelectByProgrammingMode
Client is interested only in the response from KNXnet/IP servers
in programming mode currently enabled.
\value SelectByMACAddress
Client is interested only in the response from KNXnet/IP servers
with the given MAC address.
- \value SelectByServiceSRP
+ \value SelectByService
Client is interested only in the response from KNXnet/IP servers
supporting the given KNXnet/IP service family in at least the given
version.
+ \value SelectByServiceSRP
+ This enum value has been deprecated. Use \l SelectByService instead.
\value RequestDIBs
Client includes this search request parameter (SRP) to indicate
that it is interested in the listed DIBs. This SRP shall not
@@ -687,7 +691,7 @@ bool QKnx::NetIp::isStructType(QKnx::NetIp::SearchParameterType type)
switch (QKnx::NetIp::SearchParameterType(quint8(type) & ~(0x80))) {
case QKnx::NetIp::SearchParameterType::SelectByProgrammingMode:
case QKnx::NetIp::SearchParameterType::SelectByMACAddress:
- case QKnx::NetIp::SearchParameterType::SelectByServiceSRP:
+ case QKnx::NetIp::SearchParameterType::SelectByService:
case QKnx::NetIp::SearchParameterType::RequestDIBs:
return true;
case QKnx::NetIp::SearchParameterType::Reserved01:
diff --git a/src/knx/netip/qknxnetip.h b/src/knx/netip/qknxnetip.h
index e34503c..26a891c 100644
--- a/src/knx/netip/qknxnetip.h
+++ b/src/knx/netip/qknxnetip.h
@@ -276,7 +276,8 @@ namespace QKnx
Invalid = 0x00,
SelectByProgrammingMode = 0x01,
SelectByMACAddress = 0x02,
- SelectByServiceSRP = 0x03,
+ SelectByService = 0x03,
+ SelectByServiceSRP = 0x03, // ### Qt6: remove
RequestDIBs = 0x04,
Reserved01 = 0x05,
Reserved02 = 0x06,