secure/lib/libcrypto/man/BIO_s_accept.3

   1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
   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 "BIO_s_accept 3"
 127 .TH BIO_s_accept 3 "2010-11-16" "1.0.0b" "OpenSSL"
 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 BIO_s_accept, BIO_set_accept_port, BIO_get_accept_port,
 134 BIO_set_nbio_accept, BIO_set_accept_bios, BIO_set_bind_mode,
 135 BIO_get_bind_mode, BIO_do_accept \- accept BIO
 136 .SH "SYNOPSIS"
 137 .IX Header "SYNOPSIS"
 138 .Vb 1
 139 \& #include <openssl/bio.h>
 140 \&
 141 \& BIO_METHOD *BIO_s_accept(void);
 142 \&
 143 \& long BIO_set_accept_port(BIO *b, char *name);
 144 \& char *BIO_get_accept_port(BIO *b);
 145 \&
 146 \& BIO *BIO_new_accept(char *host_port);
 147 \&
 148 \& long BIO_set_nbio_accept(BIO *b, int n);
 149 \& long BIO_set_accept_bios(BIO *b, char *bio);
 150 \&
 151 \& long BIO_set_bind_mode(BIO *b, long mode);
 152 \& long BIO_get_bind_mode(BIO *b, long dummy);
 153 \&
 154 \& #define BIO_BIND_NORMAL                0
 155 \& #define BIO_BIND_REUSEADDR_IF_UNUSED   1
 156 \& #define BIO_BIND_REUSEADDR             2
 157 \&
 158 \& int BIO_do_accept(BIO *b);
 159 .Ve
 160 .SH "DESCRIPTION"
 161 .IX Header "DESCRIPTION"
 162 \&\fIBIO_s_accept()\fR returns the accept \s-1BIO\s0 method. This is a wrapper
 163 round the platform's \s-1TCP/IP\s0 socket accept routines.
 164 .PP
 165 Using accept BIOs, \s-1TCP/IP\s0 connections can be accepted and data
 166 transferred using only \s-1BIO\s0 routines. In this way any platform
 167 specific operations are hidden by the \s-1BIO\s0 abstraction.
 168 .PP
 169 Read and write operations on an accept \s-1BIO\s0 will perform I/O
 170 on the underlying connection. If no connection is established
 171 and the port (see below) is set up properly then the \s-1BIO\s0
 172 waits for an incoming connection.
 173 .PP
 174 Accept BIOs support \fIBIO_puts()\fR but not \fIBIO_gets()\fR.
 175 .PP
 176 If the close flag is set on an accept \s-1BIO\s0 then any active
 177 connection on that chain is shutdown and the socket closed when
 178 the \s-1BIO\s0 is freed.
 179 .PP
 180 Calling \fIBIO_reset()\fR on a accept \s-1BIO\s0 will close any active
 181 connection and reset the \s-1BIO\s0 into a state where it awaits another
 182 incoming connection.
 183 .PP
 184 \&\fIBIO_get_fd()\fR and \fIBIO_set_fd()\fR can be called to retrieve or set
 185 the accept socket. See \fIBIO_s_fd\fR\|(3)
 186 .PP
 187 \&\fIBIO_set_accept_port()\fR uses the string \fBname\fR to set the accept
 188 port. The port is represented as a string of the form \*(L"host:port\*(R",
 189 where \*(L"host\*(R" is the interface to use and \*(L"port\*(R" is the port.
 190 Either or both values can be \*(L"*\*(R" which is interpreted as meaning
 191 any interface or port respectively. \*(L"port\*(R" has the same syntax
 192 as the port specified in \fIBIO_set_conn_port()\fR for connect BIOs,
 193 that is it can be a numerical port string or a string to lookup
 194 using \fIgetservbyname()\fR and a string table.
 195 .PP
 196 \&\fIBIO_new_accept()\fR combines \fIBIO_new()\fR and \fIBIO_set_accept_port()\fR into
 197 a single call: that is it creates a new accept \s-1BIO\s0 with port
 198 \&\fBhost_port\fR.
 199 .PP
 200 \&\fIBIO_set_nbio_accept()\fR sets the accept socket to blocking mode
 201 (the default) if \fBn\fR is 0 or non blocking mode if \fBn\fR is 1.
 202 .PP
 203 \&\fIBIO_set_accept_bios()\fR can be used to set a chain of BIOs which
 204 will be duplicated and prepended to the chain when an incoming
 205 connection is received. This is useful if, for example, a
 206 buffering or \s-1SSL\s0 \s-1BIO\s0 is required for each connection. The
 207 chain of BIOs must not be freed after this call, they will
 208 be automatically freed when the accept \s-1BIO\s0 is freed.
 209 .PP
 210 \&\fIBIO_set_bind_mode()\fR and \fIBIO_get_bind_mode()\fR set and retrieve
 211 the current bind mode. If \s-1BIO_BIND_NORMAL\s0 (the default) is set
 212 then another socket cannot be bound to the same port. If
 213 \&\s-1BIO_BIND_REUSEADDR\s0 is set then other sockets can bind to the
 214 same port. If \s-1BIO_BIND_REUSEADDR_IF_UNUSED\s0 is set then and
 215 attempt is first made to use \s-1BIO_BIN_NORMAL\s0, if this fails
 216 and the port is not in use then a second attempt is made
 217 using \s-1BIO_BIND_REUSEADDR\s0.
 218 .PP
 219 \&\fIBIO_do_accept()\fR serves two functions. When it is first
 220 called, after the accept \s-1BIO\s0 has been setup, it will attempt
 221 to create the accept socket and bind an address to it. Second
 222 and subsequent calls to \fIBIO_do_accept()\fR will await an incoming
 223 connection, or request a retry in non blocking mode.
 224 .SH "NOTES"
 225 .IX Header "NOTES"
 226 When an accept \s-1BIO\s0 is at the end of a chain it will await an
 227 incoming connection before processing I/O calls. When an accept
 228 \&\s-1BIO\s0 is not at then end of a chain it passes I/O calls to the next
 229 \&\s-1BIO\s0 in the chain.
 230 .PP
 231 When a connection is established a new socket \s-1BIO\s0 is created for
 232 the connection and appended to the chain. That is the chain is now
 233 accept\->socket. This effectively means that attempting I/O on
 234 an initial accept socket will await an incoming connection then
 235 perform I/O on it.
 236 .PP
 237 If any additional BIOs have been set using \fIBIO_set_accept_bios()\fR
 238 then they are placed between the socket and the accept \s-1BIO\s0,
 239 that is the chain will be accept\->otherbios\->socket.
 240 .PP
 241 If a server wishes to process multiple connections (as is normally
 242 the case) then the accept \s-1BIO\s0 must be made available for further
 243 incoming connections. This can be done by waiting for a connection and
 244 then calling:
 245 .PP
 246 .Vb 1
 247 \& connection = BIO_pop(accept);
 248 .Ve
 249 .PP
 250 After this call \fBconnection\fR will contain a \s-1BIO\s0 for the recently
 251 established connection and \fBaccept\fR will now be a single \s-1BIO\s0
 252 again which can be used to await further incoming connections.
 253 If no further connections will be accepted the \fBaccept\fR can
 254 be freed using \fIBIO_free()\fR.
 255 .PP
 256 If only a single connection will be processed it is possible to
 257 perform I/O using the accept \s-1BIO\s0 itself. This is often undesirable
 258 however because the accept \s-1BIO\s0 will still accept additional incoming
 259 connections. This can be resolved by using \fIBIO_pop()\fR (see above)
 260 and freeing up the accept \s-1BIO\s0 after the initial connection.
 261 .PP
 262 If the underlying accept socket is non-blocking and \fIBIO_do_accept()\fR is
 263 called to await an incoming connection it is possible for
 264 \&\fIBIO_should_io_special()\fR with the reason \s-1BIO_RR_ACCEPT\s0. If this happens
 265 then it is an indication that an accept attempt would block: the application
 266 should take appropriate action to wait until the underlying socket has
 267 accepted a connection and retry the call.
 268 .PP
 269 \&\fIBIO_set_accept_port()\fR, \fIBIO_get_accept_port()\fR, \fIBIO_set_nbio_accept()\fR,
 270 \&\fIBIO_set_accept_bios()\fR, \fIBIO_set_bind_mode()\fR, \fIBIO_get_bind_mode()\fR and
 271 \&\fIBIO_do_accept()\fR are macros.
 272 .SH "RETURN VALUES"
 273 .IX Header "RETURN VALUES"
 274 \&\s-1TBA\s0
 275 .SH "EXAMPLE"
 276 .IX Header "EXAMPLE"
 277 This example accepts two connections on port 4444, sends messages
 278 down each and finally closes both down.
 279 .PP
 280 .Vb 3
 281 \& BIO *abio, *cbio, *cbio2;
 282 \& ERR_load_crypto_strings();
 283 \& abio = BIO_new_accept("4444");
 284 \&
 285 \& /* First call to BIO_accept() sets up accept BIO */
 286 \& if(BIO_do_accept(abio) <= 0) {
 287 \&        fprintf(stderr, "Error setting up accept\en");
 288 \&        ERR_print_errors_fp(stderr);
 289 \&        exit(0);
 290 \& }
 291 \&
 292 \& /* Wait for incoming connection */
 293 \& if(BIO_do_accept(abio) <= 0) {
 294 \&        fprintf(stderr, "Error accepting connection\en");
 295 \&        ERR_print_errors_fp(stderr);
 296 \&        exit(0);
 297 \& }
 298 \& fprintf(stderr, "Connection 1 established\en");
 299 \& /* Retrieve BIO for connection */
 300 \& cbio = BIO_pop(abio);
 301 \& BIO_puts(cbio, "Connection 1: Sending out Data on initial connection\en");
 302 \& fprintf(stderr, "Sent out data on connection 1\en");
 303 \& /* Wait for another connection */
 304 \& if(BIO_do_accept(abio) <= 0) {
 305 \&        fprintf(stderr, "Error accepting connection\en");
 306 \&        ERR_print_errors_fp(stderr);
 307 \&        exit(0);
 308 \& }
 309 \& fprintf(stderr, "Connection 2 established\en");
 310 \& /* Close accept BIO to refuse further connections */
 311 \& cbio2 = BIO_pop(abio);
 312 \& BIO_free(abio);
 313 \& BIO_puts(cbio2, "Connection 2: Sending out Data on second\en");
 314 \& fprintf(stderr, "Sent out data on connection 2\en");
 315 \&
 316 \& BIO_puts(cbio, "Connection 1: Second connection established\en");
 317 \& /* Close the two established connections */
 318 \& BIO_free(cbio);
 319 \& BIO_free(cbio2);
 320 .Ve
 321 .SH "SEE ALSO"
 322 .IX Header "SEE ALSO"
 323 \&\s-1TBA\s0