Standard preamble:
========================================================================
..
.... Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================
Title "BIO_S_ACCEPT 3ossl"
way too many mistakes in technical documents.
Using accept BIOs, \s-1TCP/IP\s0 connections can be accepted and data transferred using only \s-1BIO\s0 routines. In this way any platform specific operations are hidden by the \s-1BIO\s0 abstraction.
Read and write operations on an accept \s-1BIO\s0 will perform I/O on the underlying connection. If no connection is established and the port (see below) is set up properly then the \s-1BIO\s0 waits for an incoming connection.
Accept BIOs support BIO_puts() but not BIO_gets().
If the close flag is set on an accept \s-1BIO\s0 then any active connection on that chain is shutdown and the socket closed when the \s-1BIO\s0 is freed.
Calling BIO_reset() on an accept \s-1BIO\s0 will close any active connection and reset the \s-1BIO\s0 into a state where it awaits another incoming connection.
\fBBIO_get_fd() and BIO_set_fd() can be called to retrieve or set the accept socket. See BIO_s_fd\|(3)
\fBBIO_set_accept_name() uses the string name to set the accept name. The name is represented as a string of the form \*(L"host:port\*(R", where \*(L"host\*(R" is the interface to use and \*(L"port\*(R" is the port. The host can be \*(L"*\*(R" or empty which is interpreted as meaning any interface. If the host is an IPv6 address, it has to be enclosed in brackets, for example \*(L"[::1]:https\*(R". \*(L"port\*(R" has the same syntax as the port specified in BIO_set_conn_port() for connect BIOs, that is it can be a numerical port string or a string to lookup using getservbyname() and a string table.
\fBBIO_set_accept_port() uses the string port to set the accept port of \s-1BIO\s0 b. \*(L"port\*(R" has the same syntax as the port specified in \fBBIO_set_conn_port() for connect BIOs, that is it can be a numerical port string or a string to lookup using getservbyname() and a string table. If the given port is 0 then a random available port is chosen. It may be queried using BIO_sock_info() and BIO_ADDR_service_string\|(3).
\fBBIO_new_accept() combines BIO_new() and BIO_set_accept_name() into a single call: that is it creates a new accept \s-1BIO\s0 with port \fBhost_port.
\fBBIO_set_nbio_accept() sets the accept socket to blocking mode (the default) if n is 0 or non blocking mode if n is 1.
\fBBIO_set_accept_bios() can be used to set a chain of BIOs which will be duplicated and prepended to the chain when an incoming connection is received. This is useful if, for example, a buffering or \s-1SSL BIO\s0 is required for each connection. The chain of BIOs must not be freed after this call, they will be automatically freed when the accept \s-1BIO\s0 is freed.
\fBBIO_get_accept_ip_family() returns the \s-1IP\s0 family accepted by the \s-1BIO\s0 b, which may be \s-1BIO_FAMILY_IPV4\s0, \s-1BIO_FAMILY_IPV6\s0, or \s-1BIO_FAMILY_IPANY\s0.
\fBBIO_set_accept_ip_family() sets the \s-1IP\s0 family family accepted by \s-1BIO\s0 b. The default is \s-1BIO_FAMILY_IPANY\s0.
\fBBIO_set_bind_mode() and BIO_get_bind_mode() set and retrieve the current bind mode. If \s-1BIO_BIND_NORMAL\s0 (the default) is set then another socket cannot be bound to the same port. If \fB\s-1BIO_BIND_REUSEADDR\s0 is set then other sockets can bind to the same port. If \s-1BIO_BIND_REUSEADDR_IF_UNUSED\s0 is set then and attempt is first made to use \s-1BIO_BIN_NORMAL,\s0 if this fails and the port is not in use then a second attempt is made using \s-1BIO_BIND_REUSEADDR\s0.
\fBBIO_do_accept() serves two functions. When it is first called, after the accept \s-1BIO\s0 has been setup, it will attempt to create the accept socket and bind an address to it. Second and subsequent calls to BIO_do_accept() will await an incoming connection, or request a retry in non blocking mode.
When a connection is established a new socket \s-1BIO\s0 is created for the connection and appended to the chain. That is the chain is now accept->socket. This effectively means that attempting I/O on an initial accept socket will await an incoming connection then perform I/O on it.
If any additional BIOs have been set using BIO_set_accept_bios() then they are placed between the socket and the accept \s-1BIO,\s0 that is the chain will be accept->otherbios->socket.
If a server wishes to process multiple connections (as is normally the case) then the accept \s-1BIO\s0 must be made available for further incoming connections. This can be done by waiting for a connection and then calling:
.Vb 1 connection = BIO_pop(accept); .Ve
After this call connection will contain a \s-1BIO\s0 for the recently established connection and accept will now be a single \s-1BIO\s0 again which can be used to await further incoming connections. If no further connections will be accepted the accept can be freed using BIO_free().
If only a single connection will be processed it is possible to perform I/O using the accept \s-1BIO\s0 itself. This is often undesirable however because the accept \s-1BIO\s0 will still accept additional incoming connections. This can be resolved by using BIO_pop() (see above) and freeing up the accept \s-1BIO\s0 after the initial connection.
If the underlying accept socket is nonblocking and BIO_do_accept() is called to await an incoming connection it is possible for \fBBIO_should_io_special() with the reason \s-1BIO_RR_ACCEPT.\s0 If this happens then it is an indication that an accept attempt would block: the application should take appropriate action to wait until the underlying socket has accepted a connection and retry the call.
\fBBIO_set_accept_name(), BIO_get_accept_name(), BIO_set_accept_port(), \fBBIO_get_accept_port(), BIO_set_nbio_accept(), BIO_set_accept_bios(), \fBBIO_get_peer_name(), BIO_get_peer_port(), \fBBIO_get_accept_ip_family(), BIO_set_accept_ip_family(), \fBBIO_set_bind_mode(), BIO_get_bind_mode() and BIO_do_accept() are macros.
\fBBIO_get_accept_name() returns the accept name or \s-1NULL\s0 on error. \fBBIO_get_peer_name() returns the peer name or \s-1NULL\s0 on error.
\fBBIO_get_accept_port() returns the accept port as a string or \s-1NULL\s0 on error. \fBBIO_get_peer_port() returns the peer port as a string or \s-1NULL\s0 on error. \fBBIO_get_accept_ip_family() returns the \s-1IP\s0 family or <=0 on error.
\fBBIO_get_bind_mode() returns the set of \s-1BIO_BIND\s0 flags, or <=0 on failure.
\fBBIO_new_accept() returns a \s-1BIO\s0 or \s-1NULL\s0 on error.
.Vb 1 BIO *abio, *cbio, *cbio2; \& /* First call to BIO_do_accept() sets up accept BIO */ abio = BIO_new_accept("4444"); if (BIO_do_accept(abio) <= 0) { fprintf(stderr, "Error setting up accept\en"); ERR_print_errors_fp(stderr); exit(1); } \& /* Wait for incoming connection */ if (BIO_do_accept(abio) <= 0) { fprintf(stderr, "Error accepting connection\en"); ERR_print_errors_fp(stderr); exit(1); } fprintf(stderr, "Connection 1 established\en"); \& /* Retrieve BIO for connection */ cbio = BIO_pop(abio); BIO_puts(cbio, "Connection 1: Sending out Data on initial connection\en"); fprintf(stderr, "Sent out data on connection 1\en"); \& /* Wait for another connection */ if (BIO_do_accept(abio) <= 0) { fprintf(stderr, "Error accepting connection\en"); ERR_print_errors_fp(stderr); exit(1); } fprintf(stderr, "Connection 2 established\en"); \& /* Close accept BIO to refuse further connections */ cbio2 = BIO_pop(abio); BIO_free(abio); BIO_puts(cbio2, "Connection 2: Sending out Data on second\en"); fprintf(stderr, "Sent out data on connection 2\en"); \& BIO_puts(cbio, "Connection 1: Second connection established\en"); \& /* Close the two established connections */ BIO_free(cbio); BIO_free(cbio2); .Ve
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.