aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLars Ingebrigtsen2016-02-21 14:08:17 +1100
committerLars Ingebrigtsen2016-02-21 14:08:17 +1100
commitc8bcb0bb1af86f2e55dc10e243ad8a0e4f69ed24 (patch)
tree7161432aefd248f6819ffabf8b87267f7759dd42
parent799367921033a9bfca27109ba934cb2981c436f9 (diff)
downloademacs-c8bcb0bb1af86f2e55dc10e243ad8a0e4f69ed24.tar.gz
emacs-c8bcb0bb1af86f2e55dc10e243ad8a0e4f69ed24.zip
Clarify levels of :nowait t.
* doc/lispref/processes.texi (Network Processes): Mention levels of asynchronicity.
-rw-r--r--doc/lispref/processes.texi16
1 files 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
2409data structure alignment. 2409data structure alignment.
2410@end itemize 2410@end itemize
2411 2411
2412@item :nowait @var{nowait} 2412@item :nowait @var{bool}
2413If @var{nowait} is non-@code{nil} for a stream connection, return 2413If @var{bool} is non-@code{nil} for a stream connection, return
2414without waiting for the connection to complete. When the connection 2414without waiting for the connection to complete. When the connection
2415succeeds or fails, Emacs will call the sentinel function, with a 2415succeeds or fails, Emacs will call the sentinel function, with a
2416second argument matching @code{"open"} (if successful) or 2416second argument matching @code{"open"} (if successful) or
2417@code{"failed"}. The default is to block, so that 2417@code{"failed"}. The default is to block, so that
2418@code{make-network-process} does not return until the connection 2418@code{make-network-process} does not return until the connection has
2419has succeeded or failed. 2419succeeded or failed.
2420
2421If you're setting up an asynchronous TLS connection, you have to also
2422provide the @code{:tls-parameters} parameter (see below).
2423
2424Depending on the capabilities of Emacs, how asynchronous
2425@code{:nowait} is may vary. The three elements that may (or may not)
2426be done asynchronously are domain name resolution, socket setup, and
2427(for TLS connections) TLS negotiation.
2420 2428
2421@item :tls-parameters 2429@item :tls-parameters
2422When opening a TLS connection, this should be where the first element 2430When opening a TLS connection, this should be where the first element