Debian Codegraph @

cextern/xpa/man/man3/xpasetfd.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 "xpasetfd 3"
127 .TH xpasetfd 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 \&\fBXPASetFd: send data from stdin to one or more \s-1XPA\s0 servers\fR
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 .Vb 1
137 \& #include <xpa.h>
138 \&
139 \& int XPASetFd(XPA xpa,
140 \& char *template, char *paramlist, char *mode,
141 \& int fd, char **names, char **messages, int n)
142 .Ve
143 .SH "DESCRIPTION"
144 .IX Header "DESCRIPTION"
145 Read data from a standard I/O fd and send it to one or more \s-1XPA\s0
146 servers whose class:name identifier matches the specified
147 template.
148 .PP
149 A
150 template
151 of the form \*(L"class1:name1\*(R" is sent to the
152 \&\s-1XPA\s0 name server, which returns a list of at most n matching \s-1XPA\s0
153 servers. A connection is established with each of these servers and
154 the paramlist string is passed to the server as the data transfer
155 request is initiated. If an \s-1XPA\s0 struct is passed to the call, then the
156 persistent connections are updated as described above. Otherwise,
157 temporary connections are made to the servers (which will be closed
158 when the call completes).
159 .PP
160 The \fIXPASetFd()\fR routine then reads bytes from the specified fd
161 until \s-1EOF\s0 and sends these bytes to the \s-1XPA\s0 servers.
162 The final parameter n specifies the maximum number of servers to contact.
163 A string containing the class:name and ip:port of each server is returned in
164 the name array. If a given server returned an error, then the error
165 message will be stored in the associated element of the messages array.
166 \&\s-1NB:\s0 if specified, the name and messages arrays must be of size n or greater.
167 .PP
168 The return value will contain the actual number of servers that were
169 processed. This value thus will hold the number of valid entries in
170 the names and messages arrays, and can be used to loop through these
171 arrays. In names and/or messages is \s-1NULL\s0, no information is passed back
172 in that array.
173 .PP
174 The mode string is of the form: \*(L"key1=value1,key2=value2,...\*(R"
175 The following keywords are recognized:
176 .PP
177 .Vb 4
178 \& key value default explanation
179 \& \-\-\-\-\-\- \-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-
180 \& ack true/false true if false, don\*(Aqt wait for ack from server (after callback completes)
181 \& verify true/false false send buf from XPASet[Fd] to stdout
182 .Ve
183 .PP
184 The ack keyword is useful in cases where one does not want to wait for
185 the server to complete, e.g. is a lot of processing needs to be done
186 on the passed data or when the success of the server operation is not
187 relevant to the client.
188 .PP
189 \&\fBExample:\fR
190 .PP
191 .Vb 1
192 \& #include <xpa.h>
193 \&
194 \& #define NXPA 10
195 \& int i, got;
196 \& int fd;
197 \& char *names[NXPA];
198 \& char *messages[NXPA];
199 \& fd = open(...);
200 \& got = XPASetFd(NULL, "ds9", "fits", NULL, fd, names, messages, NXPA);
201 \& for(i=0; i<got; i++){
202 \& if( messages[i] != NULL ){
203 \& /* error processing */
204 \& fprintf(stderr, "ERROR: %s (%s)\en", messages[i], names[i]);
205 \& }
206 \& if( names[i] )
207 \& free(names[i]);
208 \& if( messages[i] )
209 \& free(messages[i]);
210 \& }
211 .Ve
212 .SH "SEE ALSO"
213 .IX Header "SEE ALSO"
214 See xpa(n) for a list of \s-1XPA\s0 help pages