annotate lisp/tcp.el @ 2908:fea2f9ef375b

Initial revision
author Richard M. Stallman <rms@gnu.org>
date Wed, 19 May 1993 21:11:06 +0000
parents
children 62f6fd783884
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2908
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 ;;; TCP/IP stream emulation for GNU Emacs
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2 ;; Copyright (C) 1988, 1989, 1993 Free Software Foundation, Inc.
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4 ;;; Author: Masanobu Umeda
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 ;;; Maintainer: umerin@mse.kyutech.ac.jp
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
7 ;; This file is part of GNU Emacs.
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 ;; GNU Emacs is distributed in the hope that it will be useful,
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 ;; but WITHOUT ANY WARRANTY. No author or distributor
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 ;; accepts responsibility to anyone for the consequences of using it
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 ;; or for whether it serves any particular purpose or works at all,
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 ;; unless he says so in writing. Refer to the GNU Emacs General Public
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 ;; License for full details.
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; Everyone is granted permission to copy, modify and redistribute
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 ;; GNU Emacs, but only under the conditions described in the
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ;; GNU Emacs General Public License. A copy of this license is
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 ;; supposed to have been given to you along with GNU Emacs so you
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 ;; can know your rights and responsibilities. It should be in a
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 ;; file named COPYING. Among other things, the copyright notice
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22 ;; and this notice must be preserved on all copies.
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24 ;; Notes on TCP package:
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25 ;;
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 ;; This package provides a TCP/IP stream emulation for GNU Emacs. If
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 ;; the function `open-network-stream' is not defined in Emacs, but
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28 ;; your operating system has a capability of network stream
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 ;; connection, this tcp package can be used for communicating with
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 ;; NNTP server.
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 ;;
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 ;; The tcp package runs inferior process which actually does the role
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 ;; of `open-network-stream'. The program `tcp' provided with this
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 ;; package can be used for such purpose. Before loading the package,
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 ;; compile `tcp.c' and install it as `tcp' in a directory in the emacs
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 ;; search path. If you modify `tcp.c', please send diffs to the author
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 ;; of GNUS. I'll include some of them in the next releases.
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 (provide 'tcp)
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41 (defvar tcp-program-name "tcp"
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 "*The name of the program emulating open-network-stream function.")
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 (defun open-network-stream (name buffer host service)
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 "Open a TCP connection for a service to a host.
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 Returns a subprocess-object to represent the connection.
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 Input and output work as for subprocesses; `delete-process' closes it.
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48 Args are NAME BUFFER HOST SERVICE.
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 NAME is name for process. It is modified if necessary to make it unique.
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 BUFFER is the buffer (or buffer-name) to associate with the process.
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 Process output goes at end of that buffer, unless you specify
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 an output stream or filter function to handle the output.
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 BUFFER may be also nil, meaning that this process is not associated
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54 with any buffer
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55 Third arg is name of the host to connect to.
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 Fourth arg SERVICE is name of the service desired, or an integer
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57 specifying a port number to connect to."
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58 (let ((proc (start-process name buffer
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 tcp-program-name
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60 host
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 (if (stringp service)
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 service
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63 (int-to-string service))
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 )))
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 (process-kill-without-query proc)
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66 ;; Return process
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 proc
fea2f9ef375b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 ))