xpacode(7) [debian man page]

xpacode(7)							SAORD Documentation							xpacode(7)

NAME

       XPACode -  Where to Find Example/Test Code

SYNOPSIS

       The XPA source code directory contains two test programs, stest.c, and ctest.c that can serve as examples for writing XPA servers and
       clients, respectively.  They also can be used to test various features of XPA.

DESCRIPTION

       To build the XPA test programs, execute:

	  make All

       in the XPA source directory to generate the stest and ctest programs.  (NB: this should work on all platforms, although we have had prob-
       lems with unresolved externals on one Sun/Solaris machine, for reasons still unknown.)

       The stest program can be executed with no arguments to start an XPA server that contains the access points: xpa, xpa1, c_xpa (containing
       sub-commands cmd1 and cmd2), and i_xpa.	You then can use xpaset and xpaget to interact with these access points:

	 cat xpa.c | xpaset xpa      # send to xpa
	 cat xpa.c | xpaset "xpa*"   # send to xpa and xpa1
	 xpaget xpa		     # receive from xpa
	 xpaget xpa*		     # receive from xpa and xpa1

       etc. You also can use ctest to do the same thing, or to iterate:

	 ctest -s -l 100 xpa	    # send to xpa 100 times
	 ctest -s -l 100 "xpa*"     # send to xpa and xpa1 100 times
	 ctest -g -l 100 xpa	    # receive from xpa 100 times
	 ctest -g -l 100 "xpa*"     # receive from xpa and xpa1 100 times

       More options are available: see the stest.c and ctest.c code itself, which were used extensively to debug XPA.

       The file test.tcl in the XPA source directory gives examples for using the XPATclInterface.

SEE ALSO

       See xpa(7) for a list of XPA help pages

version 2.1.14							   June 7, 2012 							xpacode(7)

xpaclient(3)							SAORD Documentation						      xpaclient(3)

NAME

       XPAClient -  The XPA Client-side Programming Interface

SYNOPSIS

       A description of the XPA client-side programming interface.

DESCRIPTION

       Introduction to XPA Client Programming

       Sending/receiving data to/from an XPA access point is easy: you generally only need to call the XPAGet() or XPASet() subroutines.

	 #include <xpa.h>

	 int XPAGet(XPA xpa,
	     char *template, char *paramlist, char *mode,
	     char **bufs, int *lens, char **names, char **messages, int n);

	 int XPASet(XPA xpa,
	     char *template, char *paramlist, char *mode,
	     char *buf, int len, char **names, char **messages, int n);

	 int XPAInfo(XPA xpa,
	     char *template, char *paramlist, char *mode,
	     char **names, char **messages, int n);

	 int XPAAccess(XPA xpa,
	     char *template, char *paramlist, char *mode,
	     char **names, char **messages, int n);

	 int XPAGetFd(XPA xpa,
	     char *template, char *paramlist, char *mode,
	     int *fds, char **names, char **messages, int n);

	 int XPASetFd(XPA xpa,
	     char *template, char *paramlist, char *mode,
	     int fd, char **names, char **messages, int n);

	 XPA XPAOpen(char *mode);

	 void XPAClose(XPA xpa);

	 int XPANSLookup(XPA xpa,
	     char *template, char *type,
	     char ***classes, char ***names, char ***methods, char ***infos);

       Introduction

       To use the XPA application programming interface, a software developer generally will include the xpa.h definitions file:

	 #include <xpa.h>

       in the software module that defines or accesses an XPA access point and then will link against the libxpa.a library:

	 gcc -o foo foo.c libxpa.a

       XPA has been compiled using both C and C++ compilers.

       Client communication with XPA public access points generally is accomplished using XPAGet() or XPASet() within a program (or xpaget and
       xpaset at the command line).  Both routines require specification of the name of the access point.  If a template is used to specify the
       access point name (e.g., "ds9*"), then communication will take place with all servers matching that template.

SEE ALSO

       See xpa(7) for a list of XPA help pages

version 2.1.14							   June 7, 2012 						      xpaclient(3)