aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--lib/starttls.ml4
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
}