Debian Codegraph @

cextern/xpa/man/man3/xpaserver.3

raw
1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 . de IX
53 . tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 . nr % 0
56 . rr F
57 .\}
58 .el \{\
59 . de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
66 .if n \{\
67 . ds #H 0
68 . ds #V .8m
69 . ds #F .3m
70 . ds #[ \f1
71 . ds #] \fP
72 .\}
73 .if t \{\
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 . ds #V .6m
76 . ds #F 0
77 . ds #[ \&
78 . ds #] \&
79 .\}
80 . \" simple accents for nroff and troff
81 .if n \{\
82 . ds ' \&
83 . ds ` \&
84 . ds ^ \&
85 . ds , \&
86 . ds ~ ~
87 . ds /
88 .\}
89 .if t \{\
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 . ds : e
114 . ds 8 ss
115 . ds o a
116 . ds d- d\h'-1'\(ga
117 . ds D- D\h'-1'\(hy
118 . ds th \o'bp'
119 . ds Th \o'LP'
120 . ds ae ae
121 . ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "xpaserver 3"
127 .TH xpaserver 3 "July 23, 2013" "version 2.1.15" "SAORD Documentation"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 \&\fBXPAServer: The \s-1XPA\s0 Server-side Programming Interface\fR
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 A description of the \s-1XPA\s0 server-side programming interface.
137 .SH "DESCRIPTION"
138 .IX Header "DESCRIPTION"
139 \&\fBIntroduction to \s-1XPA\s0 Server Programming\fR
140 .PP
141 Creating an \s-1XPA\s0 server is easy: you generally only need to call the
142 \&\fIXPANew()\fR subroutine to define a named \s-1XPA\s0 access point and set up the
143 send and receive callback routines. You then enter an event loop such
144 as \fIXPAMainLoop()\fR to field \s-1XPA\s0 requests.
145 .PP
146 .Vb 1
147 \& #include <xpa.h>
148 \&
149 \& XPA XPANew(char *class, char *name, char *help,
150 \& int (*send_callback)(), void *send_data, char *send_mode,
151 \& int (*rec_callback)(), void *rec_data, char *rec_mode);
152 \&
153 \& XPA XPACmdNew(char *class, char *name);
154 \&
155 \& XPACmd XPACmdAdd(XPA xpa,
156 \& char *name, char *help,
157 \& int (*send_callback)(), void *send_data, char *send_mode,
158 \& int (*rec_callback)(), void *rec_data, char *rec_mode);
159 \&
160 \& void XPACmdDel(XPA xpa, XPACmd cmd);
161 \&
162 \& XPA XPAInfoNew(char *class, char *name,
163 \& int (*info_callback)(), void *info_data, char *info_mode);
164 \&
165 \& int XPAFree(XPA xpa);
166 \&
167 \& void XPAMainLoop(void);
168 \&
169 \& int XPAPoll(int msec, int maxreq);
170 \&
171 \& void XPAAtExit(void);
172 \&
173 \& void XPACleanup(void);
174 .Ve
175 .PP
176 \&\fBIntroduction\fR
177 .PP
178 To use the \s-1XPA\s0 application programming interface, a software developer
179 generally will include the xpa.h definitions file:
180 .PP
181 .Vb 1
182 \& #include <xpa.h>
183 .Ve
184 .PP
185 in the software module that defines or accesses an \s-1XPA\s0 access point, and
186 then will link against the libxpa.a library:
187 .PP
188 .Vb 1
189 \& gcc \-o foo foo.c libxpa.a
190 .Ve
191 .PP
192 \&\s-1XPA\s0 has been compiled using both C and \*(C+ compilers.
193 .PP
194 A server program generally defines an \s-1XPA\s0 access point by calling the
195 \&\fIXPANew()\fR routine and specifies \*(L"send\*(R" and/or \*(L"receive\*(R" callback
196 procedures to be executed by the program when an external process
197 either sends data or commands to this access point or requests data or
198 information from this access point. A program also can define several
199 sub-commands for a single access point by calling \fIXPACmdNew()\fR and
200 \&\fIXPACmdAdd()\fR instead. Having defined one or more public access points
201 in this way, an \s-1XPA\s0 server program enters its usual event loop (or
202 uses the standard \s-1XPA\s0 event loop).
203 .SH "SEE ALSO"
204 .IX Header "SEE ALSO"
205 See xpa(n) for a list of \s-1XPA\s0 help pages