diff options
| author | Lars Ingebrigtsen | 2016-02-21 14:08:17 +1100 |
|---|---|---|
| committer | Lars Ingebrigtsen | 2016-02-21 14:08:17 +1100 |
| commit | c8bcb0bb1af86f2e55dc10e243ad8a0e4f69ed24 (patch) | |
| tree | 7161432aefd248f6819ffabf8b87267f7759dd42 /doc | |
| parent | 799367921033a9bfca27109ba934cb2981c436f9 (diff) | |
| download | emacs-c8bcb0bb1af86f2e55dc10e243ad8a0e4f69ed24.tar.gz emacs-c8bcb0bb1af86f2e55dc10e243ad8a0e4f69ed24.zip | |
Clarify levels of :nowait t.
* doc/lispref/processes.texi (Network Processes): Mention
levels of asynchronicity.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/processes.texi | 16 |
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 | |||
| 2409 | data structure alignment. | 2409 | data structure alignment. |
| 2410 | @end itemize | 2410 | @end itemize |
| 2411 | 2411 | ||
| 2412 | @item :nowait @var{nowait} | 2412 | @item :nowait @var{bool} |
| 2413 | If @var{nowait} is non-@code{nil} for a stream connection, return | 2413 | If @var{bool} is non-@code{nil} for a stream connection, return |
| 2414 | without waiting for the connection to complete. When the connection | 2414 | without waiting for the connection to complete. When the connection |
| 2415 | succeeds or fails, Emacs will call the sentinel function, with a | 2415 | succeeds or fails, Emacs will call the sentinel function, with a |
| 2416 | second argument matching @code{"open"} (if successful) or | 2416 | second 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 |
| 2419 | has succeeded or failed. | 2419 | succeeded or failed. |
| 2420 | |||
| 2421 | If you're setting up an asynchronous TLS connection, you have to also | ||
| 2422 | provide the @code{:tls-parameters} parameter (see below). | ||
| 2423 | |||
| 2424 | Depending on the capabilities of Emacs, how asynchronous | ||
| 2425 | @code{:nowait} is may vary. The three elements that may (or may not) | ||
| 2426 | be 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 |
| 2422 | When opening a TLS connection, this should be where the first element | 2430 | When opening a TLS connection, this should be where the first element |