secure/lib/libcrypto/man/BIO_s_accept.3

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