1xpa(n)                        SAORD Documentation                       xpa(n)
2
3
4

NAME

6       XPA: Public Access to Data and Algorithms
7

SYNOPSIS

9       This document is the Table of Contents for XPA.
10

DESCRIPTION

12       The XPA messaging system provides seamless communication between many
13       kinds of Unix programs, including X programs and Tcl/Tk programs.  It
14       also provides an easy way for users to communicate with XPA-enabled
15       programs by executing XPA client commands in the shell or by utilizing
16       such commands in scripts.  Because XPA works both at the programming
17       level and the shell level, it is a powerful tool for unifying any
18       analysis environment: users and programmers have great flexibility in
19       choosing the best level or levels at which to access XPA services, and
20       client access can be extended or modified easily at any time.
21
22       A program becomes an XPA-enabled server by defining named points of
23       public access through which data and commands can be exchanged with
24       other client programs (and users).  Using standard TCP sockets as a
25       transport mechanism, XPA supports both single-point and broadcast
26       messaging to and from these servers.  It supports direct communication
27       between clients and servers, or indirect communication via an
28       intermediate message bus emulation program. Host-based access control
29       is implemented, as is as the ability to communicate with XPA servers
30       across a network.
31
32       XPA implements a layered interface that is designed to be useful both
33       to software developers and to users.  The interface consists of a
34       library of XPA client and server routines for use in C/C++ programs and
35       a suite of high-level user programs built on top of these libraries.
36       Using the XPA library, access points can be added to Tcl/Tk programs,
37       Xt programs, or to Unix programs that use the XPA event loop or any
38       event loop based on select().  Client access subroutines can be added
39       to any Tcl/Tk, Xt, or Unix program. Client access also is supported at
40       the command line via a suite of high-level programs.
41
42       Choose from the following topics:
43
44       ·   Introduction to XPA [xpaintro(n)]
45
46       ·   Access Point Names and Templates [xpatemplate(n)]
47
48       ·   Getting Common Information About Access Points [xpacommon(n)]
49
50       ·   Communication Methods [xpamethod(n)]
51
52       ·   Communication Between Hosts [xpainet(n)]
53
54       ·   Distinguishing Users [xpausers(n)]
55
56       ·   XPA User Programs
57
58           ·   xpaget: get data and info [xpaget(1)]
59
60           ·   xpaset: send data and info [xpaset(1)]
61
62           ·   xpainfo: send info alert [xpainfo(1)]
63
64           ·   xpaaccess: get access point info [xpaaccess(1)]
65
66           ·   xpamb: message bus emulation [xpamb(1)]
67
68           ·   xpans: the XPA name server [xpans(1)]
69
70       ·   XPA Server Routines
71
72           ·   XPANew: define a new access point [xpanew(3)]
73
74           ·   XPACmdNew: define a new command access point [xpacmdnew(3)]
75
76           ·   XPACmdAdd: add a command [xpacmdadd(3)]
77
78           ·   XPACmdDel: delete a command [xpacmddel(3)]
79
80           ·   XPAInfoNew: define an info access point [xpainfonew(3)]
81
82           ·   XPAFree: free an access point [xpafree(3)]
83
84           ·   XPAMainLoop: event loop for select server [xpamainloop(3)]
85
86           ·   XPAPoll: poll for XPA events [xpapoll(3)]
87
88           ·   XPACleanup: release reserved XPA memory [xpacleanup(3)]
89
90           ·   XPA Server Macros: accessing structure internals [xpamacros(3)]
91
92           ·   XPA Race Conditions: how to avoid them [xparace(3)]
93
94           ·   XPA Out of Memory (OOM) errors [xpaoom(3)]
95
96       ·   XPA Client Routines
97
98           ·   XPAOpen: open a persistent client connection [xpaopen(3)]
99
100           ·   XPAClose: close persistent client connection [xpaclose(3)]
101
102           ·   XPAGet: get data [xpaget(3)]
103
104           ·   XPASet: send data or commands [xpaset(3)]
105
106           ·   XPAInfo: send an info alert [xpainfo(3)]
107
108           ·   XPAGetFd: get data and write to an fd [xpagetfd(3)]
109
110           ·   XPASetFd: read data from and fd and send [xpasetfd(3)]
111
112           ·   XPANSLookup: look up an access point [xpanslookup(3)]
113
114           ·   XPAAccess: get access info [xpaaccess(3)]
115
116           ·   The XPA/Xt Interface: Xt interface to XPA [xpaxt(n)]
117
118           ·   The XPA/Tcl Interface: Tcl interface to XPA [xpatcl(n)]
119
120       ·   Tailoring the XPA Environment
121
122           ·   Environment Variables [xpaenv(n)]
123
124           ·   Access Control [xpaacl(n)]
125
126       ·   Miscellaneous
127
128           ·   Where to Find Example/Test Code
129
130           ·   User Changes Between XPA 1.0 and 2.0
131
132           ·   API Changes Between XPA 1.0 and 2.0
133
134           ·   What Does XPA Stand For, Anyway?
135
136
137
138version 2.1.15                   July 23, 2013                          xpa(n)