doc/crypto/BIO_s_bio.pod

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