annotate lisp/multicast.el @ 4636:5c427ece884b r21-5-29

XEmacs 21.5.29 "garbanzo" is released.
author Stephen J. Turnbull <stephen@xemacs.org>
date Mon, 18 May 2009 23:04:47 +0900
parents 2b6fa2618f76
children 9058351b0236
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
261
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
1 ;;; multicast.el --- lisp frontend for multicast connections in XEmacs
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
2
404
2f8bb876ab1d Import from CVS: tag r21-2-32
cvs
parents: 261
diff changeset
3 ;; Copyright (C) 1997-2000 Didier Verna.
853
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
4 ;; Copyright (C) 2002 Ben Wing.
261
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
5
404
2f8bb876ab1d Import from CVS: tag r21-2-32
cvs
parents: 261
diff changeset
6 ;; Author: Didier Verna <didier@xemacs.org>
2f8bb876ab1d Import from CVS: tag r21-2-32
cvs
parents: 261
diff changeset
7 ;; Maintainer: Didier Verna <didier@xemacs.org>
2f8bb876ab1d Import from CVS: tag r21-2-32
cvs
parents: 261
diff changeset
8 ;; Created: Thu Dec 4 16:37:39 1997
261
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
9 ;; Last Revision: Mon Jan 19 19:10:50 1998
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
10 ;; Current Version: 0.4
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
11 ;; Keywords: dumped comm processes
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
12
404
2f8bb876ab1d Import from CVS: tag r21-2-32
cvs
parents: 261
diff changeset
13 ;; This file is part of XEmacs.
261
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
14
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
15 ;; XEmacs is free software; you can redistribute it and/or modify
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
16 ;; it under the terms of the GNU General Public License as published by
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
17 ;; the Free Software Foundation; either version 2 of the License, or
404
2f8bb876ab1d Import from CVS: tag r21-2-32
cvs
parents: 261
diff changeset
18 ;; (at your option) any later version.
261
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
19
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
20 ;; XEmacs is distributed in the hope that it will be useful,
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
404
2f8bb876ab1d Import from CVS: tag r21-2-32
cvs
parents: 261
diff changeset
23 ;; GNU General Public License for more details.
261
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
24
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
25 ;; You should have received a copy of the GNU General Public License
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
26 ;; along with this program; if not, write to the Free Software
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
27 ;; Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
28
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
29
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
30 ;;; Commentary:
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
31
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
32 ;; This file just contains a lisp frontend to the internal function
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
33 ;; open-multicast-group-internal written in C and belonging to process.c
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
34 ;; Well, nothing much to say about it ... read the doc string.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
35
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
36
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
37 ;;; Change Log:
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
38
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
39 ;; Rev. of Mon Jan 19 19:04:44 1998 : packaging cleanup
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
40 ;; Rev. of Thu Dec 11 13:54:26 1997 : updated the docstring
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
41 ;; Rev. of Mon Dec 8 15:28:47 1997 : Improved the doc string
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
42 ;; Rev. of Thu Dec 4 16:38:09 1997 : Initial Version.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
43
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
44
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
45 ;;; Code:
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
46
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
47 (defun open-multicast-group (name buffer address)
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
48 "Open a multicast connection on the specified address.
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 404
diff changeset
49 Returns a process object to represent the connection.
261
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
50 Input and output work as for subprocesses; `delete-process' closes it.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
51 NAME is a name for the process. It is modified if necessary to make it unique.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
52 BUFFER is the buffer (or buffer-name) to associate with the process.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
53 Process output goes at the end of that buffer, unless you specify an output
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
54 stream or filter function to handle the output.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
55 BUFFER may be also nil, meaning that this process is not associated with any
853
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
56 buffer.
261
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
57 ADDRESS specifies a standard multicast address \"dest/port/ttl\":
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
58 dest is an internet address between 224.0.0.0 and 239.255.255.255
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
59 port is a communication port like in traditional unicast
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
60 ttl is the time-to-live (15 for site, 63 for region and 127 for world).
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
61
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
62 WARNING: it is *strongly* recommended to avoid using groups beginning with
404
2f8bb876ab1d Import from CVS: tag r21-2-32
cvs
parents: 261
diff changeset
63 224 or 239. Such groups are considered 'admin' groups, and may
853
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
64 behave in a surprising way ...
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
65
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
66 The read/write coding systems used for process I/O on the process are
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
67 determined as follows:
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
68
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
69 1. `coding-system-for-read', `coding-system-for-write', if non-nil.
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
70 (Intended as a temporary overriding mechanism for use by Lisp
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
71 code.)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
72 2. The matching value for the port from `network-coding-system-alist',
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
73 if any, and if non-nil. The value may be either a single coding
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
74 system, used for both read and write; or a cons of read/write; or a
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
75 function, called to get one of the other two values.
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
76 3. The value of `default-network-coding-system', which should be a cons
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
77 of read/write coding systems, if the values are non-nil.
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
78 4. The coding system `undecided' for read, and `raw-text' for write.
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
79
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
80 Note that the processes of determining the read and write coding systems
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
81 proceed essentially independently one from the other, as in `start-process'.
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
82
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
83 You can change the coding systems later on using
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
84 `set-process-coding-system', `set-process-input-coding-system', or
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
85 `set-process-output-coding-system'."
261
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
86 (let (dest port ttl)
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
87 ;; We check only the general form of the multicast address.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
88 ;; The rest will be handled by the internal function.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
89 (string-match "^\\([0-9\\.]+\\)/\\([0-9]+\\)/\\([0-9]+\\)$" address)
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
90 (and (not (and (= (match-beginning 0) 0)
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
91 (= (match-end 0) (length address))))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
92 (error "malformed multicast address: %s" address))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
93 (and (not (setq dest (match-string 1 address)))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
94 (error "invalid destination specification."))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
95 (and (= 0 (setq port (string-to-int (match-string 2 address))))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
96 (error "invalid port specification."))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
97 (and (= 0 (setq ttl (string-to-int (match-string 3 address))))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
98 (error "invalid ttl specification."))
853
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
99 (let (cs-r cs-w)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
100 (let (ret)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
101 (catch 'found
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
102 (let ((alist network-coding-system-alist)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
103 (case-fold-search nil)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
104 pattern)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
105 (while alist
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
106 (setq pattern (car (car alist)))
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
107 (and
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
108 (cond ((numberp pattern)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
109 (and (numberp port)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
110 (eq pattern port)))
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
111 ((stringp pattern)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
112 (or (and (stringp port)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
113 (string-match pattern port))
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
114 (and (numberp port)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
115 (string-match pattern
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
116 (number-to-string port))))))
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
117 (throw 'found (setq ret (cdr (car alist)))))
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
118 (setq alist (cdr alist))
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
119 )))
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
120 (if (functionp ret)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
121 (setq ret (funcall ret 'open-multicast-group port)))
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
122 (cond ((consp ret)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
123 (setq cs-r (car ret)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
124 cs-w (cdr ret)))
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
125 ((and ret (find-coding-system ret))
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
126 (setq cs-r ret
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
127 cs-w ret))))
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
128 (let ((coding-system-for-read
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
129 (or coding-system-for-read cs-r
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
130 (car default-network-coding-system)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
131 'undecided))
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
132 (coding-system-for-write
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
133 (or coding-system-for-write cs-w
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
134 (cdr default-network-coding-system)
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
135 'raw-text)))
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
136 (declare-fboundp (open-multicast-group-internal name buffer dest port
2b6fa2618f76 [xemacs-hg @ 2002-05-28 08:44:22 by ben]
ben
parents: 502
diff changeset
137 ttl))))))
404
2f8bb876ab1d Import from CVS: tag r21-2-32
cvs
parents: 261
diff changeset
138
261
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
139 ;;; multicast.el ends here