diff options
| author | Clombrong <cromblong@egregore.fun> | 2025-06-29 18:31:55 +0200 |
|---|---|---|
| committer | Clombrong <cromblong@egregore.fun> | 2025-06-29 18:31:55 +0200 |
| commit | ee4169faf487e0d4d75738fdddb34cc1767719f9 (patch) | |
| tree | fbc6445920043daaf511fcb4dde13996d316e023 /lib/starttls.ml | |
| parent | 95ddfc29840d980c2197f2681f804f85df160798 (diff) | |
docs(starttls): add for config type
Diffstat (limited to 'lib/starttls.ml')
| -rw-r--r-- | lib/starttls.ml | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/starttls.ml b/lib/starttls.ml index fafda66..9d09e3e 100644 --- a/lib/starttls.ml +++ b/lib/starttls.ml @@ -1,6 +1,10 @@ open Lwt.Syntax open Xml +(** This type is used to configure the STARTTLS handshake during the stream negotiation. + + When the XMPP server advertises optional STARTTLS support, whether the connection + will be upgraded to STARTTLS depends on [prefer_starttls]. *) type config = { prefer_starttls : bool } |