annotate lisp/multicast.el @ 327:03446687b7cc r21-0-61

Import from CVS: tag r21-0-61
author cvs
date Mon, 13 Aug 2007 10:48:16 +0200
parents 405dd6d1825b
children 2f8bb876ab1d
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
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
3 ;; Copyright (C) 1997-1998 Didier Verna.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
4
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
5 ;; Author: Didier Verna <verna@inf.enst.fr>
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
6 ;; Maintainer: Didier Verna <verna@inf.enst.fr>
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
7 ;; Created: Thu Dec 4 16:37:39 1997
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
8 ;; Last Revision: Mon Jan 19 19:10:50 1998
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
9 ;; Current Version: 0.4
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
10 ;; Keywords: dumped comm processes
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
11
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
12 ;; This file is part of XEmacs.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
13
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
14 ;; XEmacs is free software; you can redistribute it and/or modify
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
15 ;; it under the terms of the GNU General Public License as published by
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
16 ;; the Free Software Foundation; either version 2 of the License, or
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
17 ;; (at your option) any later version.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
18
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
19 ;; XEmacs is distributed in the hope that it will be useful,
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
22 ;; GNU General Public License for more details.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
23
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
24 ;; You should have received a copy of the GNU General Public License
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
25 ;; along with this program; if not, write to the Free Software
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
26 ;; Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
27
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
28
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
29 ;;; Commentary:
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
30
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
31 ;; This file just contains a lisp frontend to the internal function
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
32 ;; open-multicast-group-internal written in C and belonging to process.c
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
33 ;; Well, nothing much to say about it ... read the doc string.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
34
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
35
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
36 ;;; Change Log:
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
37
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
38 ;; Rev. of Mon Jan 19 19:04:44 1998 : packaging cleanup
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
39 ;; Rev. of Thu Dec 11 13:54:26 1997 : updated the docstring
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
40 ;; Rev. of Mon Dec 8 15:28:47 1997 : Improved the doc string
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
41 ;; Rev. of Thu Dec 4 16:38:09 1997 : Initial Version.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
42
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
43
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
44 ;;; Code:
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
45
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
46 (defun open-multicast-group (name buffer address)
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
47 "Open a multicast connection on the specified address.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
48 Returns a subprocess-object to represent the connection.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
49 Input and output work as for subprocesses; `delete-process' closes it.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
50 Args are NAME BUFFER ADDRESS.
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
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
56 buffer
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
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
63 224 or 239. Such groups are considered 'admin' groups, and may
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
64 behave in a surprising way ..."
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
65 (let (dest port ttl)
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
66 ;; We check only the general form of the multicast address.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
67 ;; The rest will be handled by the internal function.
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
68 (string-match "^\\([0-9\\.]+\\)/\\([0-9]+\\)/\\([0-9]+\\)$" address)
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
69 (and (not (and (= (match-beginning 0) 0)
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
70 (= (match-end 0) (length address))))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
71 (error "malformed multicast address: %s" address))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
72 (and (not (setq dest (match-string 1 address)))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
73 (error "invalid destination specification."))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
74 (and (= 0 (setq port (string-to-int (match-string 2 address))))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
75 (error "invalid port specification."))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
76 (and (= 0 (setq ttl (string-to-int (match-string 3 address))))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
77 (error "invalid ttl specification."))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
78 (open-multicast-group-internal name buffer dest port ttl)
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
79 ))
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
80
405dd6d1825b Import from CVS: tag r20-5b29
cvs
parents:
diff changeset
81 ;;; multicast.el ends here