doc/crypto/BIO_s_bio.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 BIO_s_bio, BIO_make_bio_pair, BIO_destroy_bio_pair, BIO_set_write_buf_size,
   6 BIO_get_write_buf_size, BIO_new_bio_pair, BIO_get_write_guarantee,
   7 BIO_ctrl_get_write_guarantee, BIO_get_read_request, BIO_ctrl_get_read_request,
   8 BIO_ctrl_reset_read_request - BIO pair BIO
   9
  10 =head1 SYNOPSIS
  11
  12  #include <openssl/bio.h>
  13
  14  BIO_METHOD *BIO_s_bio(void);
  15
  16  #define BIO_make_bio_pair(b1,b2)   (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
  17  #define BIO_destroy_bio_pair(b)    (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
  18
  19  #define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
  20  #define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
  21
  22  int BIO_new_bio_pair(BIO **bio1, size_t writebuf1, BIO **bio2, size_t writebuf2);
  23
  24  #define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
  25  size_t BIO_ctrl_get_write_guarantee(BIO *b);
  26
  27  #define BIO_get_read_request(b)    (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
  28  size_t BIO_ctrl_get_read_request(BIO *b);
  29
  30  int BIO_ctrl_reset_read_request(BIO *b);
  31
  32 =head1 DESCRIPTION
  33
  34 BIO_s_bio() returns the method for a BIO pair. A BIO pair is a pair of source/sink
  35 BIOs where data written to either half of the pair is buffered and can be read from
  36 the other half.
  37
  38 Since BIO chains typically end in a source/sink BIO it is possible to make this
  39 one half of a BIO pair and have all the data processed by the chain under application
  40 control.
  41
  42 One typical use of BIO pairs is to place SSL I/O under application control, this
  43 can be used when the application wishes to use a non standard trasport for
  44 SSL or the normal socket routines are inappropriate.
  45
  46 Calls to BIO_read() will read data from the buffer or request a retry if no
  47 data is available.
  48
  49 Calls to BIO_write() will place data in the buffer or request a retry if the
  50 buffer is full.
  51
  52 The standard calls BIO_ctrl_pending() and BIO_ctrl_wpending() can be used to
  53 determine the amount of pending data in the read or write buffer.
  54
  55 BIO_reset() clears any data in the write buffer.
  56
  57 BIO_make_bio_pair() joins two separate BIOs into a connected pair.
  58
  59 BIO_destroy_pair() destroys the association between two connected BIOs. Freeing
  60 up both halves of the pair will automatically destroy the association.
  61
  62 BIO_set_write_buf_size() sets the write buffer size of BIO B<b> to B<size>.
  63 If the size is not initialised a default value is used. This is currently
  64 17K, sufficient for a maximum size TLS record.
  65
  66 BIO_get_write_buf_size() returns the size of the write buffer.
  67
  68 BIO_new_bio_pair() combines the calls to BIO_new(), BIO_make_bio_pair() and
  69 BIO_set_write_buf_size() to create a connected pair of BIOs B<bio1>, B<bio2>
  70 with write buffer sizes B<writebuf1> and B<writebuf2>. If either size is
  71 zero then the default size is used.
  72
  73 BIO_get_write_guarantee() and BIO_ctrl_get_write_guarentee() return the maximum
  74 length of data that can be currently written to the BIO. Writes larger than this
  75 value will return a value from BIO_write() less than the amount requested or if the
  76 buffer is full request a retry. BIO_ctrl_get_write_guarantee() is a function
  77 whereas BIO_get_write_guarantee() is a macro.
  78
  79 BIO_get_read_request() and BIO_ctrl_get_read_request() return the amount of data
  80 requested (or the buffer size if it is less) if the last read failed due to an
  81 empty buffer. This can be used to determine how much data should be written to the
  82 other half of the pair so the next read will succeed: this is most useful in SSL
  83 applications where the amount of data read is usually meaningful rather than just
  84 a buffer size. After a successful read this call will return zero.
  85
  86 BIO_ctrl_reset_read_request() can also be used to reset the value returned by
  87 BIO_get_read_request() to zero.
  88
  89 =head1 NOTES
  90
  91 Both halves of a BIO pair should be freed. That is even if one half is implicity
  92 freed due to a BIO_free_all() or SSL_free() call the other half needs to be freed.
  93
  94 When used in bidirectional applications (such as SSL) care should be taken to
  95 flush any data in the write buffer. This can be done by calling BIO_pending()
  96 on the other half of the pair and, if any data is pending, reading it and sending
  97 it to the underlying transport. This must be done before any normal processing
  98 (such as calling select() ) due to a request and BIO_should_read() being true.
  99
 100 To see why this is important consider a case where a request is sent using
 101 BIO_write() and a response read with BIO_read(), this can occur during an
 102 SSL handshake for example. BIO_write() will succeed and place data in the write
 103 buffer. BIO_read() will initially fail and BIO_should_read() will be true. If
 104 the application then waits for data to be available on the underlying transport
 105 before flusing the write buffer it will never succeed because the request was
 106 never sent!
 107
 108 =head1 EXAMPLE
 109
 110 TBA
 111
 112 =head1 SEE ALSO
 113
 114 L<SSL_set_bio(3)|SSL_set_bio(3)>, L<ssl(3)|ssl(3)>, L<bio(3)|bio(3)>,
 115 L<BIO_should_retry(3)|BIO_should_retry(3)>, L<BIO_read(3)|BIO_read(3)>
 116
 117 =cut