diff options
| author | Lars Ingebrigtsen | 2016-02-22 13:14:35 +1100 |
|---|---|---|
| committer | Lars Ingebrigtsen | 2016-02-22 13:14:35 +1100 |
| commit | b55bf9f45acff424710c5192342a82175e12ddf8 (patch) | |
| tree | 0f80e7c3231d34c238a6e57981274c067cc9f3cd /src/process.c | |
| parent | fc4457d7143c44514810b971e103daedcea404ec (diff) | |
| download | emacs-b55bf9f45acff424710c5192342a82175e12ddf8.tar.gz emacs-b55bf9f45acff424710c5192342a82175e12ddf8.zip | |
Mention in the doc strings that process functions may block
(Fprocess_contact, Fprocess_datagram_address)
(Fset_process_datagram_address, Fset_network_process_option)
(Fprocess_send_region, Fprocess_send_string): Mention that the
functions may block.
(Fset_process_coding_system): Ditto.
Diffstat (limited to 'src/process.c')
| -rw-r--r-- | src/process.c | 33 |
1 files changed, 26 insertions, 7 deletions
diff --git a/src/process.c b/src/process.c index 79f807284a0..72580a2ff49 100644 --- a/src/process.c +++ b/src/process.c | |||
| @@ -1214,7 +1214,9 @@ SERVICE) for a network connection or (PORT SPEED) for a serial | |||
| 1214 | connection. If KEY is t, the complete contact information for the | 1214 | connection. If KEY is t, the complete contact information for the |
| 1215 | connection is returned, else the specific value for the keyword KEY is | 1215 | connection is returned, else the specific value for the keyword KEY is |
| 1216 | returned. See `make-network-process' or `make-serial-process' for a | 1216 | returned. See `make-network-process' or `make-serial-process' for a |
| 1217 | list of keywords. */) | 1217 | list of keywords. |
| 1218 | If PROCESS is a non-blocking network process that hasn't been fully | ||
| 1219 | set up yet, this function will block until socket setup has completed. */) | ||
| 1218 | (register Lisp_Object process, Lisp_Object key) | 1220 | (register Lisp_Object process, Lisp_Object key) |
| 1219 | { | 1221 | { |
| 1220 | Lisp_Object contact; | 1222 | Lisp_Object contact; |
| @@ -2449,7 +2451,9 @@ conv_lisp_to_sockaddr (int family, Lisp_Object address, struct sockaddr *sa, int | |||
| 2449 | #ifdef DATAGRAM_SOCKETS | 2451 | #ifdef DATAGRAM_SOCKETS |
| 2450 | DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address, | 2452 | DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_address, |
| 2451 | 1, 1, 0, | 2453 | 1, 1, 0, |
| 2452 | doc: /* Get the current datagram address associated with PROCESS. */) | 2454 | doc: /* Get the current datagram address associated with PROCESS. |
| 2455 | If PROCESS is a non-blocking network process that hasn't been fully | ||
| 2456 | set up yet, this function will block until socket setup has completed. */) | ||
| 2453 | (Lisp_Object process) | 2457 | (Lisp_Object process) |
| 2454 | { | 2458 | { |
| 2455 | int channel; | 2459 | int channel; |
| @@ -2470,7 +2474,10 @@ DEFUN ("process-datagram-address", Fprocess_datagram_address, Sprocess_datagram_ | |||
| 2470 | DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address, | 2474 | DEFUN ("set-process-datagram-address", Fset_process_datagram_address, Sset_process_datagram_address, |
| 2471 | 2, 2, 0, | 2475 | 2, 2, 0, |
| 2472 | doc: /* Set the datagram address for PROCESS to ADDRESS. | 2476 | doc: /* Set the datagram address for PROCESS to ADDRESS. |
| 2473 | Returns nil upon error setting address, ADDRESS otherwise. */) | 2477 | Returns nil upon error setting address, ADDRESS otherwise. |
| 2478 | |||
| 2479 | If PROCESS is a non-blocking network process that hasn't been fully | ||
| 2480 | set up yet, this function will block until socket setup has completed. */) | ||
| 2474 | (Lisp_Object process, Lisp_Object address) | 2481 | (Lisp_Object process, Lisp_Object address) |
| 2475 | { | 2482 | { |
| 2476 | int channel; | 2483 | int channel; |
| @@ -2638,7 +2645,10 @@ DEFUN ("set-network-process-option", | |||
| 2638 | doc: /* For network process PROCESS set option OPTION to value VALUE. | 2645 | doc: /* For network process PROCESS set option OPTION to value VALUE. |
| 2639 | See `make-network-process' for a list of options and values. | 2646 | See `make-network-process' for a list of options and values. |
| 2640 | If optional fourth arg NO-ERROR is non-nil, don't signal an error if | 2647 | If optional fourth arg NO-ERROR is non-nil, don't signal an error if |
| 2641 | OPTION is not a supported option, return nil instead; otherwise return t. */) | 2648 | OPTION is not a supported option, return nil instead; otherwise return t. |
| 2649 | |||
| 2650 | If PROCESS is a non-blocking network process that hasn't been fully | ||
| 2651 | set up yet, this function will block until socket setup has completed. */) | ||
| 2642 | (Lisp_Object process, Lisp_Object option, Lisp_Object value, Lisp_Object no_error) | 2652 | (Lisp_Object process, Lisp_Object option, Lisp_Object value, Lisp_Object no_error) |
| 2643 | { | 2653 | { |
| 2644 | int s; | 2654 | int s; |
| @@ -6247,7 +6257,10 @@ nil, indicating the current buffer's process. | |||
| 6247 | Called from program, takes three arguments, PROCESS, START and END. | 6257 | Called from program, takes three arguments, PROCESS, START and END. |
| 6248 | If the region is more than 500 characters long, | 6258 | If the region is more than 500 characters long, |
| 6249 | it is sent in several bunches. This may happen even for shorter regions. | 6259 | it is sent in several bunches. This may happen even for shorter regions. |
| 6250 | Output from processes can arrive in between bunches. */) | 6260 | Output from processes can arrive in between bunches. |
| 6261 | |||
| 6262 | If PROCESS is a non-blocking network process that hasn't been fully | ||
| 6263 | set up yet, this function will block until socket setup has completed. */) | ||
| 6251 | (Lisp_Object process, Lisp_Object start, Lisp_Object end) | 6264 | (Lisp_Object process, Lisp_Object start, Lisp_Object end) |
| 6252 | { | 6265 | { |
| 6253 | Lisp_Object proc = get_process (process); | 6266 | Lisp_Object proc = get_process (process); |
| @@ -6277,7 +6290,10 @@ PROCESS may be a process, a buffer, the name of a process or buffer, or | |||
| 6277 | nil, indicating the current buffer's process. | 6290 | nil, indicating the current buffer's process. |
| 6278 | If STRING is more than 500 characters long, | 6291 | If STRING is more than 500 characters long, |
| 6279 | it is sent in several bunches. This may happen even for shorter strings. | 6292 | it is sent in several bunches. This may happen even for shorter strings. |
| 6280 | Output from processes can arrive in between bunches. */) | 6293 | Output from processes can arrive in between bunches. |
| 6294 | |||
| 6295 | If PROCESS is a non-blocking network process that hasn't been fully | ||
| 6296 | set up yet, this function will block until socket setup has completed. */) | ||
| 6281 | (Lisp_Object process, Lisp_Object string) | 6297 | (Lisp_Object process, Lisp_Object string) |
| 6282 | { | 6298 | { |
| 6283 | Lisp_Object proc; | 6299 | Lisp_Object proc; |
| @@ -7151,7 +7167,10 @@ DEFUN ("set-process-coding-system", Fset_process_coding_system, | |||
| 7151 | Sset_process_coding_system, 1, 3, 0, | 7167 | Sset_process_coding_system, 1, 3, 0, |
| 7152 | doc: /* Set coding systems of PROCESS to DECODING and ENCODING. | 7168 | doc: /* Set coding systems of PROCESS to DECODING and ENCODING. |
| 7153 | DECODING will be used to decode subprocess output and ENCODING to | 7169 | DECODING will be used to decode subprocess output and ENCODING to |
| 7154 | encode subprocess input. */) | 7170 | encode subprocess input. |
| 7171 | |||
| 7172 | If PROCESS is a non-blocking network process that hasn't been fully | ||
| 7173 | set up yet, this function will block until socket setup has completed. */) | ||
| 7155 | (register Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding) | 7174 | (register Lisp_Object process, Lisp_Object decoding, Lisp_Object encoding) |
| 7156 | { | 7175 | { |
| 7157 | register struct Lisp_Process *p; | 7176 | register struct Lisp_Process *p; |