summaryrefslogtreecommitdiffstats
path: root/xpa/doc/pod/xpaopen.pod
diff options
context:
space:
mode:
authorWilliam Joye <wjoye@cfa.harvard.edu>2017-10-26 16:44:17 (GMT)
committerWilliam Joye <wjoye@cfa.harvard.edu>2017-10-26 16:44:17 (GMT)
commit79d64f400391ce81b4eda73977cb40099256b348 (patch)
tree47afaed270cf59335dbaf4eb7965eac64a02a687 /xpa/doc/pod/xpaopen.pod
parent1377ae8b2142276c24d28d65865e459038984c62 (diff)
downloadblt-79d64f400391ce81b4eda73977cb40099256b348.zip
blt-79d64f400391ce81b4eda73977cb40099256b348.tar.gz
blt-79d64f400391ce81b4eda73977cb40099256b348.tar.bz2
upgrade XPA
Diffstat (limited to 'xpa/doc/pod/xpaopen.pod')
-rw-r--r--xpa/doc/pod/xpaopen.pod69
1 files changed, 0 insertions, 69 deletions
diff --git a/xpa/doc/pod/xpaopen.pod b/xpa/doc/pod/xpaopen.pod
deleted file mode 100644
index d88df02..0000000
--- a/xpa/doc/pod/xpaopen.pod
+++ /dev/null
@@ -1,69 +0,0 @@
-=pod
-
-=head1 NAME
-
-
-
-B<XPAOpen: allocate a persistent client handle>
-
-
-
-=head1 SYNOPSIS
-
-
-
-
-
- #include <xpa.h>
-
- XPA XPAOpen(char *mode);
-
-
-
-
-
-=head1 DESCRIPTION
-
-
-
-
-XPAOpen() allocates a persistent XPA struct that can be used with
-calls to XPAGet(), XPASet(), XPAInfo(), XPAGetFd(), and
-XPASetFd(). Persistence means that a connection to an XPA server is
-not closed when one of the above calls is completed but will be
-re-used on successive calls. Using XPAOpen() therefore saves the time
-it takes to connect to a server, which could be significant with slow
-connections or if there will be a large number of exchanges with a
-given access point. The mode argument currently is ignored ("reserved
-for future use").
-
-
-An XPA struct is returned if XPAOpen() was successful; otherwise NULL
-is returned. This returned struct can be passed as the first argument
-to XPAGet(), etc. Those calls will update the list of active XPA
-connections. Already connected servers (from a previous call) are
-left connected and new servers also will be connected. Old servers
-(from a previous call) that are no longer needed are disconnected.
-The connected servers will remain connected when the next call to
-XPAGet() is made and connections are once again updated.
-
-
-B<Example:>
-
- #include <xpa.h>
-
- XPA xpa;
- xpa = XPAOpen(NULL);
-
-
-
-
-
-=head1 SEE ALSO
-
-
-
-See xpa(n) for a list of XPA help pages
-
-
-=cut