etc/services - sync with NetBSD-8
[minix.git] / crypto / external / bsd / openssl / lib / libcrypto / man / BIO_s_accept.3
blobb600a7f26904a2da76dba798ce1f5ed8e5d651f9
1 .\"     $NetBSD: BIO_s_accept.3,v 1.14 2015/06/12 17:01:13 christos Exp $
2 .\"
3 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
4 .\"
5 .\" Standard preamble:
6 .\" ========================================================================
7 .de Sp \" Vertical space (when we can't use .PP)
8 .if t .sp .5v
9 .if n .sp
11 .de Vb \" Begin verbatim text
12 .ft CW
13 .nf
14 .ne \\$1
16 .de Ve \" End verbatim text
17 .ft R
18 .fi
20 .\" Set up some character translations and predefined strings.  \*(-- will
21 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
22 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
23 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
24 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
25 .\" nothing in troff, for use with C<>.
26 .tr \(*W-
27 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
28 .ie n \{\
29 .    ds -- \(*W-
30 .    ds PI pi
31 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
32 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
33 .    ds L" ""
34 .    ds R" ""
35 .    ds C` ""
36 .    ds C' ""
37 'br\}
38 .el\{\
39 .    ds -- \|\(em\|
40 .    ds PI \(*p
41 .    ds L" ``
42 .    ds R" ''
43 .    ds C`
44 .    ds C'
45 'br\}
46 .\"
47 .\" Escape single quotes in literal strings from groff's Unicode transform.
48 .ie \n(.g .ds Aq \(aq
49 .el       .ds Aq '
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .\"
56 .\" Avoid warning from groff about undefined register 'F'.
57 .de IX
59 .nr rF 0
60 .if \n(.g .if rF .nr rF 1
61 .if (\n(rF:(\n(.g==0)) \{
62 .    if \nF \{
63 .        de IX
64 .        tm Index:\\$1\t\\n%\t"\\$2"
66 .        if !\nF==2 \{
67 .            nr % 0
68 .            nr F 2
69 .        \}
70 .    \}
71 .\}
72 .rr rF
73 .\"
74 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
75 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
76 .    \" fudge factors for nroff and troff
77 .if n \{\
78 .    ds #H 0
79 .    ds #V .8m
80 .    ds #F .3m
81 .    ds #[ \f1
82 .    ds #] \fP
83 .\}
84 .if t \{\
85 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
86 .    ds #V .6m
87 .    ds #F 0
88 .    ds #[ \&
89 .    ds #] \&
90 .\}
91 .    \" simple accents for nroff and troff
92 .if n \{\
93 .    ds ' \&
94 .    ds ` \&
95 .    ds ^ \&
96 .    ds , \&
97 .    ds ~ ~
98 .    ds /
99 .\}
100 .if t \{\
101 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
102 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
103 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
104 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
105 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
106 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
108 .    \" troff and (daisy-wheel) nroff accents
109 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
110 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
111 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
112 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
113 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
114 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
115 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
116 .ds ae a\h'-(\w'a'u*4/10)'e
117 .ds Ae A\h'-(\w'A'u*4/10)'E
118 .    \" corrections for vroff
119 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
120 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
121 .    \" for low resolution devices (crt and lpr)
122 .if \n(.H>23 .if \n(.V>19 \
124 .    ds : e
125 .    ds 8 ss
126 .    ds o a
127 .    ds d- d\h'-1'\(ga
128 .    ds D- D\h'-1'\(hy
129 .    ds th \o'bp'
130 .    ds Th \o'LP'
131 .    ds ae ae
132 .    ds Ae AE
134 .rm #[ #] #H #V #F C
135 .\" ========================================================================
137 .IX Title "BIO_s_accept 3"
138 .TH BIO_s_accept 3 "2014-10-17" "1.0.1n" "OpenSSL"
139 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
140 .\" way too many mistakes in technical documents.
141 .if n .ad l
143 .SH "NAME"
144 BIO_s_accept, BIO_set_accept_port, BIO_get_accept_port,
145 BIO_set_nbio_accept, BIO_set_accept_bios, BIO_set_bind_mode,
146 BIO_get_bind_mode, BIO_do_accept \- accept BIO
147 .SH "LIBRARY"
148 libcrypto, -lcrypto
149 .SH "SYNOPSIS"
150 .IX Header "SYNOPSIS"
151 .Vb 1
152 \& #include <openssl/bio.h>
154 \& BIO_METHOD *BIO_s_accept(void);
156 \& long BIO_set_accept_port(BIO *b, char *name);
157 \& char *BIO_get_accept_port(BIO *b);
159 \& BIO *BIO_new_accept(char *host_port);
161 \& long BIO_set_nbio_accept(BIO *b, int n);
162 \& long BIO_set_accept_bios(BIO *b, char *bio);
164 \& long BIO_set_bind_mode(BIO *b, long mode);
165 \& long BIO_get_bind_mode(BIO *b, long dummy);
167 \& #define BIO_BIND_NORMAL                0
168 \& #define BIO_BIND_REUSEADDR_IF_UNUSED   1
169 \& #define BIO_BIND_REUSEADDR             2
171 \& int BIO_do_accept(BIO *b);
173 .SH "DESCRIPTION"
174 .IX Header "DESCRIPTION"
175 \&\fIBIO_s_accept()\fR returns the accept \s-1BIO\s0 method. This is a wrapper
176 round the platform's \s-1TCP/IP\s0 socket accept routines.
178 Using accept BIOs, \s-1TCP/IP\s0 connections can be accepted and data
179 transferred using only \s-1BIO\s0 routines. In this way any platform
180 specific operations are hidden by the \s-1BIO\s0 abstraction.
182 Read and write operations on an accept \s-1BIO\s0 will perform I/O
183 on the underlying connection. If no connection is established
184 and the port (see below) is set up properly then the \s-1BIO\s0
185 waits for an incoming connection.
187 Accept BIOs support \fIBIO_puts()\fR but not \fIBIO_gets()\fR.
189 If the close flag is set on an accept \s-1BIO\s0 then any active
190 connection on that chain is shutdown and the socket closed when
191 the \s-1BIO\s0 is freed.
193 Calling \fIBIO_reset()\fR on a accept \s-1BIO\s0 will close any active
194 connection and reset the \s-1BIO\s0 into a state where it awaits another
195 incoming connection.
197 \&\fIBIO_get_fd()\fR and \fIBIO_set_fd()\fR can be called to retrieve or set
198 the accept socket. See \fIBIO_s_fd\fR\|(3)
200 \&\fIBIO_set_accept_port()\fR uses the string \fBname\fR to set the accept
201 port. The port is represented as a string of the form \*(L"host:port\*(R",
202 where \*(L"host\*(R" is the interface to use and \*(L"port\*(R" is the port.
203 The host can be can be \*(L"*\*(R" which is interpreted as meaning
204 any interface; \*(L"port\*(R" has the same syntax
205 as the port specified in \fIBIO_set_conn_port()\fR for connect BIOs,
206 that is it can be a numerical port string or a string to lookup
207 using \fIgetservbyname()\fR and a string table.
209 \&\fIBIO_new_accept()\fR combines \fIBIO_new()\fR and \fIBIO_set_accept_port()\fR into
210 a single call: that is it creates a new accept \s-1BIO\s0 with port
211 \&\fBhost_port\fR.
213 \&\fIBIO_set_nbio_accept()\fR sets the accept socket to blocking mode
214 (the default) if \fBn\fR is 0 or non blocking mode if \fBn\fR is 1.
216 \&\fIBIO_set_accept_bios()\fR can be used to set a chain of BIOs which
217 will be duplicated and prepended to the chain when an incoming
218 connection is received. This is useful if, for example, a
219 buffering or \s-1SSL BIO\s0 is required for each connection. The
220 chain of BIOs must not be freed after this call, they will
221 be automatically freed when the accept \s-1BIO\s0 is freed.
223 \&\fIBIO_set_bind_mode()\fR and \fIBIO_get_bind_mode()\fR set and retrieve
224 the current bind mode. If \s-1BIO_BIND_NORMAL \s0(the default) is set
225 then another socket cannot be bound to the same port. If
226 \&\s-1BIO_BIND_REUSEADDR\s0 is set then other sockets can bind to the
227 same port. If \s-1BIO_BIND_REUSEADDR_IF_UNUSED\s0 is set then and
228 attempt is first made to use \s-1BIO_BIN_NORMAL,\s0 if this fails
229 and the port is not in use then a second attempt is made
230 using \s-1BIO_BIND_REUSEADDR.\s0
232 \&\fIBIO_do_accept()\fR serves two functions. When it is first
233 called, after the accept \s-1BIO\s0 has been setup, it will attempt
234 to create the accept socket and bind an address to it. Second
235 and subsequent calls to \fIBIO_do_accept()\fR will await an incoming
236 connection, or request a retry in non blocking mode.
237 .SH "NOTES"
238 .IX Header "NOTES"
239 When an accept \s-1BIO\s0 is at the end of a chain it will await an
240 incoming connection before processing I/O calls. When an accept
241 \&\s-1BIO\s0 is not at then end of a chain it passes I/O calls to the next
242 \&\s-1BIO\s0 in the chain.
244 When a connection is established a new socket \s-1BIO\s0 is created for
245 the connection and appended to the chain. That is the chain is now
246 accept\->socket. This effectively means that attempting I/O on
247 an initial accept socket will await an incoming connection then
248 perform I/O on it.
250 If any additional BIOs have been set using \fIBIO_set_accept_bios()\fR
251 then they are placed between the socket and the accept \s-1BIO,\s0
252 that is the chain will be accept\->otherbios\->socket.
254 If a server wishes to process multiple connections (as is normally
255 the case) then the accept \s-1BIO\s0 must be made available for further
256 incoming connections. This can be done by waiting for a connection and
257 then calling:
259 .Vb 1
260 \& connection = BIO_pop(accept);
263 After this call \fBconnection\fR will contain a \s-1BIO\s0 for the recently
264 established connection and \fBaccept\fR will now be a single \s-1BIO\s0
265 again which can be used to await further incoming connections.
266 If no further connections will be accepted the \fBaccept\fR can
267 be freed using \fIBIO_free()\fR.
269 If only a single connection will be processed it is possible to
270 perform I/O using the accept \s-1BIO\s0 itself. This is often undesirable
271 however because the accept \s-1BIO\s0 will still accept additional incoming
272 connections. This can be resolved by using \fIBIO_pop()\fR (see above)
273 and freeing up the accept \s-1BIO\s0 after the initial connection.
275 If the underlying accept socket is non-blocking and \fIBIO_do_accept()\fR is
276 called to await an incoming connection it is possible for
277 \&\fIBIO_should_io_special()\fR with the reason \s-1BIO_RR_ACCEPT.\s0 If this happens
278 then it is an indication that an accept attempt would block: the application
279 should take appropriate action to wait until the underlying socket has
280 accepted a connection and retry the call.
282 \&\fIBIO_set_accept_port()\fR, \fIBIO_get_accept_port()\fR, \fIBIO_set_nbio_accept()\fR,
283 \&\fIBIO_set_accept_bios()\fR, \fIBIO_set_bind_mode()\fR, \fIBIO_get_bind_mode()\fR and
284 \&\fIBIO_do_accept()\fR are macros.
285 .SH "RETURN VALUES"
286 .IX Header "RETURN VALUES"
287 \&\s-1TBA\s0
288 .SH "EXAMPLE"
289 .IX Header "EXAMPLE"
290 This example accepts two connections on port 4444, sends messages
291 down each and finally closes both down.
293 .Vb 3
294 \& BIO *abio, *cbio, *cbio2;
295 \& ERR_load_crypto_strings();
296 \& abio = BIO_new_accept("4444");
298 \& /* First call to BIO_accept() sets up accept BIO */
299 \& if(BIO_do_accept(abio) <= 0) {
300 \&        fprintf(stderr, "Error setting up accept\en");
301 \&        ERR_print_errors_fp(stderr);
302 \&        exit(0);
303 \& }
305 \& /* Wait for incoming connection */
306 \& if(BIO_do_accept(abio) <= 0) {
307 \&        fprintf(stderr, "Error accepting connection\en");
308 \&        ERR_print_errors_fp(stderr);
309 \&        exit(0);
310 \& }
311 \& fprintf(stderr, "Connection 1 established\en");
312 \& /* Retrieve BIO for connection */
313 \& cbio = BIO_pop(abio);
314 \& BIO_puts(cbio, "Connection 1: Sending out Data on initial connection\en");
315 \& fprintf(stderr, "Sent out data on connection 1\en");
316 \& /* Wait for another connection */
317 \& if(BIO_do_accept(abio) <= 0) {
318 \&        fprintf(stderr, "Error accepting connection\en");
319 \&        ERR_print_errors_fp(stderr);
320 \&        exit(0);
321 \& }
322 \& fprintf(stderr, "Connection 2 established\en");
323 \& /* Close accept BIO to refuse further connections */
324 \& cbio2 = BIO_pop(abio);
325 \& BIO_free(abio);
326 \& BIO_puts(cbio2, "Connection 2: Sending out Data on second\en");
327 \& fprintf(stderr, "Sent out data on connection 2\en");
329 \& BIO_puts(cbio, "Connection 1: Second connection established\en");
330 \& /* Close the two established connections */
331 \& BIO_free(cbio);
332 \& BIO_free(cbio2);
334 .SH "SEE ALSO"
335 .IX Header "SEE ALSO"
336 \&\s-1TBA\s0