Mercurial > emacs
annotate lispref/processes.texi @ 21347:aca24aa07fb4
(rmail-mode-2): Locally set enable-local-variables
to nil, so a local var list in a message won't confuse things.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Fri, 03 Apr 1998 05:34:10 +0000 |
parents | 66d807bdc5b4 |
children | 90da2489c498 |
rev | line source |
---|---|
6558 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998 Free Software Foundation, Inc. |
6558 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/processes | |
6 @node Processes, System Interface, Abbrevs, Top | |
7 @chapter Processes | |
8 @cindex child process | |
9 @cindex parent process | |
10 @cindex subprocess | |
11 @cindex process | |
12 | |
13 In the terminology of operating systems, a @dfn{process} is a space in | |
14 which a program can execute. Emacs runs in a process. Emacs Lisp | |
15 programs can invoke other programs in processes of their own. These are | |
16 called @dfn{subprocesses} or @dfn{child processes} of the Emacs process, | |
17 which is their @dfn{parent process}. | |
18 | |
19 A subprocess of Emacs may be @dfn{synchronous} or @dfn{asynchronous}, | |
20 depending on how it is created. When you create a synchronous | |
21 subprocess, the Lisp program waits for the subprocess to terminate | |
22 before continuing execution. When you create an asynchronous | |
23 subprocess, it can run in parallel with the Lisp program. This kind of | |
24 subprocess is represented within Emacs by a Lisp object which is also | |
25 called a ``process''. Lisp programs can use this object to communicate | |
26 with the subprocess or to control it. For example, you can send | |
27 signals, obtain status information, receive output from the process, or | |
28 send input to it. | |
29 | |
30 @defun processp object | |
31 This function returns @code{t} if @var{object} is a process, | |
32 @code{nil} otherwise. | |
33 @end defun | |
34 | |
35 @menu | |
36 * Subprocess Creation:: Functions that start subprocesses. | |
37 * Synchronous Processes:: Details of using synchronous subprocesses. | |
7411
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
38 * MS-DOS Subprocesses:: On MS-DOS, you must indicate text vs binary |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
39 for data sent to and from a subprocess. |
6558 | 40 * Asynchronous Processes:: Starting up an asynchronous subprocess. |
41 * Deleting Processes:: Eliminating an asynchronous subprocess. | |
42 * Process Information:: Accessing run-status and other attributes. | |
43 * Input to Processes:: Sending input to an asynchronous subprocess. | |
44 * Signals to Processes:: Stopping, continuing or interrupting | |
45 an asynchronous subprocess. | |
46 * Output from Processes:: Collecting output from an asynchronous subprocess. | |
47 * Sentinels:: Sentinels run when process run-status changes. | |
48 * Transaction Queues:: Transaction-based communication with subprocesses. | |
12098 | 49 * Network:: Opening network connections. |
6558 | 50 @end menu |
51 | |
52 @node Subprocess Creation | |
53 @section Functions that Create Subprocesses | |
54 | |
55 There are three functions that create a new subprocess in which to run | |
56 a program. One of them, @code{start-process}, creates an asynchronous | |
57 process and returns a process object (@pxref{Asynchronous Processes}). | |
58 The other two, @code{call-process} and @code{call-process-region}, | |
59 create a synchronous process and do not return a process object | |
60 (@pxref{Synchronous Processes}). | |
61 | |
62 Synchronous and asynchronous processes are explained in following | |
63 sections. Since the three functions are all called in a similar | |
64 fashion, their common arguments are described here. | |
65 | |
66 @cindex execute program | |
67 @cindex @code{PATH} environment variable | |
68 @cindex @code{HOME} environment variable | |
69 In all cases, the function's @var{program} argument specifies the | |
70 program to be run. An error is signaled if the file is not found or | |
71 cannot be executed. If the file name is relative, the variable | |
72 @code{exec-path} contains a list of directories to search. Emacs | |
73 initializes @code{exec-path} when it starts up, based on the value of | |
74 the environment variable @code{PATH}. The standard file name | |
75 constructs, @samp{~}, @samp{.}, and @samp{..}, are interpreted as usual | |
76 in @code{exec-path}, but environment variable substitutions | |
77 (@samp{$HOME}, etc.) are not recognized; use | |
78 @code{substitute-in-file-name} to perform them (@pxref{File Name | |
79 Expansion}). | |
80 | |
81 Each of the subprocess-creating functions has a @var{buffer-or-name} | |
82 argument which specifies where the standard output from the program will | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
83 go. It should be a buffer or a buffer name (which will create the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
84 buffer if it does not already exist). It can also be @code{nil}, which |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
85 says to discard the output unless a filter function handles it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
86 (@xref{Filter Functions}, and @ref{Read and Print}.) Normally, you |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
87 should avoid having multiple processes send output to the same buffer |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
88 because their output would be intermixed randomly. |
6558 | 89 |
90 @cindex program arguments | |
91 All three of the subprocess-creating functions have a @code{&rest} | |
92 argument, @var{args}. The @var{args} must all be strings, and they are | |
93 supplied to @var{program} as separate command line arguments. Wildcard | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
94 characters and other shell constructs have no special meanings in these |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
95 strings, since the whole strings are passed directly to the specified |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
96 program. |
6558 | 97 |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7411
diff
changeset
|
98 @strong{Please note:} The argument @var{program} contains only the |
6558 | 99 name of the program; it may not contain any command-line arguments. You |
100 must use @var{args} to provide those. | |
101 | |
102 The subprocess gets its current directory from the value of | |
103 @code{default-directory} (@pxref{File Name Expansion}). | |
104 | |
105 @cindex environment variables, subprocesses | |
106 The subprocess inherits its environment from Emacs; but you can | |
107 specify overrides for it with @code{process-environment}. @xref{System | |
108 Environment}. | |
109 | |
110 @defvar exec-directory | |
17611
1b2afa6391ca
(exec-directory): Wakeup no longer exists, so use movemail as example.
Richard M. Stallman <rms@gnu.org>
parents:
16664
diff
changeset
|
111 @pindex movemail |
6558 | 112 The value of this variable is the name of a directory (a string) that |
113 contains programs that come with GNU Emacs, that are intended for Emacs | |
17611
1b2afa6391ca
(exec-directory): Wakeup no longer exists, so use movemail as example.
Richard M. Stallman <rms@gnu.org>
parents:
16664
diff
changeset
|
114 to invoke. The program @code{movemail} is an example of such a program; |
1b2afa6391ca
(exec-directory): Wakeup no longer exists, so use movemail as example.
Richard M. Stallman <rms@gnu.org>
parents:
16664
diff
changeset
|
115 Rmail uses it to fetch new mail from an inbox. |
6558 | 116 @end defvar |
117 | |
118 @defopt exec-path | |
119 The value of this variable is a list of directories to search for | |
120 programs to run in subprocesses. Each element is either the name of a | |
121 directory (i.e., a string), or @code{nil}, which stands for the default | |
122 directory (which is the value of @code{default-directory}). | |
123 @cindex program directories | |
124 | |
125 The value of @code{exec-path} is used by @code{call-process} and | |
126 @code{start-process} when the @var{program} argument is not an absolute | |
127 file name. | |
128 @end defopt | |
129 | |
130 @node Synchronous Processes | |
131 @section Creating a Synchronous Process | |
132 @cindex synchronous subprocess | |
133 | |
134 After a @dfn{synchronous process} is created, Emacs waits for the | |
135 process to terminate before continuing. Starting Dired is an example of | |
136 this: it runs @code{ls} in a synchronous process, then modifies the | |
137 output slightly. Because the process is synchronous, the entire | |
138 directory listing arrives in the buffer before Emacs tries to do | |
139 anything with it. | |
140 | |
141 While Emacs waits for the synchronous subprocess to terminate, the | |
142 user can quit by typing @kbd{C-g}. The first @kbd{C-g} tries to kill | |
143 the subprocess with a @code{SIGINT} signal; but it waits until the | |
144 subprocess actually terminates before quitting. If during that time the | |
145 user types another @kbd{C-g}, that kills the subprocess instantly with | |
146 @code{SIGKILL} and quits immediately. @xref{Quitting}. | |
147 | |
148 The synchronous subprocess functions returned @code{nil} in version | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
149 18. Now they return an indication of how the process terminated. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
150 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
151 The output from a synchronous subprocess is generally decoded using a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
152 coding system, much like text read from a file. The input sent to a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
153 subprocess by @code{call-process-region} is encoded using a coding |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
154 system, much like text written into a file. @xref{Coding Systems}. |
6558 | 155 |
12067 | 156 @defun call-process program &optional infile destination display &rest args |
6558 | 157 This function calls @var{program} in a separate process and waits for |
158 it to finish. | |
159 | |
160 The standard input for the process comes from file @var{infile} if | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
161 @var{infile} is not @code{nil}, and from @file{/dev/null} otherwise. |
12067 | 162 The argument @var{destination} says where to put the process output. |
163 Here are the possibilities: | |
164 | |
165 @table @asis | |
166 @item a buffer | |
167 Insert the output in that buffer, before point. This includes both the | |
168 standard output stream and the standard error stream of the process. | |
169 | |
170 @item a string | |
16664
f67402af7555
call-process does not create a buffer.
Richard M. Stallman <rms@gnu.org>
parents:
15759
diff
changeset
|
171 Find the buffer with that name, then insert the output in that buffer, |
f67402af7555
call-process does not create a buffer.
Richard M. Stallman <rms@gnu.org>
parents:
15759
diff
changeset
|
172 before point. |
12067 | 173 |
174 @item @code{t} | |
175 Insert the output in the current buffer, before point. | |
176 | |
177 @item @code{nil} | |
178 Discard the output. | |
6558 | 179 |
12067 | 180 @item 0 |
181 Discard the output, and return immediately without waiting | |
182 for the subprocess to finish. | |
183 | |
184 In this case, the process is not truly synchronous, since it can run in | |
185 parallel with Emacs; but you can think of it as synchronous in that | |
186 Emacs is essentially finished with the subprocess as soon as this | |
187 function returns. | |
188 | |
189 @item (@var{real-destination} @var{error-destination}) | |
190 Keep the standard output stream separate from the standard error stream; | |
191 deal with the ordinary output as specified by @var{real-destination}, | |
192 and dispose of the error output according to @var{error-destination}. | |
193 The value @code{nil} means discard it, @code{t} means mix it with the | |
194 ordinary output, and a string specifies a file name to redirect error | |
195 output into. | |
196 | |
197 You can't directly specify a buffer to put the error output in; that is | |
198 too difficult to implement. But you can achieve this result by sending | |
199 the error output to a temporary file and then inserting the file into a | |
200 buffer. | |
201 @end table | |
6558 | 202 |
203 If @var{display} is non-@code{nil}, then @code{call-process} redisplays | |
204 the buffer as output is inserted. Otherwise the function does no | |
205 redisplay, and the results become visible on the screen only when Emacs | |
206 redisplays that buffer in the normal course of events. | |
207 | |
208 The remaining arguments, @var{args}, are strings that specify command | |
209 line arguments for the program. | |
210 | |
211 The value returned by @code{call-process} (unless you told it not to | |
212 wait) indicates the reason for process termination. A number gives the | |
213 exit status of the subprocess; 0 means success, and any other value | |
214 means failure. If the process terminated with a signal, | |
215 @code{call-process} returns a string describing the signal. | |
216 | |
217 In the examples below, the buffer @samp{foo} is current. | |
218 | |
219 @smallexample | |
220 @group | |
221 (call-process "pwd" nil t) | |
222 @result{} nil | |
223 | |
224 ---------- Buffer: foo ---------- | |
225 /usr/user/lewis/manual | |
226 ---------- Buffer: foo ---------- | |
227 @end group | |
228 | |
229 @group | |
230 (call-process "grep" nil "bar" nil "lewis" "/etc/passwd") | |
231 @result{} nil | |
232 | |
233 ---------- Buffer: bar ---------- | |
234 lewis:5LTsHm66CSWKg:398:21:Bil Lewis:/user/lewis:/bin/csh | |
235 | |
236 ---------- Buffer: bar ---------- | |
237 @end group | |
238 @end smallexample | |
239 | |
240 The @code{insert-directory} function contains a good example of the use | |
241 of @code{call-process}: | |
242 | |
243 @smallexample | |
244 @group | |
245 (call-process insert-directory-program nil t nil switches | |
246 (if full-directory-p | |
247 (concat (file-name-as-directory file) ".") | |
248 file)) | |
249 @end group | |
250 @end smallexample | |
251 @end defun | |
252 | |
12067 | 253 @defun call-process-region start end program &optional delete destination display &rest args |
6558 | 254 This function sends the text between @var{start} to @var{end} as |
255 standard input to a process running @var{program}. It deletes the text | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
256 sent if @var{delete} is non-@code{nil}; this is useful when |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
257 @var{destination} is @code{t}, to insert the output in the current |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
258 buffer in place of the input. |
6558 | 259 |
12067 | 260 The arguments @var{destination} and @var{display} control what to do |
6558 | 261 with the output from the subprocess, and whether to update the display |
262 as it comes in. For details, see the description of | |
12067 | 263 @code{call-process}, above. If @var{destination} is the integer 0, |
6558 | 264 @code{call-process-region} discards the output and returns @code{nil} |
265 immediately, without waiting for the subprocess to finish. | |
266 | |
267 The remaining arguments, @var{args}, are strings that specify command | |
268 line arguments for the program. | |
269 | |
270 The return value of @code{call-process-region} is just like that of | |
271 @code{call-process}: @code{nil} if you told it to return without | |
272 waiting; otherwise, a number or string which indicates how the | |
273 subprocess terminated. | |
274 | |
275 In the following example, we use @code{call-process-region} to run the | |
276 @code{cat} utility, with standard input being the first five characters | |
277 in buffer @samp{foo} (the word @samp{input}). @code{cat} copies its | |
278 standard input into its standard output. Since the argument | |
12067 | 279 @var{destination} is @code{t}, this output is inserted in the current |
6558 | 280 buffer. |
281 | |
282 @smallexample | |
283 @group | |
284 ---------- Buffer: foo ---------- | |
285 input@point{} | |
286 ---------- Buffer: foo ---------- | |
287 @end group | |
288 | |
289 @group | |
290 (call-process-region 1 6 "cat" nil t) | |
291 @result{} nil | |
292 | |
293 ---------- Buffer: foo ---------- | |
294 inputinput@point{} | |
295 ---------- Buffer: foo ---------- | |
296 @end group | |
297 @end smallexample | |
298 | |
299 The @code{shell-command-on-region} command uses | |
300 @code{call-process-region} like this: | |
301 | |
302 @smallexample | |
303 @group | |
304 (call-process-region | |
305 start end | |
306 shell-file-name ; @r{Name of program.} | |
307 nil ; @r{Do not delete region.} | |
308 buffer ; @r{Send output to @code{buffer}.} | |
309 nil ; @r{No redisplay during output.} | |
310 "-c" command) ; @r{Arguments for the shell.} | |
311 @end group | |
312 @end smallexample | |
313 @end defun | |
314 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
315 @tindex shell-command-to-string |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
316 @defun shell-command-to-string command |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
317 This function executes @var{command} (a string) as a shell command, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
318 then returns the command's output as a string. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
319 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
320 |
7411
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
321 @node MS-DOS Subprocesses |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
322 @section MS-DOS Subprocesses |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
323 |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
324 On MS-DOS, you must indicate whether the data going to and from |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
325 a synchronous subprocess are text or binary. Text data requires |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
326 translation between the end-of-line convention used within Emacs |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
327 (a single newline character) and the convention used outside Emacs |
12098 | 328 (the two-character sequence, @sc{crlf}). |
7411
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
329 |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
330 The variable @code{binary-process-input} applies to input sent to the |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
331 subprocess, and @code{binary-process-output} applies to output received |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
332 from it. A non-@code{nil} value means the data is non-text; @code{nil} |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
333 means the data is text, and calls for conversion. |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
334 |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
335 @defvar binary-process-input |
12098 | 336 If this variable is @code{nil}, convert newlines to @sc{crlf} sequences in |
7411
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
337 the input to a synchronous subprocess. |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
338 @end defvar |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
339 |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
340 @defvar binary-process-output |
12098 | 341 If this variable is @code{nil}, convert @sc{crlf} sequences to newlines in |
7411
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
342 the output from a synchronous subprocess. |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
343 @end defvar |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
344 |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
345 @xref{Files and MS-DOS}, for related information. |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
346 |
6558 | 347 @node Asynchronous Processes |
348 @section Creating an Asynchronous Process | |
349 @cindex asynchronous subprocess | |
350 | |
351 After an @dfn{asynchronous process} is created, Emacs and the Lisp | |
352 program both continue running immediately. The process may thereafter | |
353 run in parallel with Emacs, and the two may communicate with each other | |
354 using the functions described in following sections. Here we describe | |
355 how to create an asynchronous process with @code{start-process}. | |
356 | |
357 @defun start-process name buffer-or-name program &rest args | |
358 This function creates a new asynchronous subprocess and starts the | |
359 program @var{program} running in it. It returns a process object that | |
360 stands for the new subprocess in Lisp. The argument @var{name} | |
361 specifies the name for the process object; if a process with this name | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
362 already exists, then @var{name} is modified (by appending @samp{<1>}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
363 etc.) to be unique. The buffer @var{buffer-or-name} is the buffer to |
6558 | 364 associate with the process. |
365 | |
366 The remaining arguments, @var{args}, are strings that specify command | |
367 line arguments for the program. | |
368 | |
369 In the example below, the first process is started and runs (rather, | |
370 sleeps) for 100 seconds. Meanwhile, the second process is started, and | |
371 given the name @samp{my-process<1>} for the sake of uniqueness. It | |
372 inserts the directory listing at the end of the buffer @samp{foo}, | |
373 before the first process finishes. Then it finishes, and a message to | |
374 that effect is inserted in the buffer. Much later, the first process | |
375 finishes, and another message is inserted in the buffer for it. | |
376 | |
377 @smallexample | |
378 @group | |
379 (start-process "my-process" "foo" "sleep" "100") | |
380 @result{} #<process my-process> | |
381 @end group | |
382 | |
383 @group | |
384 (start-process "my-process" "foo" "ls" "-l" "/user/lewis/bin") | |
385 @result{} #<process my-process<1>> | |
386 | |
387 ---------- Buffer: foo ---------- | |
388 total 2 | |
389 lrwxrwxrwx 1 lewis 14 Jul 22 10:12 gnuemacs --> /emacs | |
390 -rwxrwxrwx 1 lewis 19 Jul 30 21:02 lemon | |
391 | |
392 Process my-process<1> finished | |
393 | |
394 Process my-process finished | |
395 ---------- Buffer: foo ---------- | |
396 @end group | |
397 @end smallexample | |
398 @end defun | |
399 | |
400 @defun start-process-shell-command name buffer-or-name command &rest command-args | |
401 This function is like @code{start-process} except that it uses a shell | |
402 to execute the specified command. The argument @var{command} is a shell | |
403 command name, and @var{command-args} are the arguments for the shell | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
404 command. The variable @code{shell-file-name} specifies which shell to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
405 use. |
6558 | 406 @end defun |
407 | |
408 @defvar process-connection-type | |
409 @cindex pipes | |
410 @cindex @sc{pty}s | |
411 This variable controls the type of device used to communicate with | |
12098 | 412 asynchronous subprocesses. If it is non-@code{nil}, then @sc{pty}s are |
413 used, when available. Otherwise, pipes are used. | |
6558 | 414 |
415 @sc{pty}s are usually preferable for processes visible to the user, as | |
416 in Shell mode, because they allow job control (@kbd{C-c}, @kbd{C-z}, | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
417 etc.) to work between the process and its children, whereas pipes do |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
418 not. For subprocesses used for internal purposes by programs, it is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
419 often better to use a pipe, because they are more efficient. In |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
420 addition, the total number of @sc{pty}s is limited on many systems and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
421 it is good not to waste them. |
6558 | 422 |
423 The value @code{process-connection-type} is used when | |
424 @code{start-process} is called. So you can specify how to communicate | |
425 with one subprocess by binding the variable around the call to | |
426 @code{start-process}. | |
427 | |
428 @smallexample | |
429 @group | |
430 (let ((process-connection-type nil)) ; @r{Use a pipe.} | |
431 (start-process @dots{})) | |
432 @end group | |
433 @end smallexample | |
12067 | 434 |
435 To determine whether a given subprocess actually got a pipe or a | |
436 @sc{pty}, use the function @code{process-tty-name} (@pxref{Process | |
437 Information}). | |
6558 | 438 @end defvar |
439 | |
440 @node Deleting Processes | |
441 @section Deleting Processes | |
442 @cindex deleting processes | |
443 | |
444 @dfn{Deleting a process} disconnects Emacs immediately from the | |
445 subprocess, and removes it from the list of active processes. It sends | |
446 a signal to the subprocess to make the subprocess terminate, but this is | |
447 not guaranteed to happen immediately. The process object itself | |
15759
e74f36ff89e7
Explain how deletion of process doesn't affect process mark.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
448 continues to exist as long as other Lisp objects point to it. The |
e74f36ff89e7
Explain how deletion of process doesn't affect process mark.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
449 process mark continues to point to the same place as before (usually |
e74f36ff89e7
Explain how deletion of process doesn't affect process mark.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
450 into a buffer where output from the process was being inserted). |
6558 | 451 |
452 You can delete a process explicitly at any time. Processes are | |
453 deleted automatically after they terminate, but not necessarily right | |
454 away. If you delete a terminated process explicitly before it is | |
455 deleted automatically, no harm results. | |
456 | |
457 @defvar delete-exited-processes | |
458 This variable controls automatic deletion of processes that have | |
459 terminated (due to calling @code{exit} or to a signal). If it is | |
460 @code{nil}, then they continue to exist until the user runs | |
461 @code{list-processes}. Otherwise, they are deleted immediately after | |
462 they exit. | |
463 @end defvar | |
464 | |
465 @defun delete-process name | |
466 This function deletes the process associated with @var{name}, killing it | |
467 with a @code{SIGHUP} signal. The argument @var{name} may be a process, | |
468 the name of a process, a buffer, or the name of a buffer. | |
469 | |
470 @smallexample | |
471 @group | |
472 (delete-process "*shell*") | |
473 @result{} nil | |
474 @end group | |
475 @end smallexample | |
476 @end defun | |
477 | |
478 @defun process-kill-without-query process | |
479 This function declares that Emacs need not query the user if | |
480 @var{process} is still running when Emacs is exited. The process will | |
481 be deleted silently. The value is @code{t}. | |
482 | |
483 @smallexample | |
484 @group | |
485 (process-kill-without-query (get-process "shell")) | |
486 @result{} t | |
487 @end group | |
488 @end smallexample | |
489 @end defun | |
490 | |
491 @node Process Information | |
492 @section Process Information | |
493 | |
494 Several functions return information about processes. | |
495 @code{list-processes} is provided for interactive use. | |
496 | |
497 @deffn Command list-processes | |
498 This command displays a listing of all living processes. In addition, | |
499 it finally deletes any process whose status was @samp{Exited} or | |
500 @samp{Signaled}. It returns @code{nil}. | |
501 @end deffn | |
502 | |
503 @defun process-list | |
504 This function returns a list of all processes that have not been deleted. | |
505 | |
506 @smallexample | |
507 @group | |
508 (process-list) | |
509 @result{} (#<process display-time> #<process shell>) | |
510 @end group | |
511 @end smallexample | |
512 @end defun | |
513 | |
514 @defun get-process name | |
515 This function returns the process named @var{name}, or @code{nil} if | |
516 there is none. An error is signaled if @var{name} is not a string. | |
517 | |
518 @smallexample | |
519 @group | |
520 (get-process "shell") | |
521 @result{} #<process shell> | |
522 @end group | |
523 @end smallexample | |
524 @end defun | |
525 | |
526 @defun process-command process | |
527 This function returns the command that was executed to start | |
528 @var{process}. This is a list of strings, the first string being the | |
529 program executed and the rest of the strings being the arguments that | |
530 were given to the program. | |
531 | |
532 @smallexample | |
533 @group | |
534 (process-command (get-process "shell")) | |
535 @result{} ("/bin/csh" "-i") | |
536 @end group | |
537 @end smallexample | |
538 @end defun | |
539 | |
540 @defun process-id process | |
541 This function returns the @sc{pid} of @var{process}. This is an | |
9009 | 542 integer that distinguishes the process @var{process} from all other |
6558 | 543 processes running on the same computer at the current time. The |
544 @sc{pid} of a process is chosen by the operating system kernel when the | |
545 process is started and remains constant as long as the process exists. | |
546 @end defun | |
547 | |
548 @defun process-name process | |
549 This function returns the name of @var{process}. | |
550 @end defun | |
551 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
552 @tindex process-contact |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
553 @defun process-contact process |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
554 This function returns @code{t} for an ordinary child process, and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
555 @code{(@var{hostname} @var{service})} for a net connection |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
556 (@pxref{Network}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
557 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
558 |
6558 | 559 @defun process-status process-name |
560 This function returns the status of @var{process-name} as a symbol. | |
561 The argument @var{process-name} must be a process, a buffer, a | |
562 process name (string) or a buffer name (string). | |
563 | |
564 The possible values for an actual subprocess are: | |
565 | |
566 @table @code | |
567 @item run | |
568 for a process that is running. | |
569 @item stop | |
570 for a process that is stopped but continuable. | |
571 @item exit | |
572 for a process that has exited. | |
573 @item signal | |
574 for a process that has received a fatal signal. | |
575 @item open | |
576 for a network connection that is open. | |
577 @item closed | |
578 for a network connection that is closed. Once a connection | |
579 is closed, you cannot reopen it, though you might be able to open | |
580 a new connection to the same place. | |
581 @item nil | |
582 if @var{process-name} is not the name of an existing process. | |
583 @end table | |
584 | |
585 @smallexample | |
586 @group | |
587 (process-status "shell") | |
588 @result{} run | |
589 @end group | |
590 @group | |
591 (process-status (get-buffer "*shell*")) | |
592 @result{} run | |
593 @end group | |
594 @group | |
595 x | |
596 @result{} #<process xx<1>> | |
597 (process-status x) | |
598 @result{} exit | |
599 @end group | |
600 @end smallexample | |
601 | |
602 For a network connection, @code{process-status} returns one of the symbols | |
603 @code{open} or @code{closed}. The latter means that the other side | |
604 closed the connection, or Emacs did @code{delete-process}. | |
605 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
606 In Emacs version 18, the status of a network connection was @code{run} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
607 if open, and @code{exit} if closed. |
6558 | 608 @end defun |
609 | |
610 @defun process-exit-status process | |
611 This function returns the exit status of @var{process} or the signal | |
612 number that killed it. (Use the result of @code{process-status} to | |
613 determine which of those it is.) If @var{process} has not yet | |
614 terminated, the value is 0. | |
615 @end defun | |
616 | |
12067 | 617 @defun process-tty-name process |
618 This function returns the terminal name that @var{process} is using for | |
619 its communication with Emacs---or @code{nil} if it is using pipes | |
620 instead of a terminal (see @code{process-connection-type} in | |
621 @ref{Asynchronous Processes}). | |
622 @end defun | |
623 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
624 @tindex process-coding-system |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
625 @defun process-coding-system process |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
626 This function returns a cons cell describing the coding systems in use |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
627 for decoding output from @var{process} and for encoding input to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
628 @var{process} (@pxref{Coding Systems}). The value has this form: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
629 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
630 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
631 (@var{coding-system-for-decoding} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
632 . @var{coding-system-for-encoding}) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
633 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
634 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
635 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
636 @tindex set-process-coding-system |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
637 @defun set-process-coding-system process decoding-system encoding-system |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
638 This function specifies the coding systems to use for subsequent output |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
639 from and input to @var{process}. It will use @var{decoding-system} to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
640 decode subprocess output, and @var{encoding-system} to encode subprocess |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
641 input. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
642 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
643 |
6558 | 644 @node Input to Processes |
645 @section Sending Input to Processes | |
646 @cindex process input | |
647 | |
648 Asynchronous subprocesses receive input when it is sent to them by | |
649 Emacs, which is done with the functions in this section. You must | |
650 specify the process to send input to, and the input data to send. The | |
651 data appears on the ``standard input'' of the subprocess. | |
652 | |
653 Some operating systems have limited space for buffered input in a | |
654 @sc{pty}. On these systems, Emacs sends an @sc{eof} periodically amidst | |
655 the other characters, to force them through. For most programs, | |
656 these @sc{eof}s do no harm. | |
657 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
658 Subprocess input is normally encoded using a coding system before the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
659 subprocess receives it, much like text written into a file. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
660 @xref{Coding Systems}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
661 |
6558 | 662 @defun process-send-string process-name string |
663 This function sends @var{process-name} the contents of @var{string} as | |
664 standard input. The argument @var{process-name} must be a process or | |
665 the name of a process. If it is @code{nil}, the current buffer's | |
666 process is used. | |
667 | |
668 The function returns @code{nil}. | |
669 | |
670 @smallexample | |
671 @group | |
672 (process-send-string "shell<1>" "ls\n") | |
673 @result{} nil | |
674 @end group | |
675 | |
676 | |
677 @group | |
678 ---------- Buffer: *shell* ---------- | |
679 ... | |
680 introduction.texi syntax-tables.texi~ | |
681 introduction.texi~ text.texi | |
682 introduction.txt text.texi~ | |
683 ... | |
684 ---------- Buffer: *shell* ---------- | |
685 @end group | |
686 @end smallexample | |
687 @end defun | |
688 | |
689 @deffn Command process-send-region process-name start end | |
690 This function sends the text in the region defined by @var{start} and | |
691 @var{end} as standard input to @var{process-name}, which is a process or | |
692 a process name. (If it is @code{nil}, the current buffer's process is | |
693 used.) | |
694 | |
695 An error is signaled unless both @var{start} and @var{end} are | |
696 integers or markers that indicate positions in the current buffer. (It | |
697 is unimportant which number is larger.) | |
698 @end deffn | |
699 | |
700 @defun process-send-eof &optional process-name | |
701 This function makes @var{process-name} see an end-of-file in its | |
702 input. The @sc{eof} comes after any text already sent to it. | |
703 | |
704 If @var{process-name} is not supplied, or if it is @code{nil}, then | |
705 this function sends the @sc{eof} to the current buffer's process. An | |
706 error is signaled if the current buffer has no process. | |
707 | |
708 The function returns @var{process-name}. | |
709 | |
710 @smallexample | |
711 @group | |
712 (process-send-eof "shell") | |
713 @result{} "shell" | |
714 @end group | |
715 @end smallexample | |
716 @end defun | |
717 | |
718 @node Signals to Processes | |
719 @section Sending Signals to Processes | |
720 @cindex process signals | |
721 @cindex sending signals | |
722 @cindex signals | |
723 | |
724 @dfn{Sending a signal} to a subprocess is a way of interrupting its | |
725 activities. There are several different signals, each with its own | |
726 meaning. The set of signals and their names is defined by the operating | |
727 system. For example, the signal @code{SIGINT} means that the user has | |
728 typed @kbd{C-c}, or that some analogous thing has happened. | |
729 | |
730 Each signal has a standard effect on the subprocess. Most signals | |
731 kill the subprocess, but some stop or resume execution instead. Most | |
732 signals can optionally be handled by programs; if the program handles | |
733 the signal, then we can say nothing in general about its effects. | |
734 | |
735 You can send signals explicitly by calling the functions in this | |
736 section. Emacs also sends signals automatically at certain times: | |
737 killing a buffer sends a @code{SIGHUP} signal to all its associated | |
738 processes; killing Emacs sends a @code{SIGHUP} signal to all remaining | |
739 processes. (@code{SIGHUP} is a signal that usually indicates that the | |
740 user hung up the phone.) | |
741 | |
742 Each of the signal-sending functions takes two optional arguments: | |
743 @var{process-name} and @var{current-group}. | |
744 | |
745 The argument @var{process-name} must be either a process, the name of | |
746 one, or @code{nil}. If it is @code{nil}, the process defaults to the | |
747 process associated with the current buffer. An error is signaled if | |
748 @var{process-name} does not identify a process. | |
749 | |
750 The argument @var{current-group} is a flag that makes a difference | |
751 when you are running a job-control shell as an Emacs subprocess. If it | |
752 is non-@code{nil}, then the signal is sent to the current process-group | |
9009 | 753 of the terminal that Emacs uses to communicate with the subprocess. If |
6558 | 754 the process is a job-control shell, this means the shell's current |
755 subjob. If it is @code{nil}, the signal is sent to the process group of | |
756 the immediate subprocess of Emacs. If the subprocess is a job-control | |
757 shell, this is the shell itself. | |
758 | |
759 The flag @var{current-group} has no effect when a pipe is used to | |
760 communicate with the subprocess, because the operating system does not | |
761 support the distinction in the case of pipes. For the same reason, | |
762 job-control shells won't work when a pipe is used. See | |
763 @code{process-connection-type} in @ref{Asynchronous Processes}. | |
764 | |
765 @defun interrupt-process &optional process-name current-group | |
766 This function interrupts the process @var{process-name} by sending the | |
767 signal @code{SIGINT}. Outside of Emacs, typing the ``interrupt | |
768 character'' (normally @kbd{C-c} on some systems, and @code{DEL} on | |
769 others) sends this signal. When the argument @var{current-group} is | |
770 non-@code{nil}, you can think of this function as ``typing @kbd{C-c}'' | |
771 on the terminal by which Emacs talks to the subprocess. | |
772 @end defun | |
773 | |
774 @defun kill-process &optional process-name current-group | |
775 This function kills the process @var{process-name} by sending the | |
776 signal @code{SIGKILL}. This signal kills the subprocess immediately, | |
777 and cannot be handled by the subprocess. | |
778 @end defun | |
779 | |
780 @defun quit-process &optional process-name current-group | |
781 This function sends the signal @code{SIGQUIT} to the process | |
782 @var{process-name}. This signal is the one sent by the ``quit | |
783 character'' (usually @kbd{C-b} or @kbd{C-\}) when you are not inside | |
784 Emacs. | |
785 @end defun | |
786 | |
787 @defun stop-process &optional process-name current-group | |
788 This function stops the process @var{process-name} by sending the | |
789 signal @code{SIGTSTP}. Use @code{continue-process} to resume its | |
790 execution. | |
791 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
792 On systems with job control, outside of Emacs)\, the ``stop character'' |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
793 (usually @kbd{C-z}) normally sends this signal. When |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
794 @var{current-group} is non-@code{nil}, you can think of this function as |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
795 ``typing @kbd{C-z}'' on the terminal Emacs uses to communicate with the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
796 subprocess. |
6558 | 797 @end defun |
798 | |
799 @defun continue-process &optional process-name current-group | |
800 This function resumes execution of the process @var{process} by sending | |
801 it the signal @code{SIGCONT}. This presumes that @var{process-name} was | |
802 stopped previously. | |
803 @end defun | |
804 | |
805 @c Emacs 19 feature | |
806 @defun signal-process pid signal | |
807 This function sends a signal to process @var{pid}, which need not be | |
808 a child of Emacs. The argument @var{signal} specifies which signal | |
809 to send; it should be an integer. | |
810 @end defun | |
811 | |
812 @node Output from Processes | |
813 @section Receiving Output from Processes | |
814 @cindex process output | |
815 @cindex output from processes | |
816 | |
817 There are two ways to receive the output that a subprocess writes to | |
818 its standard output stream. The output can be inserted in a buffer, | |
819 which is called the associated buffer of the process, or a function | |
9009 | 820 called the @dfn{filter function} can be called to act on the output. If |
821 the process has no buffer and no filter function, its output is | |
822 discarded. | |
6558 | 823 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
824 Subprocess output is normally decoded using a coding system before the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
825 buffer or filter function receives it, much like text read from a file. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
826 @xref{Coding Systems}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
827 |
6558 | 828 @menu |
829 * Process Buffers:: If no filter, output is put in a buffer. | |
830 * Filter Functions:: Filter functions accept output from the process. | |
831 * Accepting Output:: Explicitly permitting subprocess output. | |
832 Waiting for subprocess output. | |
833 @end menu | |
834 | |
835 @node Process Buffers | |
836 @subsection Process Buffers | |
837 | |
838 A process can (and usually does) have an @dfn{associated buffer}, | |
839 which is an ordinary Emacs buffer that is used for two purposes: storing | |
840 the output from the process, and deciding when to kill the process. You | |
841 can also use the buffer to identify a process to operate on, since in | |
842 normal practice only one process is associated with any given buffer. | |
843 Many applications of processes also use the buffer for editing input to | |
844 be sent to the process, but this is not built into Emacs Lisp. | |
845 | |
846 Unless the process has a filter function (@pxref{Filter Functions}), | |
847 its output is inserted in the associated buffer. The position to insert | |
9009 | 848 the output is determined by the @code{process-mark}, which is then |
849 updated to point to the end of the text just inserted. Usually, but not | |
850 always, the @code{process-mark} is at the end of the buffer. | |
6558 | 851 |
852 @defun process-buffer process | |
853 This function returns the associated buffer of the process | |
854 @var{process}. | |
855 | |
856 @smallexample | |
857 @group | |
858 (process-buffer (get-process "shell")) | |
859 @result{} #<buffer *shell*> | |
860 @end group | |
861 @end smallexample | |
862 @end defun | |
863 | |
864 @defun process-mark process | |
865 This function returns the process marker for @var{process}, which is the | |
866 marker that says where to insert output from the process. | |
867 | |
868 If @var{process} does not have a buffer, @code{process-mark} returns a | |
869 marker that points nowhere. | |
870 | |
871 Insertion of process output in a buffer uses this marker to decide where | |
872 to insert, and updates it to point after the inserted text. That is why | |
873 successive batches of output are inserted consecutively. | |
874 | |
875 Filter functions normally should use this marker in the same fashion | |
876 as is done by direct insertion of output in the buffer. A good | |
877 example of a filter function that uses @code{process-mark} is found at | |
878 the end of the following section. | |
879 | |
880 When the user is expected to enter input in the process buffer for | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
881 transmission to the process, the process marker separates the new input |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
882 from previous output. |
6558 | 883 @end defun |
884 | |
885 @defun set-process-buffer process buffer | |
886 This function sets the buffer associated with @var{process} to | |
887 @var{buffer}. If @var{buffer} is @code{nil}, the process becomes | |
888 associated with no buffer. | |
889 @end defun | |
890 | |
891 @defun get-buffer-process buffer-or-name | |
892 This function returns the process associated with @var{buffer-or-name}. | |
893 If there are several processes associated with it, then one is chosen. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
894 (Currently, the one chosen is the one most recently created.) It is |
6558 | 895 usually a bad idea to have more than one process associated with the |
896 same buffer. | |
897 | |
898 @smallexample | |
899 @group | |
900 (get-buffer-process "*shell*") | |
901 @result{} #<process shell> | |
902 @end group | |
903 @end smallexample | |
904 | |
905 Killing the process's buffer deletes the process, which kills the | |
906 subprocess with a @code{SIGHUP} signal (@pxref{Signals to Processes}). | |
907 @end defun | |
908 | |
909 @node Filter Functions | |
910 @subsection Process Filter Functions | |
911 @cindex filter function | |
912 @cindex process filter | |
913 | |
914 A process @dfn{filter function} is a function that receives the | |
915 standard output from the associated process. If a process has a filter, | |
9009 | 916 then @emph{all} output from that process is passed to the filter. The |
917 process buffer is used directly for output from the process only when | |
918 there is no filter. | |
6558 | 919 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
920 A filter function must accept two arguments: the associated process |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
921 and a string, which is output just received from it. The function is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
922 then free to do whatever it chooses with the output. |
6558 | 923 |
924 A filter function runs only while Emacs is waiting (e.g., for terminal | |
925 input, or for time to elapse, or for process output). This avoids the | |
926 timing errors that could result from running filters at random places in | |
927 the middle of other Lisp programs. You may explicitly cause Emacs to | |
9009 | 928 wait, so that filter functions will run, by calling @code{sit-for} or |
929 @code{sleep-for} (@pxref{Waiting}), or @code{accept-process-output} | |
930 (@pxref{Accepting Output}). Emacs is also waiting when the command loop | |
931 is reading input. | |
6558 | 932 |
933 Quitting is normally inhibited within a filter function---otherwise, | |
934 the effect of typing @kbd{C-g} at command level or to quit a user | |
935 command would be unpredictable. If you want to permit quitting inside a | |
936 filter function, bind @code{inhibit-quit} to @code{nil}. | |
937 @xref{Quitting}. | |
938 | |
12067 | 939 If an error happens during execution of a filter function, it is |
940 caught automatically, so that it doesn't stop the execution of whatever | |
12125
995be67f3fd1
updates for version 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
941 program was running when the filter function was started. However, if |
12067 | 942 @code{debug-on-error} is non-@code{nil}, the error-catching is turned |
943 off. This makes it possible to use the Lisp debugger to debug the | |
944 filter function. @xref{Debugger}. | |
945 | |
6558 | 946 Many filter functions sometimes or always insert the text in the |
947 process's buffer, mimicking the actions of Emacs when there is no | |
948 filter. Such filter functions need to use @code{set-buffer} in order to | |
949 be sure to insert in that buffer. To avoid setting the current buffer | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
950 semipermanently, these filter functions must save and restore the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
951 current buffer. They should also update the process marker, and in some |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
952 cases update the value of point. Here is how to do these things: |
6558 | 953 |
954 @smallexample | |
955 @group | |
956 (defun ordinary-insertion-filter (proc string) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
957 (with-current-buffer (process-buffer proc) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
958 (let ((moving (= (point) (process-mark proc)))) |
6558 | 959 @end group |
960 @group | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
961 (save-excursion |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
962 ;; @r{Insert the text, advancing the process marker.} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
963 (goto-char (process-mark proc)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
964 (insert string) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
965 (set-marker (process-mark proc) (point))) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
966 (if moving (goto-char (process-mark proc)))))) |
6558 | 967 @end group |
968 @end smallexample | |
969 | |
970 @noindent | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
971 The reason to use @code{with-current-buffer}, rather than using |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
972 @code{save-excursion} to save and restore the current buffer, is so as |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
973 to preserve the change in point made by the second call to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
974 @code{goto-char}. |
6558 | 975 |
976 To make the filter force the process buffer to be visible whenever new | |
977 text arrives, insert the following line just before the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
978 @code{with-current-buffer} construct: |
6558 | 979 |
980 @smallexample | |
981 (display-buffer (process-buffer proc)) | |
982 @end smallexample | |
983 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
984 To force point to the end of the new output, no matter where it was |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
985 previously, eliminate the variable @code{moving} and call |
6558 | 986 @code{goto-char} unconditionally. |
987 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
988 In earlier Emacs versions, every filter function that did regular |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
989 expression searching or matching had to explicitly save and restore the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
990 match data. Now Emacs does this automatically for filter functions; |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
991 they never need to do it explicitly. @xref{Match Data}. |
6558 | 992 |
993 A filter function that writes the output into the buffer of the | |
12098 | 994 process should check whether the buffer is still alive. If it tries to |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
995 insert into a dead buffer, it will get an error. The expression |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
996 @code{(buffer-name (process-buffer @var{process}))} returns @code{nil} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
997 if the buffer is dead. |
6558 | 998 |
999 The output to the function may come in chunks of any size. A program | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1000 that produces the same output twice in a row may send it as one batch of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1001 200 characters one time, and five batches of 40 characters the next. If |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1002 the filter looks for certain text strings in the subprocess output, make |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1003 sure to handle the case where one of these strings is split across two |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1004 or more batches of output. |
6558 | 1005 |
1006 @defun set-process-filter process filter | |
1007 This function gives @var{process} the filter function @var{filter}. If | |
1008 @var{filter} is @code{nil}, it gives the process no filter. | |
1009 @end defun | |
1010 | |
1011 @defun process-filter process | |
1012 This function returns the filter function of @var{process}, or @code{nil} | |
1013 if it has none. | |
1014 @end defun | |
1015 | |
1016 Here is an example of use of a filter function: | |
1017 | |
1018 @smallexample | |
1019 @group | |
1020 (defun keep-output (process output) | |
1021 (setq kept (cons output kept))) | |
1022 @result{} keep-output | |
1023 @end group | |
1024 @group | |
1025 (setq kept nil) | |
1026 @result{} nil | |
1027 @end group | |
1028 @group | |
1029 (set-process-filter (get-process "shell") 'keep-output) | |
1030 @result{} keep-output | |
1031 @end group | |
1032 @group | |
1033 (process-send-string "shell" "ls ~/other\n") | |
1034 @result{} nil | |
1035 kept | |
1036 @result{} ("lewis@@slug[8] % " | |
1037 @end group | |
1038 @group | |
1039 "FINAL-W87-SHORT.MSS backup.otl kolstad.mss~ | |
1040 address.txt backup.psf kolstad.psf | |
1041 backup.bib~ david.mss resume-Dec-86.mss~ | |
1042 backup.err david.psf resume-Dec.psf | |
1043 backup.mss dland syllabus.mss | |
1044 " | |
1045 "#backups.mss# backup.mss~ kolstad.mss | |
1046 ") | |
1047 @end group | |
1048 @end smallexample | |
1049 | |
1050 @ignore @c The code in this example doesn't show the right way to do things. | |
1051 Here is another, more realistic example, which demonstrates how to use | |
1052 the process mark to do insertion in the same fashion as is done when | |
1053 there is no filter function: | |
1054 | |
1055 @smallexample | |
1056 @group | |
1057 ;; @r{Insert input in the buffer specified by @code{my-shell-buffer}} | |
1058 ;; @r{and make sure that buffer is shown in some window.} | |
1059 (defun my-process-filter (proc str) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1060 (let ((cur (selected-window)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1061 (pop-up-windows t)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1062 (pop-to-buffer my-shell-buffer) |
6558 | 1063 @end group |
1064 @group | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1065 (goto-char (point-max)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1066 (insert str) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1067 (set-marker (process-mark proc) (point-max)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1068 (select-window cur))) |
6558 | 1069 @end group |
1070 @end smallexample | |
1071 @end ignore | |
1072 | |
1073 @node Accepting Output | |
1074 @subsection Accepting Output from Processes | |
1075 | |
1076 Output from asynchronous subprocesses normally arrives only while | |
1077 Emacs is waiting for some sort of external event, such as elapsed time | |
1078 or terminal input. Occasionally it is useful in a Lisp program to | |
1079 explicitly permit output to arrive at a specific point, or even to wait | |
1080 until output arrives from a process. | |
1081 | |
1082 @defun accept-process-output &optional process seconds millisec | |
1083 This function allows Emacs to read pending output from processes. The | |
1084 output is inserted in the associated buffers or given to their filter | |
1085 functions. If @var{process} is non-@code{nil} then this function does | |
1086 not return until some output has been received from @var{process}. | |
1087 | |
1088 @c Emacs 19 feature | |
1089 The arguments @var{seconds} and @var{millisec} let you specify timeout | |
1090 periods. The former specifies a period measured in seconds and the | |
1091 latter specifies one measured in milliseconds. The two time periods | |
1092 thus specified are added together, and @code{accept-process-output} | |
1093 returns after that much time whether or not there has been any | |
1094 subprocess output. | |
1095 | |
12098 | 1096 The argument @var{seconds} need not be an integer. If it is a floating |
1097 point number, this function waits for a fractional number of seconds. | |
1098 Some systems support only a whole number of seconds; on these systems, | |
1099 @var{seconds} is rounded down. If the system doesn't support waiting | |
1100 fractions of a second, you get an error if you specify nonzero | |
1101 @var{millisec}. | |
1102 | |
6558 | 1103 Not all operating systems support waiting periods other than multiples |
1104 of a second; on those that do not, you get an error if you specify | |
1105 nonzero @var{millisec}. | |
1106 | |
1107 The function @code{accept-process-output} returns non-@code{nil} if it | |
1108 did get some output, or @code{nil} if the timeout expired before output | |
1109 arrived. | |
1110 @end defun | |
1111 | |
1112 @node Sentinels | |
1113 @section Sentinels: Detecting Process Status Changes | |
1114 @cindex process sentinel | |
1115 @cindex sentinel | |
1116 | |
1117 A @dfn{process sentinel} is a function that is called whenever the | |
1118 associated process changes status for any reason, including signals | |
1119 (whether sent by Emacs or caused by the process's own actions) that | |
1120 terminate, stop, or continue the process. The process sentinel is also | |
1121 called if the process exits. The sentinel receives two arguments: the | |
1122 process for which the event occurred, and a string describing the type | |
1123 of event. | |
1124 | |
1125 The string describing the event looks like one of the following: | |
1126 | |
1127 @itemize @bullet | |
1128 @item | |
1129 @code{"finished\n"}. | |
1130 | |
1131 @item | |
1132 @code{"exited abnormally with code @var{exitcode}\n"}. | |
1133 | |
1134 @item | |
1135 @code{"@var{name-of-signal}\n"}. | |
1136 | |
1137 @item | |
1138 @code{"@var{name-of-signal} (core dumped)\n"}. | |
1139 @end itemize | |
1140 | |
1141 A sentinel runs only while Emacs is waiting (e.g., for terminal input, | |
1142 or for time to elapse, or for process output). This avoids the timing | |
1143 errors that could result from running them at random places in the | |
1144 middle of other Lisp programs. A program can wait, so that sentinels | |
9009 | 1145 will run, by calling @code{sit-for} or @code{sleep-for} |
1146 (@pxref{Waiting}), or @code{accept-process-output} (@pxref{Accepting | |
1147 Output}). Emacs is also waiting when the command loop is reading input. | |
6558 | 1148 |
1149 Quitting is normally inhibited within a sentinel---otherwise, the | |
1150 effect of typing @kbd{C-g} at command level or to quit a user command | |
1151 would be unpredictable. If you want to permit quitting inside a | |
1152 sentinel, bind @code{inhibit-quit} to @code{nil}. @xref{Quitting}. | |
1153 | |
1154 A sentinel that writes the output into the buffer of the process | |
12098 | 1155 should check whether the buffer is still alive. If it tries to insert |
6558 | 1156 into a dead buffer, it will get an error. If the buffer is dead, |
1157 @code{(buffer-name (process-buffer @var{process}))} returns @code{nil}. | |
1158 | |
12067 | 1159 If an error happens during execution of a sentinel, it is caught |
1160 automatically, so that it doesn't stop the execution of whatever | |
1161 programs was running when the sentinel was started. However, if | |
1162 @code{debug-on-error} is non-@code{nil}, the error-catching is turned | |
1163 off. This makes it possible to use the Lisp debugger to debug the | |
1164 sentinel. @xref{Debugger}. | |
1165 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1166 In earlier Emacs versions, every sentinel that did regular expression |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1167 searching or matching had to explicitly save and restore the match data. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1168 Now Emacs does this automatically for sentinels; they never need to do |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1169 it explicitly. @xref{Match Data}. |
12098 | 1170 |
6558 | 1171 @defun set-process-sentinel process sentinel |
1172 This function associates @var{sentinel} with @var{process}. If | |
1173 @var{sentinel} is @code{nil}, then the process will have no sentinel. | |
1174 The default behavior when there is no sentinel is to insert a message in | |
1175 the process's buffer when the process status changes. | |
1176 | |
1177 @smallexample | |
1178 @group | |
1179 (defun msg-me (process event) | |
1180 (princ | |
1181 (format "Process: %s had the event `%s'" process event))) | |
1182 (set-process-sentinel (get-process "shell") 'msg-me) | |
1183 @result{} msg-me | |
1184 @end group | |
1185 @group | |
1186 (kill-process (get-process "shell")) | |
1187 @print{} Process: #<process shell> had the event `killed' | |
1188 @result{} #<process shell> | |
1189 @end group | |
1190 @end smallexample | |
1191 @end defun | |
1192 | |
1193 @defun process-sentinel process | |
1194 This function returns the sentinel of @var{process}, or @code{nil} if it | |
1195 has none. | |
1196 @end defun | |
1197 | |
1198 @defun waiting-for-user-input-p | |
1199 While a sentinel or filter function is running, this function returns | |
1200 non-@code{nil} if Emacs was waiting for keyboard input from the user at | |
1201 the time the sentinel or filter function was called, @code{nil} if it | |
1202 was not. | |
1203 @end defun | |
1204 | |
1205 @node Transaction Queues | |
1206 @section Transaction Queues | |
1207 @cindex transaction queue | |
1208 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1209 You can use a @dfn{transaction queue} to communicate with a subprocess |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1210 using transactions. First use @code{tq-create} to create a transaction |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1211 queue communicating with a specified process. Then you can call |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1212 @code{tq-enqueue} to send a transaction. |
6558 | 1213 |
1214 @defun tq-create process | |
1215 This function creates and returns a transaction queue communicating with | |
1216 @var{process}. The argument @var{process} should be a subprocess | |
1217 capable of sending and receiving streams of bytes. It may be a child | |
9009 | 1218 process, or it may be a TCP connection to a server, possibly on another |
6558 | 1219 machine. |
1220 @end defun | |
1221 | |
1222 @defun tq-enqueue queue question regexp closure fn | |
1223 This function sends a transaction to queue @var{queue}. Specifying the | |
1224 queue has the effect of specifying the subprocess to talk to. | |
1225 | |
9009 | 1226 The argument @var{question} is the outgoing message that starts the |
6558 | 1227 transaction. The argument @var{fn} is the function to call when the |
1228 corresponding answer comes back; it is called with two arguments: | |
1229 @var{closure}, and the answer received. | |
1230 | |
1231 The argument @var{regexp} is a regular expression that should match the | |
1232 entire answer, but nothing less; that's how @code{tq-enqueue} determines | |
1233 where the answer ends. | |
1234 | |
1235 The return value of @code{tq-enqueue} itself is not meaningful. | |
1236 @end defun | |
1237 | |
1238 @defun tq-close queue | |
1239 Shut down transaction queue @var{queue}, waiting for all pending transactions | |
1240 to complete, and then terminate the connection or child process. | |
1241 @end defun | |
1242 | |
1243 Transaction queues are implemented by means of a filter function. | |
1244 @xref{Filter Functions}. | |
1245 | |
12098 | 1246 @node Network |
1247 @section Network Connections | |
1248 @cindex network connection | |
6558 | 1249 @cindex TCP |
1250 | |
12098 | 1251 Emacs Lisp programs can open TCP network connections to other processes on |
1252 the same machine or other machines. A network connection is handled by Lisp | |
6558 | 1253 much like a subprocess, and is represented by a process object. |
1254 However, the process you are communicating with is not a child of the | |
1255 Emacs process, so you can't kill it or send it signals. All you can do | |
1256 is send and receive data. @code{delete-process} closes the connection, | |
1257 but does not kill the process at the other end; that process must decide | |
1258 what to do about closure of the connection. | |
1259 | |
1260 You can distinguish process objects representing network connections | |
1261 from those representing subprocesses with the @code{process-status} | |
12098 | 1262 function. It always returns either @code{open} or @code{closed} for a |
1263 network connection, and it never returns either of those values for a | |
1264 real subprocess. @xref{Process Information}. | |
6558 | 1265 |
1266 @defun open-network-stream name buffer-or-name host service | |
1267 This function opens a TCP connection for a service to a host. It | |
1268 returns a process object to represent the connection. | |
1269 | |
1270 The @var{name} argument specifies the name for the process object. It | |
1271 is modified as necessary to make it unique. | |
1272 | |
1273 The @var{buffer-or-name} argument is the buffer to associate with the | |
1274 connection. Output from the connection is inserted in the buffer, | |
1275 unless you specify a filter function to handle the output. If | |
1276 @var{buffer-or-name} is @code{nil}, it means that the connection is not | |
1277 associated with any buffer. | |
1278 | |
1279 The arguments @var{host} and @var{service} specify where to connect to; | |
1280 @var{host} is the host name (a string), and @var{service} is the name of | |
1281 a defined network service (a string) or a port number (an integer). | |
1282 @end defun |