Mercurial > emacs
annotate lispref/processes.texi @ 56724:2c932ff651d2
(skip_chars): Fix for unibyte case.
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Fri, 20 Aug 2004 08:46:50 +0000 |
parents | 900340a218c9 |
children | dd36fc88814a d8411455de48 |
rev | line source |
---|---|
6558 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
27189 | 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46340
diff
changeset
|
4 @c Free Software Foundation, Inc. |
6558 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/processes | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
7 @node Processes, Display, Abbrevs, Top |
6558 | 8 @chapter Processes |
9 @cindex child process | |
10 @cindex parent process | |
11 @cindex subprocess | |
12 @cindex process | |
13 | |
14 In the terminology of operating systems, a @dfn{process} is a space in | |
15 which a program can execute. Emacs runs in a process. Emacs Lisp | |
16 programs can invoke other programs in processes of their own. These are | |
17 called @dfn{subprocesses} or @dfn{child processes} of the Emacs process, | |
18 which is their @dfn{parent process}. | |
19 | |
20 A subprocess of Emacs may be @dfn{synchronous} or @dfn{asynchronous}, | |
21 depending on how it is created. When you create a synchronous | |
22 subprocess, the Lisp program waits for the subprocess to terminate | |
23 before continuing execution. When you create an asynchronous | |
24 subprocess, it can run in parallel with the Lisp program. This kind of | |
25 subprocess is represented within Emacs by a Lisp object which is also | |
26 called a ``process''. Lisp programs can use this object to communicate | |
27 with the subprocess or to control it. For example, you can send | |
28 signals, obtain status information, receive output from the process, or | |
29 send input to it. | |
30 | |
31 @defun processp object | |
32 This function returns @code{t} if @var{object} is a process, | |
33 @code{nil} otherwise. | |
34 @end defun | |
35 | |
36 @menu | |
37 * Subprocess Creation:: Functions that start subprocesses. | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
38 * Shell Arguments:: Quoting an argument to pass it to a shell. |
6558 | 39 * Synchronous Processes:: Details of using synchronous subprocesses. |
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. | |
46340
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
48 * Query Before Exit:: Whether to query if exiting will kill a process. |
6558 | 49 * Transaction Queues:: Transaction-based communication with subprocesses. |
12098 | 50 * Network:: Opening network connections. |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
51 * Network Servers:: Network servers let Emacs accept net connections. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
52 * Datagrams:: |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
53 * Low-Level Network:: Lower-level but more general function |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
54 to create connections and servers. |
6558 | 55 @end menu |
56 | |
57 @node Subprocess Creation | |
58 @section Functions that Create Subprocesses | |
59 | |
60 There are three functions that create a new subprocess in which to run | |
61 a program. One of them, @code{start-process}, creates an asynchronous | |
62 process and returns a process object (@pxref{Asynchronous Processes}). | |
63 The other two, @code{call-process} and @code{call-process-region}, | |
64 create a synchronous process and do not return a process object | |
65 (@pxref{Synchronous Processes}). | |
66 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
67 Synchronous and asynchronous processes are explained in the following |
6558 | 68 sections. Since the three functions are all called in a similar |
69 fashion, their common arguments are described here. | |
70 | |
71 @cindex execute program | |
72 @cindex @code{PATH} environment variable | |
73 @cindex @code{HOME} environment variable | |
74 In all cases, the function's @var{program} argument specifies the | |
75 program to be run. An error is signaled if the file is not found or | |
76 cannot be executed. If the file name is relative, the variable | |
77 @code{exec-path} contains a list of directories to search. Emacs | |
78 initializes @code{exec-path} when it starts up, based on the value of | |
79 the environment variable @code{PATH}. The standard file name | |
80 constructs, @samp{~}, @samp{.}, and @samp{..}, are interpreted as usual | |
81 in @code{exec-path}, but environment variable substitutions | |
82 (@samp{$HOME}, etc.) are not recognized; use | |
83 @code{substitute-in-file-name} to perform them (@pxref{File Name | |
84 Expansion}). | |
85 | |
51922
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
86 Executing a program can also try adding suffixes to the specified |
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
87 name: |
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
88 |
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
89 @defvar exec-suffixes |
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
90 This variable is a list of suffixes (strings) to try adding to the |
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
91 specified program file name. The list should include @code{""} if you |
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
92 want the name to be tried exactly as specified. The default value is |
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
93 system-dependent. |
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
94 @end defvar |
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
95 |
6558 | 96 Each of the subprocess-creating functions has a @var{buffer-or-name} |
97 argument which specifies where the standard output from the program will | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
98 go. It should be a buffer or a buffer name; if it is a buffer name, |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
99 that will create the buffer if it does not already exist. It can also |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
100 be @code{nil}, which says to discard the output unless a filter function |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
101 handles it. (@xref{Filter Functions}, and @ref{Read and Print}.) |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
102 Normally, you should avoid having multiple processes send output to the |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
103 same buffer because their output would be intermixed randomly. |
6558 | 104 |
105 @cindex program arguments | |
106 All three of the subprocess-creating functions have a @code{&rest} | |
107 argument, @var{args}. The @var{args} must all be strings, and they are | |
108 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
|
109 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
|
110 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
|
111 program. |
6558 | 112 |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7411
diff
changeset
|
113 @strong{Please note:} The argument @var{program} contains only the |
6558 | 114 name of the program; it may not contain any command-line arguments. You |
115 must use @var{args} to provide those. | |
116 | |
117 The subprocess gets its current directory from the value of | |
118 @code{default-directory} (@pxref{File Name Expansion}). | |
119 | |
120 @cindex environment variables, subprocesses | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
121 The subprocess inherits its environment from Emacs, but you can |
6558 | 122 specify overrides for it with @code{process-environment}. @xref{System |
123 Environment}. | |
124 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46340
diff
changeset
|
125 @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
|
126 @pindex movemail |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
127 The value of this variable is a string, the name of a directory that |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
128 contains programs that come with GNU Emacs, programs 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
|
129 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
|
130 Rmail uses it to fetch new mail from an inbox. |
6558 | 131 @end defvar |
132 | |
133 @defopt exec-path | |
134 The value of this variable is a list of directories to search for | |
135 programs to run in subprocesses. Each element is either the name of a | |
136 directory (i.e., a string), or @code{nil}, which stands for the default | |
137 directory (which is the value of @code{default-directory}). | |
138 @cindex program directories | |
139 | |
140 The value of @code{exec-path} is used by @code{call-process} and | |
141 @code{start-process} when the @var{program} argument is not an absolute | |
142 file name. | |
143 @end defopt | |
144 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
145 @node Shell Arguments |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
146 @section Shell Arguments |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
147 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
148 Lisp programs sometimes need to run a shell and give it a command |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
149 that contains file names that were specified by the user. These |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
150 programs ought to be able to support any valid file name. But the shell |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
151 gives special treatment to certain characters, and if these characters |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
152 occur in the file name, they will confuse the shell. To handle these |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
153 characters, use the function @code{shell-quote-argument}: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
154 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
155 @defun shell-quote-argument argument |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
156 This function returns a string which represents, in shell syntax, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
157 an argument whose actual contents are @var{argument}. It should |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
158 work reliably to concatenate the return value into a shell command |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
159 and then pass it to a shell for execution. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
160 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
161 Precisely what this function does depends on your operating system. The |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
162 function is designed to work with the syntax of your system's standard |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
163 shell; if you use an unusual shell, you will need to redefine this |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
164 function. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
165 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
166 @example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
167 ;; @r{This example shows the behavior on GNU and Unix systems.} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
168 (shell-quote-argument "foo > bar") |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
169 @result{} "foo\\ \\>\\ bar" |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
170 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
171 ;; @r{This example shows the behavior on MS-DOS and MS-Windows systems.} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
172 (shell-quote-argument "foo > bar") |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
173 @result{} "\"foo > bar\"" |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
174 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
175 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
176 Here's an example of using @code{shell-quote-argument} to construct |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
177 a shell command: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
178 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
179 @example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
180 (concat "diff -c " |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
181 (shell-quote-argument oldfile) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
182 " " |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
183 (shell-quote-argument newfile)) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
184 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
185 @end defun |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
186 |
6558 | 187 @node Synchronous Processes |
188 @section Creating a Synchronous Process | |
189 @cindex synchronous subprocess | |
190 | |
191 After a @dfn{synchronous process} is created, Emacs waits for the | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
192 process to terminate before continuing. Starting Dired on GNU or |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
193 Unix@footnote{On other systems, Emacs uses a Lisp emulation of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
194 @code{ls}; see @ref{Contents of Directories}.} is an example of this: it |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
195 runs @code{ls} in a synchronous process, then modifies the output |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
196 slightly. Because the process is synchronous, the entire directory |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
197 listing arrives in the buffer before Emacs tries to do anything with it. |
6558 | 198 |
199 While Emacs waits for the synchronous subprocess to terminate, the | |
200 user can quit by typing @kbd{C-g}. The first @kbd{C-g} tries to kill | |
201 the subprocess with a @code{SIGINT} signal; but it waits until the | |
202 subprocess actually terminates before quitting. If during that time the | |
203 user types another @kbd{C-g}, that kills the subprocess instantly with | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
204 @code{SIGKILL} and quits immediately (except on MS-DOS, where killing |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
205 other processes doesn't work). @xref{Quitting}. |
6558 | 206 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
207 The synchronous subprocess functions return an indication of how the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
208 process terminated. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
209 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
210 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
|
211 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
|
212 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
|
213 system, much like text written into a file. @xref{Coding Systems}. |
6558 | 214 |
12067 | 215 @defun call-process program &optional infile destination display &rest args |
6558 | 216 This function calls @var{program} in a separate process and waits for |
217 it to finish. | |
218 | |
219 The standard input for the process comes from file @var{infile} if | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
220 @var{infile} is not @code{nil}, and from the null device otherwise. |
12067 | 221 The argument @var{destination} says where to put the process output. |
222 Here are the possibilities: | |
223 | |
224 @table @asis | |
225 @item a buffer | |
226 Insert the output in that buffer, before point. This includes both the | |
227 standard output stream and the standard error stream of the process. | |
228 | |
229 @item a string | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
230 Insert the output in a buffer with that name, before point. |
12067 | 231 |
232 @item @code{t} | |
233 Insert the output in the current buffer, before point. | |
234 | |
235 @item @code{nil} | |
236 Discard the output. | |
6558 | 237 |
12067 | 238 @item 0 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
239 Discard the output, and return @code{nil} immediately without waiting |
12067 | 240 for the subprocess to finish. |
241 | |
242 In this case, the process is not truly synchronous, since it can run in | |
243 parallel with Emacs; but you can think of it as synchronous in that | |
244 Emacs is essentially finished with the subprocess as soon as this | |
245 function returns. | |
246 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
247 MS-DOS doesn't support asynchronous subprocesses, so this option doesn't |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
248 work there. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
249 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
250 @item @code{(@var{real-destination} @var{error-destination})} |
12067 | 251 Keep the standard output stream separate from the standard error stream; |
252 deal with the ordinary output as specified by @var{real-destination}, | |
253 and dispose of the error output according to @var{error-destination}. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
254 If @var{error-destination} is @code{nil}, that means to discard the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
255 error output, @code{t} means mix it with the ordinary output, and a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
256 string specifies a file name to redirect error output into. |
12067 | 257 |
258 You can't directly specify a buffer to put the error output in; that is | |
259 too difficult to implement. But you can achieve this result by sending | |
260 the error output to a temporary file and then inserting the file into a | |
261 buffer. | |
262 @end table | |
6558 | 263 |
264 If @var{display} is non-@code{nil}, then @code{call-process} redisplays | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
265 the buffer as output is inserted. (However, if the coding system chosen |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
266 for decoding output is @code{undecided}, meaning deduce the encoding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
267 from the actual data, then redisplay sometimes cannot continue once |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
268 non-@acronym{ASCII} characters are encountered. There are fundamental |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
269 reasons why it is hard to fix this; see @ref{Output from Processes}.) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
270 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
271 Otherwise the function @code{call-process} does no redisplay, and the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
272 results become visible on the screen only when Emacs redisplays that |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
273 buffer in the normal course of events. |
6558 | 274 |
275 The remaining arguments, @var{args}, are strings that specify command | |
276 line arguments for the program. | |
277 | |
278 The value returned by @code{call-process} (unless you told it not to | |
279 wait) indicates the reason for process termination. A number gives the | |
280 exit status of the subprocess; 0 means success, and any other value | |
281 means failure. If the process terminated with a signal, | |
282 @code{call-process} returns a string describing the signal. | |
283 | |
284 In the examples below, the buffer @samp{foo} is current. | |
285 | |
286 @smallexample | |
287 @group | |
288 (call-process "pwd" nil t) | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
289 @result{} 0 |
6558 | 290 |
291 ---------- Buffer: foo ---------- | |
292 /usr/user/lewis/manual | |
293 ---------- Buffer: foo ---------- | |
294 @end group | |
295 | |
296 @group | |
297 (call-process "grep" nil "bar" nil "lewis" "/etc/passwd") | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
298 @result{} 0 |
6558 | 299 |
300 ---------- Buffer: bar ---------- | |
301 lewis:5LTsHm66CSWKg:398:21:Bil Lewis:/user/lewis:/bin/csh | |
302 | |
303 ---------- Buffer: bar ---------- | |
304 @end group | |
305 @end smallexample | |
306 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
307 Here is a good example of the use of @code{call-process}, which used to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
308 be found in the definition of @code{insert-directory}: |
6558 | 309 |
310 @smallexample | |
311 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
312 (call-process insert-directory-program nil t nil @var{switches} |
6558 | 313 (if full-directory-p |
314 (concat (file-name-as-directory file) ".") | |
315 file)) | |
316 @end group | |
317 @end smallexample | |
318 @end defun | |
319 | |
12067 | 320 @defun call-process-region start end program &optional delete destination display &rest args |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
321 This function sends the text from @var{start} to @var{end} as |
6558 | 322 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
|
323 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
|
324 @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
|
325 buffer in place of the input. |
6558 | 326 |
12067 | 327 The arguments @var{destination} and @var{display} control what to do |
6558 | 328 with the output from the subprocess, and whether to update the display |
329 as it comes in. For details, see the description of | |
12067 | 330 @code{call-process}, above. If @var{destination} is the integer 0, |
6558 | 331 @code{call-process-region} discards the output and returns @code{nil} |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
332 immediately, without waiting for the subprocess to finish (this only |
27370
70846ee19545
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
333 works if asynchronous subprocesses are supported). |
6558 | 334 |
335 The remaining arguments, @var{args}, are strings that specify command | |
336 line arguments for the program. | |
337 | |
338 The return value of @code{call-process-region} is just like that of | |
339 @code{call-process}: @code{nil} if you told it to return without | |
340 waiting; otherwise, a number or string which indicates how the | |
341 subprocess terminated. | |
342 | |
343 In the following example, we use @code{call-process-region} to run the | |
344 @code{cat} utility, with standard input being the first five characters | |
345 in buffer @samp{foo} (the word @samp{input}). @code{cat} copies its | |
346 standard input into its standard output. Since the argument | |
12067 | 347 @var{destination} is @code{t}, this output is inserted in the current |
6558 | 348 buffer. |
349 | |
350 @smallexample | |
351 @group | |
352 ---------- Buffer: foo ---------- | |
353 input@point{} | |
354 ---------- Buffer: foo ---------- | |
355 @end group | |
356 | |
357 @group | |
358 (call-process-region 1 6 "cat" nil t) | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
359 @result{} 0 |
6558 | 360 |
361 ---------- Buffer: foo ---------- | |
362 inputinput@point{} | |
363 ---------- Buffer: foo ---------- | |
364 @end group | |
365 @end smallexample | |
366 | |
367 The @code{shell-command-on-region} command uses | |
368 @code{call-process-region} like this: | |
369 | |
370 @smallexample | |
371 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46340
diff
changeset
|
372 (call-process-region |
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46340
diff
changeset
|
373 start end |
6558 | 374 shell-file-name ; @r{Name of program.} |
375 nil ; @r{Do not delete region.} | |
376 buffer ; @r{Send output to @code{buffer}.} | |
377 nil ; @r{No redisplay during output.} | |
378 "-c" command) ; @r{Arguments for the shell.} | |
379 @end group | |
380 @end smallexample | |
381 @end defun | |
382 | |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
383 @defun call-process-shell-command command &optional infile destination display &rest args |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
384 This function executes the shell command @var{command} synchronously |
54265 | 385 in a separate process. The final arguments @var{args} are additional |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
386 arguments to add at the end of @var{command}. The other arguments |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
387 are handled as in @code{call-process}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
388 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
389 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
390 @defun shell-command-to-string command |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
391 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
|
392 then returns the command's output as a string. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
393 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
394 |
6558 | 395 @node Asynchronous Processes |
396 @section Creating an Asynchronous Process | |
397 @cindex asynchronous subprocess | |
398 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
399 After an @dfn{asynchronous process} is created, Emacs and the subprocess |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
400 both continue running immediately. The process thereafter runs |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
401 in parallel with Emacs, and the two can communicate with each other |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
402 using the functions described in the following sections. However, |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
403 communication is only partially asynchronous: Emacs sends data to the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
404 process only when certain functions are called, and Emacs accepts data |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
405 from the process only when Emacs is waiting for input or for a time |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
406 delay. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
407 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
408 Here we describe how to create an asynchronous process. |
6558 | 409 |
410 @defun start-process name buffer-or-name program &rest args | |
411 This function creates a new asynchronous subprocess and starts the | |
412 program @var{program} running in it. It returns a process object that | |
413 stands for the new subprocess in Lisp. The argument @var{name} | |
414 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
|
415 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
|
416 etc.) to be unique. The buffer @var{buffer-or-name} is the buffer to |
6558 | 417 associate with the process. |
418 | |
419 The remaining arguments, @var{args}, are strings that specify command | |
420 line arguments for the program. | |
421 | |
422 In the example below, the first process is started and runs (rather, | |
423 sleeps) for 100 seconds. Meanwhile, the second process is started, and | |
424 given the name @samp{my-process<1>} for the sake of uniqueness. It | |
425 inserts the directory listing at the end of the buffer @samp{foo}, | |
426 before the first process finishes. Then it finishes, and a message to | |
427 that effect is inserted in the buffer. Much later, the first process | |
428 finishes, and another message is inserted in the buffer for it. | |
429 | |
430 @smallexample | |
431 @group | |
432 (start-process "my-process" "foo" "sleep" "100") | |
433 @result{} #<process my-process> | |
434 @end group | |
435 | |
436 @group | |
437 (start-process "my-process" "foo" "ls" "-l" "/user/lewis/bin") | |
438 @result{} #<process my-process<1>> | |
439 | |
440 ---------- Buffer: foo ---------- | |
441 total 2 | |
442 lrwxrwxrwx 1 lewis 14 Jul 22 10:12 gnuemacs --> /emacs | |
443 -rwxrwxrwx 1 lewis 19 Jul 30 21:02 lemon | |
444 | |
445 Process my-process<1> finished | |
446 | |
447 Process my-process finished | |
448 ---------- Buffer: foo ---------- | |
449 @end group | |
450 @end smallexample | |
451 @end defun | |
452 | |
453 @defun start-process-shell-command name buffer-or-name command &rest command-args | |
454 This function is like @code{start-process} except that it uses a shell | |
455 to execute the specified command. The argument @var{command} is a shell | |
456 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
|
457 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
|
458 use. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
459 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
460 The point of running a program through the shell, rather than directly |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
461 with @code{start-process}, is so that you can employ shell features such |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
462 as wildcards in the arguments. It follows that if you include an |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
463 arbitrary user-specified arguments in the command, you should quote it |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
464 with @code{shell-quote-argument} first, so that any special shell |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
465 characters do @emph{not} have their special shell meanings. @xref{Shell |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
466 Arguments}. |
6558 | 467 @end defun |
468 | |
469 @defvar process-connection-type | |
470 @cindex pipes | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
471 @cindex @acronym{PTY}s |
6558 | 472 This variable controls the type of device used to communicate with |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
473 asynchronous subprocesses. If it is non-@code{nil}, then @acronym{PTY}s are |
12098 | 474 used, when available. Otherwise, pipes are used. |
6558 | 475 |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
476 @acronym{PTY}s are usually preferable for processes visible to the user, as |
6558 | 477 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
|
478 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
|
479 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
|
480 often better to use a pipe, because they are more efficient. In |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
481 addition, the total number of @acronym{PTY}s is limited on many systems and |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
482 it is good not to waste them. |
6558 | 483 |
46340
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
484 The value of @code{process-connection-type} takes effect when |
6558 | 485 @code{start-process} is called. So you can specify how to communicate |
486 with one subprocess by binding the variable around the call to | |
487 @code{start-process}. | |
488 | |
489 @smallexample | |
490 @group | |
491 (let ((process-connection-type nil)) ; @r{Use a pipe.} | |
492 (start-process @dots{})) | |
493 @end group | |
494 @end smallexample | |
12067 | 495 |
496 To determine whether a given subprocess actually got a pipe or a | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
497 @acronym{PTY}, use the function @code{process-tty-name} (@pxref{Process |
12067 | 498 Information}). |
6558 | 499 @end defvar |
500 | |
501 @node Deleting Processes | |
502 @section Deleting Processes | |
503 @cindex deleting processes | |
504 | |
505 @dfn{Deleting a process} disconnects Emacs immediately from the | |
44345
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
506 subprocess. Processes are deleted automatically after they terminate, |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
507 but not necessarily right away. You can delete a process explicitly |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
508 at any time. If you delete a terminated process explicitly before it |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
509 is deleted automatically, no harm results. Deletion of a running |
46340
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
510 process sends a signal to terminate it (and its child processes if |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
511 any), and calls the process sentinel if it has one. |
6558 | 512 |
44345
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
513 @code{get-buffer-process} and @code{process-list} do not remember a |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
514 deleted process, but the process object itself continues to exist as |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
515 long as other Lisp objects point to it. All the Lisp primitives that |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
516 work on process objects accept deleted processes, but those that do |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
517 I/O or send signals will report an error. The process mark continues |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
518 to point to the same place as before, usually into a buffer where |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
519 output from the process was being inserted. |
6558 | 520 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
521 @defopt delete-exited-processes |
6558 | 522 This variable controls automatic deletion of processes that have |
523 terminated (due to calling @code{exit} or to a signal). If it is | |
524 @code{nil}, then they continue to exist until the user runs | |
525 @code{list-processes}. Otherwise, they are deleted immediately after | |
526 they exit. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
527 @end defopt |
6558 | 528 |
529 @defun delete-process name | |
44345
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
530 This function deletes the process associated with @var{name}, killing |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
531 it with a @code{SIGKILL} signal. The argument @var{name} may be a |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
532 process, the name of a process, a buffer, or the name of a buffer. |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
533 Calling @code{delete-process} on a running process terminates it, |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
534 updates the process status, and runs the sentinel (if any) immediately. |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
535 If the process has already terminated, calling @code{delete-process} |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
536 has no effect on its status, or on the running of its sentinel (which |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
537 will happen sooner or later). |
6558 | 538 |
539 @smallexample | |
540 @group | |
541 (delete-process "*shell*") | |
542 @result{} nil | |
543 @end group | |
544 @end smallexample | |
545 @end defun | |
546 | |
547 @node Process Information | |
548 @section Process Information | |
549 | |
550 Several functions return information about processes. | |
551 @code{list-processes} is provided for interactive use. | |
552 | |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
553 @deffn Command list-processes &optional query-only |
6558 | 554 This command displays a listing of all living processes. In addition, |
555 it finally deletes any process whose status was @samp{Exited} or | |
556 @samp{Signaled}. It returns @code{nil}. | |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
557 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
558 If @var{query-only} is non-@code{nil} then it lists only processes |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
559 whose query flag is non-@code{nil}. @xref{Query Before Exit}. |
6558 | 560 @end deffn |
561 | |
562 @defun process-list | |
563 This function returns a list of all processes that have not been deleted. | |
564 | |
565 @smallexample | |
566 @group | |
567 (process-list) | |
568 @result{} (#<process display-time> #<process shell>) | |
569 @end group | |
570 @end smallexample | |
571 @end defun | |
572 | |
573 @defun get-process name | |
574 This function returns the process named @var{name}, or @code{nil} if | |
575 there is none. An error is signaled if @var{name} is not a string. | |
576 | |
577 @smallexample | |
578 @group | |
579 (get-process "shell") | |
580 @result{} #<process shell> | |
581 @end group | |
582 @end smallexample | |
583 @end defun | |
584 | |
585 @defun process-command process | |
586 This function returns the command that was executed to start | |
587 @var{process}. This is a list of strings, the first string being the | |
588 program executed and the rest of the strings being the arguments that | |
589 were given to the program. | |
590 | |
591 @smallexample | |
592 @group | |
593 (process-command (get-process "shell")) | |
594 @result{} ("/bin/csh" "-i") | |
595 @end group | |
596 @end smallexample | |
597 @end defun | |
598 | |
599 @defun process-id process | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
600 This function returns the @acronym{PID} of @var{process}. This is an |
9009 | 601 integer that distinguishes the process @var{process} from all other |
6558 | 602 processes running on the same computer at the current time. The |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
603 @acronym{PID} of a process is chosen by the operating system kernel when the |
6558 | 604 process is started and remains constant as long as the process exists. |
605 @end defun | |
606 | |
607 @defun process-name process | |
608 This function returns the name of @var{process}. | |
609 @end defun | |
610 | |
611 @defun process-status process-name | |
612 This function returns the status of @var{process-name} as a symbol. | |
613 The argument @var{process-name} must be a process, a buffer, a | |
614 process name (string) or a buffer name (string). | |
615 | |
616 The possible values for an actual subprocess are: | |
617 | |
618 @table @code | |
619 @item run | |
620 for a process that is running. | |
621 @item stop | |
622 for a process that is stopped but continuable. | |
623 @item exit | |
624 for a process that has exited. | |
625 @item signal | |
626 for a process that has received a fatal signal. | |
627 @item open | |
628 for a network connection that is open. | |
629 @item closed | |
630 for a network connection that is closed. Once a connection | |
631 is closed, you cannot reopen it, though you might be able to open | |
632 a new connection to the same place. | |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
633 @item connect |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
634 for a non-blocking connection that is waiting to complete. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
635 @item failed |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
636 for a non-blocking connection that has failed to complete. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
637 @item listen |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
638 for a network server that is listening. |
6558 | 639 @item nil |
640 if @var{process-name} is not the name of an existing process. | |
641 @end table | |
642 | |
643 @smallexample | |
644 @group | |
645 (process-status "shell") | |
646 @result{} run | |
647 @end group | |
648 @group | |
649 (process-status (get-buffer "*shell*")) | |
650 @result{} run | |
651 @end group | |
652 @group | |
653 x | |
654 @result{} #<process xx<1>> | |
655 (process-status x) | |
656 @result{} exit | |
657 @end group | |
658 @end smallexample | |
659 | |
660 For a network connection, @code{process-status} returns one of the symbols | |
661 @code{open} or @code{closed}. The latter means that the other side | |
662 closed the connection, or Emacs did @code{delete-process}. | |
663 @end defun | |
664 | |
665 @defun process-exit-status process | |
666 This function returns the exit status of @var{process} or the signal | |
667 number that killed it. (Use the result of @code{process-status} to | |
668 determine which of those it is.) If @var{process} has not yet | |
669 terminated, the value is 0. | |
670 @end defun | |
671 | |
12067 | 672 @defun process-tty-name process |
673 This function returns the terminal name that @var{process} is using for | |
674 its communication with Emacs---or @code{nil} if it is using pipes | |
675 instead of a terminal (see @code{process-connection-type} in | |
676 @ref{Asynchronous Processes}). | |
677 @end defun | |
678 | |
56215 | 679 @defun process-coding-system process |
53292
5408fe43d709
(Process Information): Add anchor.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
680 @anchor{Coding systems for a subprocess} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
681 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
|
682 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
|
683 @var{process} (@pxref{Coding Systems}). The value has this form: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
684 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
685 @example |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
686 (@var{coding-system-for-decoding} . @var{coding-system-for-encoding}) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
687 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
688 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
689 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
690 @defun set-process-coding-system process decoding-system encoding-system |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
691 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
|
692 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
|
693 decode subprocess output, and @var{encoding-system} to encode subprocess |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
694 input. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
695 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
696 |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
697 Every process also has a property list that you can use to store |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
698 miscellaneous values associated with the process. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
699 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
700 @defun process-get process propname |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
701 This function returns the value of the @var{propname} property |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
702 of @var{process}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
703 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
704 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
705 @defun process-put process propname value |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
706 This function sets the value of the @var{propname} property |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
707 of @var{process} to @var{value}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
708 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
709 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
710 @defun process-plist process |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
711 This function returns the process plist of @var{process}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
712 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
713 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
714 @defun set-process-plist process plist |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
715 This function sets the process plist of @var{process} to @var{plist}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
716 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
717 |
6558 | 718 @node Input to Processes |
719 @section Sending Input to Processes | |
720 @cindex process input | |
721 | |
722 Asynchronous subprocesses receive input when it is sent to them by | |
723 Emacs, which is done with the functions in this section. You must | |
724 specify the process to send input to, and the input data to send. The | |
725 data appears on the ``standard input'' of the subprocess. | |
726 | |
727 Some operating systems have limited space for buffered input in a | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
728 @acronym{PTY}. On these systems, Emacs sends an @acronym{EOF} periodically amidst |
6558 | 729 the other characters, to force them through. For most programs, |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
730 these @acronym{EOF}s do no harm. |
6558 | 731 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
732 Subprocess input is normally encoded using a coding system before the |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
733 subprocess receives it, much like text written into a file. You can use |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
734 @code{set-process-coding-system} to specify which coding system to use |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
735 (@pxref{Process Information}). Otherwise, the coding system comes from |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
736 @code{coding-system-for-write}, if that is non-@code{nil}; or else from |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
737 the defaulting mechanism (@pxref{Default Coding Systems}). |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
738 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
739 Sometimes the system is unable to accept input for that process, |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
740 because the input buffer is full. When this happens, the send functions |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
741 wait a short while, accepting output from subprocesses, and then try |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
742 again. This gives the subprocess a chance to read more of its pending |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
743 input and make space in the buffer. It also allows filters, sentinels |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
744 and timers to run---so take account of that in writing your code. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
745 |
6558 | 746 @defun process-send-string process-name string |
747 This function sends @var{process-name} the contents of @var{string} as | |
748 standard input. The argument @var{process-name} must be a process or | |
749 the name of a process. If it is @code{nil}, the current buffer's | |
750 process is used. | |
751 | |
752 The function returns @code{nil}. | |
753 | |
754 @smallexample | |
755 @group | |
756 (process-send-string "shell<1>" "ls\n") | |
757 @result{} nil | |
758 @end group | |
759 | |
760 | |
761 @group | |
762 ---------- Buffer: *shell* ---------- | |
763 ... | |
764 introduction.texi syntax-tables.texi~ | |
765 introduction.texi~ text.texi | |
766 introduction.txt text.texi~ | |
767 ... | |
768 ---------- Buffer: *shell* ---------- | |
769 @end group | |
770 @end smallexample | |
771 @end defun | |
772 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
773 @defun process-send-region process-name start end |
6558 | 774 This function sends the text in the region defined by @var{start} and |
775 @var{end} as standard input to @var{process-name}, which is a process or | |
776 a process name. (If it is @code{nil}, the current buffer's process is | |
777 used.) | |
778 | |
779 An error is signaled unless both @var{start} and @var{end} are | |
780 integers or markers that indicate positions in the current buffer. (It | |
781 is unimportant which number is larger.) | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
782 @end defun |
6558 | 783 |
784 @defun process-send-eof &optional process-name | |
785 This function makes @var{process-name} see an end-of-file in its | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
786 input. The @acronym{EOF} comes after any text already sent to it. |
6558 | 787 |
788 If @var{process-name} is not supplied, or if it is @code{nil}, then | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
789 this function sends the @acronym{EOF} to the current buffer's process. An |
6558 | 790 error is signaled if the current buffer has no process. |
791 | |
792 The function returns @var{process-name}. | |
793 | |
794 @smallexample | |
795 @group | |
796 (process-send-eof "shell") | |
797 @result{} "shell" | |
798 @end group | |
799 @end smallexample | |
800 @end defun | |
801 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
802 @defun process-running-child-p process |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
803 @tindex process-running-child-p process |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
804 This function will tell you whether a subprocess has given control of |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
805 its terminal to its own child process. The value is @code{t} if this is |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
806 true, or if Emacs cannot tell; it is @code{nil} if Emacs can be certain |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
807 that this is not so. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
808 @end defun |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
809 |
6558 | 810 @node Signals to Processes |
811 @section Sending Signals to Processes | |
812 @cindex process signals | |
813 @cindex sending signals | |
814 @cindex signals | |
815 | |
816 @dfn{Sending a signal} to a subprocess is a way of interrupting its | |
817 activities. There are several different signals, each with its own | |
818 meaning. The set of signals and their names is defined by the operating | |
819 system. For example, the signal @code{SIGINT} means that the user has | |
820 typed @kbd{C-c}, or that some analogous thing has happened. | |
821 | |
822 Each signal has a standard effect on the subprocess. Most signals | |
823 kill the subprocess, but some stop or resume execution instead. Most | |
824 signals can optionally be handled by programs; if the program handles | |
825 the signal, then we can say nothing in general about its effects. | |
826 | |
827 You can send signals explicitly by calling the functions in this | |
828 section. Emacs also sends signals automatically at certain times: | |
829 killing a buffer sends a @code{SIGHUP} signal to all its associated | |
830 processes; killing Emacs sends a @code{SIGHUP} signal to all remaining | |
831 processes. (@code{SIGHUP} is a signal that usually indicates that the | |
832 user hung up the phone.) | |
833 | |
834 Each of the signal-sending functions takes two optional arguments: | |
835 @var{process-name} and @var{current-group}. | |
836 | |
837 The argument @var{process-name} must be either a process, the name of | |
838 one, or @code{nil}. If it is @code{nil}, the process defaults to the | |
839 process associated with the current buffer. An error is signaled if | |
840 @var{process-name} does not identify a process. | |
841 | |
842 The argument @var{current-group} is a flag that makes a difference | |
843 when you are running a job-control shell as an Emacs subprocess. If it | |
844 is non-@code{nil}, then the signal is sent to the current process-group | |
9009 | 845 of the terminal that Emacs uses to communicate with the subprocess. If |
6558 | 846 the process is a job-control shell, this means the shell's current |
847 subjob. If it is @code{nil}, the signal is sent to the process group of | |
848 the immediate subprocess of Emacs. If the subprocess is a job-control | |
849 shell, this is the shell itself. | |
850 | |
851 The flag @var{current-group} has no effect when a pipe is used to | |
852 communicate with the subprocess, because the operating system does not | |
853 support the distinction in the case of pipes. For the same reason, | |
854 job-control shells won't work when a pipe is used. See | |
855 @code{process-connection-type} in @ref{Asynchronous Processes}. | |
856 | |
857 @defun interrupt-process &optional process-name current-group | |
858 This function interrupts the process @var{process-name} by sending the | |
859 signal @code{SIGINT}. Outside of Emacs, typing the ``interrupt | |
860 character'' (normally @kbd{C-c} on some systems, and @code{DEL} on | |
861 others) sends this signal. When the argument @var{current-group} is | |
862 non-@code{nil}, you can think of this function as ``typing @kbd{C-c}'' | |
863 on the terminal by which Emacs talks to the subprocess. | |
864 @end defun | |
865 | |
866 @defun kill-process &optional process-name current-group | |
867 This function kills the process @var{process-name} by sending the | |
868 signal @code{SIGKILL}. This signal kills the subprocess immediately, | |
869 and cannot be handled by the subprocess. | |
870 @end defun | |
871 | |
872 @defun quit-process &optional process-name current-group | |
873 This function sends the signal @code{SIGQUIT} to the process | |
874 @var{process-name}. This signal is the one sent by the ``quit | |
875 character'' (usually @kbd{C-b} or @kbd{C-\}) when you are not inside | |
876 Emacs. | |
877 @end defun | |
878 | |
879 @defun stop-process &optional process-name current-group | |
880 This function stops the process @var{process-name} by sending the | |
881 signal @code{SIGTSTP}. Use @code{continue-process} to resume its | |
882 execution. | |
883 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
884 Outside of Emacs, on systems with job control, the ``stop character'' |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
885 (usually @kbd{C-z}) normally sends this signal. When |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
886 @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
|
887 ``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
|
888 subprocess. |
6558 | 889 @end defun |
890 | |
891 @defun continue-process &optional process-name current-group | |
892 This function resumes execution of the process @var{process} by sending | |
893 it the signal @code{SIGCONT}. This presumes that @var{process-name} was | |
894 stopped previously. | |
895 @end defun | |
896 | |
897 @c Emacs 19 feature | |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
898 @defun signal-process process signal |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
899 This function sends a signal to process @var{process}. The argument |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
900 @var{signal} specifies which signal to send; it should be an integer. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
901 |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
902 You can specify the target process by its process @acronym{ID}; that allows |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
903 you to send signals to processes that are not children of Emacs. |
6558 | 904 @end defun |
905 | |
906 @node Output from Processes | |
907 @section Receiving Output from Processes | |
908 @cindex process output | |
909 @cindex output from processes | |
910 | |
911 There are two ways to receive the output that a subprocess writes to | |
912 its standard output stream. The output can be inserted in a buffer, | |
913 which is called the associated buffer of the process, or a function | |
9009 | 914 called the @dfn{filter function} can be called to act on the output. If |
915 the process has no buffer and no filter function, its output is | |
916 discarded. | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46340
diff
changeset
|
917 |
46340
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
918 When a subprocess terminates, Emacs reads any pending output, |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
919 then stops reading output from that subprocess. Therefore, if the |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
920 subprocess has children that are still live and still producing |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
921 output, Emacs won't receive that output. |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
922 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
923 Output from a subprocess can arrive only while Emacs is waiting: when |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
924 reading terminal input, in @code{sit-for} and @code{sleep-for} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
925 (@pxref{Waiting}), and in @code{accept-process-output} (@pxref{Accepting |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
926 Output}). This minimizes the problem of timing errors that usually |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
927 plague parallel programming. For example, you can safely create a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
928 process and only then specify its buffer or filter function; no output |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
929 can arrive before you finish, if the code in between does not call any |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
930 primitive that waits. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
931 |
56704
900340a218c9
(Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents:
56703
diff
changeset
|
932 @defvar process-adaptive-read-buffering |
900340a218c9
(Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents:
56703
diff
changeset
|
933 On some systems, when Emacs reads the output from a subprocess, the |
900340a218c9
(Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents:
56703
diff
changeset
|
934 output data is read in very small blocks, potentially resulting in |
900340a218c9
(Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents:
56703
diff
changeset
|
935 very poor performance. This behaviour can be remedied to some extent |
900340a218c9
(Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents:
56703
diff
changeset
|
936 by setting the variable @var{process-adaptive-read-buffering} to a |
900340a218c9
(Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents:
56703
diff
changeset
|
937 non-nil value (the default), as it will automatically delay reading |
900340a218c9
(Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents:
56703
diff
changeset
|
938 from such processes, thus allowing them to produce more output before |
900340a218c9
(Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents:
56703
diff
changeset
|
939 Emacs tries to read it. |
900340a218c9
(Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents:
56703
diff
changeset
|
940 @end defvar |
900340a218c9
(Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents:
56703
diff
changeset
|
941 |
27259
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
942 It is impossible to separate the standard output and standard error |
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
943 streams of the subprocess, because Emacs normally spawns the subprocess |
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
944 inside a pseudo-TTY, and a pseudo-TTY has only one output channel. If |
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
945 you want to keep the output to those streams separate, you should |
54916 | 946 redirect one of them to a file---for example, by using an appropriate |
27259
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
947 shell command. |
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
948 |
6558 | 949 @menu |
51993
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
950 * Process Buffers:: If no filter, output is put in a buffer. |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
951 * Filter Functions:: Filter functions accept output from the process. |
51994 | 952 * Decoding Output:: Filters can get unibyte or multibyte strings. |
51993
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
953 * Accepting Output:: How to wait until process output arrives. |
6558 | 954 @end menu |
955 | |
956 @node Process Buffers | |
957 @subsection Process Buffers | |
958 | |
959 A process can (and usually does) have an @dfn{associated buffer}, | |
960 which is an ordinary Emacs buffer that is used for two purposes: storing | |
961 the output from the process, and deciding when to kill the process. You | |
962 can also use the buffer to identify a process to operate on, since in | |
963 normal practice only one process is associated with any given buffer. | |
964 Many applications of processes also use the buffer for editing input to | |
965 be sent to the process, but this is not built into Emacs Lisp. | |
966 | |
967 Unless the process has a filter function (@pxref{Filter Functions}), | |
968 its output is inserted in the associated buffer. The position to insert | |
9009 | 969 the output is determined by the @code{process-mark}, which is then |
970 updated to point to the end of the text just inserted. Usually, but not | |
971 always, the @code{process-mark} is at the end of the buffer. | |
6558 | 972 |
973 @defun process-buffer process | |
974 This function returns the associated buffer of the process | |
975 @var{process}. | |
976 | |
977 @smallexample | |
978 @group | |
979 (process-buffer (get-process "shell")) | |
980 @result{} #<buffer *shell*> | |
981 @end group | |
982 @end smallexample | |
983 @end defun | |
984 | |
985 @defun process-mark process | |
986 This function returns the process marker for @var{process}, which is the | |
987 marker that says where to insert output from the process. | |
988 | |
989 If @var{process} does not have a buffer, @code{process-mark} returns a | |
990 marker that points nowhere. | |
991 | |
992 Insertion of process output in a buffer uses this marker to decide where | |
993 to insert, and updates it to point after the inserted text. That is why | |
994 successive batches of output are inserted consecutively. | |
995 | |
996 Filter functions normally should use this marker in the same fashion | |
997 as is done by direct insertion of output in the buffer. A good | |
998 example of a filter function that uses @code{process-mark} is found at | |
999 the end of the following section. | |
1000 | |
1001 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
|
1002 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
|
1003 from previous output. |
6558 | 1004 @end defun |
1005 | |
1006 @defun set-process-buffer process buffer | |
1007 This function sets the buffer associated with @var{process} to | |
1008 @var{buffer}. If @var{buffer} is @code{nil}, the process becomes | |
1009 associated with no buffer. | |
1010 @end defun | |
1011 | |
1012 @defun get-buffer-process buffer-or-name | |
44345
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1013 This function returns a nondeleted process associated with the buffer |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1014 specified by @var{buffer-or-name}. If there are several processes |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1015 associated with it, this function chooses one (currently, the one most |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1016 recently created, but don't count on that). Deletion of a process |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1017 (see @code{delete-process}) makes it ineligible for this function to |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1018 return. |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1019 |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1020 It is usually a bad idea to have more than one process associated with |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1021 the same buffer. |
6558 | 1022 |
1023 @smallexample | |
1024 @group | |
1025 (get-buffer-process "*shell*") | |
1026 @result{} #<process shell> | |
1027 @end group | |
1028 @end smallexample | |
1029 | |
1030 Killing the process's buffer deletes the process, which kills the | |
1031 subprocess with a @code{SIGHUP} signal (@pxref{Signals to Processes}). | |
1032 @end defun | |
1033 | |
1034 @node Filter Functions | |
1035 @subsection Process Filter Functions | |
1036 @cindex filter function | |
1037 @cindex process filter | |
1038 | |
1039 A process @dfn{filter function} is a function that receives the | |
1040 standard output from the associated process. If a process has a filter, | |
9009 | 1041 then @emph{all} output from that process is passed to the filter. The |
1042 process buffer is used directly for output from the process only when | |
1043 there is no filter. | |
6558 | 1044 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1045 The filter function can only be called when Emacs is waiting for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1046 something, because process output arrives only at such times. Emacs |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1047 waits when reading terminal input, in @code{sit-for} and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1048 @code{sleep-for} (@pxref{Waiting}), and in @code{accept-process-output} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1049 (@pxref{Accepting Output}). |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1050 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1051 A filter function must accept two arguments: the associated process |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1052 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
|
1053 then free to do whatever it chooses with the output. |
6558 | 1054 |
1055 Quitting is normally inhibited within a filter function---otherwise, | |
1056 the effect of typing @kbd{C-g} at command level or to quit a user | |
1057 command would be unpredictable. If you want to permit quitting inside a | |
1058 filter function, bind @code{inhibit-quit} to @code{nil}. | |
1059 @xref{Quitting}. | |
1060 | |
12067 | 1061 If an error happens during execution of a filter function, it is |
1062 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
|
1063 program was running when the filter function was started. However, if |
12067 | 1064 @code{debug-on-error} is non-@code{nil}, the error-catching is turned |
1065 off. This makes it possible to use the Lisp debugger to debug the | |
1066 filter function. @xref{Debugger}. | |
1067 | |
6558 | 1068 Many filter functions sometimes or always insert the text in the |
1069 process's buffer, mimicking the actions of Emacs when there is no | |
1070 filter. Such filter functions need to use @code{set-buffer} in order to | |
1071 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
|
1072 semipermanently, these filter functions must save and restore the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1073 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
|
1074 cases update the value of point. Here is how to do these things: |
6558 | 1075 |
1076 @smallexample | |
1077 @group | |
1078 (defun ordinary-insertion-filter (proc string) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1079 (with-current-buffer (process-buffer proc) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1080 (let ((moving (= (point) (process-mark proc)))) |
6558 | 1081 @end group |
1082 @group | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1083 (save-excursion |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1084 ;; @r{Insert the text, advancing the process marker.} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1085 (goto-char (process-mark proc)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1086 (insert string) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1087 (set-marker (process-mark proc) (point))) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1088 (if moving (goto-char (process-mark proc)))))) |
6558 | 1089 @end group |
1090 @end smallexample | |
1091 | |
1092 @noindent | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1093 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
|
1094 @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
|
1095 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
|
1096 @code{goto-char}. |
6558 | 1097 |
1098 To make the filter force the process buffer to be visible whenever new | |
1099 text arrives, insert the following line just before the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1100 @code{with-current-buffer} construct: |
6558 | 1101 |
1102 @smallexample | |
1103 (display-buffer (process-buffer proc)) | |
1104 @end smallexample | |
1105 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1106 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
|
1107 previously, eliminate the variable @code{moving} and call |
6558 | 1108 @code{goto-char} unconditionally. |
1109 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1110 In earlier Emacs versions, every filter function that did regular |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1111 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
|
1112 match data. Now Emacs does this automatically for filter functions; |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1113 they never need to do it explicitly. @xref{Match Data}. |
6558 | 1114 |
1115 A filter function that writes the output into the buffer of the | |
12098 | 1116 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
|
1117 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
|
1118 @code{(buffer-name (process-buffer @var{process}))} returns @code{nil} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1119 if the buffer is dead. |
6558 | 1120 |
1121 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
|
1122 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
|
1123 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
|
1124 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
|
1125 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
|
1126 or more batches of output. |
6558 | 1127 |
1128 @defun set-process-filter process filter | |
1129 This function gives @var{process} the filter function @var{filter}. If | |
1130 @var{filter} is @code{nil}, it gives the process no filter. | |
1131 @end defun | |
1132 | |
1133 @defun process-filter process | |
1134 This function returns the filter function of @var{process}, or @code{nil} | |
1135 if it has none. | |
1136 @end defun | |
1137 | |
1138 Here is an example of use of a filter function: | |
1139 | |
1140 @smallexample | |
1141 @group | |
1142 (defun keep-output (process output) | |
1143 (setq kept (cons output kept))) | |
1144 @result{} keep-output | |
1145 @end group | |
1146 @group | |
1147 (setq kept nil) | |
1148 @result{} nil | |
1149 @end group | |
1150 @group | |
1151 (set-process-filter (get-process "shell") 'keep-output) | |
1152 @result{} keep-output | |
1153 @end group | |
1154 @group | |
1155 (process-send-string "shell" "ls ~/other\n") | |
1156 @result{} nil | |
1157 kept | |
1158 @result{} ("lewis@@slug[8] % " | |
1159 @end group | |
1160 @group | |
1161 "FINAL-W87-SHORT.MSS backup.otl kolstad.mss~ | |
1162 address.txt backup.psf kolstad.psf | |
1163 backup.bib~ david.mss resume-Dec-86.mss~ | |
1164 backup.err david.psf resume-Dec.psf | |
1165 backup.mss dland syllabus.mss | |
1166 " | |
1167 "#backups.mss# backup.mss~ kolstad.mss | |
1168 ") | |
1169 @end group | |
1170 @end smallexample | |
1171 | |
1172 @ignore @c The code in this example doesn't show the right way to do things. | |
1173 Here is another, more realistic example, which demonstrates how to use | |
1174 the process mark to do insertion in the same fashion as is done when | |
1175 there is no filter function: | |
1176 | |
1177 @smallexample | |
1178 @group | |
1179 ;; @r{Insert input in the buffer specified by @code{my-shell-buffer}} | |
1180 ;; @r{and make sure that buffer is shown in some window.} | |
1181 (defun my-process-filter (proc str) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1182 (let ((cur (selected-window)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1183 (pop-up-windows t)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1184 (pop-to-buffer my-shell-buffer) |
6558 | 1185 @end group |
1186 @group | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1187 (goto-char (point-max)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1188 (insert str) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1189 (set-marker (process-mark proc) (point-max)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1190 (select-window cur))) |
6558 | 1191 @end group |
1192 @end smallexample | |
1193 @end ignore | |
1194 | |
51993
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1195 @node Decoding Output |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1196 @subsection Decoding Process Output |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1197 |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1198 When Emacs writes process output directly into a multibyte buffer, |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1199 it decodes the output according to the process output coding system. |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1200 If the coding system is @code{raw-text} or @code{no-conversion}, Emacs |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1201 converts the unibyte output to multibyte using |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1202 @code{string-to-multibyte}, inserts the resulting multibyte text. |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1203 |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1204 You can use @code{set-process-coding-system} to specify which coding |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1205 system to use (@pxref{Process Information}). Otherwise, the coding |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1206 system comes from @code{coding-system-for-read}, if that is |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1207 non-@code{nil}; or else from the defaulting mechanism (@pxref{Default |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1208 Coding Systems}). |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1209 |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1210 @strong{Warning:} Coding systems such as @code{undecided} which |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1211 determine the coding system from the data do not work entirely |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1212 reliably with asynchronous subprocess output. This is because Emacs |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1213 has to process asynchronous subprocess output in batches, as it |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1214 arrives. Emacs must try to detect the proper coding system from one |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1215 batch at a time, and this does not always work. Therefore, if at all |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1216 possible, specify a coding system that determines both the character |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1217 code conversion and the end of line conversion---that is, one like |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1218 @code{latin-1-unix}, rather than @code{undecided} or @code{latin-1}. |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1219 |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1220 @cindex filter multibyte flag, of process |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1221 @cindex process filter multibyte flag |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1222 When Emacs calls a process filter function, it provides the process |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1223 output as a multibyte string or as a unibyte string according to the |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1224 process's filter multibyte flag. If the flag is non-@code{nil}, Emacs |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1225 decodes the output according to the process output coding system to |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1226 produce a multibyte string, and passes that to the process. If the |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1227 flag is @code{nil}, Emacs puts the output into a unibyte string, with |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1228 no decoding, and passes that. |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1229 |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1230 When you create a process, the filter multibyte flag takes its |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1231 initial value from @code{default-enable-multibyte-characters}. If you |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1232 want to change the flag later on, use |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1233 @code{set-process-filter-multibyte}. |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1234 |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1235 @defun set-process-filter-multibyte process multibyte |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1236 This function sets the filter multibyte flag of @var{process} |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1237 to @var{multibyte}. |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1238 @end defun |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1239 |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1240 @defun process-filter-multibyte-p process |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1241 This function returns the filter multibyte flag of @var{process}. |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1242 @end defun |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1243 |
6558 | 1244 @node Accepting Output |
1245 @subsection Accepting Output from Processes | |
1246 | |
1247 Output from asynchronous subprocesses normally arrives only while | |
1248 Emacs is waiting for some sort of external event, such as elapsed time | |
1249 or terminal input. Occasionally it is useful in a Lisp program to | |
1250 explicitly permit output to arrive at a specific point, or even to wait | |
1251 until output arrives from a process. | |
1252 | |
56703
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1253 @defun accept-process-output &optional process seconds millisec just-this-one |
6558 | 1254 This function allows Emacs to read pending output from processes. The |
1255 output is inserted in the associated buffers or given to their filter | |
1256 functions. If @var{process} is non-@code{nil} then this function does | |
1257 not return until some output has been received from @var{process}. | |
1258 | |
1259 @c Emacs 19 feature | |
1260 The arguments @var{seconds} and @var{millisec} let you specify timeout | |
1261 periods. The former specifies a period measured in seconds and the | |
1262 latter specifies one measured in milliseconds. The two time periods | |
1263 thus specified are added together, and @code{accept-process-output} | |
1264 returns after that much time whether or not there has been any | |
1265 subprocess output. | |
1266 | |
12098 | 1267 The argument @var{seconds} need not be an integer. If it is a floating |
1268 point number, this function waits for a fractional number of seconds. | |
1269 Some systems support only a whole number of seconds; on these systems, | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1270 @var{seconds} is rounded down. |
12098 | 1271 |
6558 | 1272 Not all operating systems support waiting periods other than multiples |
1273 of a second; on those that do not, you get an error if you specify | |
1274 nonzero @var{millisec}. | |
1275 | |
56703
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1276 @c Emacs 21.4 feature |
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1277 If @var{process} is a process, and the argument @var{just-this-one} is |
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1278 non-nil, only output from that process is handled, suspending output |
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1279 from other processes until some output has been received from that |
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1280 process or the timeout expires. If @var{just-this-one} is an integer, |
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1281 also inhibit running timers. This feature is generally not |
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1282 recommended, but may be necessary for specific applications, such as |
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1283 speech synthesis. |
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1284 |
6558 | 1285 The function @code{accept-process-output} returns non-@code{nil} if it |
1286 did get some output, or @code{nil} if the timeout expired before output | |
1287 arrived. | |
1288 @end defun | |
1289 | |
1290 @node Sentinels | |
1291 @section Sentinels: Detecting Process Status Changes | |
1292 @cindex process sentinel | |
1293 @cindex sentinel | |
1294 | |
1295 A @dfn{process sentinel} is a function that is called whenever the | |
1296 associated process changes status for any reason, including signals | |
1297 (whether sent by Emacs or caused by the process's own actions) that | |
44345
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1298 terminate, stop, or continue the process. The process sentinel is |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1299 also called if the process exits. The sentinel receives two |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1300 arguments: the process for which the event occurred, and a string |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1301 describing the type of event. |
6558 | 1302 |
1303 The string describing the event looks like one of the following: | |
1304 | |
1305 @itemize @bullet | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46340
diff
changeset
|
1306 @item |
6558 | 1307 @code{"finished\n"}. |
1308 | |
1309 @item | |
1310 @code{"exited abnormally with code @var{exitcode}\n"}. | |
1311 | |
1312 @item | |
1313 @code{"@var{name-of-signal}\n"}. | |
1314 | |
1315 @item | |
1316 @code{"@var{name-of-signal} (core dumped)\n"}. | |
1317 @end itemize | |
1318 | |
44345
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1319 A sentinel runs only while Emacs is waiting (e.g., for terminal |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1320 input, or for time to elapse, or for process output). This avoids the |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1321 timing errors that could result from running them at random places in |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1322 the middle of other Lisp programs. A program can wait, so that |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1323 sentinels will run, by calling @code{sit-for} or @code{sleep-for} |
9009 | 1324 (@pxref{Waiting}), or @code{accept-process-output} (@pxref{Accepting |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1325 Output}). Emacs also allows sentinels to run when the command loop is |
44345
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1326 reading input. @code{delete-process} calls the sentinel when it |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1327 terminates a running process. |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1328 |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1329 Emacs does not keep a queue of multiple reasons to call the sentinel |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1330 of one process; it records just the current status and the fact that |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1331 there has been a change. Therefore two changes in status, coming in |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1332 quick succession, can call the sentinel just once. However, process |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1333 termination will always run the sentinel exactly once. This is |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1334 because the process status can't change again after termination. |
6558 | 1335 |
1336 Quitting is normally inhibited within a sentinel---otherwise, the | |
1337 effect of typing @kbd{C-g} at command level or to quit a user command | |
1338 would be unpredictable. If you want to permit quitting inside a | |
1339 sentinel, bind @code{inhibit-quit} to @code{nil}. @xref{Quitting}. | |
1340 | |
1341 A sentinel that writes the output into the buffer of the process | |
12098 | 1342 should check whether the buffer is still alive. If it tries to insert |
6558 | 1343 into a dead buffer, it will get an error. If the buffer is dead, |
1344 @code{(buffer-name (process-buffer @var{process}))} returns @code{nil}. | |
1345 | |
12067 | 1346 If an error happens during execution of a sentinel, it is caught |
1347 automatically, so that it doesn't stop the execution of whatever | |
1348 programs was running when the sentinel was started. However, if | |
1349 @code{debug-on-error} is non-@code{nil}, the error-catching is turned | |
1350 off. This makes it possible to use the Lisp debugger to debug the | |
1351 sentinel. @xref{Debugger}. | |
1352 | |
44428
7e1a0877a121
Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents:
44345
diff
changeset
|
1353 While a sentinel is running, the process sentinel is temporarily |
7e1a0877a121
Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents:
44345
diff
changeset
|
1354 set to @code{nil} so that the sentinel won't run recursively. |
7e1a0877a121
Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents:
44345
diff
changeset
|
1355 For this reason it is not possible for a sentinel to specify |
7e1a0877a121
Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents:
44345
diff
changeset
|
1356 a new sentinel. |
7e1a0877a121
Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents:
44345
diff
changeset
|
1357 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1358 In earlier Emacs versions, every sentinel that did regular expression |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1359 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
|
1360 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
|
1361 it explicitly. @xref{Match Data}. |
12098 | 1362 |
6558 | 1363 @defun set-process-sentinel process sentinel |
1364 This function associates @var{sentinel} with @var{process}. If | |
1365 @var{sentinel} is @code{nil}, then the process will have no sentinel. | |
1366 The default behavior when there is no sentinel is to insert a message in | |
1367 the process's buffer when the process status changes. | |
1368 | |
44345
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1369 Changes in process sentinel take effect immediately---if the sentinel |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1370 is slated to be run but has not been called yet, and you specify a new |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1371 sentinel, the eventual call to the sentinel will use the new one. |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1372 |
6558 | 1373 @smallexample |
1374 @group | |
1375 (defun msg-me (process event) | |
1376 (princ | |
1377 (format "Process: %s had the event `%s'" process event))) | |
1378 (set-process-sentinel (get-process "shell") 'msg-me) | |
1379 @result{} msg-me | |
1380 @end group | |
1381 @group | |
1382 (kill-process (get-process "shell")) | |
1383 @print{} Process: #<process shell> had the event `killed' | |
1384 @result{} #<process shell> | |
1385 @end group | |
1386 @end smallexample | |
1387 @end defun | |
1388 | |
1389 @defun process-sentinel process | |
1390 This function returns the sentinel of @var{process}, or @code{nil} if it | |
1391 has none. | |
1392 @end defun | |
1393 | |
1394 @defun waiting-for-user-input-p | |
1395 While a sentinel or filter function is running, this function returns | |
1396 non-@code{nil} if Emacs was waiting for keyboard input from the user at | |
1397 the time the sentinel or filter function was called, @code{nil} if it | |
1398 was not. | |
1399 @end defun | |
1400 | |
46340
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1401 @node Query Before Exit |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46340
diff
changeset
|
1402 @section Querying Before Exit |
46340
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1403 |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1404 When Emacs exits, it terminates all its subprocesses by sending them |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1405 the @code{SIGHUP} signal. Because some subprocesses are doing |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1406 valuable work, Emacs normally asks the user to confirm that it is ok |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1407 to terminate them. Each process has a query flag which, if |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1408 non-@code{nil}, says that Emacs should ask for confirmation before |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1409 exiting and thus killing that process. The default for the query flag |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1410 is @code{t}, meaning @emph{do} query. |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1411 |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1412 @tindex process-query-on-exit-flag |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1413 @defun process-query-on-exit-flag process |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1414 This returns the query flag of @var{process}. |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1415 @end defun |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1416 |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1417 @tindex set-process-query-on-exit-flag |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1418 @defun set-process-query-on-exit-flag process flag |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1419 This function sets the query flag of @var{process} to @var{flag}. It |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1420 returns @var{flag}. |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1421 |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1422 @smallexample |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1423 @group |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1424 ;; @r{Don't query about the shell process} |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1425 (set-process-query-on-exit-flag (get-process "shell") nil) |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1426 @result{} t |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1427 @end group |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1428 @end smallexample |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1429 @end defun |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1430 |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1431 @defun process-kill-without-query process &optional do-query |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1432 This function clears the query flag of @var{process}, so that |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1433 Emacs will not query the user on account of that process. |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1434 |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1435 Actually, the function does more than that: it returns the old value of |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1436 the process's query flag, and sets the query flag to @var{do-query}. |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1437 Please don't use this function to do those things any more---please |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1438 use the newer, cleaner functions @code{process-query-on-exit-flag} and |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1439 @code{set-process-query-on-exit-flag} in all but the simplest cases. |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1440 The only way you should use @code{process-kill-without-query} nowadays |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1441 is like this: |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1442 |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1443 @smallexample |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1444 @group |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1445 ;; @r{Don't query about the shell process} |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1446 (process-kill-without-query (get-process "shell")) |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1447 @end group |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1448 @end smallexample |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1449 @end defun |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1450 |
6558 | 1451 @node Transaction Queues |
1452 @section Transaction Queues | |
1453 @cindex transaction queue | |
1454 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1455 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
|
1456 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
|
1457 queue communicating with a specified process. Then you can call |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1458 @code{tq-enqueue} to send a transaction. |
6558 | 1459 |
1460 @defun tq-create process | |
1461 This function creates and returns a transaction queue communicating with | |
1462 @var{process}. The argument @var{process} should be a subprocess | |
1463 capable of sending and receiving streams of bytes. It may be a child | |
9009 | 1464 process, or it may be a TCP connection to a server, possibly on another |
6558 | 1465 machine. |
1466 @end defun | |
1467 | |
1468 @defun tq-enqueue queue question regexp closure fn | |
1469 This function sends a transaction to queue @var{queue}. Specifying the | |
1470 queue has the effect of specifying the subprocess to talk to. | |
1471 | |
9009 | 1472 The argument @var{question} is the outgoing message that starts the |
6558 | 1473 transaction. The argument @var{fn} is the function to call when the |
1474 corresponding answer comes back; it is called with two arguments: | |
1475 @var{closure}, and the answer received. | |
1476 | |
39426
4520697c8aa5
(tq-enqueue): Clarify meaning of REGEXP.
Richard M. Stallman <rms@gnu.org>
parents:
27370
diff
changeset
|
1477 The argument @var{regexp} is a regular expression that should match |
4520697c8aa5
(tq-enqueue): Clarify meaning of REGEXP.
Richard M. Stallman <rms@gnu.org>
parents:
27370
diff
changeset
|
1478 text at the end of the entire answer, but nothing before; that's how |
4520697c8aa5
(tq-enqueue): Clarify meaning of REGEXP.
Richard M. Stallman <rms@gnu.org>
parents:
27370
diff
changeset
|
1479 @code{tq-enqueue} determines where the answer ends. |
6558 | 1480 |
1481 The return value of @code{tq-enqueue} itself is not meaningful. | |
1482 @end defun | |
1483 | |
1484 @defun tq-close queue | |
1485 Shut down transaction queue @var{queue}, waiting for all pending transactions | |
1486 to complete, and then terminate the connection or child process. | |
1487 @end defun | |
1488 | |
1489 Transaction queues are implemented by means of a filter function. | |
1490 @xref{Filter Functions}. | |
1491 | |
12098 | 1492 @node Network |
1493 @section Network Connections | |
1494 @cindex network connection | |
6558 | 1495 @cindex TCP |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1496 @cindex UDP |
6558 | 1497 |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1498 Emacs Lisp programs can open stream (TCP) and datagram (UDP) network |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1499 connections to other processes on the same machine or other machines. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1500 A network connection is handled by Lisp much like a subprocess, and is |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1501 represented by a process object. However, the process you are |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1502 communicating with is not a child of the Emacs process, so it has no |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
1503 process @acronym{ID}, and you can't kill it or send it signals. All you |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1504 can do is send and receive data. @code{delete-process} closes the |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1505 connection, but does not kill the program at the other end; that |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1506 program must decide what to do about closure of the connection. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1507 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1508 Lisp programs can listen for connections by creating network |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1509 servers. A network server is also represented by a kind of process |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1510 object, but unlike a network connection, the network server never |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1511 transfers data itself. When it receives a connection request, it |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1512 creates a new network connection to represent the connection just |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1513 made. (The network connection inherits certain information, including |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1514 the process plist, from the server.) The network server then goes |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1515 back to listening for more connection requests. |
6558 | 1516 |
52818
39239421c7e3
(Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents:
52759
diff
changeset
|
1517 Network connections and servers are created by calling |
39239421c7e3
(Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents:
52759
diff
changeset
|
1518 @code{make-network-process} with an argument list consisting of |
39239421c7e3
(Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents:
52759
diff
changeset
|
1519 keyword/argument pairs, for example @code{:server t} to create a |
39239421c7e3
(Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents:
52759
diff
changeset
|
1520 server process, or @code{:type 'datagram} to create a datagram |
52830
b4281fb5cff8
(Network): Fix typo in xref (from Robert J. Chassell).
Kim F. Storm <storm@cua.dk>
parents:
52818
diff
changeset
|
1521 connection. @xref{Low-Level Network}, for details. You can also use |
52818
39239421c7e3
(Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents:
52759
diff
changeset
|
1522 one of the @code{open-network-...} functions descibed below; |
39239421c7e3
(Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents:
52759
diff
changeset
|
1523 internally, they just call @code{make-network-process} with suitable |
39239421c7e3
(Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents:
52759
diff
changeset
|
1524 arguments. |
39239421c7e3
(Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents:
52759
diff
changeset
|
1525 |
6558 | 1526 You can distinguish process objects representing network connections |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1527 and servers from those representing subprocesses with the |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1528 @code{process-status} function. The possible status values for |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1529 network connections are @code{open}, @code{closed}, @code{connect}, |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1530 and @code{failed}. For a network server, the status is always |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1531 @code{listen}. None of those values is possible for a real |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1532 subprocess. @xref{Process Information}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1533 |
54265 | 1534 You can stop and resume operation of a network process by calling |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1535 @code{stop-process} and @code{continue-process}. For a server |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1536 process, being stopped means not accepting new connections. (Up to 5 |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1537 connection requests will be queued for when you resume the server; you |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1538 can increase this limit, unless it is imposed by the operating |
52695
e5c94aabfe90
(Network): Say what stopped datagram connections do.
Richard M. Stallman <rms@gnu.org>
parents:
52598
diff
changeset
|
1539 systems.) For a network stream connection, being stopped means not |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1540 processing input (any arriving input waits until you resume the |
52695
e5c94aabfe90
(Network): Say what stopped datagram connections do.
Richard M. Stallman <rms@gnu.org>
parents:
52598
diff
changeset
|
1541 connection). For a datagram connection, some number of packets may be |
e5c94aabfe90
(Network): Say what stopped datagram connections do.
Richard M. Stallman <rms@gnu.org>
parents:
52598
diff
changeset
|
1542 queued but input may be lost. You can use the function |
e5c94aabfe90
(Network): Say what stopped datagram connections do.
Richard M. Stallman <rms@gnu.org>
parents:
52598
diff
changeset
|
1543 @code{process-command} to determine whether a network connection or |
e5c94aabfe90
(Network): Say what stopped datagram connections do.
Richard M. Stallman <rms@gnu.org>
parents:
52598
diff
changeset
|
1544 server is stopped; a non-@code{nil} value means yes. |
6558 | 1545 |
1546 @defun open-network-stream name buffer-or-name host service | |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1547 This function opens a TCP connection, and returns a process object |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1548 that represents the connection. |
6558 | 1549 |
1550 The @var{name} argument specifies the name for the process object. It | |
1551 is modified as necessary to make it unique. | |
1552 | |
1553 The @var{buffer-or-name} argument is the buffer to associate with the | |
1554 connection. Output from the connection is inserted in the buffer, | |
1555 unless you specify a filter function to handle the output. If | |
1556 @var{buffer-or-name} is @code{nil}, it means that the connection is not | |
1557 associated with any buffer. | |
1558 | |
1559 The arguments @var{host} and @var{service} specify where to connect to; | |
1560 @var{host} is the host name (a string), and @var{service} is the name of | |
1561 a defined network service (a string) or a port number (an integer). | |
1562 @end defun | |
52401 | 1563 |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1564 @defun open-network-stream-nowait name buffer-or-name host service &optional sentinel filter |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1565 This function opens a TCP connection, like @code{open-network-stream}, |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1566 but it returns immediately without waiting for the request to be |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1567 accepted or rejected by the remote server. When the request is |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1568 subsequently accepted or rejected, the process's sentinel function |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1569 will be called with a string that starts with @code{"open"} (on |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1570 success) or @code{"failed"} (on error). |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1571 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1572 Some systems do not support non-blocking connections; on those |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1573 systems, @code{open-network-stream-nowait} returns @code{nil} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1574 and does nothing. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1575 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1576 The optional arguments @var{sentinel} and @var{filter} specify the |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1577 sentinel and filter functions for this network connection. It is |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1578 useful to specify them when opening the connection, because they will |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1579 be used later asynchronously. The other arguments mean the same as in |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1580 @code{open-network-stream}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1581 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1582 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1583 @defun process-contact process &optional key |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1584 This function returns information about how a network process was set |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1585 up. For a connection, when @var{key} is @code{nil}, it returns |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1586 @code{(@var{hostname} @var{service})} which specifies what you |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1587 connected to. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1588 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1589 If @var{key} is @code{t}, the value is the complete status information |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1590 for the connection or server; that is, the list of keywords and values |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1591 specified in @code{make-network-process}, except that some of the |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1592 values represent the current status instead of what you specified: |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1593 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1594 @table @code |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1595 @item :buffer |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1596 The associated value is the process buffer. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1597 @item :filter |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1598 The associated value is the process filter function. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1599 @item :sentinel |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1600 The associated value is the process sentinel function. |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1601 @item :remote |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1602 In a connection, this is the address in internal format of the remote peer. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1603 @item :local |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1604 The local address, in internal format. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1605 @item :service |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1606 In a server, if you specified @code{t} for @var{service}, |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1607 this value is the actual port number. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1608 @end table |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1609 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1610 @code{:local} and @code{:remote} are included even if they were not |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1611 specified explicitly in @code{make-network-process}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1612 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1613 If @var{key} is a keyword, the function returns the value corresponding |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1614 to that keyword. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1615 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1616 For an ordinary child process, this function always returns @code{t}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1617 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1618 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1619 @node Network Servers |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1620 @section Network Servers |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1621 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1622 You create a server by calling @code{make-network-process} with |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1623 @code{:server t}. The server will listen for connection requests from |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1624 clients. When it accepts a client connection request, that creates a |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1625 new network connection, itself a process object, with the following |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1626 parameters: |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1627 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1628 @itemize @bullet |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1629 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1630 The connection's process name is constructed by concatenating the |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1631 server process' @var{name} with a client identification string. The |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1632 client identification string for an IPv4 connection looks like |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1633 @samp{<@var{a}.@var{b}.@var{c}.@var{d}:@var{p}>}. Otherwise, it is a |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1634 unique number in brackets, as in @samp{<@var{nnn}>}. The number |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1635 is unique for each connection in the Emacs session. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1636 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1637 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1638 If the server's filter is non-@code{nil}, the connection process does |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1639 not get a separate process buffer; otherwise, Emacs creates a new |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1640 buffer for the purpose. The buffer name is the server's buffer name |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1641 or process name, concatenated with the client identification string. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1642 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1643 The server's process buffer value is never used directly by Emacs, but |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1644 it is passed to the log function, which can log connections by |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1645 inserting text there. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1646 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1647 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1648 The communication type and the process filter and sentinel are |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1649 inherited from those of the server. The server never directly |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1650 uses its filter and sentinel; their sole purpose is to initialize |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1651 connections made to the server. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1652 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1653 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1654 The connection's process contact info is set according to the client's |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1655 addressing information (typically an IP address and a port number). |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1656 This information is associated with the @code{process-contact} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1657 keywords @code{:host}, @code{:service}, @code{:remote}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1658 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1659 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1660 The connection's local address is set up according to the port |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1661 number used for the connection. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1662 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1663 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1664 The client process' plist is initialized from the server's plist. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1665 @end itemize |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1666 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1667 @defun open-network-stream-server name buffer-or-name service &optional sentinel filter |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1668 Create a network server process for a TCP service. |
54777 | 1669 It returns @code{nil} if server processes are not supported; otherwise, |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1670 it returns a subprocess-object to represent the server. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1671 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1672 When a client connects to the specified service, Emacs creates a new |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1673 subprocess to handle the new connection, and then calls its sentinel |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1674 function (which it has inherited from the server). |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1675 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1676 The optional arguments @var{sentinel} and @var{filter} specify the |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1677 sentinel and filter functions for the server. It is useful to specify |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1678 them now, because they will be used later asynchronously when the |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1679 server receives a connection request. The three arguments @var{name}, |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1680 @var{buffer-or-name} and @var{service} mean the same thing as in |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1681 @code{open-network-stream}, but @var{service} can be @code{t} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1682 meaning ask the system to allocate an unused port to listen on. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1683 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1684 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1685 @node Datagrams |
56703
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1686 @section Datagrams |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1687 @cindex datagrams |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1688 |
54265 | 1689 A datagram connection communicates with individual packets rather |
1690 than streams of data. Each call to @code{process-send} sends one | |
1691 datagram packet (@pxref{Input to Processes}), and each datagram | |
1692 received results in one call to the filter function. | |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1693 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1694 The datagram connection doesn't have to talk with the same remote |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1695 peer all the time. It has a @dfn{remote peer address} which specifies |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1696 where to send datagrams to. Each time an incoming datagram is passed |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1697 to the filter function, the peer address is set to the address that |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1698 datagram came from; that way, if the filter function sends a datagram, |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1699 it will go back to that place. You can specify the remote peer |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1700 address when you create the datagram connection using the |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1701 @code{:remote} keyword. You can change it later on by calling |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1702 @code{set-process-datagram-address}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1703 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1704 @defun process-datagram-address process |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1705 If @var{process} is a datagram connection or server, this function |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1706 returns its remote peer address. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1707 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1708 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1709 @defun set-process-datagram-address process address |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1710 If @var{process} is a datagram connection or server, this function |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1711 sets its remote peer address to @var{address}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1712 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1713 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1714 @node Low-Level Network |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1715 @section Low-Level Network Access |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1716 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1717 The basic function for creating network connections and network |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1718 servers is @code{make-network-process}. It can do either of those |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1719 jobs, depending on the arguments you give it. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1720 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1721 @defun make-network-process &rest args |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1722 This function creates a network connection or server and returns the |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1723 process object that represents it. The arguments @var{args} are a |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1724 list of keyword/argument pairs. Omitting a keyword is always |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1725 equivalent to specifying it with value @code{nil}, except for |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1726 @code{:coding}, @code{:filter-multibyte}, and @code{:reuseaddr}. Here |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1727 are the meaningful keywords: |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1728 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1729 @table @asis |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1730 @item :name name |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1731 Use the string @var{name} as the process name. It is modified if |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1732 necessary to make it unique. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1733 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1734 @item :type @var{type} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1735 Specify the communication type. A value of @code{nil} specifies a |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1736 stream connection (the default); @code{datagram} specifies a datagram |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1737 connection. Both connections and servers can be of either type. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1738 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1739 @item :server @var{server-flag} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1740 If @var{server-flag} is non-@code{nil}, create a server. Otherwise, |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1741 create a connection. For a stream type server, @var{server-flag} may |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1742 be an integer which then specifies the length of the queue of pending |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1743 connections to the server. The default queue length is 5. |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1744 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1745 @item :host @var{host} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1746 Specify the host to connect to. @var{host} should be a host name or |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1747 internet address, as a string, or the symbol @code{local} to specify |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1748 the local host. If you specify @var{host} for a server, it must |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1749 specify a valid address for the local host, and only clients |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1750 connecting to that address will be accepted. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1751 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1752 @item :service @var{service} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1753 @var{service} specifies a port number to connect to, or, for a server, |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1754 the port number to listen on. It should be a service name that |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1755 translates to a port number, or an integer specifying the port number |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1756 directly. For a server, it can also be @code{t}, which means to let |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1757 the system select an unused port number. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1758 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1759 @item :family @var{family} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1760 @var{family} specifies the address (and protocol) family for |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1761 communication. @code{nil} stands for IPv4. @code{local} specifies a |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1762 Unix socket, in which case @var{host} is ignored. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1763 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1764 @item :local @var{local-address} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1765 For a server process, @var{local-address} is the address to listen on. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1766 It overrides @var{family}, @var{host} and @var{service}, and you |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1767 may as well not specify them. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1768 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1769 @item :remote @var{remote-address} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1770 For a connection, @var{remote-address} is the address to connect to. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1771 It overrides @var{family}, @var{host} and @var{service}, and you |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1772 may as well not specify them. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1773 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1774 For a datagram server, @var{remote-address} specifies the initial |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1775 setting of the remote datagram address. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1776 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1777 The format of @var{local-address} or @var{remote-address} depends on |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1778 the address family: |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1779 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1780 @itemize - |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1781 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1782 An IPv4 address is represented as a vector of integers @code{[@var{a} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1783 @var{b} @var{c} @var{d} @var{p}]} corresponding to numeric IP address |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1784 @var{a}.@var{b}.@var{c}.@var{d} and port number @var{p}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1785 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1786 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1787 A local address is represented as a string which specifies the address |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1788 in the local address space. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1789 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1790 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1791 An ``unsupported family'' address is represented by a cons |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1792 @code{(@var{f} . @var{av})}, where @var{f} is the family number and |
54265 | 1793 @var{av} is a vector specifying the socket address using one element |
1794 per address data byte. Do not rely on this format in portable code, | |
1795 as it may depend on implementation defined constants, data sizes, and | |
1796 data structure alignment. | |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1797 @end itemize |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1798 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1799 @item :nowait @var{bool} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1800 If @var{bool} is non-@code{nil} for a stream connection, return |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1801 without waiting for the connection to complete. When the connection |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1802 succeeds or fails, Emacs will call the sentinel function, with a |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1803 second argument matching @code{"open"} (if successful) or |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1804 @code{"failed"}. The default is to block, so that |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1805 @code{make-network-process} does not return until the connection |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1806 has succeeded or failed. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1807 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1808 @item :stop @var{stopped} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1809 Start the network connection or server in the `stopped' state if |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1810 @var{stopped} is non-@code{nil}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1811 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1812 @item :buffer @var{buffer} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1813 Use @var{buffer} as the process buffer. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1814 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1815 @item :coding @var{coding} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1816 Use @var{coding} as the coding system for this process. To specify |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1817 different coding systems for decoding data from the connection and for |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1818 encoding data sent to it, specify @code{(@var{decoding} . |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1819 @var{encoding})} for @var{coding}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1820 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1821 If you don't specify this keyword at all, the default |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1822 is to determine the coding systems from the data. |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1823 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1824 @item :noquery @var{query-flag} |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1825 Initialize the process query flag to @var{query-flag}. @xref{Query Before Exit}. |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1826 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1827 @item :filter @var{filter} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1828 Initialize the process filter to @var{filter}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1829 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1830 @item :filter-multibyte @var{bool} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1831 If @var{bool} is non-@code{nil}, strings given to the process filter |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1832 are multibyte, otherwise they are unibyte. If you don't specify this |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1833 keyword at all, the default is that the strings are multibyte if |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1834 @code{default-enable-multibyte-characters} is non-@code{nil}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1835 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1836 @item :sentinel @var{sentinel} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1837 Initialize the process sentinel to @var{sentinel}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1838 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1839 @item :log @var{log} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1840 Initialize the log function of a server process to @var{log}. The log |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1841 function is called each time the server accepts a network connection |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1842 from a client. The arguments passed to the log function are |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1843 @var{server}, @var{connection}, and @var{message}, where @var{server} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1844 is the server process, @var{connection} is the new process for the |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1845 connection, and @var{message} is a string describing what has |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1846 happened. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1847 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1848 @item :plist @var{plist} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1849 Initialize the process plist to @var{plist}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1850 @end table |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1851 |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1852 The following network options can be specified for the network |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1853 process. Except for @code{:reuseaddr}, you can set or modify these |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1854 options later using @code{set-network-process-option}. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1855 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1856 For a server process, the options specified with |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1857 @code{make-network-process} are not inherited by the client |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1858 connections, so you will need to set the necessary options for each |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1859 child connection as they are created. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1860 |
52598
a0ba017ef9ef
(Low-Level Network): Fix typo.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52596
diff
changeset
|
1861 @table @asis |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1862 @item :bindtodevice @var{device-name} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1863 If @var{device-name} is a non-empty string identifying a network |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1864 interface name (see @code{network-interface-list}), only handle |
54777 | 1865 packets received on that interface. If @var{device-name} is @code{nil} |
1866 (the default), handle packets received on any interface. | |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1867 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1868 Using this option may require special privileges on some systems. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1869 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1870 @item :broadcast @var{broadcast-flag} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1871 If @var{broadcast-flag} is non-@code{nil} for a datagram process, the |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1872 process will receive datagram packet sent to a broadcast address, and |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1873 be able to send packets to a broadcast address. Ignored for a stream |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1874 connection. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1875 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1876 @item :dontroute @var{dontroute-flag} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1877 If @var{dontroute-flag} is non-@code{nil}, the process can only send |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1878 to hosts on the same network as the local host. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1879 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1880 @item :keepalive @var{keepalive-flag} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1881 If @var{keepalive-flag} is non-@code{nil} for a stream connection, |
54004
8cc16a7bf4ce
(Low-Level Network): Fix a typo.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53292
diff
changeset
|
1882 enable exchange of low-level keep-alive messages. |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1883 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1884 @item :linger @var{linger-arg} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1885 If @var{linger-arg} is non-@code{nil}, wait for successful |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1886 transmission of all queued packets on the connection before it is |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1887 deleted (see @code{delete-process}). If @var{linger-arg} is an |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1888 integer, it specifies the maximum time in seconds to wait for queued |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1889 packets to be sent before closing the connection. Default is |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1890 @code{nil} which means to discard unsent queued packets when the |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1891 process is deleted. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1892 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1893 @item :oobinline @var{oobinline-flag} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1894 If @var{oobinline-flag} is non-@code{nil} for a stream connection, |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1895 receive out-of-band data in the normal data stream. Otherwise, ignore |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1896 out-of-band data. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1897 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1898 @item :priority @var{priority} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1899 Set the priority for packets sent on this connection to the integer |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1900 @var{priority}. The interpretation of this number is protocol |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1901 specific, such as setting the TOS (type of service) field on IP |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1902 packets sent on this connection. It may also have system dependent |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1903 effects, such as selecting a specific output queue on the network |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1904 interface. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1905 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1906 @item :reuseaddr @var{reuseaddr-flag} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1907 If @var{reuseaddr-flag} is non-@code{nil} (the default) for a stream |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1908 server process, allow this server to reuse a specific port number (see |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1909 @code{:service}) unless another process on this host is already |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1910 listening on that port. If @var{reuseaddr-flag} is @code{nil}, there |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1911 may be a period of time after the last use of that port (by any |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1912 process on the host), where it is not possible to make a new server on |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1913 that port. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1914 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1915 @end table |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1916 |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1917 The original argument list, modified with the actual connection |
54864 | 1918 information, is available via the @code{process-contact} function. |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1919 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1920 |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1921 @defun set-network-process-option process option value |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1922 This function sets or modifies a network option for network process |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1923 @var{process}. See @code{make-network-process} for details of options |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1924 @var{option} and their corresponding values @var{value}. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1925 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1926 The current setting of an option is available via the |
54864 | 1927 @code{process-contact} function. |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1928 @end defun |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1929 |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1930 @defun network-interface-list |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1931 This function returns a list describing the network interfaces |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1932 of the machine you are using. The value is an alist whose |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1933 elements have the form @code{(@var{name} . @var{address})}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1934 @var{address} has the same form as the @var{local-address} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1935 and @var{remote-address} arguments to @code{make-network-process}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1936 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1937 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1938 @defun network-interface-info ifname |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1939 This function returns information about the network interface named |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1940 @var{ifname}. The value is a list of the form @code{(@var{addr} @var{bcast} @var{netmask} @var{hwaddr} @var{flags})}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1941 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1942 @table @var |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1943 @item addr |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1944 The internet protocol address. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1945 @item bcast |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1946 The broadcast address. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1947 @item netmask |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1948 The network mask. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1949 @item hwaddr |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1950 The layer 2 address (Ethernet MAC address, for instance). |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1951 @item flags |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1952 The current flags of the interface. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1953 @end table |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1954 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1955 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1956 @defun format-network-address address &optional omit-port |
52759 | 1957 This function converts the Lisp representation of a network address to |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1958 a string. For example, a five-element vector @code{[@var{a} @var{b} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1959 @var{c} @var{d} @var{p}]} represents an IP address |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1960 @var{a}.@var{b}.@var{c}.@var{d} and port number @var{p}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1961 @code{format-network-address} converts that to the string |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1962 @code{"@var{a}.@var{b}.@var{c}.@var{d}:@var{p}"}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1963 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1964 If @var{omit-port} is non-@code{nil}, the value does not include |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1965 the port number. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1966 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1967 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1968 To test for the availability of a given network feature, use |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1969 @code{featurep} like this: |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1970 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1971 @example |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1972 (featurep 'make-network-process '(@var{keyword} @var{value})) |
56703
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1973 @end example |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1974 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1975 @noindent |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1976 The result of the first form is @code{t} if it works to specify |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1977 @var{keyword} with value @var{value} in @code{make-network-process}. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1978 The result of the second form is @code{t} if @var{keyword} is |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1979 supported by @code{make-network-process}. Here are some of the |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1980 @var{keyword}---@var{value} pairs you can test in |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1981 this way. |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1982 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1983 @table @code |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1984 @item (:nowait t) |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1985 Non-@code{nil} if non-blocking connect is supported. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1986 @item (:type datagram) |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1987 Non-@code{nil} if datagrams are supported. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1988 @item (:family local) |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1989 Non-@code{nil} if local (aka ``UNIX domain'') sockets are supported. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1990 @item (:service t) |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1991 Non-@code{nil} if the system can select the port for a server. |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1992 @end table |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1993 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1994 To test for the availability of a given network option, use |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1995 @code{featurep} like this: |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1996 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1997 @example |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1998 (featurep 'make-network-process '@var{keyword}) |
56703
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1999 @end example |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2000 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2001 Here are some of the option @var{keyword}s you can test in |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2002 this way. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2003 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2004 @table @code |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2005 @item :bindtodevice |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2006 @itemx :broadcast |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2007 @itemx :dontroute |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2008 @itemx :keepalive |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2009 @itemx :linger |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2010 @itemx :oobinline |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2011 @itemx :priority |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2012 @itemx :reuseaddr |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2013 That particular network option is supported by |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2014 @code{make-network-process} and @code{set-network-process-option}. |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2015 @end table |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2016 |
52401 | 2017 @ignore |
2018 arch-tag: ba9da253-e65f-4e7f-b727-08fba0a1df7a | |
2019 @end ignore | |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2020 |