doc/crypto/bio.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 bio - I/O abstraction
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/bio.h>
  10
  11 =head1 DESCRIPTION
  12
  13 A BIO is an I/O abstraction, it hides many of the underlying I/O
  14 details from an application. If an application uses a BIO for its
  15 I/O it can transparently handle SSL connections, unencrypted network
  16 connections and file I/O.
  17
  18 There are two type of BIO, a source/sink BIO and a filter BIO.
  19
  20 As its name implies a source/sink BIO is a source and/or sink of data,
  21 examples include a socket BIO and a file BIO.
  22
  23 A filter BIO takes data from one BIO and passes it through to
  24 another, or the application. The data may be left unmodified (for
  25 example a message digest BIO) or translated (for example an
  26 encryption BIO). The effect of a filter BIO may change according
  27 to the I/O operation it is performing: for example an encryption
  28 BIO will encrypt data if it is being written to and decrypt data
  29 if it is being read from.
  30
  31 BIOs can be joined together to form a chain (a single BIO is a chain
  32 with one component). A chain normally consist of one source/sink
  33 BIO and one or more filter BIOs. Data read from or written to the
  34 first BIO then traverses the chain to the end (normally a source/sink
  35 BIO).
  36
  37 =head1 SEE ALSO
  38
  39 L<BIO_ctrl(3)>,
  40 L<BIO_f_base64(3)>, L<BIO_f_buffer(3)>,
  41 L<BIO_f_cipher(3)>, L<BIO_f_md(3)>,
  42 L<BIO_f_null(3)>, L<BIO_f_ssl(3)>,
  43 L<BIO_find_type(3)>, L<BIO_new(3)>,
  44 L<BIO_new_bio_pair(3)>,
  45 L<BIO_push(3)>, L<BIO_read(3)>,
  46 L<BIO_s_accept(3)>, L<BIO_s_bio(3)>,
  47 L<BIO_s_connect(3)>, L<BIO_s_fd(3)>,
  48 L<BIO_s_file(3)>, L<BIO_s_mem(3)>,
  49 L<BIO_s_mem(3)>,
  50 L<BIO_s_null(3)>, L<BIO_s_socket(3)>,
  51 L<BIO_set_callback(3)>,
  52 L<BIO_should_retry(3)>
  53
  54 =head1 COPYRIGHT
  55
  56 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  57
  58 Licensed under the OpenSSL license (the "License").  You may not use
  59 this file except in compliance with the License.  You can obtain a copy
  60 in the file LICENSE in the source distribution or at
  61 L<https://www.openssl.org/source/license.html>.
  62
  63 =cut