summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKarsten Heimrich <karsten.heimrich@qt.io>2019-03-04 11:51:58 +0100
committerKarsten Heimrich <karsten.heimrich@qt.io>2019-03-05 10:50:27 +0000
commit54d4cdc7d40c4e1816f62c6400ca7cdaf54ac5bb (patch)
tree4aacc9fba264c6c9721fd6dbeeea9f80151df28f
parent0d6a4f6c5973f077670c26edcb01b4c69d5f6ff2 (diff)
Fix some missing documentation
Change-Id: I953cc2dcb1f31b67e7b1964fd280c8d89da46b6f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
-rw-r--r--src/knx/netip/qknxnetip.cpp9
-rw-r--r--src/knx/netip/qknxnetipendpointconnection.cpp22
-rw-r--r--src/knx/netip/qknxnetipendpointconnection.h2
3 files changed, 28 insertions, 5 deletions
diff --git a/src/knx/netip/qknxnetip.cpp b/src/knx/netip/qknxnetip.cpp
index 64a325c..e68bf47 100644
--- a/src/knx/netip/qknxnetip.cpp
+++ b/src/knx/netip/qknxnetip.cpp
@@ -579,6 +579,15 @@ bool QKnxNetIp::isCapability(Capability capability)
The timeout used to empty the incoming queue of a KNXnet/IP router or KNX
IP device if the number of received datagrams exceeds the number of frames
that the device can actually process.
+ \value SecureSessionTimeout
+ The maximum time an authenticated secure session can remain unused
+ without any communication before the secure session gets dropped.
+ \value SecureSessionRequestTimeout
+ The maximum time the KNXnet/IP client will wait for the session
+ response from the KNXnet/IP server after sending a session request.
+ \value SecureSessionAuthenticateTimeout
+ The maximum time the authentication process for a newly created secure
+ session may last until the unauthenticated session will be dropped.
*/
/*!
diff --git a/src/knx/netip/qknxnetipendpointconnection.cpp b/src/knx/netip/qknxnetipendpointconnection.cpp
index 851eb0d..c1769bf 100644
--- a/src/knx/netip/qknxnetipendpointconnection.cpp
+++ b/src/knx/netip/qknxnetipendpointconnection.cpp
@@ -114,7 +114,18 @@ QT_BEGIN_NAMESPACE
State request timeout.
\value Cemi
No cEMI frame acknowledge in time.
+ \value SecureConfig
+ An invalid secure configuration was used to establish the connection.
+ \value SerialNumber
+ An invalid serial number was set for the device.
+ \value AuthFailed
+ The secure client was not successfully authenticated.
+ \value Timeout
+ A timeout occurred during secure session handshake.
+ \value Close
+ The server requested to close the secure session.
\value Unknown
+ An unknown error occurred.
*/
/*!
\enum QKnxNetIpEndpointConnection::SequenceType
@@ -1262,19 +1273,19 @@ void QKnxNetIpEndpointConnection::connectToHost(const QHostAddress &address, qui
});
}
-/*
+/*!
\since 5.13
Returns the serial number of the device using this connection. The default
value is set to \c {0x000000000000}.
*/
-QKnxByteArray QKnxNetIpEndpointConnection::serialNumer() const
+QKnxByteArray QKnxNetIpEndpointConnection::serialNumber() const
{
Q_D(const QKnxNetIpEndpointConnection);
return d->m_serialNumber;
}
-/*
+/*!
\since 5.13
Sets the serial number to \a serialNumber of the device using this
@@ -1329,7 +1340,7 @@ void QKnxNetIpEndpointConnection::connectToHostEncrypted(const QKnxNetIpHpai &co
connectToHost(proxy.hostAddress(), proxy.port());
}
-/*
+/*!
\since 5.13
Establishes a secure session to the host with \a address and \a port.
@@ -1409,6 +1420,9 @@ void QKnxNetIpEndpointConnection::disconnectFromHost()
}
}
+/*!
+ \internal
+*/
QKnxNetIpEndpointConnection::QKnxNetIpEndpointConnection(QKnxNetIpEndpointConnectionPrivate &dd,
QObject *parent)
: QObject(dd, parent)
diff --git a/src/knx/netip/qknxnetipendpointconnection.h b/src/knx/netip/qknxnetipendpointconnection.h
index 3d94fec..d401b82 100644
--- a/src/knx/netip/qknxnetipendpointconnection.h
+++ b/src/knx/netip/qknxnetipendpointconnection.h
@@ -118,7 +118,7 @@ public:
void connectToHost(const QHostAddress &address, quint16 port);
void connectToHost(const QHostAddress &address, quint16 port, QKnxNetIp::HostProtocol proto);
- QKnxByteArray serialNumer() const;
+ QKnxByteArray serialNumber() const;
void setSerialNumber(const QKnxByteArray &serialNumber);
QKnxSecureConfiguration secureConfiguration() const;