From c8bcb0bb1af86f2e55dc10e243ad8a0e4f69ed24 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sun, 21 Feb 2016 14:08:17 +1100 Subject: [PATCH] Clarify levels of :nowait t. * doc/lispref/processes.texi (Network Processes): Mention levels of asynchronicity. --- doc/lispref/processes.texi | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/doc/lispref/processes.texi b/doc/lispref/processes.texi index 60b2d90d819..8234501fd89 100644 --- a/doc/lispref/processes.texi +++ b/doc/lispref/processes.texi @@ -2409,14 +2409,22 @@ as it may depend on implementation defined constants, data sizes, and data structure alignment. @end itemize -@item :nowait @var{nowait} -If @var{nowait} is non-@code{nil} for a stream connection, return +@item :nowait @var{bool} +If @var{bool} is non-@code{nil} for a stream connection, return without waiting for the connection to complete. When the connection succeeds or fails, Emacs will call the sentinel function, with a second argument matching @code{"open"} (if successful) or @code{"failed"}. The default is to block, so that -@code{make-network-process} does not return until the connection -has succeeded or failed. +@code{make-network-process} does not return until the connection has +succeeded or failed. + +If you're setting up an asynchronous TLS connection, you have to also +provide the @code{:tls-parameters} parameter (see below). + +Depending on the capabilities of Emacs, how asynchronous +@code{:nowait} is may vary. The three elements that may (or may not) +be done asynchronously are domain name resolution, socket setup, and +(for TLS connections) TLS negotiation. @item :tls-parameters When opening a TLS connection, this should be where the first element -- 2.39.5