Skip to content

Commit

Permalink
Client: Document new connection behaviour and SRV record handling
Browse files Browse the repository at this point in the history
  • Loading branch information
lnjX committed Jul 30, 2024
1 parent 1120a6b commit 57349e7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
12 changes: 12 additions & 0 deletions src/client/QXmppClient.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,18 @@ bool process(QXmppClient *client, const QList<QXmppClientExtension *> &extension
/// - QXmppDiscoveryManager
/// - QXmppEntityTimeManager
///
/// ## Connection details
///
/// If no explicit host and port are configured, the client will look up the SRV records of the
/// domain of the configured JID. Since QXmpp 1.8 both TCP and direct TLS records are looked up
/// and connection via direct TLS is preferred as it saves the extra round trip from STARTTLS. See
/// also \xep{0368, SRV records for XMPP over TLS}.
///
/// On connection errors the other SRV records are tested too (if multiple are available).
///
/// For servers without SRV records or if looking up the records did not succeed, domain and the
/// default port of 5223 (TLS) and 5222 (TCP/STARTTLS) are tried.
///
/// ## Usage of FAST token-based authentication
///
/// QXmpp uses \xep{0484, Fast Authentication Streamlining Tokens} if enabled and supported by the
Expand Down
4 changes: 3 additions & 1 deletion src/client/QXmppConfiguration.h
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@ class QXMPP_EXPORT QXmppConfiguration
TLSDisabled, ///< No encryption even if the server offers it.
TLSRequired, ///< Encryption must be available, otherwise the
///< connection will not be established.
LegacySSL ///< Use only legacy SSL mode.
/// Use direct TLS connection only and connect to configured host and port or domain and
/// 5223 or 5222. No SRV records are looked up.
LegacySSL
};

/// An enumeration for various Non-SASL authentication mechanisms available.
Expand Down

0 comments on commit 57349e7

Please sign in to comment.