Mercurial > emacs
annotate lispref/processes.texi @ 83809:1b3f6edd2612
Remove term-environment-variable.
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Fri, 31 Aug 2007 07:39:07 +0000 |
parents | f59dca8510d0 |
children | aaccdab0ee26 |
rev | line source |
---|---|
6558 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
75250
6d19c76d81c5
Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents:
75050
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001, |
6d19c76d81c5
Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents:
75050
diff
changeset
|
4 @c 2002, 2003, 2004, 2005, 2006, 2007 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 | |
71957
61cb5aae3bc3
Put period and comma inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71697
diff
changeset
|
26 called a ``process.'' Lisp programs can use this object to communicate |
6558 | 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. |
62245
a9109def6d90
(Processes): Add menu description.
Lute Kamstra <lute@gnu.org>
parents:
62230
diff
changeset
|
52 * Datagrams:: UDP network connections. |
52542
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. |
64913
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
55 * Misc Network:: Additional relevant functions for network connections. |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
56 * Byte Packing:: Using bindat to pack and unpack binary data. |
6558 | 57 @end menu |
58 | |
59 @node Subprocess Creation | |
60 @section Functions that Create Subprocesses | |
61 | |
62 There are three functions that create a new subprocess in which to run | |
63 a program. One of them, @code{start-process}, creates an asynchronous | |
64 process and returns a process object (@pxref{Asynchronous Processes}). | |
65 The other two, @code{call-process} and @code{call-process-region}, | |
66 create a synchronous process and do not return a process object | |
67 (@pxref{Synchronous Processes}). | |
68 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
69 Synchronous and asynchronous processes are explained in the following |
6558 | 70 sections. Since the three functions are all called in a similar |
71 fashion, their common arguments are described here. | |
72 | |
73 @cindex execute program | |
74 @cindex @code{PATH} environment variable | |
75 @cindex @code{HOME} environment variable | |
76 In all cases, the function's @var{program} argument specifies the | |
77 program to be run. An error is signaled if the file is not found or | |
78 cannot be executed. If the file name is relative, the variable | |
79 @code{exec-path} contains a list of directories to search. Emacs | |
80 initializes @code{exec-path} when it starts up, based on the value of | |
81 the environment variable @code{PATH}. The standard file name | |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
82 constructs, @samp{~}, @samp{.}, and @samp{..}, are interpreted as |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
83 usual in @code{exec-path}, but environment variable substitutions |
6558 | 84 (@samp{$HOME}, etc.) are not recognized; use |
85 @code{substitute-in-file-name} to perform them (@pxref{File Name | |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
86 Expansion}). @code{nil} in this list refers to |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
87 @code{default-directory}. |
6558 | 88 |
51922
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
89 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
|
90 name: |
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
91 |
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
92 @defvar exec-suffixes |
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
93 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
|
94 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
|
95 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
|
96 system-dependent. |
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
97 @end defvar |
97cfe6cd3e4f
(Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
98 |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
99 @strong{Please note:} The argument @var{program} contains only the |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
100 name of the program; it may not contain any command-line arguments. You |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
101 must use @var{args} to provide those. |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
102 |
6558 | 103 Each of the subprocess-creating functions has a @var{buffer-or-name} |
104 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
|
105 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
|
106 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
|
107 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
|
108 handles it. (@xref{Filter Functions}, and @ref{Read and Print}.) |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
109 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
|
110 same buffer because their output would be intermixed randomly. |
6558 | 111 |
112 @cindex program arguments | |
113 All three of the subprocess-creating functions have a @code{&rest} | |
114 argument, @var{args}. The @var{args} must all be strings, and they are | |
115 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
|
116 characters and other shell constructs have no special meanings in these |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
117 strings, since the strings are passed directly to the specified program. |
6558 | 118 |
119 The subprocess gets its current directory from the value of | |
120 @code{default-directory} (@pxref{File Name Expansion}). | |
121 | |
122 @cindex environment variables, subprocesses | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
123 The subprocess inherits its environment from Emacs, but you can |
6558 | 124 specify overrides for it with @code{process-environment}. @xref{System |
125 Environment}. | |
126 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46340
diff
changeset
|
127 @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
|
128 @pindex movemail |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
129 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
|
130 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
|
131 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
|
132 Rmail uses it to fetch new mail from an inbox. |
6558 | 133 @end defvar |
134 | |
135 @defopt exec-path | |
136 The value of this variable is a list of directories to search for | |
137 programs to run in subprocesses. Each element is either the name of a | |
138 directory (i.e., a string), or @code{nil}, which stands for the default | |
139 directory (which is the value of @code{default-directory}). | |
140 @cindex program directories | |
141 | |
142 The value of @code{exec-path} is used by @code{call-process} and | |
143 @code{start-process} when the @var{program} argument is not an absolute | |
144 file name. | |
145 @end defopt | |
146 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
147 @node Shell Arguments |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
148 @section Shell Arguments |
76993 | 149 @cindex arguments for shell commands |
150 @cindex shell command arguments | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
151 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
152 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
|
153 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
|
154 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
|
155 gives special treatment to certain characters, and if these characters |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
156 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
|
157 characters, use the function @code{shell-quote-argument}: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
158 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
159 @defun shell-quote-argument argument |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
160 This function returns a string which represents, in shell syntax, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
161 an argument whose actual contents are @var{argument}. It should |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
162 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
|
163 and then pass it to a shell for execution. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
164 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
165 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
|
166 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
|
167 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
|
168 function. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
169 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
170 @example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
171 ;; @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
|
172 (shell-quote-argument "foo > bar") |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
173 @result{} "foo\\ \\>\\ bar" |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
174 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63569
diff
changeset
|
175 ;; @r{This example shows the behavior on MS-DOS and MS-Windows.} |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
176 (shell-quote-argument "foo > bar") |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
177 @result{} "\"foo > bar\"" |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
178 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
179 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
180 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
|
181 a shell command: |
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 @example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
184 (concat "diff -c " |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
185 (shell-quote-argument oldfile) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
186 " " |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
187 (shell-quote-argument newfile)) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
188 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
189 @end defun |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
190 |
6558 | 191 @node Synchronous Processes |
192 @section Creating a Synchronous Process | |
193 @cindex synchronous subprocess | |
194 | |
195 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
|
196 process to terminate before continuing. Starting Dired on GNU or |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
197 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
|
198 @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
|
199 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
|
200 slightly. Because the process is synchronous, the entire directory |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
201 listing arrives in the buffer before Emacs tries to do anything with it. |
6558 | 202 |
203 While Emacs waits for the synchronous subprocess to terminate, the | |
204 user can quit by typing @kbd{C-g}. The first @kbd{C-g} tries to kill | |
205 the subprocess with a @code{SIGINT} signal; but it waits until the | |
206 subprocess actually terminates before quitting. If during that time the | |
207 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
|
208 @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
|
209 other processes doesn't work). @xref{Quitting}. |
6558 | 210 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
211 The synchronous subprocess functions return an indication of how the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
212 process terminated. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
213 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
214 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
|
215 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
|
216 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
|
217 system, much like text written into a file. @xref{Coding Systems}. |
6558 | 218 |
12067 | 219 @defun call-process program &optional infile destination display &rest args |
6558 | 220 This function calls @var{program} in a separate process and waits for |
221 it to finish. | |
222 | |
223 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
|
224 @var{infile} is not @code{nil}, and from the null device otherwise. |
12067 | 225 The argument @var{destination} says where to put the process output. |
226 Here are the possibilities: | |
227 | |
228 @table @asis | |
229 @item a buffer | |
230 Insert the output in that buffer, before point. This includes both the | |
231 standard output stream and the standard error stream of the process. | |
232 | |
233 @item a string | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
234 Insert the output in a buffer with that name, before point. |
12067 | 235 |
236 @item @code{t} | |
237 Insert the output in the current buffer, before point. | |
238 | |
239 @item @code{nil} | |
240 Discard the output. | |
6558 | 241 |
12067 | 242 @item 0 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
243 Discard the output, and return @code{nil} immediately without waiting |
12067 | 244 for the subprocess to finish. |
245 | |
246 In this case, the process is not truly synchronous, since it can run in | |
247 parallel with Emacs; but you can think of it as synchronous in that | |
248 Emacs is essentially finished with the subprocess as soon as this | |
249 function returns. | |
250 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
251 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
|
252 work there. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
253 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
254 @item @code{(@var{real-destination} @var{error-destination})} |
12067 | 255 Keep the standard output stream separate from the standard error stream; |
256 deal with the ordinary output as specified by @var{real-destination}, | |
257 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
|
258 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
|
259 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
|
260 string specifies a file name to redirect error output into. |
12067 | 261 |
262 You can't directly specify a buffer to put the error output in; that is | |
263 too difficult to implement. But you can achieve this result by sending | |
264 the error output to a temporary file and then inserting the file into a | |
265 buffer. | |
266 @end table | |
6558 | 267 |
268 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
|
269 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
|
270 for decoding output is @code{undecided}, meaning deduce the encoding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
271 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
|
272 non-@acronym{ASCII} characters are encountered. There are fundamental |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
273 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
|
274 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
275 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
|
276 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
|
277 buffer in the normal course of events. |
6558 | 278 |
279 The remaining arguments, @var{args}, are strings that specify command | |
280 line arguments for the program. | |
281 | |
282 The value returned by @code{call-process} (unless you told it not to | |
283 wait) indicates the reason for process termination. A number gives the | |
284 exit status of the subprocess; 0 means success, and any other value | |
285 means failure. If the process terminated with a signal, | |
286 @code{call-process} returns a string describing the signal. | |
287 | |
288 In the examples below, the buffer @samp{foo} is current. | |
289 | |
290 @smallexample | |
291 @group | |
292 (call-process "pwd" nil t) | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
293 @result{} 0 |
6558 | 294 |
295 ---------- Buffer: foo ---------- | |
296 /usr/user/lewis/manual | |
297 ---------- Buffer: foo ---------- | |
298 @end group | |
299 | |
300 @group | |
301 (call-process "grep" nil "bar" nil "lewis" "/etc/passwd") | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
302 @result{} 0 |
6558 | 303 |
304 ---------- Buffer: bar ---------- | |
305 lewis:5LTsHm66CSWKg:398:21:Bil Lewis:/user/lewis:/bin/csh | |
306 | |
307 ---------- Buffer: bar ---------- | |
308 @end group | |
309 @end smallexample | |
310 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
311 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
|
312 be found in the definition of @code{insert-directory}: |
6558 | 313 |
314 @smallexample | |
315 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
316 (call-process insert-directory-program nil t nil @var{switches} |
6558 | 317 (if full-directory-p |
318 (concat (file-name-as-directory file) ".") | |
319 file)) | |
320 @end group | |
321 @end smallexample | |
322 @end defun | |
323 | |
57670
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
324 @defun process-file program &optional infile buffer display &rest args |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
325 This function processes files synchronously in a separate process. It |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
326 is similar to @code{call-process} but may invoke a file handler based |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
327 on the value of the variable @code{default-directory}. The current |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
328 working directory of the subprocess is @code{default-directory}. |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
329 |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
330 The arguments are handled in almost the same way as for |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
331 @code{call-process}, with the following differences: |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
332 |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
333 Some file handlers may not support all combinations and forms of the |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
334 arguments @var{infile}, @var{buffer}, and @var{display}. For example, |
58500
6f8c0631e5aa
(Synchronous Processes): Grammar fix.
Richard M. Stallman <rms@gnu.org>
parents:
58405
diff
changeset
|
335 some file handlers might behave as if @var{display} were @code{nil}, |
57670
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
336 regardless of the value actually passed. As another example, some |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
337 file handlers might not support separating standard output and error |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
338 output by way of the @var{buffer} argument. |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
339 |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
340 If a file handler is invoked, it determines the program to run based |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
341 on the first argument @var{program}. For instance, consider that a |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
342 handler for remote files is invoked. Then the path that is used for |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
343 searching the program might be different than @code{exec-path}. |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
344 |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
345 The second argument @var{infile} may invoke a file handler. The file |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
346 handler could be different from the handler chosen for the |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
347 @code{process-file} function itself. (For example, |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
348 @code{default-directory} could be on a remote host, whereas |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
349 @var{infile} is on another remote host. Or @code{default-directory} |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
350 could be non-special, whereas @var{infile} is on a remote host.) |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
351 |
77123 | 352 If @var{buffer} is a list of the form @code{(@var{real-destination} |
57670
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
353 @var{error-destination})}, and @var{error-destination} names a file, |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
354 then the same remarks as for @var{infile} apply. |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
355 |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
356 The remaining arguments (@var{args}) will be passed to the process |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
357 verbatim. Emacs is not involved in processing file names that are |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
358 present in @var{args}. To avoid confusion, it may be best to avoid |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
359 absolute file names in @var{args}, but rather to specify all file |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
360 names as relative to @code{default-directory}. The function |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
361 @code{file-relative-name} is useful for constructing such relative |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
362 file names. |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
363 @end defun |
dd36fc88814a
(Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
56704
diff
changeset
|
364 |
12067 | 365 @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
|
366 This function sends the text from @var{start} to @var{end} as |
6558 | 367 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
|
368 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
|
369 @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
|
370 buffer in place of the input. |
6558 | 371 |
12067 | 372 The arguments @var{destination} and @var{display} control what to do |
6558 | 373 with the output from the subprocess, and whether to update the display |
374 as it comes in. For details, see the description of | |
12067 | 375 @code{call-process}, above. If @var{destination} is the integer 0, |
6558 | 376 @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
|
377 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
|
378 works if asynchronous subprocesses are supported). |
6558 | 379 |
380 The remaining arguments, @var{args}, are strings that specify command | |
381 line arguments for the program. | |
382 | |
383 The return value of @code{call-process-region} is just like that of | |
384 @code{call-process}: @code{nil} if you told it to return without | |
385 waiting; otherwise, a number or string which indicates how the | |
386 subprocess terminated. | |
387 | |
388 In the following example, we use @code{call-process-region} to run the | |
389 @code{cat} utility, with standard input being the first five characters | |
390 in buffer @samp{foo} (the word @samp{input}). @code{cat} copies its | |
391 standard input into its standard output. Since the argument | |
12067 | 392 @var{destination} is @code{t}, this output is inserted in the current |
6558 | 393 buffer. |
394 | |
395 @smallexample | |
396 @group | |
397 ---------- Buffer: foo ---------- | |
398 input@point{} | |
399 ---------- Buffer: foo ---------- | |
400 @end group | |
401 | |
402 @group | |
403 (call-process-region 1 6 "cat" nil t) | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
404 @result{} 0 |
6558 | 405 |
406 ---------- Buffer: foo ---------- | |
407 inputinput@point{} | |
408 ---------- Buffer: foo ---------- | |
409 @end group | |
410 @end smallexample | |
411 | |
412 The @code{shell-command-on-region} command uses | |
413 @code{call-process-region} like this: | |
414 | |
415 @smallexample | |
416 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46340
diff
changeset
|
417 (call-process-region |
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46340
diff
changeset
|
418 start end |
6558 | 419 shell-file-name ; @r{Name of program.} |
420 nil ; @r{Do not delete region.} | |
421 buffer ; @r{Send output to @code{buffer}.} | |
422 nil ; @r{No redisplay during output.} | |
423 "-c" command) ; @r{Arguments for the shell.} | |
424 @end group | |
425 @end smallexample | |
426 @end defun | |
427 | |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
428 @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
|
429 This function executes the shell command @var{command} synchronously |
54265 | 430 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
|
431 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
|
432 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
|
433 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
434 |
82092
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
435 @defun process-file-shell-command command &optional infile destination display &rest args |
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
436 This function is like @code{call-process-shell-command}, but uses |
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
437 @code{process-file} internally. Depending on @code{default-directory}, |
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
438 @var{command} can be executed also on remote hosts. |
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
439 @end defun |
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
440 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
441 @defun shell-command-to-string command |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
442 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
|
443 then returns the command's output as a string. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
444 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
445 |
6558 | 446 @node Asynchronous Processes |
447 @section Creating an Asynchronous Process | |
448 @cindex asynchronous subprocess | |
449 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
450 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
|
451 both continue running immediately. The process thereafter runs |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
452 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
|
453 using the functions described in the following sections. However, |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
454 communication is only partially asynchronous: Emacs sends data to the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
455 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
|
456 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
|
457 delay. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
458 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
459 Here we describe how to create an asynchronous process. |
6558 | 460 |
461 @defun start-process name buffer-or-name program &rest args | |
462 This function creates a new asynchronous subprocess and starts the | |
463 program @var{program} running in it. It returns a process object that | |
464 stands for the new subprocess in Lisp. The argument @var{name} | |
465 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
|
466 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
|
467 etc.) to be unique. The buffer @var{buffer-or-name} is the buffer to |
6558 | 468 associate with the process. |
469 | |
470 The remaining arguments, @var{args}, are strings that specify command | |
471 line arguments for the program. | |
472 | |
473 In the example below, the first process is started and runs (rather, | |
474 sleeps) for 100 seconds. Meanwhile, the second process is started, and | |
475 given the name @samp{my-process<1>} for the sake of uniqueness. It | |
476 inserts the directory listing at the end of the buffer @samp{foo}, | |
477 before the first process finishes. Then it finishes, and a message to | |
478 that effect is inserted in the buffer. Much later, the first process | |
479 finishes, and another message is inserted in the buffer for it. | |
480 | |
481 @smallexample | |
482 @group | |
483 (start-process "my-process" "foo" "sleep" "100") | |
484 @result{} #<process my-process> | |
485 @end group | |
486 | |
487 @group | |
488 (start-process "my-process" "foo" "ls" "-l" "/user/lewis/bin") | |
489 @result{} #<process my-process<1>> | |
490 | |
491 ---------- Buffer: foo ---------- | |
492 total 2 | |
493 lrwxrwxrwx 1 lewis 14 Jul 22 10:12 gnuemacs --> /emacs | |
494 -rwxrwxrwx 1 lewis 19 Jul 30 21:02 lemon | |
495 | |
496 Process my-process<1> finished | |
497 | |
498 Process my-process finished | |
499 ---------- Buffer: foo ---------- | |
500 @end group | |
501 @end smallexample | |
502 @end defun | |
503 | |
81737
326bae23bda1
* process.texi (Asynchronous Processes):
Michael Albinus <michael.albinus@gmx.de>
parents:
77655
diff
changeset
|
504 @defun start-file-process name buffer-or-name program &rest args |
326bae23bda1
* process.texi (Asynchronous Processes):
Michael Albinus <michael.albinus@gmx.de>
parents:
77655
diff
changeset
|
505 Like @code{start-process}, this function starts a new asynchronous |
82406
f59dca8510d0
(Asynchronous Processes): Clarify doc of start-file-process.
Richard M. Stallman <rms@gnu.org>
parents:
82092
diff
changeset
|
506 subprocess running @var{program} in it, and returns its process |
f59dca8510d0
(Asynchronous Processes): Clarify doc of start-file-process.
Richard M. Stallman <rms@gnu.org>
parents:
82092
diff
changeset
|
507 object---when @code{default-directory} is not a magic file name. |
f59dca8510d0
(Asynchronous Processes): Clarify doc of start-file-process.
Richard M. Stallman <rms@gnu.org>
parents:
82092
diff
changeset
|
508 |
f59dca8510d0
(Asynchronous Processes): Clarify doc of start-file-process.
Richard M. Stallman <rms@gnu.org>
parents:
82092
diff
changeset
|
509 If @code{default-directory} is magic, the function invokes its file |
f59dca8510d0
(Asynchronous Processes): Clarify doc of start-file-process.
Richard M. Stallman <rms@gnu.org>
parents:
82092
diff
changeset
|
510 handler instead. This handler ought to run @var{program}, perhaps on |
f59dca8510d0
(Asynchronous Processes): Clarify doc of start-file-process.
Richard M. Stallman <rms@gnu.org>
parents:
82092
diff
changeset
|
511 the local host, perhaps on a remote host that corresponds to |
f59dca8510d0
(Asynchronous Processes): Clarify doc of start-file-process.
Richard M. Stallman <rms@gnu.org>
parents:
82092
diff
changeset
|
512 @code{default-directory}. In the latter case, the local part of |
f59dca8510d0
(Asynchronous Processes): Clarify doc of start-file-process.
Richard M. Stallman <rms@gnu.org>
parents:
82092
diff
changeset
|
513 @code{default-directory} becomes the working directory of the process. |
f59dca8510d0
(Asynchronous Processes): Clarify doc of start-file-process.
Richard M. Stallman <rms@gnu.org>
parents:
82092
diff
changeset
|
514 |
f59dca8510d0
(Asynchronous Processes): Clarify doc of start-file-process.
Richard M. Stallman <rms@gnu.org>
parents:
82092
diff
changeset
|
515 This function does not try to invoke file name handlers for |
f59dca8510d0
(Asynchronous Processes): Clarify doc of start-file-process.
Richard M. Stallman <rms@gnu.org>
parents:
82092
diff
changeset
|
516 @var{program} or for the @var{program-args}. |
81737
326bae23bda1
* process.texi (Asynchronous Processes):
Michael Albinus <michael.albinus@gmx.de>
parents:
77655
diff
changeset
|
517 |
82092
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
518 Depending on the implementation of the file handler, it might not be |
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
519 possible to apply @code{process-filter} or @code{process-sentinel} to |
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
520 the resulting process object (@pxref{Filter Functions}, @pxref{Sentinels}). |
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
521 |
81737
326bae23bda1
* process.texi (Asynchronous Processes):
Michael Albinus <michael.albinus@gmx.de>
parents:
77655
diff
changeset
|
522 Some file handlers may not support @code{start-file-process} (for |
82406
f59dca8510d0
(Asynchronous Processes): Clarify doc of start-file-process.
Richard M. Stallman <rms@gnu.org>
parents:
82092
diff
changeset
|
523 example @code{ange-ftp-hook-function}). In such cases, the function |
f59dca8510d0
(Asynchronous Processes): Clarify doc of start-file-process.
Richard M. Stallman <rms@gnu.org>
parents:
82092
diff
changeset
|
524 does nothing and returns @code{nil}. |
81737
326bae23bda1
* process.texi (Asynchronous Processes):
Michael Albinus <michael.albinus@gmx.de>
parents:
77655
diff
changeset
|
525 @end defun |
326bae23bda1
* process.texi (Asynchronous Processes):
Michael Albinus <michael.albinus@gmx.de>
parents:
77655
diff
changeset
|
526 |
6558 | 527 @defun start-process-shell-command name buffer-or-name command &rest command-args |
528 This function is like @code{start-process} except that it uses a shell | |
529 to execute the specified command. The argument @var{command} is a shell | |
530 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
|
531 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
|
532 use. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
533 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
534 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
|
535 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
|
536 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
|
537 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
|
538 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
|
539 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
|
540 Arguments}. |
6558 | 541 @end defun |
542 | |
82092
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
543 @defun start-file-process-shell-command name buffer-or-name command &rest command-args |
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
544 This function is like @code{start-process-shell-command}, but uses |
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
545 @code{start-file-process} internally. By this, @var{command} can be |
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
546 executed also on remote hosts, depending on @code{default-directory}. |
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
547 @end defun |
38bfa1de0aca
* processes.texi (Synchronous Processes): Add
Michael Albinus <michael.albinus@gmx.de>
parents:
81737
diff
changeset
|
548 |
6558 | 549 @defvar process-connection-type |
550 @cindex pipes | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
551 @cindex @acronym{PTY}s |
6558 | 552 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
|
553 asynchronous subprocesses. If it is non-@code{nil}, then @acronym{PTY}s are |
12098 | 554 used, when available. Otherwise, pipes are used. |
6558 | 555 |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
556 @acronym{PTY}s are usually preferable for processes visible to the user, as |
6558 | 557 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
|
558 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
|
559 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
|
560 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
|
561 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
|
562 it is good not to waste them. |
6558 | 563 |
46340
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
564 The value of @code{process-connection-type} takes effect when |
6558 | 565 @code{start-process} is called. So you can specify how to communicate |
566 with one subprocess by binding the variable around the call to | |
567 @code{start-process}. | |
568 | |
569 @smallexample | |
570 @group | |
571 (let ((process-connection-type nil)) ; @r{Use a pipe.} | |
572 (start-process @dots{})) | |
573 @end group | |
574 @end smallexample | |
12067 | 575 |
576 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
|
577 @acronym{PTY}, use the function @code{process-tty-name} (@pxref{Process |
12067 | 578 Information}). |
6558 | 579 @end defvar |
580 | |
581 @node Deleting Processes | |
582 @section Deleting Processes | |
583 @cindex deleting processes | |
584 | |
585 @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
|
586 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
|
587 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
|
588 at any time. If you delete a terminated process explicitly before it |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
589 is deleted automatically, no harm results. Deleting a running |
46340
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
590 process sends a signal to terminate it (and its child processes if |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
591 any), and calls the process sentinel if it has one. @xref{Sentinels}. |
6558 | 592 |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
593 When a process is deleted, the process object itself continues to |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
594 exist as long as other Lisp objects point to it. All the Lisp |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
595 primitives that work on process objects accept deleted processes, but |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
596 those that do I/O or send signals will report an error. The process |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
597 mark continues to point to the same place as before, usually into a |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
598 buffer where output from the process was being inserted. |
6558 | 599 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
600 @defopt delete-exited-processes |
6558 | 601 This variable controls automatic deletion of processes that have |
602 terminated (due to calling @code{exit} or to a signal). If it is | |
603 @code{nil}, then they continue to exist until the user runs | |
604 @code{list-processes}. Otherwise, they are deleted immediately after | |
605 they exit. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
606 @end defopt |
6558 | 607 |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
608 @defun delete-process process |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
609 This function deletes a process, killing it with a @code{SIGKILL} |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
610 signal. The argument may be a process, the name of a process, a |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
611 buffer, or the name of a buffer. (A buffer or buffer-name stands for |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
612 the process that @code{get-buffer-process} returns.) Calling |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
613 @code{delete-process} on a running process terminates it, updates the |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
614 process status, and runs the sentinel (if any) immediately. If the |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
615 process has already terminated, calling @code{delete-process} has no |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
616 effect on its status, or on the running of its sentinel (which will |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
617 happen sooner or later). |
6558 | 618 |
619 @smallexample | |
620 @group | |
621 (delete-process "*shell*") | |
622 @result{} nil | |
623 @end group | |
624 @end smallexample | |
625 @end defun | |
626 | |
627 @node Process Information | |
628 @section Process Information | |
629 | |
630 Several functions return information about processes. | |
631 @code{list-processes} is provided for interactive use. | |
632 | |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
633 @deffn Command list-processes &optional query-only |
6558 | 634 This command displays a listing of all living processes. In addition, |
635 it finally deletes any process whose status was @samp{Exited} or | |
636 @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
|
637 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
638 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
|
639 whose query flag is non-@code{nil}. @xref{Query Before Exit}. |
6558 | 640 @end deffn |
641 | |
642 @defun process-list | |
643 This function returns a list of all processes that have not been deleted. | |
644 | |
645 @smallexample | |
646 @group | |
647 (process-list) | |
648 @result{} (#<process display-time> #<process shell>) | |
649 @end group | |
650 @end smallexample | |
651 @end defun | |
652 | |
653 @defun get-process name | |
654 This function returns the process named @var{name}, or @code{nil} if | |
655 there is none. An error is signaled if @var{name} is not a string. | |
656 | |
657 @smallexample | |
658 @group | |
659 (get-process "shell") | |
660 @result{} #<process shell> | |
661 @end group | |
662 @end smallexample | |
663 @end defun | |
664 | |
665 @defun process-command process | |
666 This function returns the command that was executed to start | |
667 @var{process}. This is a list of strings, the first string being the | |
668 program executed and the rest of the strings being the arguments that | |
669 were given to the program. | |
670 | |
671 @smallexample | |
672 @group | |
673 (process-command (get-process "shell")) | |
674 @result{} ("/bin/csh" "-i") | |
675 @end group | |
676 @end smallexample | |
677 @end defun | |
678 | |
679 @defun process-id process | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
680 This function returns the @acronym{PID} of @var{process}. This is an |
9009 | 681 integer that distinguishes the process @var{process} from all other |
6558 | 682 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
|
683 @acronym{PID} of a process is chosen by the operating system kernel when the |
6558 | 684 process is started and remains constant as long as the process exists. |
685 @end defun | |
686 | |
687 @defun process-name process | |
688 This function returns the name of @var{process}. | |
689 @end defun | |
690 | |
691 @defun process-status process-name | |
692 This function returns the status of @var{process-name} as a symbol. | |
693 The argument @var{process-name} must be a process, a buffer, a | |
694 process name (string) or a buffer name (string). | |
695 | |
696 The possible values for an actual subprocess are: | |
697 | |
698 @table @code | |
699 @item run | |
700 for a process that is running. | |
701 @item stop | |
702 for a process that is stopped but continuable. | |
703 @item exit | |
704 for a process that has exited. | |
705 @item signal | |
706 for a process that has received a fatal signal. | |
707 @item open | |
708 for a network connection that is open. | |
709 @item closed | |
710 for a network connection that is closed. Once a connection | |
711 is closed, you cannot reopen it, though you might be able to open | |
712 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
|
713 @item connect |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
714 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
|
715 @item failed |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
716 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
|
717 @item listen |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
718 for a network server that is listening. |
6558 | 719 @item nil |
720 if @var{process-name} is not the name of an existing process. | |
721 @end table | |
722 | |
723 @smallexample | |
724 @group | |
725 (process-status "shell") | |
726 @result{} run | |
727 @end group | |
728 @group | |
729 (process-status (get-buffer "*shell*")) | |
730 @result{} run | |
731 @end group | |
732 @group | |
733 x | |
734 @result{} #<process xx<1>> | |
735 (process-status x) | |
736 @result{} exit | |
737 @end group | |
738 @end smallexample | |
739 | |
740 For a network connection, @code{process-status} returns one of the symbols | |
741 @code{open} or @code{closed}. The latter means that the other side | |
742 closed the connection, or Emacs did @code{delete-process}. | |
743 @end defun | |
744 | |
745 @defun process-exit-status process | |
746 This function returns the exit status of @var{process} or the signal | |
747 number that killed it. (Use the result of @code{process-status} to | |
748 determine which of those it is.) If @var{process} has not yet | |
749 terminated, the value is 0. | |
750 @end defun | |
751 | |
12067 | 752 @defun process-tty-name process |
753 This function returns the terminal name that @var{process} is using for | |
754 its communication with Emacs---or @code{nil} if it is using pipes | |
755 instead of a terminal (see @code{process-connection-type} in | |
756 @ref{Asynchronous Processes}). | |
757 @end defun | |
758 | |
56215 | 759 @defun process-coding-system process |
53292
5408fe43d709
(Process Information): Add anchor.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
760 @anchor{Coding systems for a subprocess} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
761 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
|
762 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
|
763 @var{process} (@pxref{Coding Systems}). The value has this form: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
764 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
765 @example |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
766 (@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
|
767 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
768 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
769 |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
770 @defun set-process-coding-system process &optional decoding-system encoding-system |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
771 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
|
772 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
|
773 decode subprocess output, and @var{encoding-system} to encode subprocess |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
774 input. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
775 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
776 |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
777 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
|
778 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
|
779 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
780 @defun process-get process propname |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
781 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
|
782 of @var{process}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
783 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
784 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
785 @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
|
786 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
|
787 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
|
788 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
789 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
790 @defun process-plist process |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
791 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
|
792 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
793 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
794 @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
|
795 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
|
796 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
797 |
6558 | 798 @node Input to Processes |
799 @section Sending Input to Processes | |
800 @cindex process input | |
801 | |
802 Asynchronous subprocesses receive input when it is sent to them by | |
803 Emacs, which is done with the functions in this section. You must | |
804 specify the process to send input to, and the input data to send. The | |
805 data appears on the ``standard input'' of the subprocess. | |
806 | |
807 Some operating systems have limited space for buffered input in a | |
63560 | 808 @acronym{PTY}. On these systems, Emacs sends an @acronym{EOF} |
809 periodically amidst the other characters, to force them through. For | |
810 most programs, these @acronym{EOF}s do no harm. | |
6558 | 811 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
812 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
|
813 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
|
814 @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
|
815 (@pxref{Process Information}). Otherwise, the coding system comes from |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
816 @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
|
817 the defaulting mechanism (@pxref{Default Coding Systems}). |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
818 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
819 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
|
820 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
|
821 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
|
822 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
|
823 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
|
824 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
|
825 |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
826 In these functions, the @var{process} argument can be a process or |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
827 the name of a process, or a buffer or buffer name (which stands |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
828 for a process via @code{get-buffer-process}). @code{nil} means |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
829 the current buffer's process. |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
830 |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
831 @defun process-send-string process string |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
832 This function sends @var{process} the contents of @var{string} as |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
833 standard input. If it is @code{nil}, the current buffer's process is used. |
6558 | 834 |
835 The function returns @code{nil}. | |
836 | |
837 @smallexample | |
838 @group | |
839 (process-send-string "shell<1>" "ls\n") | |
840 @result{} nil | |
841 @end group | |
842 | |
843 | |
844 @group | |
845 ---------- Buffer: *shell* ---------- | |
846 ... | |
847 introduction.texi syntax-tables.texi~ | |
848 introduction.texi~ text.texi | |
849 introduction.txt text.texi~ | |
850 ... | |
851 ---------- Buffer: *shell* ---------- | |
852 @end group | |
853 @end smallexample | |
854 @end defun | |
855 | |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
856 @defun process-send-region process start end |
6558 | 857 This function sends the text in the region defined by @var{start} and |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
858 @var{end} as standard input to @var{process}. |
6558 | 859 |
860 An error is signaled unless both @var{start} and @var{end} are | |
861 integers or markers that indicate positions in the current buffer. (It | |
862 is unimportant which number is larger.) | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
863 @end defun |
6558 | 864 |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
865 @defun process-send-eof &optional process |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
866 This function makes @var{process} see an end-of-file in its |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52830
diff
changeset
|
867 input. The @acronym{EOF} comes after any text already sent to it. |
6558 | 868 |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
869 The function returns @var{process}. |
6558 | 870 |
871 @smallexample | |
872 @group | |
873 (process-send-eof "shell") | |
874 @result{} "shell" | |
875 @end group | |
876 @end smallexample | |
877 @end defun | |
878 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
879 @defun process-running-child-p process |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
880 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
|
881 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
|
882 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
|
883 that this is not so. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
884 @end defun |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
885 |
6558 | 886 @node Signals to Processes |
887 @section Sending Signals to Processes | |
888 @cindex process signals | |
889 @cindex sending signals | |
890 @cindex signals | |
891 | |
892 @dfn{Sending a signal} to a subprocess is a way of interrupting its | |
893 activities. There are several different signals, each with its own | |
894 meaning. The set of signals and their names is defined by the operating | |
895 system. For example, the signal @code{SIGINT} means that the user has | |
896 typed @kbd{C-c}, or that some analogous thing has happened. | |
897 | |
898 Each signal has a standard effect on the subprocess. Most signals | |
899 kill the subprocess, but some stop or resume execution instead. Most | |
900 signals can optionally be handled by programs; if the program handles | |
901 the signal, then we can say nothing in general about its effects. | |
902 | |
903 You can send signals explicitly by calling the functions in this | |
904 section. Emacs also sends signals automatically at certain times: | |
905 killing a buffer sends a @code{SIGHUP} signal to all its associated | |
906 processes; killing Emacs sends a @code{SIGHUP} signal to all remaining | |
907 processes. (@code{SIGHUP} is a signal that usually indicates that the | |
908 user hung up the phone.) | |
909 | |
910 Each of the signal-sending functions takes two optional arguments: | |
62229
789b9a24928a
(Signals to Processes): Fix typo.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
60270
diff
changeset
|
911 @var{process} and @var{current-group}. |
6558 | 912 |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
913 The argument @var{process} must be either a process, a process |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
914 name, a buffer, a buffer name, or @code{nil}. A buffer or buffer name |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
915 stands for a process through @code{get-buffer-process}. @code{nil} |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
916 stands for the process associated with the current buffer. An error |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
917 is signaled if @var{process} does not identify a process. |
6558 | 918 |
919 The argument @var{current-group} is a flag that makes a difference | |
920 when you are running a job-control shell as an Emacs subprocess. If it | |
921 is non-@code{nil}, then the signal is sent to the current process-group | |
9009 | 922 of the terminal that Emacs uses to communicate with the subprocess. If |
6558 | 923 the process is a job-control shell, this means the shell's current |
924 subjob. If it is @code{nil}, the signal is sent to the process group of | |
925 the immediate subprocess of Emacs. If the subprocess is a job-control | |
926 shell, this is the shell itself. | |
927 | |
928 The flag @var{current-group} has no effect when a pipe is used to | |
929 communicate with the subprocess, because the operating system does not | |
930 support the distinction in the case of pipes. For the same reason, | |
931 job-control shells won't work when a pipe is used. See | |
932 @code{process-connection-type} in @ref{Asynchronous Processes}. | |
933 | |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
934 @defun interrupt-process &optional process current-group |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
935 This function interrupts the process @var{process} by sending the |
6558 | 936 signal @code{SIGINT}. Outside of Emacs, typing the ``interrupt |
937 character'' (normally @kbd{C-c} on some systems, and @code{DEL} on | |
938 others) sends this signal. When the argument @var{current-group} is | |
939 non-@code{nil}, you can think of this function as ``typing @kbd{C-c}'' | |
940 on the terminal by which Emacs talks to the subprocess. | |
941 @end defun | |
942 | |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
943 @defun kill-process &optional process current-group |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
944 This function kills the process @var{process} by sending the |
6558 | 945 signal @code{SIGKILL}. This signal kills the subprocess immediately, |
946 and cannot be handled by the subprocess. | |
947 @end defun | |
948 | |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
949 @defun quit-process &optional process current-group |
6558 | 950 This function sends the signal @code{SIGQUIT} to the process |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
951 @var{process}. This signal is the one sent by the ``quit |
6558 | 952 character'' (usually @kbd{C-b} or @kbd{C-\}) when you are not inside |
953 Emacs. | |
954 @end defun | |
955 | |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
956 @defun stop-process &optional process current-group |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
957 This function stops the process @var{process} by sending the |
6558 | 958 signal @code{SIGTSTP}. Use @code{continue-process} to resume its |
959 execution. | |
960 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
961 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
|
962 (usually @kbd{C-z}) normally sends this signal. When |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
963 @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
|
964 ``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
|
965 subprocess. |
6558 | 966 @end defun |
967 | |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
968 @defun continue-process &optional process current-group |
6558 | 969 This function resumes execution of the process @var{process} by sending |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
970 it the signal @code{SIGCONT}. This presumes that @var{process} was |
6558 | 971 stopped previously. |
972 @end defun | |
973 | |
974 @c Emacs 19 feature | |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
975 @defun signal-process process signal |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
976 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
|
977 @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
|
978 |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
979 The @var{process} argument can be a system process @acronym{ID}; that |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
980 allows you to send signals to processes that are not children of |
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
981 Emacs. |
6558 | 982 @end defun |
983 | |
984 @node Output from Processes | |
985 @section Receiving Output from Processes | |
986 @cindex process output | |
987 @cindex output from processes | |
988 | |
989 There are two ways to receive the output that a subprocess writes to | |
990 its standard output stream. The output can be inserted in a buffer, | |
991 which is called the associated buffer of the process, or a function | |
9009 | 992 called the @dfn{filter function} can be called to act on the output. If |
993 the process has no buffer and no filter function, its output is | |
994 discarded. | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46340
diff
changeset
|
995 |
46340
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
996 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
|
997 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
|
998 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
|
999 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
|
1000 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1001 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
|
1002 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
|
1003 (@pxref{Waiting}), and in @code{accept-process-output} (@pxref{Accepting |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1004 Output}). This minimizes the problem of timing errors that usually |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1005 plague parallel programming. For example, you can safely create a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1006 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
|
1007 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
|
1008 primitive that waits. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1009 |
56704
900340a218c9
(Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents:
56703
diff
changeset
|
1010 @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
|
1011 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
|
1012 output data is read in very small blocks, potentially resulting in |
63560 | 1013 very poor performance. This behavior can be remedied to some extent |
56704
900340a218c9
(Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents:
56703
diff
changeset
|
1014 by setting the variable @var{process-adaptive-read-buffering} to a |
58405
4fe765649696
(Synchronous Processes, Output from Processes):
Jesper Harder <harder@ifa.au.dk>
parents:
57670
diff
changeset
|
1015 non-@code{nil} value (the default), as it will automatically delay reading |
56704
900340a218c9
(Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents:
56703
diff
changeset
|
1016 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
|
1017 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
|
1018 @end defvar |
900340a218c9
(Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents:
56703
diff
changeset
|
1019 |
27259
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1020 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
|
1021 streams of the subprocess, because Emacs normally spawns the subprocess |
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1022 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
|
1023 you want to keep the output to those streams separate, you should |
54916 | 1024 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
|
1025 shell command. |
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1026 |
6558 | 1027 @menu |
51993
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1028 * 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
|
1029 * Filter Functions:: Filter functions accept output from the process. |
51994 | 1030 * 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
|
1031 * Accepting Output:: How to wait until process output arrives. |
6558 | 1032 @end menu |
1033 | |
1034 @node Process Buffers | |
1035 @subsection Process Buffers | |
1036 | |
1037 A process can (and usually does) have an @dfn{associated buffer}, | |
1038 which is an ordinary Emacs buffer that is used for two purposes: storing | |
1039 the output from the process, and deciding when to kill the process. You | |
1040 can also use the buffer to identify a process to operate on, since in | |
1041 normal practice only one process is associated with any given buffer. | |
1042 Many applications of processes also use the buffer for editing input to | |
1043 be sent to the process, but this is not built into Emacs Lisp. | |
1044 | |
1045 Unless the process has a filter function (@pxref{Filter Functions}), | |
1046 its output is inserted in the associated buffer. The position to insert | |
9009 | 1047 the output is determined by the @code{process-mark}, which is then |
1048 updated to point to the end of the text just inserted. Usually, but not | |
1049 always, the @code{process-mark} is at the end of the buffer. | |
6558 | 1050 |
1051 @defun process-buffer process | |
1052 This function returns the associated buffer of the process | |
1053 @var{process}. | |
1054 | |
1055 @smallexample | |
1056 @group | |
1057 (process-buffer (get-process "shell")) | |
1058 @result{} #<buffer *shell*> | |
1059 @end group | |
1060 @end smallexample | |
1061 @end defun | |
1062 | |
1063 @defun process-mark process | |
1064 This function returns the process marker for @var{process}, which is the | |
1065 marker that says where to insert output from the process. | |
1066 | |
1067 If @var{process} does not have a buffer, @code{process-mark} returns a | |
1068 marker that points nowhere. | |
1069 | |
1070 Insertion of process output in a buffer uses this marker to decide where | |
1071 to insert, and updates it to point after the inserted text. That is why | |
1072 successive batches of output are inserted consecutively. | |
1073 | |
1074 Filter functions normally should use this marker in the same fashion | |
1075 as is done by direct insertion of output in the buffer. A good | |
1076 example of a filter function that uses @code{process-mark} is found at | |
1077 the end of the following section. | |
1078 | |
1079 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
|
1080 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
|
1081 from previous output. |
6558 | 1082 @end defun |
1083 | |
1084 @defun set-process-buffer process buffer | |
1085 This function sets the buffer associated with @var{process} to | |
1086 @var{buffer}. If @var{buffer} is @code{nil}, the process becomes | |
1087 associated with no buffer. | |
1088 @end defun | |
1089 | |
1090 @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
|
1091 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
|
1092 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
|
1093 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
|
1094 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
|
1095 (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
|
1096 return. |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1097 |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1098 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
|
1099 the same buffer. |
6558 | 1100 |
1101 @smallexample | |
1102 @group | |
1103 (get-buffer-process "*shell*") | |
1104 @result{} #<process shell> | |
1105 @end group | |
1106 @end smallexample | |
1107 | |
1108 Killing the process's buffer deletes the process, which kills the | |
1109 subprocess with a @code{SIGHUP} signal (@pxref{Signals to Processes}). | |
1110 @end defun | |
1111 | |
1112 @node Filter Functions | |
1113 @subsection Process Filter Functions | |
1114 @cindex filter function | |
1115 @cindex process filter | |
1116 | |
1117 A process @dfn{filter function} is a function that receives the | |
1118 standard output from the associated process. If a process has a filter, | |
9009 | 1119 then @emph{all} output from that process is passed to the filter. The |
1120 process buffer is used directly for output from the process only when | |
1121 there is no filter. | |
6558 | 1122 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1123 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
|
1124 something, because process output arrives only at such times. Emacs |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1125 waits when reading terminal input, in @code{sit-for} and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1126 @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
|
1127 (@pxref{Accepting Output}). |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1128 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1129 A filter function must accept two arguments: the associated process |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1130 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
|
1131 then free to do whatever it chooses with the output. |
6558 | 1132 |
1133 Quitting is normally inhibited within a filter function---otherwise, | |
1134 the effect of typing @kbd{C-g} at command level or to quit a user | |
66152
6677034b52bb
(Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents:
64913
diff
changeset
|
1135 command would be unpredictable. If you want to permit quitting inside |
6677034b52bb
(Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents:
64913
diff
changeset
|
1136 a filter function, bind @code{inhibit-quit} to @code{nil}. In most |
6677034b52bb
(Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents:
64913
diff
changeset
|
1137 cases, the right way to do this is with the macro |
6677034b52bb
(Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents:
64913
diff
changeset
|
1138 @code{with-local-quit}. @xref{Quitting}. |
6558 | 1139 |
12067 | 1140 If an error happens during execution of a filter function, it is |
1141 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
|
1142 program was running when the filter function was started. However, if |
12067 | 1143 @code{debug-on-error} is non-@code{nil}, the error-catching is turned |
1144 off. This makes it possible to use the Lisp debugger to debug the | |
1145 filter function. @xref{Debugger}. | |
1146 | |
6558 | 1147 Many filter functions sometimes or always insert the text in the |
1148 process's buffer, mimicking the actions of Emacs when there is no | |
1149 filter. Such filter functions need to use @code{set-buffer} in order to | |
1150 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
|
1151 semipermanently, these filter functions must save and restore the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1152 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
|
1153 cases update the value of point. Here is how to do these things: |
6558 | 1154 |
1155 @smallexample | |
1156 @group | |
1157 (defun ordinary-insertion-filter (proc string) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1158 (with-current-buffer (process-buffer proc) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1159 (let ((moving (= (point) (process-mark proc)))) |
6558 | 1160 @end group |
1161 @group | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1162 (save-excursion |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1163 ;; @r{Insert the text, advancing the process marker.} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1164 (goto-char (process-mark proc)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1165 (insert string) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1166 (set-marker (process-mark proc) (point))) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1167 (if moving (goto-char (process-mark proc)))))) |
6558 | 1168 @end group |
1169 @end smallexample | |
1170 | |
1171 @noindent | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1172 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
|
1173 @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
|
1174 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
|
1175 @code{goto-char}. |
6558 | 1176 |
1177 To make the filter force the process buffer to be visible whenever new | |
1178 text arrives, insert the following line just before the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1179 @code{with-current-buffer} construct: |
6558 | 1180 |
1181 @smallexample | |
1182 (display-buffer (process-buffer proc)) | |
1183 @end smallexample | |
1184 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1185 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
|
1186 previously, eliminate the variable @code{moving} and call |
6558 | 1187 @code{goto-char} unconditionally. |
1188 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1189 In earlier Emacs versions, every filter function that did regular |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1190 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
|
1191 match data. Now Emacs does this automatically for filter functions; |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1192 they never need to do it explicitly. @xref{Match Data}. |
6558 | 1193 |
1194 A filter function that writes the output into the buffer of the | |
12098 | 1195 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
|
1196 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
|
1197 @code{(buffer-name (process-buffer @var{process}))} returns @code{nil} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1198 if the buffer is dead. |
6558 | 1199 |
1200 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
|
1201 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
|
1202 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
|
1203 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
|
1204 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
|
1205 or more batches of output. |
6558 | 1206 |
1207 @defun set-process-filter process filter | |
1208 This function gives @var{process} the filter function @var{filter}. If | |
1209 @var{filter} is @code{nil}, it gives the process no filter. | |
1210 @end defun | |
1211 | |
1212 @defun process-filter process | |
1213 This function returns the filter function of @var{process}, or @code{nil} | |
1214 if it has none. | |
1215 @end defun | |
1216 | |
1217 Here is an example of use of a filter function: | |
1218 | |
1219 @smallexample | |
1220 @group | |
1221 (defun keep-output (process output) | |
1222 (setq kept (cons output kept))) | |
1223 @result{} keep-output | |
1224 @end group | |
1225 @group | |
1226 (setq kept nil) | |
1227 @result{} nil | |
1228 @end group | |
1229 @group | |
1230 (set-process-filter (get-process "shell") 'keep-output) | |
1231 @result{} keep-output | |
1232 @end group | |
1233 @group | |
1234 (process-send-string "shell" "ls ~/other\n") | |
1235 @result{} nil | |
1236 kept | |
1237 @result{} ("lewis@@slug[8] % " | |
1238 @end group | |
1239 @group | |
1240 "FINAL-W87-SHORT.MSS backup.otl kolstad.mss~ | |
1241 address.txt backup.psf kolstad.psf | |
1242 backup.bib~ david.mss resume-Dec-86.mss~ | |
1243 backup.err david.psf resume-Dec.psf | |
1244 backup.mss dland syllabus.mss | |
1245 " | |
1246 "#backups.mss# backup.mss~ kolstad.mss | |
1247 ") | |
1248 @end group | |
1249 @end smallexample | |
1250 | |
1251 @ignore @c The code in this example doesn't show the right way to do things. | |
1252 Here is another, more realistic example, which demonstrates how to use | |
1253 the process mark to do insertion in the same fashion as is done when | |
1254 there is no filter function: | |
1255 | |
1256 @smallexample | |
1257 @group | |
1258 ;; @r{Insert input in the buffer specified by @code{my-shell-buffer}} | |
1259 ;; @r{and make sure that buffer is shown in some window.} | |
1260 (defun my-process-filter (proc str) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1261 (let ((cur (selected-window)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1262 (pop-up-windows t)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1263 (pop-to-buffer my-shell-buffer) |
6558 | 1264 @end group |
1265 @group | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1266 (goto-char (point-max)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1267 (insert str) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1268 (set-marker (process-mark proc) (point-max)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1269 (select-window cur))) |
6558 | 1270 @end group |
1271 @end smallexample | |
1272 @end ignore | |
1273 | |
51993
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1274 @node Decoding Output |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1275 @subsection Decoding Process Output |
76835 | 1276 @cindex decode process output |
51993
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1277 |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1278 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
|
1279 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
|
1280 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
|
1281 converts the unibyte output to multibyte using |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
1282 @code{string-to-multibyte}, and inserts the resulting multibyte text. |
51993
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1283 |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1284 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
|
1285 system to use (@pxref{Process Information}). Otherwise, the coding |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1286 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
|
1287 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
|
1288 Coding Systems}). |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1289 |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1290 @strong{Warning:} Coding systems such as @code{undecided} which |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1291 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
|
1292 reliably with asynchronous subprocess output. This is because Emacs |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1293 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
|
1294 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
|
1295 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
|
1296 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
|
1297 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
|
1298 @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
|
1299 |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1300 @cindex filter multibyte flag, of process |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1301 @cindex process filter multibyte flag |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1302 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
|
1303 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
|
1304 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
|
1305 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
|
1306 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
|
1307 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
|
1308 no decoding, and passes that. |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1309 |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1310 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
|
1311 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
|
1312 want to change the flag later on, use |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1313 @code{set-process-filter-multibyte}. |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1314 |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1315 @defun set-process-filter-multibyte process multibyte |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1316 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
|
1317 to @var{multibyte}. |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1318 @end defun |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1319 |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1320 @defun process-filter-multibyte-p process |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1321 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
|
1322 @end defun |
d99e407c0a21
(Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents:
51922
diff
changeset
|
1323 |
6558 | 1324 @node Accepting Output |
1325 @subsection Accepting Output from Processes | |
76835 | 1326 @cindex accept input from processes |
6558 | 1327 |
1328 Output from asynchronous subprocesses normally arrives only while | |
1329 Emacs is waiting for some sort of external event, such as elapsed time | |
1330 or terminal input. Occasionally it is useful in a Lisp program to | |
1331 explicitly permit output to arrive at a specific point, or even to wait | |
1332 until output arrives from a process. | |
1333 | |
77655
61d6d08c1ecf
(Accepting Output): Revert most of previous change.
Richard M. Stallman <rms@gnu.org>
parents:
77648
diff
changeset
|
1334 @defun accept-process-output &optional process seconds millisec just-this-one |
6558 | 1335 This function allows Emacs to read pending output from processes. The |
1336 output is inserted in the associated buffers or given to their filter | |
1337 functions. If @var{process} is non-@code{nil} then this function does | |
1338 not return until some output has been received from @var{process}. | |
1339 | |
1340 @c Emacs 19 feature | |
77655
61d6d08c1ecf
(Accepting Output): Revert most of previous change.
Richard M. Stallman <rms@gnu.org>
parents:
77648
diff
changeset
|
1341 The arguments @var{seconds} and @var{millisec} let you specify timeout |
6558 | 1342 periods. The former specifies a period measured in seconds and the |
77655
61d6d08c1ecf
(Accepting Output): Revert most of previous change.
Richard M. Stallman <rms@gnu.org>
parents:
77648
diff
changeset
|
1343 latter specifies one measured in milliseconds. The two time periods |
6558 | 1344 thus specified are added together, and @code{accept-process-output} |
77648
5fac150d631b
(Accepting Output): accept-process-output
Richard M. Stallman <rms@gnu.org>
parents:
77123
diff
changeset
|
1345 returns after that much time, whether or not there has been any |
6558 | 1346 subprocess output. |
81737
326bae23bda1
* process.texi (Asynchronous Processes):
Michael Albinus <michael.albinus@gmx.de>
parents:
77655
diff
changeset
|
1347 |
77655
61d6d08c1ecf
(Accepting Output): Revert most of previous change.
Richard M. Stallman <rms@gnu.org>
parents:
77648
diff
changeset
|
1348 The argument @var{millisec} is semi-obsolete nowadays because |
77648
5fac150d631b
(Accepting Output): accept-process-output
Richard M. Stallman <rms@gnu.org>
parents:
77123
diff
changeset
|
1349 @var{seconds} can be a floating point number to specify waiting a |
5fac150d631b
(Accepting Output): accept-process-output
Richard M. Stallman <rms@gnu.org>
parents:
77123
diff
changeset
|
1350 fractional number of seconds. If @var{seconds} is 0, the function |
5fac150d631b
(Accepting Output): accept-process-output
Richard M. Stallman <rms@gnu.org>
parents:
77123
diff
changeset
|
1351 accepts whatever output is pending but does not wait. |
6558 | 1352 |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
58500
diff
changeset
|
1353 @c Emacs 22.1 feature |
56703
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1354 If @var{process} is a process, and the argument @var{just-this-one} is |
58405
4fe765649696
(Synchronous Processes, Output from Processes):
Jesper Harder <harder@ifa.au.dk>
parents:
57670
diff
changeset
|
1355 non-@code{nil}, only output from that process is handled, suspending output |
56703
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1356 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
|
1357 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
|
1358 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
|
1359 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
|
1360 speech synthesis. |
fdf8546f215b
(Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents:
56215
diff
changeset
|
1361 |
6558 | 1362 The function @code{accept-process-output} returns non-@code{nil} if it |
1363 did get some output, or @code{nil} if the timeout expired before output | |
1364 arrived. | |
1365 @end defun | |
1366 | |
1367 @node Sentinels | |
1368 @section Sentinels: Detecting Process Status Changes | |
1369 @cindex process sentinel | |
76993 | 1370 @cindex sentinel (of process) |
6558 | 1371 |
1372 A @dfn{process sentinel} is a function that is called whenever the | |
1373 associated process changes status for any reason, including signals | |
1374 (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
|
1375 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
|
1376 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
|
1377 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
|
1378 describing the type of event. |
6558 | 1379 |
1380 The string describing the event looks like one of the following: | |
1381 | |
1382 @itemize @bullet | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46340
diff
changeset
|
1383 @item |
6558 | 1384 @code{"finished\n"}. |
1385 | |
1386 @item | |
1387 @code{"exited abnormally with code @var{exitcode}\n"}. | |
1388 | |
1389 @item | |
1390 @code{"@var{name-of-signal}\n"}. | |
1391 | |
1392 @item | |
1393 @code{"@var{name-of-signal} (core dumped)\n"}. | |
1394 @end itemize | |
1395 | |
44345
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1396 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
|
1397 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
|
1398 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
|
1399 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
|
1400 sentinels will run, by calling @code{sit-for} or @code{sleep-for} |
9009 | 1401 (@pxref{Waiting}), or @code{accept-process-output} (@pxref{Accepting |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1402 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
|
1403 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
|
1404 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
|
1405 |
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1406 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
|
1407 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
|
1408 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
|
1409 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
|
1410 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
|
1411 because the process status can't change again after termination. |
6558 | 1412 |
66152
6677034b52bb
(Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents:
64913
diff
changeset
|
1413 Emacs explicitly checks for output from the process before running |
6677034b52bb
(Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents:
64913
diff
changeset
|
1414 the process sentinel. Once the sentinel runs due to process |
6677034b52bb
(Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents:
64913
diff
changeset
|
1415 termination, no further output can arrive from the process. |
6558 | 1416 |
1417 A sentinel that writes the output into the buffer of the process | |
12098 | 1418 should check whether the buffer is still alive. If it tries to insert |
6558 | 1419 into a dead buffer, it will get an error. If the buffer is dead, |
1420 @code{(buffer-name (process-buffer @var{process}))} returns @code{nil}. | |
1421 | |
66152
6677034b52bb
(Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents:
64913
diff
changeset
|
1422 Quitting is normally inhibited within a sentinel---otherwise, the |
6677034b52bb
(Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents:
64913
diff
changeset
|
1423 effect of typing @kbd{C-g} at command level or to quit a user command |
6677034b52bb
(Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents:
64913
diff
changeset
|
1424 would be unpredictable. If you want to permit quitting inside a |
6677034b52bb
(Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents:
64913
diff
changeset
|
1425 sentinel, bind @code{inhibit-quit} to @code{nil}. In most cases, the |
6677034b52bb
(Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents:
64913
diff
changeset
|
1426 right way to do this is with the macro @code{with-local-quit}. |
6677034b52bb
(Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents:
64913
diff
changeset
|
1427 @xref{Quitting}. |
6677034b52bb
(Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents:
64913
diff
changeset
|
1428 |
12067 | 1429 If an error happens during execution of a sentinel, it is caught |
1430 automatically, so that it doesn't stop the execution of whatever | |
1431 programs was running when the sentinel was started. However, if | |
1432 @code{debug-on-error} is non-@code{nil}, the error-catching is turned | |
1433 off. This makes it possible to use the Lisp debugger to debug the | |
1434 sentinel. @xref{Debugger}. | |
1435 | |
44428
7e1a0877a121
Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents:
44345
diff
changeset
|
1436 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
|
1437 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
|
1438 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
|
1439 a new sentinel. |
7e1a0877a121
Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents:
44345
diff
changeset
|
1440 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1441 In earlier Emacs versions, every sentinel that did regular expression |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1442 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
|
1443 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
|
1444 it explicitly. @xref{Match Data}. |
12098 | 1445 |
6558 | 1446 @defun set-process-sentinel process sentinel |
1447 This function associates @var{sentinel} with @var{process}. If | |
1448 @var{sentinel} is @code{nil}, then the process will have no sentinel. | |
1449 The default behavior when there is no sentinel is to insert a message in | |
1450 the process's buffer when the process status changes. | |
1451 | |
44345
d2f43521efb4
New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents:
39426
diff
changeset
|
1452 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
|
1453 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
|
1454 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
|
1455 |
6558 | 1456 @smallexample |
1457 @group | |
1458 (defun msg-me (process event) | |
1459 (princ | |
1460 (format "Process: %s had the event `%s'" process event))) | |
1461 (set-process-sentinel (get-process "shell") 'msg-me) | |
1462 @result{} msg-me | |
1463 @end group | |
1464 @group | |
1465 (kill-process (get-process "shell")) | |
1466 @print{} Process: #<process shell> had the event `killed' | |
1467 @result{} #<process shell> | |
1468 @end group | |
1469 @end smallexample | |
1470 @end defun | |
1471 | |
1472 @defun process-sentinel process | |
1473 This function returns the sentinel of @var{process}, or @code{nil} if it | |
1474 has none. | |
1475 @end defun | |
1476 | |
1477 @defun waiting-for-user-input-p | |
1478 While a sentinel or filter function is running, this function returns | |
1479 non-@code{nil} if Emacs was waiting for keyboard input from the user at | |
1480 the time the sentinel or filter function was called, @code{nil} if it | |
1481 was not. | |
1482 @end defun | |
1483 | |
46340
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1484 @node Query Before Exit |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46340
diff
changeset
|
1485 @section Querying Before Exit |
46340
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1486 |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1487 When Emacs exits, it terminates all its subprocesses by sending them |
60270
b87ad571b7a8
(Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
1488 the @code{SIGHUP} signal. Because subprocesses may be doing |
46340
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1489 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
|
1490 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
|
1491 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
|
1492 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
|
1493 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
|
1494 |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1495 @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
|
1496 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
|
1497 @end defun |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1498 |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1499 @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
|
1500 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
|
1501 returns @var{flag}. |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1502 |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1503 @smallexample |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1504 @group |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1505 ;; @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
|
1506 (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
|
1507 @result{} t |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1508 @end group |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1509 @end smallexample |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1510 @end defun |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1511 |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1512 @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
|
1513 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
|
1514 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
|
1515 |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1516 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
|
1517 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
|
1518 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
|
1519 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
|
1520 @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
|
1521 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
|
1522 is like this: |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1523 |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1524 @smallexample |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1525 @group |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1526 ;; @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
|
1527 (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
|
1528 @end group |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1529 @end smallexample |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1530 @end defun |
dd413d2af8ad
Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents:
44428
diff
changeset
|
1531 |
6558 | 1532 @node Transaction Queues |
1533 @section Transaction Queues | |
1534 @cindex transaction queue | |
1535 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1536 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
|
1537 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
|
1538 queue communicating with a specified process. Then you can call |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17611
diff
changeset
|
1539 @code{tq-enqueue} to send a transaction. |
6558 | 1540 |
1541 @defun tq-create process | |
1542 This function creates and returns a transaction queue communicating with | |
1543 @var{process}. The argument @var{process} should be a subprocess | |
1544 capable of sending and receiving streams of bytes. It may be a child | |
9009 | 1545 process, or it may be a TCP connection to a server, possibly on another |
6558 | 1546 machine. |
1547 @end defun | |
1548 | |
70034
db4c2d467e9a
Revision: emacs@sv.gnu.org/emacs--devo--0--patch-220
Miles Bader <miles@gnu.org>
parents:
69708
diff
changeset
|
1549 @defun tq-enqueue queue question regexp closure fn &optional delay-question |
6558 | 1550 This function sends a transaction to queue @var{queue}. Specifying the |
1551 queue has the effect of specifying the subprocess to talk to. | |
1552 | |
9009 | 1553 The argument @var{question} is the outgoing message that starts the |
6558 | 1554 transaction. The argument @var{fn} is the function to call when the |
1555 corresponding answer comes back; it is called with two arguments: | |
1556 @var{closure}, and the answer received. | |
1557 | |
39426
4520697c8aa5
(tq-enqueue): Clarify meaning of REGEXP.
Richard M. Stallman <rms@gnu.org>
parents:
27370
diff
changeset
|
1558 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
|
1559 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
|
1560 @code{tq-enqueue} determines where the answer ends. |
6558 | 1561 |
70034
db4c2d467e9a
Revision: emacs@sv.gnu.org/emacs--devo--0--patch-220
Miles Bader <miles@gnu.org>
parents:
69708
diff
changeset
|
1562 If the argument @var{delay-question} is non-nil, delay sending this |
db4c2d467e9a
Revision: emacs@sv.gnu.org/emacs--devo--0--patch-220
Miles Bader <miles@gnu.org>
parents:
69708
diff
changeset
|
1563 question until the process has finished replying to any previous |
72548
e5542d6aad7f
Miscellaneous tq-related fixes.
Miles Bader <miles@gnu.org>
parents:
72010
diff
changeset
|
1564 questions. This produces more reliable results with some processes. |
70034
db4c2d467e9a
Revision: emacs@sv.gnu.org/emacs--devo--0--patch-220
Miles Bader <miles@gnu.org>
parents:
69708
diff
changeset
|
1565 |
6558 | 1566 The return value of @code{tq-enqueue} itself is not meaningful. |
1567 @end defun | |
1568 | |
1569 @defun tq-close queue | |
1570 Shut down transaction queue @var{queue}, waiting for all pending transactions | |
1571 to complete, and then terminate the connection or child process. | |
1572 @end defun | |
1573 | |
1574 Transaction queues are implemented by means of a filter function. | |
1575 @xref{Filter Functions}. | |
1576 | |
12098 | 1577 @node Network |
1578 @section Network Connections | |
1579 @cindex network connection | |
6558 | 1580 @cindex TCP |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1581 @cindex UDP |
6558 | 1582 |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1583 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
|
1584 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
|
1585 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
|
1586 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
|
1587 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
|
1588 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
|
1589 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
|
1590 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
|
1591 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
|
1592 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1593 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
|
1594 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
|
1595 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
|
1596 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
|
1597 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
|
1598 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
|
1599 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
|
1600 back to listening for more connection requests. |
6558 | 1601 |
52818
39239421c7e3
(Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents:
52759
diff
changeset
|
1602 Network connections and servers are created by calling |
39239421c7e3
(Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents:
52759
diff
changeset
|
1603 @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
|
1604 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
|
1605 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
|
1606 connection. @xref{Low-Level Network}, for details. You can also use |
63560 | 1607 the @code{open-network-stream} function described below. |
52818
39239421c7e3
(Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents:
52759
diff
changeset
|
1608 |
6558 | 1609 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
|
1610 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
|
1611 @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
|
1612 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
|
1613 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
|
1614 @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
|
1615 subprocess. @xref{Process Information}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1616 |
54265 | 1617 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
|
1618 @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
|
1619 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
|
1620 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
|
1621 can increase this limit, unless it is imposed by the operating |
64720 | 1622 system.) 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
|
1623 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
|
1624 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
|
1625 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
|
1626 @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
|
1627 server is stopped; a non-@code{nil} value means yes. |
6558 | 1628 |
1629 @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
|
1630 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
|
1631 that represents the connection. |
6558 | 1632 |
1633 The @var{name} argument specifies the name for the process object. It | |
1634 is modified as necessary to make it unique. | |
1635 | |
1636 The @var{buffer-or-name} argument is the buffer to associate with the | |
1637 connection. Output from the connection is inserted in the buffer, | |
1638 unless you specify a filter function to handle the output. If | |
1639 @var{buffer-or-name} is @code{nil}, it means that the connection is not | |
1640 associated with any buffer. | |
1641 | |
1642 The arguments @var{host} and @var{service} specify where to connect to; | |
1643 @var{host} is the host name (a string), and @var{service} is the name of | |
1644 a defined network service (a string) or a port number (an integer). | |
1645 @end defun | |
52401 | 1646 |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1647 @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
|
1648 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
|
1649 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
|
1650 @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
|
1651 connected to. |
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 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
|
1654 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
|
1655 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
|
1656 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
|
1657 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1658 @table @code |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1659 @item :buffer |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1660 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
|
1661 @item :filter |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1662 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
|
1663 @item :sentinel |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1664 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
|
1665 @item :remote |
76922 | 1666 In a connection, the address in internal format of the remote peer. |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1667 @item :local |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1668 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
|
1669 @item :service |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1670 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
|
1671 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
|
1672 @end table |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1673 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1674 @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
|
1675 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
|
1676 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1677 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
|
1678 to that keyword. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1679 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1680 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
|
1681 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1682 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1683 @node Network Servers |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1684 @section Network Servers |
76835 | 1685 @cindex network servers |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1686 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1687 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
|
1688 @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
|
1689 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
|
1690 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
|
1691 parameters: |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1692 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1693 @itemize @bullet |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1694 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1695 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
|
1696 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
|
1697 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
|
1698 @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
|
1699 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
|
1700 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
|
1701 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1702 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1703 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
|
1704 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
|
1705 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
|
1706 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
|
1707 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1708 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
|
1709 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
|
1710 inserting text there. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1711 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1712 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1713 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
|
1714 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
|
1715 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
|
1716 connections made to the server. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1717 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1718 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1719 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
|
1720 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
|
1721 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
|
1722 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
|
1723 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1724 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1725 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
|
1726 number used for the connection. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1727 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1728 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1729 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
|
1730 @end itemize |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1731 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1732 @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
|
1733 @section Datagrams |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1734 @cindex datagrams |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1735 |
54265 | 1736 A datagram connection communicates with individual packets rather |
1737 than streams of data. Each call to @code{process-send} sends one | |
1738 datagram packet (@pxref{Input to Processes}), and each datagram | |
1739 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
|
1740 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1741 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
|
1742 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
|
1743 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
|
1744 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
|
1745 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
|
1746 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
|
1747 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
|
1748 @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
|
1749 @code{set-process-datagram-address}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1750 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1751 @defun process-datagram-address process |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1752 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
|
1753 returns its remote peer address. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1754 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1755 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1756 @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
|
1757 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
|
1758 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
|
1759 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1760 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1761 @node Low-Level Network |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1762 @section Low-Level Network Access |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1763 |
64913
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1764 You can also create network connections by operating at a lower |
76878 | 1765 level than that of @code{open-network-stream}, using |
64913
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1766 @code{make-network-process}. |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1767 |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1768 @menu |
72010
248521aae95b
(Low-Level Network): Make menu more convenient.
Richard M. Stallman <rms@gnu.org>
parents:
71999
diff
changeset
|
1769 * Proc: Network Processes. Using @code{make-network-process}. |
248521aae95b
(Low-Level Network): Make menu more convenient.
Richard M. Stallman <rms@gnu.org>
parents:
71999
diff
changeset
|
1770 * Options: Network Options. Further control over network connections. |
248521aae95b
(Low-Level Network): Make menu more convenient.
Richard M. Stallman <rms@gnu.org>
parents:
71999
diff
changeset
|
1771 * Features: Network Feature Testing. |
248521aae95b
(Low-Level Network): Make menu more convenient.
Richard M. Stallman <rms@gnu.org>
parents:
71999
diff
changeset
|
1772 Determining which network features work on |
64913
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1773 the machine you are using. |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1774 @end menu |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1775 |
71999
77f1713977dd
(Low-Level Network): Rename node "Make Network"
Kim F. Storm <storm@cua.dk>
parents:
71957
diff
changeset
|
1776 @node Network Processes |
64913
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1777 @subsection @code{make-network-process} |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1778 |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1779 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
|
1780 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
|
1781 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
|
1782 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1783 @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
|
1784 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
|
1785 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
|
1786 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
|
1787 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
|
1788 @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
|
1789 are the meaningful keywords: |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1790 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1791 @table @asis |
62230
98c45ed7ca3f
(Low-Level Network): Fix typo.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
62229
diff
changeset
|
1792 @item :name @var{name} |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1793 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
|
1794 necessary to make it unique. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1795 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1796 @item :type @var{type} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1797 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
|
1798 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
|
1799 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
|
1800 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1801 @item :server @var{server-flag} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1802 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
|
1803 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
|
1804 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
|
1805 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
|
1806 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1807 @item :host @var{host} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1808 Specify the host to connect to. @var{host} should be a host name or |
70603 | 1809 Internet address, as a string, or the symbol @code{local} to specify |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1810 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
|
1811 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
|
1812 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
|
1813 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1814 @item :service @var{service} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1815 @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
|
1816 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
|
1817 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
|
1818 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
|
1819 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
|
1820 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1821 @item :family @var{family} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1822 @var{family} specifies the address (and protocol) family for |
68029
61a03413f18b
(Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
68010
diff
changeset
|
1823 communication. @code{nil} means determine the proper address family |
61a03413f18b
(Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
68010
diff
changeset
|
1824 automatically for the given @var{host} and @var{service}. |
61a03413f18b
(Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
68010
diff
changeset
|
1825 @code{local} specifies a Unix socket, in which case @var{host} is |
61a03413f18b
(Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
68010
diff
changeset
|
1826 ignored. @code{ipv4} and @code{ipv6} specify to use IPv4 and IPv6 |
61a03413f18b
(Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
68010
diff
changeset
|
1827 respectively. |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1828 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1829 @item :local @var{local-address} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1830 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
|
1831 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
|
1832 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
|
1833 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1834 @item :remote @var{remote-address} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1835 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
|
1836 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
|
1837 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
|
1838 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1839 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
|
1840 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
|
1841 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1842 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
|
1843 the address family: |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1844 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1845 @itemize - |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1846 @item |
68009
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
1847 An IPv4 address is represented as a five-element vector of four 8-bit |
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
1848 integers and one 16-bit integer |
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
1849 @code{[@var{a} @var{b} @var{c} @var{d} @var{p}]} corresponding to |
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
1850 numeric IPv4 address @var{a}.@var{b}.@var{c}.@var{d} and port number |
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
1851 @var{p}. |
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
1852 |
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
1853 @item |
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
1854 An IPv6 address is represented as a nine-element vector of 16-bit |
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
1855 integers @code{[@var{a} @var{b} @var{c} @var{d} @var{e} @var{f} |
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
1856 @var{g} @var{h} @var{p}]} corresponding to numeric IPv6 address |
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
1857 @var{a}:@var{b}:@var{c}:@var{d}:@var{e}:@var{f}:@var{g}:@var{h} and |
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
1858 port number @var{p}. |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1859 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1860 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1861 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
|
1862 in the local address space. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1863 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1864 @item |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1865 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
|
1866 @code{(@var{f} . @var{av})}, where @var{f} is the family number and |
54265 | 1867 @var{av} is a vector specifying the socket address using one element |
1868 per address data byte. Do not rely on this format in portable code, | |
1869 as it may depend on implementation defined constants, data sizes, and | |
1870 data structure alignment. | |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1871 @end itemize |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1872 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1873 @item :nowait @var{bool} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1874 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
|
1875 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
|
1876 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
|
1877 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
|
1878 @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
|
1879 @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
|
1880 has succeeded or failed. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1881 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1882 @item :stop @var{stopped} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1883 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
|
1884 @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
|
1885 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1886 @item :buffer @var{buffer} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1887 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
|
1888 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1889 @item :coding @var{coding} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1890 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
|
1891 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
|
1892 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
|
1893 @var{encoding})} for @var{coding}. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1894 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1895 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
|
1896 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
|
1897 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1898 @item :noquery @var{query-flag} |
63560 | 1899 Initialize the process query flag to @var{query-flag}. |
1900 @xref{Query Before Exit}. | |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1901 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1902 @item :filter @var{filter} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1903 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
|
1904 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1905 @item :filter-multibyte @var{bool} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1906 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
|
1907 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
|
1908 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
|
1909 @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
|
1910 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1911 @item :sentinel @var{sentinel} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1912 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
|
1913 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1914 @item :log @var{log} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1915 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
|
1916 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
|
1917 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
|
1918 @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
|
1919 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
|
1920 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
|
1921 happened. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1922 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1923 @item :plist @var{plist} |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1924 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
|
1925 @end table |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
1926 |
64913
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1927 The original argument list, modified with the actual connection |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1928 information, is available via the @code{process-contact} function. |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1929 @end defun |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1930 |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1931 @node Network Options |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1932 @subsection Network Options |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1933 |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1934 The following network options can be specified when you create a |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1935 network process. Except for @code{:reuseaddr}, you can also set or |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1936 modify these options later, using @code{set-network-process-option}. |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1937 |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1938 For a server process, the options specified with |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1939 @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
|
1940 connections, so you will need to set the necessary options for each |
64913
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
1941 child connection as it is created. |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1942 |
52598
a0ba017ef9ef
(Low-Level Network): Fix typo.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52596
diff
changeset
|
1943 @table @asis |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1944 @item :bindtodevice @var{device-name} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1945 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
|
1946 interface name (see @code{network-interface-list}), only handle |
54777 | 1947 packets received on that interface. If @var{device-name} is @code{nil} |
1948 (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
|
1949 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1950 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
|
1951 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1952 @item :broadcast @var{broadcast-flag} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1953 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
|
1954 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
|
1955 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
|
1956 connection. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1957 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1958 @item :dontroute @var{dontroute-flag} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1959 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
|
1960 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
|
1961 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1962 @item :keepalive @var{keepalive-flag} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1963 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
|
1964 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
|
1965 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1966 @item :linger @var{linger-arg} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1967 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
|
1968 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
|
1969 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
|
1970 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
|
1971 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
|
1972 @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
|
1973 process is deleted. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1974 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1975 @item :oobinline @var{oobinline-flag} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1976 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
|
1977 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
|
1978 out-of-band data. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1979 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1980 @item :priority @var{priority} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1981 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
|
1982 @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
|
1983 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
|
1984 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
|
1985 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
|
1986 interface. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1987 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1988 @item :reuseaddr @var{reuseaddr-flag} |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1989 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
|
1990 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
|
1991 @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
|
1992 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
|
1993 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
|
1994 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
|
1995 that port. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1996 @end table |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1997 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1998 @defun set-network-process-option process option value |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
1999 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
|
2000 @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
|
2001 @var{option} and their corresponding values @var{value}. |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2002 |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2003 The current setting of an option is available via the |
54864 | 2004 @code{process-contact} function. |
52596
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2005 @end defun |
f277840b17b2
(Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents:
52542
diff
changeset
|
2006 |
64913
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2007 @node Network Feature Testing |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2008 @subsection Testing Availability of Network Features |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2009 |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2010 To test for the availability of a given network feature, use |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2011 @code{featurep} like this: |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2012 |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2013 @example |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2014 (featurep 'make-network-process '(@var{keyword} @var{value})) |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2015 @end example |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2016 |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2017 @noindent |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2018 The result of the first form is @code{t} if it works to specify |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2019 @var{keyword} with value @var{value} in @code{make-network-process}. |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2020 The result of the second form is @code{t} if @var{keyword} is |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2021 supported by @code{make-network-process}. Here are some of the |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2022 @var{keyword}---@var{value} pairs you can test in |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2023 this way. |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2024 |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2025 @table @code |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2026 @item (:nowait t) |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2027 Non-@code{nil} if non-blocking connect is supported. |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2028 @item (:type datagram) |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2029 Non-@code{nil} if datagrams are supported. |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2030 @item (:family local) |
70603 | 2031 Non-@code{nil} if local (a.k.a.@: ``UNIX domain'') sockets are supported. |
68009
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
2032 @item (:family ipv6) |
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
2033 Non-@code{nil} if IPv6 is supported. |
64913
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2034 @item (:service t) |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2035 Non-@code{nil} if the system can select the port for a server. |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2036 @end table |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2037 |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2038 To test for the availability of a given network option, use |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2039 @code{featurep} like this: |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2040 |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2041 @example |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2042 (featurep 'make-network-process '@var{keyword}) |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2043 @end example |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2044 |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2045 @noindent |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2046 Here are some of the options you can test in this way. |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2047 |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2048 @table @code |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2049 @item :bindtodevice |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2050 @itemx :broadcast |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2051 @itemx :dontroute |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2052 @itemx :keepalive |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2053 @itemx :linger |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2054 @itemx :oobinline |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2055 @itemx :priority |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2056 @itemx :reuseaddr |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2057 That particular network option is supported by |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2058 @code{make-network-process} and @code{set-network-process-option}. |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2059 @end table |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2060 |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2061 @node Misc Network |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2062 @section Misc Network Facilities |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2063 |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2064 These additional functions are useful for creating and operating |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2065 on network connections. |
989a5fc8da03
(Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
2066 |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2067 @defun network-interface-list |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2068 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
|
2069 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
|
2070 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
|
2071 @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
|
2072 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
|
2073 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2074 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2075 @defun network-interface-info ifname |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2076 This function returns information about the network interface named |
63560 | 2077 @var{ifname}. The value is a list of the form |
2078 @code{(@var{addr} @var{bcast} @var{netmask} @var{hwaddr} @var{flags})}. | |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2079 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2080 @table @var |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2081 @item addr |
70603 | 2082 The Internet protocol address. |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2083 @item bcast |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2084 The broadcast address. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2085 @item netmask |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2086 The network mask. |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2087 @item hwaddr |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2088 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
|
2089 @item flags |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2090 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
|
2091 @end table |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2092 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2093 |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2094 @defun format-network-address address &optional omit-port |
52759 | 2095 This function converts the Lisp representation of a network address to |
68009
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
2096 a string. |
68029
61a03413f18b
(Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
68010
diff
changeset
|
2097 |
61a03413f18b
(Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
68010
diff
changeset
|
2098 A five-element vector @code{[@var{a} @var{b} @var{c} @var{d} @var{p}]} |
61a03413f18b
(Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
68010
diff
changeset
|
2099 represents an IPv4 address @var{a}.@var{b}.@var{c}.@var{d} and port |
61a03413f18b
(Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
68010
diff
changeset
|
2100 number @var{p}. @code{format-network-address} converts that to the |
61a03413f18b
(Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
68010
diff
changeset
|
2101 string @code{"@var{a}.@var{b}.@var{c}.@var{d}:@var{p}"}. |
61a03413f18b
(Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
68010
diff
changeset
|
2102 |
61a03413f18b
(Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
68010
diff
changeset
|
2103 A nine-element vector @code{[@var{a} @var{b} @var{c} @var{d} @var{e} |
77123 | 2104 @var{f} @var{g} @var{h} @var{p}]} represents an IPv6 address along |
2105 with a port number. @code{format-network-address} converts that to | |
2106 the string | |
68009
dd865bff7357
(Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents:
67044
diff
changeset
|
2107 @code{"[@var{a}:@var{b}:@var{c}:@var{d}:@var{e}:@var{f}:@var{g}:@var{h}]:@var{p}"}. |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2108 |
68029
61a03413f18b
(Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
68010
diff
changeset
|
2109 If the vector does not include the port number, @var{p}, or if |
61a03413f18b
(Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
68010
diff
changeset
|
2110 @var{omit-port} is non-@code{nil}, the result does not include the |
61a03413f18b
(Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
68010
diff
changeset
|
2111 @code{:@var{p}} suffix. |
52542
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2112 @end defun |
0df4c5163e4e
(Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2113 |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2114 @node Byte Packing |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2115 @section Packing and Unpacking Byte Arrays |
76833 | 2116 @cindex byte packing and unpacking |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2117 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2118 This section describes how to pack and unpack arrays of bytes, |
63563
c78918330811
(Byte Packing): Fix ungrammatical sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
63562
diff
changeset
|
2119 usually for binary network protocols. These functions convert byte arrays |
c78918330811
(Byte Packing): Fix ungrammatical sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
63562
diff
changeset
|
2120 to alists, and vice versa. The byte array can be represented as a |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2121 unibyte string or as a vector of integers, while the alist associates |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2122 symbols either with fixed-size objects or with recursive sub-alists. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2123 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2124 @cindex serializing |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2125 @cindex deserializing |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2126 @cindex packing |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2127 @cindex unpacking |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2128 Conversion from byte arrays to nested alists is also known as |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2129 @dfn{deserializing} or @dfn{unpacking}, while going in the opposite |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2130 direction is also known as @dfn{serializing} or @dfn{packing}. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2131 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2132 @menu |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2133 * Bindat Spec:: Describing data layout. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2134 * Bindat Functions:: Doing the unpacking and packing. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2135 * Bindat Examples:: Samples of what bindat.el can do for you! |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2136 @end menu |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2137 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2138 @node Bindat Spec |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2139 @subsection Describing Data Layout |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2140 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2141 To control unpacking and packing, you write a @dfn{data layout |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2142 specification}, a special nested list describing named and typed |
63568 | 2143 @dfn{fields}. This specification controls length of each field to be |
72723
e32b692e4da5
(Bindat Spec): Suggest names ending in -bindat-spec.
Richard M. Stallman <rms@gnu.org>
parents:
72640
diff
changeset
|
2144 processed, and how to pack or unpack it. We normally keep bindat specs |
e32b692e4da5
(Bindat Spec): Suggest names ending in -bindat-spec.
Richard M. Stallman <rms@gnu.org>
parents:
72640
diff
changeset
|
2145 in variables whose names end in @samp{-bindat-spec}; that kind of name |
e32b692e4da5
(Bindat Spec): Suggest names ending in -bindat-spec.
Richard M. Stallman <rms@gnu.org>
parents:
72640
diff
changeset
|
2146 is automatically recognized as ``risky.'' |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2147 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2148 @cindex endianness |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2149 @cindex big endian |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2150 @cindex little endian |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2151 @cindex network byte ordering |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2152 A field's @dfn{type} describes the size (in bytes) of the object |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2153 that the field represents and, in the case of multibyte fields, how |
63560 | 2154 the bytes are ordered within the field. The two possible orderings |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2155 are ``big endian'' (also known as ``network byte ordering'') and |
71957
61cb5aae3bc3
Put period and comma inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71697
diff
changeset
|
2156 ``little endian.'' For instance, the number @code{#x23cd} (decimal |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2157 9165) in big endian would be the two bytes @code{#x23} @code{#xcd}; |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2158 and in little endian, @code{#xcd} @code{#x23}. Here are the possible |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2159 type values: |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2160 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2161 @table @code |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2162 @item u8 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2163 @itemx byte |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2164 Unsigned byte, with length 1. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2165 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2166 @item u16 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2167 @itemx word |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2168 @itemx short |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2169 Unsigned integer in network byte order, with length 2. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2170 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2171 @item u24 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2172 Unsigned integer in network byte order, with length 3. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2173 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2174 @item u32 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2175 @itemx dword |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2176 @itemx long |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2177 Unsigned integer in network byte order, with length 4. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2178 Note: These values may be limited by Emacs' integer implementation limits. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2179 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2180 @item u16r |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2181 @itemx u24r |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2182 @itemx u32r |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2183 Unsigned integer in little endian order, with length 2, 3 and 4, respectively. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2184 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2185 @item str @var{len} |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2186 String of length @var{len}. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2187 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2188 @item strz @var{len} |
74952
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2189 Zero-terminated string, in a fixed-size field with length @var{len}. |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2190 |
75987
9012e6e12d0e
(Bindat Spec): Vector types can have optional element type.
Kim F. Storm <storm@cua.dk>
parents:
75250
diff
changeset
|
2191 @item vec @var{len} [@var{type}] |
9012e6e12d0e
(Bindat Spec): Vector types can have optional element type.
Kim F. Storm <storm@cua.dk>
parents:
75250
diff
changeset
|
2192 Vector of @var{len} elements of type @var{type}, or bytes if not |
9012e6e12d0e
(Bindat Spec): Vector types can have optional element type.
Kim F. Storm <storm@cua.dk>
parents:
75250
diff
changeset
|
2193 @var{type} is specified. |
9012e6e12d0e
(Bindat Spec): Vector types can have optional element type.
Kim F. Storm <storm@cua.dk>
parents:
75250
diff
changeset
|
2194 The @var{type} is any of the simple types above, or another vector |
9012e6e12d0e
(Bindat Spec): Vector types can have optional element type.
Kim F. Storm <storm@cua.dk>
parents:
75250
diff
changeset
|
2195 specified as a list @code{(vec @var{len} [@var{type}])}. |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2196 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2197 @item ip |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2198 Four-byte vector representing an Internet address. For example: |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2199 @code{[127 0 0 1]} for localhost. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2200 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2201 @item bits @var{len} |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2202 List of set bits in @var{len} bytes. The bytes are taken in big |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2203 endian order and the bits are numbered starting with @code{8 * |
63560 | 2204 @var{len} @minus{} 1} and ending with zero. For example: @code{bits |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2205 2} unpacks @code{#x28} @code{#x1c} to @code{(2 3 4 11 13)} and |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2206 @code{#x1c} @code{#x28} to @code{(3 5 10 11 12)}. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2207 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2208 @item (eval @var{form}) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2209 @var{form} is a Lisp expression evaluated at the moment the field is |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2210 unpacked or packed. The result of the evaluation should be one of the |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2211 above-listed type specifications. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2212 @end table |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2213 |
74970
d278931df0dd
(Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents:
74952
diff
changeset
|
2214 For a fixed-size field, the length @var{len} is given as an integer |
d278931df0dd
(Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents:
74952
diff
changeset
|
2215 specifying the number of bytes in the field. |
d278931df0dd
(Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents:
74952
diff
changeset
|
2216 |
d278931df0dd
(Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents:
74952
diff
changeset
|
2217 When the length of a field is not fixed, it typically depends on the |
d278931df0dd
(Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents:
74952
diff
changeset
|
2218 value of a preceding field. In this case, the length @var{len} can be |
d278931df0dd
(Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents:
74952
diff
changeset
|
2219 given either as a list @code{(@var{name} ...)} identifying a |
d278931df0dd
(Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents:
74952
diff
changeset
|
2220 @dfn{field name} in the format specified for @code{bindat-get-field} |
d278931df0dd
(Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents:
74952
diff
changeset
|
2221 below, or by an expression @code{(eval @var{form})} where @var{form} |
d278931df0dd
(Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents:
74952
diff
changeset
|
2222 should evaluate to an integer, specifying the field length. |
74952
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2223 |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2224 A field specification generally has the form @code{([@var{name}] |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2225 @var{handler})}. The square braces indicate that @var{name} is |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2226 optional. (Don't use names that are symbols meaningful as type |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2227 specifications (above) or handler specifications (below), since that |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2228 would be ambiguous.) @var{name} can be a symbol or the expression |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2229 @code{(eval @var{form})}, in which case @var{form} should evaluate to |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2230 a symbol. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2231 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2232 @var{handler} describes how to unpack or pack the field and can be one |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2233 of the following: |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2234 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2235 @table @code |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2236 @item @var{type} |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2237 Unpack/pack this field according to the type specification @var{type}. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2238 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2239 @item eval @var{form} |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2240 Evaluate @var{form}, a Lisp expression, for side-effect only. If the |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2241 field name is specified, the value is bound to that field name. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2242 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2243 @item fill @var{len} |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2244 Skip @var{len} bytes. In packing, this leaves them unchanged, |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2245 which normally means they remain zero. In unpacking, this means |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2246 they are ignored. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2247 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2248 @item align @var{len} |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2249 Skip to the next multiple of @var{len} bytes. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2250 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2251 @item struct @var{spec-name} |
63560 | 2252 Process @var{spec-name} as a sub-specification. This describes a |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2253 structure nested within another structure. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2254 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2255 @item union @var{form} (@var{tag} @var{spec})@dots{} |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2256 @c ??? I don't see how one would actually use this. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2257 @c ??? what kind of expression would be useful for @var{form}? |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2258 Evaluate @var{form}, a Lisp expression, find the first @var{tag} |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2259 that matches it, and process its associated data layout specification |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2260 @var{spec}. Matching can occur in one of three ways: |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2261 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2262 @itemize |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2263 @item |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2264 If a @var{tag} has the form @code{(eval @var{expr})}, evaluate |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2265 @var{expr} with the variable @code{tag} dynamically bound to the value |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2266 of @var{form}. A non-@code{nil} result indicates a match. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2267 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2268 @item |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2269 @var{tag} matches if it is @code{equal} to the value of @var{form}. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2270 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2271 @item |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2272 @var{tag} matches unconditionally if it is @code{t}. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2273 @end itemize |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2274 |
71394
4b4feab31516
(Bindat Spec): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71035
diff
changeset
|
2275 @item repeat @var{count} @var{field-specs}@dots{} |
4b4feab31516
(Bindat Spec): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71035
diff
changeset
|
2276 Process the @var{field-specs} recursively, in order, then repeat |
4b4feab31516
(Bindat Spec): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71035
diff
changeset
|
2277 starting from the first one, processing all the specs @var{count} |
74952
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2278 times overall. The @var{count} is given using the same formats as a |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2279 field length---if an @code{eval} form is used, it is evaluated just once. |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2280 For correct operation, each spec in @var{field-specs} must include a name. |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2281 @end table |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2282 |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2283 For the @code{(eval @var{form})} forms used in a bindat specification, |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2284 the @var{form} can access and update these dynamically bound variables |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2285 during evaluation: |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2286 |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2287 @table @code |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2288 @item last |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2289 Value of the last field processed. |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2290 |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2291 @item bindat-raw |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2292 The data as a byte array. |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2293 |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2294 @item bindat-idx |
75050
27f521750ce8
(Bindat Spec): Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
74970
diff
changeset
|
2295 Current index (within @code{bindat-raw}) for unpacking or packing. |
74952
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2296 |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2297 @item struct |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2298 The alist containing the structured data that have been unpacked so |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2299 far, or the entire structure being packed. You can use |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2300 @code{bindat-get-field} to access specific fields of this structure. |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2301 |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2302 @item count |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2303 @itemx index |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2304 Inside a @code{repeat} block, these contain the maximum number of |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2305 repetitions (as specified by the @var{count} parameter), and the |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2306 current repetition number (counting from 0). Setting @code{count} to |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2307 zero will terminate the inner-most repeat block after the current |
0e7b380a6c47
(Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents:
72723
diff
changeset
|
2308 repetition has completed. |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2309 @end table |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2310 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2311 @node Bindat Functions |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2312 @subsection Functions to Unpack and Pack Bytes |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2313 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2314 In the following documentation, @var{spec} refers to a data layout |
71035
3574bac9e172
(Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents:
71013
diff
changeset
|
2315 specification, @code{bindat-raw} to a byte array, and @var{struct} to an |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2316 alist representing unpacked field data. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2317 |
71035
3574bac9e172
(Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents:
71013
diff
changeset
|
2318 @defun bindat-unpack spec bindat-raw &optional bindat-idx |
70907
4f3bfa0df084
(Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70603
diff
changeset
|
2319 This function unpacks data from the unibyte string or byte |
71035
3574bac9e172
(Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents:
71013
diff
changeset
|
2320 array @code{bindat-raw} |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2321 according to @var{spec}. Normally this starts unpacking at the |
71035
3574bac9e172
(Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents:
71013
diff
changeset
|
2322 beginning of the byte array, but if @var{bindat-idx} is non-@code{nil}, it |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2323 specifies a zero-based starting position to use instead. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2324 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2325 The value is an alist or nested alist in which each element describes |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2326 one unpacked field. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2327 @end defun |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2328 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2329 @defun bindat-get-field struct &rest name |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2330 This function selects a field's data from the nested alist |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2331 @var{struct}. Usually @var{struct} was returned by |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2332 @code{bindat-unpack}. If @var{name} corresponds to just one argument, |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2333 that means to extract a top-level field value. Multiple @var{name} |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2334 arguments specify repeated lookup of sub-structures. An integer name |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2335 acts as an array index. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2336 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2337 For example, if @var{name} is @code{(a b 2 c)}, that means to find |
67044
a40ac89f9800
(Bindat Functions): Say "third" to refer to zero-based index "2".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
66152
diff
changeset
|
2338 field @code{c} in the third element of subfield @code{b} of field |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2339 @code{a}. (This corresponds to @code{struct.a.b[2].c} in C.) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2340 @end defun |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2341 |
70985
183e16c7e0b2
(Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70907
diff
changeset
|
2342 Although packing and unpacking operations change the organization of |
183e16c7e0b2
(Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70907
diff
changeset
|
2343 data (in memory), they preserve the data's @dfn{total length}, which is |
183e16c7e0b2
(Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70907
diff
changeset
|
2344 the sum of all the fields' lengths, in bytes. This value is not |
183e16c7e0b2
(Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70907
diff
changeset
|
2345 generally inherent in either the specification or alist alone; instead, |
183e16c7e0b2
(Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70907
diff
changeset
|
2346 both pieces of information contribute to its calculation. Likewise, the |
183e16c7e0b2
(Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70907
diff
changeset
|
2347 length of a string or array being unpacked may be longer than the data's |
183e16c7e0b2
(Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70907
diff
changeset
|
2348 total length as described by the specification. |
183e16c7e0b2
(Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70907
diff
changeset
|
2349 |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2350 @defun bindat-length spec struct |
70985
183e16c7e0b2
(Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70907
diff
changeset
|
2351 This function returns the total length of the data in @var{struct}, |
183e16c7e0b2
(Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70907
diff
changeset
|
2352 according to @var{spec}. |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2353 @end defun |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2354 |
71035
3574bac9e172
(Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents:
71013
diff
changeset
|
2355 @defun bindat-pack spec struct &optional bindat-raw bindat-idx |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2356 This function returns a byte array packed according to @var{spec} from |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2357 the data in the alist @var{struct}. Normally it creates and fills a |
71035
3574bac9e172
(Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents:
71013
diff
changeset
|
2358 new byte array starting at the beginning. However, if @var{bindat-raw} |
70907
4f3bfa0df084
(Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70603
diff
changeset
|
2359 is non-@code{nil}, it specifies a pre-allocated unibyte string or vector to |
71035
3574bac9e172
(Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents:
71013
diff
changeset
|
2360 pack into. If @var{bindat-idx} is non-@code{nil}, it specifies the starting |
3574bac9e172
(Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents:
71013
diff
changeset
|
2361 offset for packing into @code{bindat-raw}. |
3574bac9e172
(Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents:
71013
diff
changeset
|
2362 |
3574bac9e172
(Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents:
71013
diff
changeset
|
2363 When pre-allocating, you should make sure @code{(length @var{bindat-raw})} |
70985
183e16c7e0b2
(Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70907
diff
changeset
|
2364 meets or exceeds the total length to avoid an out-of-range error. |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2365 @end defun |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2366 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2367 @defun bindat-ip-to-string ip |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2368 Convert the Internet address vector @var{ip} to a string in the usual |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2369 dotted notation. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2370 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2371 @example |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2372 (bindat-ip-to-string [127 0 0 1]) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2373 @result{} "127.0.0.1" |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2374 @end example |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2375 @end defun |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2376 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2377 @node Bindat Examples |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2378 @subsection Examples of Byte Unpacking and Packing |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2379 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2380 Here is a complete example of byte unpacking and packing: |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2381 |
63569
bd65461db3b8
(Bindat Examples): Move @lisp to beginning of line. (Whitespace change.)
Luc Teirlinck <teirllm@auburn.edu>
parents:
63568
diff
changeset
|
2382 @lisp |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2383 (defvar fcookie-index-spec |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2384 '((:version u32) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2385 (:count u32) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2386 (:longest u32) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2387 (:shortest u32) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2388 (:flags u32) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2389 (:delim u8) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2390 (:ignored fill 3) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2391 (:offset repeat (:count) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2392 (:foo u32))) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2393 "Description of a fortune cookie index file's contents.") |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2394 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2395 (defun fcookie (cookies &optional index) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2396 "Display a random fortune cookie from file COOKIES. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2397 Optional second arg INDEX specifies the associated index |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2398 filename, which is by default constructed by appending |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2399 \".dat\" to COOKIES. Display cookie text in possibly |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2400 new buffer \"*Fortune Cookie: BASENAME*\" where BASENAME |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2401 is COOKIES without the directory part." |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2402 (interactive "fCookies file: ") |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2403 (let* ((info (with-temp-buffer |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2404 (insert-file-contents-literally |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2405 (or index (concat cookies ".dat"))) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2406 (bindat-unpack fcookie-index-spec |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2407 (buffer-string)))) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2408 (sel (random (bindat-get-field info :count))) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2409 (beg (cdar (bindat-get-field info :offset sel))) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63569
diff
changeset
|
2410 (end (or (cdar (bindat-get-field info |
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63569
diff
changeset
|
2411 :offset (1+ sel))) |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2412 (nth 7 (file-attributes cookies))))) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63569
diff
changeset
|
2413 (switch-to-buffer |
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63569
diff
changeset
|
2414 (get-buffer-create |
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63569
diff
changeset
|
2415 (format "*Fortune Cookie: %s*" |
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63569
diff
changeset
|
2416 (file-name-nondirectory cookies)))) |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2417 (erase-buffer) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63569
diff
changeset
|
2418 (insert-file-contents-literally |
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63569
diff
changeset
|
2419 cookies nil beg (- end 3)))) |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2420 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2421 (defun fcookie-create-index (cookies &optional index delim) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2422 "Scan file COOKIES, and write out its index file. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2423 Optional second arg INDEX specifies the index filename, |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2424 which is by default constructed by appending \".dat\" to |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2425 COOKIES. Optional third arg DELIM specifies the unibyte |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2426 character which, when found on a line of its own in |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2427 COOKIES, indicates the border between entries." |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2428 (interactive "fCookies file: ") |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2429 (setq delim (or delim ?%)) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2430 (let ((delim-line (format "\n%c\n" delim)) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2431 (count 0) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2432 (max 0) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2433 min p q len offsets) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2434 (unless (= 3 (string-bytes delim-line)) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2435 (error "Delimiter cannot be represented in one byte")) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2436 (with-temp-buffer |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2437 (insert-file-contents-literally cookies) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2438 (while (and (setq p (point)) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2439 (search-forward delim-line (point-max) t) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2440 (setq len (- (point) 3 p))) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2441 (setq count (1+ count) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2442 max (max max len) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2443 min (min (or min max) len) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2444 offsets (cons (1- p) offsets)))) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2445 (with-temp-buffer |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2446 (set-buffer-multibyte nil) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63569
diff
changeset
|
2447 (insert |
70907
4f3bfa0df084
(Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70603
diff
changeset
|
2448 (bindat-pack |
4f3bfa0df084
(Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70603
diff
changeset
|
2449 fcookie-index-spec |
4f3bfa0df084
(Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70603
diff
changeset
|
2450 `((:version . 2) |
4f3bfa0df084
(Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70603
diff
changeset
|
2451 (:count . ,count) |
4f3bfa0df084
(Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70603
diff
changeset
|
2452 (:longest . ,max) |
4f3bfa0df084
(Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70603
diff
changeset
|
2453 (:shortest . ,min) |
4f3bfa0df084
(Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70603
diff
changeset
|
2454 (:flags . 0) |
4f3bfa0df084
(Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70603
diff
changeset
|
2455 (:delim . ,delim) |
4f3bfa0df084
(Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70603
diff
changeset
|
2456 (:offset . ,(mapcar (lambda (o) |
4f3bfa0df084
(Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70603
diff
changeset
|
2457 (list (cons :foo o))) |
4f3bfa0df084
(Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70603
diff
changeset
|
2458 (nreverse offsets)))))) |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2459 (let ((coding-system-for-write 'raw-text-unix)) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2460 (write-file (or index (concat cookies ".dat"))))))) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2461 @end lisp |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2462 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2463 Following is an example of defining and unpacking a complex structure. |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2464 Consider the following C structures: |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2465 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2466 @example |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2467 struct header @{ |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2468 unsigned long dest_ip; |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2469 unsigned long src_ip; |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2470 unsigned short dest_port; |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2471 unsigned short src_port; |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2472 @}; |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2473 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2474 struct data @{ |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2475 unsigned char type; |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2476 unsigned char opcode; |
75992
035ff8761729
More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents:
75987
diff
changeset
|
2477 unsigned short length; /* In network byte order */ |
63560 | 2478 unsigned char id[8]; /* null-terminated string */ |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2479 unsigned char data[/* (length + 3) & ~3 */]; |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2480 @}; |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2481 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2482 struct packet @{ |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2483 struct header header; |
75992
035ff8761729
More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents:
75987
diff
changeset
|
2484 unsigned long counters[2]; /* In little endian order */ |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2485 unsigned char items; |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2486 unsigned char filler[3]; |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2487 struct data item[/* items */]; |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2488 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2489 @}; |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2490 @end example |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2491 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2492 The corresponding data layout specification: |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2493 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2494 @lisp |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2495 (setq header-spec |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2496 '((dest-ip ip) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2497 (src-ip ip) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2498 (dest-port u16) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2499 (src-port u16))) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2500 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2501 (setq data-spec |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2502 '((type u8) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2503 (opcode u8) |
75992
035ff8761729
More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents:
75987
diff
changeset
|
2504 (length u16) ;; network byte order |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2505 (id strz 8) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2506 (data vec (length)) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2507 (align 4))) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2508 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2509 (setq packet-spec |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2510 '((header struct header-spec) |
75992
035ff8761729
More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents:
75987
diff
changeset
|
2511 (counters vec 2 u32r) ;; little endian order |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2512 (items u8) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2513 (fill 3) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2514 (item repeat (items) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2515 (struct data-spec)))) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2516 @end lisp |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2517 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2518 A binary data representation: |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2519 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2520 @lisp |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2521 (setq binary-data |
75992
035ff8761729
More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents:
75987
diff
changeset
|
2522 [ 192 168 1 100 192 168 1 101 01 28 21 32 |
035ff8761729
More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents:
75987
diff
changeset
|
2523 160 134 1 0 5 1 0 0 2 0 0 0 |
035ff8761729
More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents:
75987
diff
changeset
|
2524 2 3 0 5 ?A ?B ?C ?D ?E ?F 0 0 1 2 3 4 5 0 0 0 |
035ff8761729
More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents:
75987
diff
changeset
|
2525 1 4 0 7 ?B ?C ?D ?E ?F ?G 0 0 6 7 8 9 10 11 12 0 ]) |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2526 @end lisp |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2527 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2528 The corresponding decoded structure: |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2529 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2530 @lisp |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63569
diff
changeset
|
2531 (setq decoded (bindat-unpack packet-spec binary-data)) |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2532 @result{} |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2533 ((header |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2534 (dest-ip . [192 168 1 100]) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2535 (src-ip . [192 168 1 101]) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2536 (dest-port . 284) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2537 (src-port . 5408)) |
75992
035ff8761729
More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents:
75987
diff
changeset
|
2538 (counters . [100000 261]) |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2539 (items . 2) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2540 (item ((data . [1 2 3 4 5]) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2541 (id . "ABCDEF") |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2542 (length . 5) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2543 (opcode . 3) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2544 (type . 2)) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2545 ((data . [6 7 8 9 10 11 12]) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2546 (id . "BCDEFG") |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2547 (length . 7) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2548 (opcode . 4) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2549 (type . 1)))) |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2550 @end lisp |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2551 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2552 Fetching data from this structure: |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2553 |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2554 @lisp |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63569
diff
changeset
|
2555 (bindat-get-field decoded 'item 1 'id) |
63542
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2556 @result{} "BCDEFG" |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2557 @end lisp |
e8205c5fb59b
(Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents:
62370
diff
changeset
|
2558 |
52401 | 2559 @ignore |
2560 arch-tag: ba9da253-e65f-4e7f-b727-08fba0a1df7a | |
2561 @end ignore |