secure/lib/libcrypto/man/BIO_s_accept.3

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