1xpatemplate(n) SAORD Documentation xpatemplate(n)
2
3
4
6 XPATemplate: Access Point Names and Templates
7
9 XPA access points are composed of two parts: a general class and a spe‐
10 cific name. Both parts accept template characters so that you can
11 send/retrieve data to/from multiple servers at one time.
12
14 When XPA servers call XPANew(), or XPACmdNew() to define XPA access
15 points, they specify a string identifier composed of a class and a
16 name. When clients communicate with XPA access points, they specify
17 which access points to communicate with using an identifier of the
18 form:
19
20 class:name
21
22 All registered XPA access points that match the specified identifier
23 will be available for communication (subject to access control rules,
24 etc.)
25
26 As of XPA 2.1.5, the length of both the class and name designations are
27 limited to 1024 characters.
28
29 The XPA class:name identifier actually is a template: it accepts wild
30 cards in its syntax, so a single specifier can match more than one XPA
31 access point. (Note that the class is optional and defaults to "*".)
32 The allowed syntax for clients to specify the class:name template is of
33 the form shown below. (Note that "*" is used to denote a generic wild
34 card, but other wild cards characters are supported, as described
35 below).
36
37 template explanation
38 -------- -----------
39 class:name exact match of class and name
40 name match any class with this name
41 *:name match any class with this name
42 class:* match any name of this class
43 *:* match any access point
44
45 In general, the following wild-cards can be applied to class and name:
46
47 wildcard explanation
48 -------- -----------
49 ? match any character, but there must be one
50 * match anything, or nothing
51 [...] match an inclusive set
52
53 Although the class:name template normally is used to refer to XPA
54 access points, these also can be specified using their individual
55 socket identifiers. For inet sockets, the socket identifier is
56 ip:port, where ip can be the DNS-registered name, the ASCII IP number
57 (e.g. 123.45.67.890) or the hex IP number (e.g. 838f3a60). For unix
58 sockets, the identifier is the socket file name. These socket identi‐
59 fiers are displayed as the fourth argument in the xpans display of reg‐
60 istered access points. For example, consider the ds9 program started
61 using inet sockets. The xpans name server will register something like
62 this:
63
64 csh> xpaget xpans
65 DS9 ds9 gs saord.harvard.edu:3236 eric
66
67 You can access ds9 using ip:3236 in any of the three forms:
68
69 csh> xpaget saord:3236 file
70 /home/eric/data/snr.ev
71
72 csh> xpaget 123.45.67.890:3236 file
73 /home/eric/data/snr.ev
74
75 csh> xpaget 838f3a60:3236 file
76 /home/eric/data/snr.ev
77
78 In the case of unix sockets, the socket identifier is a file:
79
80 csh> xpaget xpans
81 DS9 ds9 gs /tmp/.xpa/DS9_ds9.2631 eric
82
83 csh> xpaget /tmp/.xpa/DS9_ds9.2631 file
84 /home/eric/data/snr.ev
85
86 This feature can be useful in distinguishing between multiple instances
87 of a program that all have the same class:name designation.
88
90 See xpa(n) for a list of XPA help pages
91
92
93
94version 2.1.12 January 26, 2010 xpatemplate(n)