xpaclient(3)

1xpaclient(3)                  SAORD Documentation                 xpaclient(3)
2
3
4

NAME

6       XPAClient: The XPA Client-side Programming Interface
7

SYNOPSIS

9       A description of the XPA client-side programming interface.
10

DESCRIPTION

12       Introduction to XPA Client Programming
13
14       Sending/receiving data to/from an XPA access point is easy: you
15       generally only need to call the XPAGet() or XPASet() subroutines.
16
17         #include <xpa.h>
18
19         int XPAGet(XPA xpa,
20             char *template, char *paramlist, char *mode,
21             char **bufs, size_t *lens, char **names, char **messages, int n);
22
23         int XPASet(XPA xpa,
24             char *template, char *paramlist, char *mode,
25             char *buf, size_t len, char **names, char **messages, int n);
26
27         int XPAInfo(XPA xpa,
28             char *template, char *paramlist, char *mode,
29             char **names, char **messages, int n);
30
31         int XPAAccess(XPA xpa,
32             char *template, char *paramlist, char *mode,
33             char **names, char **messages, int n);
34
35         int XPAGetFd(XPA xpa,
36             char *template, char *paramlist, char *mode,
37             int *fds, char **names, char **messages, int n);
38
39         int XPASetFd(XPA xpa,
40             char *template, char *paramlist, char *mode,
41             int fd, char **names, char **messages, int n);
42
43         XPA XPAOpen(char *mode);
44
45         void XPAClose(XPA xpa);
46
47         int XPANSLookup(XPA xpa,
48             char *template, char *type,
49             char ***classes, char ***names, char ***methods, char ***infos);
50
51       Introduction
52
53       To use the XPA application programming interface, a software developer
54       generally will include the xpa.h definitions file:
55
56         #include <xpa.h>
57
58       in the software module that defines or accesses an XPA access point and
59       then will link against the libxpa.a library:
60
61         gcc -o foo foo.c libxpa.a
62
63       XPA has been compiled using both C and C++ compilers.
64
65       Client communication with XPA public access points generally is
66       accomplished using XPAGet() or XPASet() within a program (or xpaget and
67       xpaset at the command line).  Both routines require specification of
68       the name of the access point.  If a template is used to specify the
69       access point name (e.g., "ds9*"), then communication will take place
70       with all servers matching that template.
71

NAME

SYNOPSIS

DESCRIPTION

SEE ALSO