diff options
| author | Linus Jahn <lnj@kaidan.im> | 2020-04-07 12:09:21 +0200 |
|---|---|---|
| committer | Linus Jahn <lnj@kaidan.im> | 2020-04-07 12:09:21 +0200 |
| commit | d7da60e0537c610257df1fcee5fac6cb2afc1b17 (patch) | |
| tree | 64eae77182484ebcce8c42f4ac661cf38b929721 /src | |
| parent | 2fdb098e44c07638dd7862bb8c2e7f1b2af5d667 (diff) | |
| download | qxmpp-d7da60e0537c610257df1fcee5fac6cb2afc1b17.tar.gz | |
QXmppClient: State that iqReceived() is only emitted for results
Diffstat (limited to 'src')
| -rw-r--r-- | src/client/QXmppClient.h | 10 | ||||
| -rw-r--r-- | src/client/QXmppOutgoingClient.h | 3 |
2 files changed, 8 insertions, 5 deletions
diff --git a/src/client/QXmppClient.h b/src/client/QXmppClient.h index 1f6f206b..60b9934f 100644 --- a/src/client/QXmppClient.h +++ b/src/client/QXmppClient.h @@ -261,10 +261,12 @@ Q_SIGNALS: /// changes Busy, Idle, Invisible etc. void presenceReceived(const QXmppPresence &presence); - /// Notifies that an XMPP iq stanza is received. The QXmppIq - /// parameter contains the details of the iq sent to this client. - /// IQ stanzas provide a structured request-response mechanism. Roster - /// management, setting-getting vCards etc is done using iq stanzas. + /// This signal is emitted when IQs of type result or error are received by + /// the client and no registered QXmppClientExtension could handle it. + /// + /// This is useful when it is only important to check whether the response + /// of an IQ was successful. However, the recommended way is still to use an + /// additional QXmppClientExtension for this kind of tasks. void iqReceived(const QXmppIq &iq); /// This signal is emitted to indicate that one or more SSL errors were diff --git a/src/client/QXmppOutgoingClient.h b/src/client/QXmppOutgoingClient.h index 623fb7b3..abb044f3 100644 --- a/src/client/QXmppOutgoingClient.h +++ b/src/client/QXmppOutgoingClient.h @@ -74,7 +74,8 @@ Q_SIGNALS: /// This signal is emitted when a message is received. void messageReceived(const QXmppMessage &); - /// This signal is emitted when an IQ is received. + /// This signal is emitted when an IQ response (type result or error) has + /// been received that was not handled by elementReceived(). void iqReceived(const QXmppIq &); /// This signal is emitted when SSL errors are encountered. |