Debian Codegraph @

cextern/xpa/man/man3/xpamainloop.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 "xpamainloop 3"
127 .TH xpamainloop 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 \&\fBXPAMainLoop: optional main loop for \s-1XPA\s0\fR
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 .Vb 1
137 \& #include <xpa.h>
138 \&
139 \& void XPAMainLoop();
140 .Ve
141 .SH "DESCRIPTION"
142 .IX Header "DESCRIPTION"
143 Once \s-1XPA\s0 access points have been defined, a program must enter an
144 event loop to watch for requests from external programs. This can be
145 done in a variety of ways, depending on whether the event loop is
146 processing events other than \s-1XPA\s0 events. In cases where there are no
147 non-XPA events to be processed, the program can simply call the
148 \&\fIXPAMainLoop()\fR event loop. This loop is implemented essentially as
149 follows (error checking is simplified in this example):
150 .PP
151 .Vb 8
152 \& FD_ZERO(&readfds);
153 \& while( XPAAddSelect(NULL, &readfds) ){
154 \& if( sgot = select(swidth, &readfds, NULL, NULL, NULL) >0 )
155 \& XPAProcessSelect(&readfds, 0);
156 \& else
157 \& break;
158 \& FD_ZERO(&readfds);
159 \& }
160 .Ve
161 .PP
162 The \fIXPAAddSelect()\fR routine sets up the \fIselect()\fR readfds variable so
163 that \fIselect()\fR will wait for I/O on all the active \s-1XPA\s0 channels. It
164 returns the number of XPAs that are active; the loop will end when
165 there are no active XPAs. The standard \fIselect()\fR routine is called to
166 wait for an external I/O request. Since no timeout struct is passed
167 in argument 5, the \fIselect()\fR call hangs until there is an external
168 request. When an external I/O request is made, the \fIXPAProcessSelect()\fR
169 routine is executed to process the pending requests. In this routine,
170 the maxreq value determines how many requests will be processed: if
171 maxreq <=0, then all currently pending requests will be processed.
172 Otherwise, up to maxreq requests will be processed. (The most usual
173 values for maxreq is 0 to process all requests.)
174 .PP
175 If a program has its own Unix \fIselect()\fR loop, then \s-1XPA\s0 access points can
176 be added to it by using a variation of the standard XPAMainLoop:
177 .PP
178 .Vb 7
179 \& XPAAddSelect(xpa, &readfds);
180 \& [app\-specific ...]
181 \& if( select(width, &readfds, ...) ){
182 \& XPAProcessSelect(&readfds, maxreq);
183 \& [app\-specific ...]
184 \& FD_ZERO(&readfds);
185 \& }
186 .Ve
187 .PP
188 \&\fIXPAAddSelect()\fR is called before \fIselect()\fR to add the access points.
189 If the first argument is \s-1NULL\s0, then all active \s-1XPA\s0 access points
190 are added. Otherwise only the specified access point is added.
191 After \fIselect()\fR is called, the \fIXPAProcessSelect()\fR routine can be called
192 to process \s-1XPA\s0 requests. Once again, the maxreq value determines how
193 many requests will be processed: if maxreq <=0, then all currently
194 pending requests will be processed. Otherwise, up to maxreq requests
195 will be processed.
196 .PP
197 \&\s-1XPA\s0 access points can be added to
198 Xt event loops (using \fIXtAppMainLoop()\fR)
199 and
200 Tcl/Tk event loops (using vwait and the Tk loop).
201 When using \s-1XPA\s0 with these event loops, you only need to call:
202 .PP
203 int XPAXtAddInput(XtAppContext app, \s-1XPA\s0 xpa)
204 .PP
205 or
206 .PP
207 .Vb 1
208 \& int XPATclAddInput(XPA xpa)
209 .Ve
210 .PP
211 respectively before entering the loop.
212 .SH "SEE ALSO"
213 .IX Header "SEE ALSO"
214 See xpa(n) for a list of \s-1XPA\s0 help pages