summaryrefslogtreecommitdiffstats
path: root/xpa/man/man3/xpaserver.3
diff options
context:
space:
mode:
Diffstat (limited to 'xpa/man/man3/xpaserver.3')
-rw-r--r--xpa/man/man3/xpaserver.3205
1 files changed, 205 insertions, 0 deletions
diff --git a/xpa/man/man3/xpaserver.3 b/xpa/man/man3/xpaserver.3
new file mode 100644
index 0000000..a0803aa
--- /dev/null
+++ b/xpa/man/man3/xpaserver.3
@@ -0,0 +1,205 @@
+.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings. \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote. \*(C+ will
+.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+. ds -- \(*W-
+. ds PI pi
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+. ds L" ""
+. ds R" ""
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds -- \|\(em\|
+. ds PI \(*p
+. ds L" ``
+. ds R" ''
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.ie \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. nr % 0
+. rr F
+.\}
+.el \{\
+. de IX
+..
+.\}
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "xpaserver 3"
+.TH xpaserver 3 "July 23, 2013" "version 2.1.15" "SAORD Documentation"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+\&\fBXPAServer: The \s-1XPA\s0 Server-side Programming Interface\fR
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+A description of the \s-1XPA\s0 server-side programming interface.
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+\&\fBIntroduction to \s-1XPA\s0 Server Programming\fR
+.PP
+Creating an \s-1XPA\s0 server is easy: you generally only need to call the
+\&\fIXPANew()\fR subroutine to define a named \s-1XPA\s0 access point and set up the
+send and receive callback routines. You then enter an event loop such
+as \fIXPAMainLoop()\fR to field \s-1XPA\s0 requests.
+.PP
+.Vb 1
+\& #include <xpa.h>
+\&
+\& XPA XPANew(char *class, char *name, char *help,
+\& int (*send_callback)(), void *send_data, char *send_mode,
+\& int (*rec_callback)(), void *rec_data, char *rec_mode);
+\&
+\& XPA XPACmdNew(char *class, char *name);
+\&
+\& XPACmd XPACmdAdd(XPA xpa,
+\& char *name, char *help,
+\& int (*send_callback)(), void *send_data, char *send_mode,
+\& int (*rec_callback)(), void *rec_data, char *rec_mode);
+\&
+\& void XPACmdDel(XPA xpa, XPACmd cmd);
+\&
+\& XPA XPAInfoNew(char *class, char *name,
+\& int (*info_callback)(), void *info_data, char *info_mode);
+\&
+\& int XPAFree(XPA xpa);
+\&
+\& void XPAMainLoop(void);
+\&
+\& int XPAPoll(int msec, int maxreq);
+\&
+\& void XPAAtExit(void);
+\&
+\& void XPACleanup(void);
+.Ve
+.PP
+\&\fBIntroduction\fR
+.PP
+To use the \s-1XPA\s0 application programming interface, a software developer
+generally will include the xpa.h definitions file:
+.PP
+.Vb 1
+\& #include <xpa.h>
+.Ve
+.PP
+in the software module that defines or accesses an \s-1XPA\s0 access point, and
+then will link against the libxpa.a library:
+.PP
+.Vb 1
+\& gcc \-o foo foo.c libxpa.a
+.Ve
+.PP
+\&\s-1XPA\s0 has been compiled using both C and \*(C+ compilers.
+.PP
+A server program generally defines an \s-1XPA\s0 access point by calling the
+\&\fIXPANew()\fR routine and specifies \*(L"send\*(R" and/or \*(L"receive\*(R" callback
+procedures to be executed by the program when an external process
+either sends data or commands to this access point or requests data or
+information from this access point. A program also can define several
+sub-commands for a single access point by calling \fIXPACmdNew()\fR and
+\&\fIXPACmdAdd()\fR instead. Having defined one or more public access points
+in this way, an \s-1XPA\s0 server program enters its usual event loop (or
+uses the standard \s-1XPA\s0 event loop).
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+See xpa(n) for a list of \s-1XPA\s0 help pages