summaryrefslogtreecommitdiffstats
path: root/xpa/doc/pod/xpa.pod
blob: 7787d4b50711bdd820fc93cdb19b5a5fec548318 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
=pod

=head1 NAME



B<XPA: Public Access to Data and Algorithms>



=head1 SYNOPSIS




This document is the Table of Contents for XPA.



=head1 DESCRIPTION





The XPA messaging system provides seamless communication between many
kinds of Unix programs, including X programs and Tcl/Tk programs.  It
also provides an easy way for users to communicate with XPA-enabled
programs by executing XPA client commands in the shell or by utilizing
such commands in scripts.  Because XPA works both at the programming
level and the shell level, it is a powerful tool for unifying any
analysis environment: users and programmers have great flexibility in
choosing the best level or levels at which to access XPA services, and
client access can be extended or modified easily at any time.


A program becomes an XPA-enabled server by defining named points of
public access through which data and commands can be exchanged with
other client programs (and users).  Using standard TCP sockets as a
transport mechanism, XPA supports both single-point and broadcast
messaging to and from these servers.  It supports direct communication
between clients and servers, or indirect communication via an
intermediate message bus emulation program. Host-based access control
is implemented, as is as the ability to communicate with XPA servers
across a network.


XPA implements a layered interface that is designed to be useful both
to software developers and to users.  The interface consists of a
library of XPA client and server routines for use in C/C++ programs and
a suite of high-level user programs built on top of these libraries.
Using the XPA library, access points can be added to Tcl/Tk programs,
Xt programs, or to Unix programs that use the XPA event loop or any
event loop based on select().  Client access subroutines can be added
to any Tcl/Tk, Xt, or Unix program. Client access also is supported at
the command line via a suite of high-level programs.


Choose from the following topics:



=over 4

 


=item *

Introduction to XPA
[xpaintro(n)]


=item *

Access Point Names and Templates
[xpatemplate(n)]


=item *

Getting Common Information About Access Points
[xpacommon(n)]


=item *

Communication Methods
[xpamethod(n)]


=item *

Communication Between Hosts
[xpainet(n)]


=item *

Distinguishing Users
[xpausers(n)]



=item *

XPA User Programs


=over 4




=item *

xpaget: get data and info
[xpaget(1)]


=item *

xpaset: send data and info
[xpaset(1)]


=item *

xpainfo: send info alert
[xpainfo(1)]


=item *

xpaaccess: get access point info
[xpaaccess(1)]


=item *

xpamb: message bus emulation
[xpamb(1)]


=item *

xpans: the XPA name server
[xpans(1)]


=back





=item *

XPA Server Routines


=over 4




=item *

XPANew: define a new access point
[xpanew(3)]


=item *

XPACmdNew: define a new command access point
[xpacmdnew(3)]


=item *

XPACmdAdd: add a command
[xpacmdadd(3)]


=item *

XPACmdDel: delete a command
[xpacmddel(3)]


=item *

XPAInfoNew: define an info access point
[xpainfonew(3)]


=item *

XPAFree: free an access point
[xpafree(3)]


=item *

XPAMainLoop: event loop for select server
[xpamainloop(3)]


=item *

XPAPoll: poll for XPA events
[xpapoll(3)]


=item *

XPACleanup: release reserved XPA memory
[xpacleanup(3)]


=item *

XPA Server Macros: accessing structure internals
[xpamacros(3)]


=item *

XPA Race Conditions: how to avoid them
[xparace(3)]


=item *

XPA Out of Memory (OOM) errors
[xpaoom(3)]


=back





=item *

XPA Client Routines


=over 4




=item *

XPAOpen: open a persistent client connection
[xpaopen(3)]


=item *

XPAClose: close persistent client connection
[xpaclose(3)]


=item *

XPAGet: get data
[xpaget(3)]


=item *

XPASet: send data or commands
[xpaset(3)]


=item *

XPAInfo: send an info alert
[xpainfo(3)]


=item *

XPAGetFd: get data and write to an fd
[xpagetfd(3)]


=item *

XPASetFd: read data from and fd and send
[xpasetfd(3)]


=item *

XPANSLookup: look up an access point
[xpanslookup(3)]


=item *

XPAAccess: get access info
[xpaaccess(3)]


=item *

The XPA/Xt Interface: Xt interface to XPA
[xpaxt(n)]


=item *

The XPA/Tcl Interface: Tcl interface to XPA
[xpatcl(n)]


=back





=item *

Tailoring the XPA Environment


=over 4




=item *

Environment Variables
[xpaenv(n)]


=item *

Access Control
[xpaacl(n)]


=back





=item *

Miscellaneous


=over 4





=item *

Where to Find Example/Test Code


=item *

User Changes Between XPA 1.0 and 2.0


=item *

API Changes Between XPA 1.0 and 2.0


=item *

What Does XPA Stand For, Anyway?


=back





=back

 




=cut