doc/man3/BIO_f_buffer.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 BIO_get_buffer_num_lines,
   6 BIO_set_read_buffer_size,
   7 BIO_set_write_buffer_size,
   8 BIO_set_buffer_size,
   9 BIO_set_buffer_read_data,
  10 BIO_f_buffer
  11 - buffering BIO
  12
  13 =head1 SYNOPSIS
  14
  15  #include <openssl/bio.h>
  16
  17  const BIO_METHOD *BIO_f_buffer(void);
  18
  19  long BIO_get_buffer_num_lines(BIO *b);
  20  long BIO_set_read_buffer_size(BIO *b, long size);
  21  long BIO_set_write_buffer_size(BIO *b, long size);
  22  long BIO_set_buffer_size(BIO *b, long size);
  23  long BIO_set_buffer_read_data(BIO *b, void *buf, long num);
  24
  25 =head1 DESCRIPTION
  26
  27 BIO_f_buffer() returns the buffering BIO method.
  28
  29 Data written to a buffering BIO is buffered and periodically written
  30 to the next BIO in the chain. Data read from a buffering BIO comes from
  31 an internal buffer which is filled from the next BIO in the chain.
  32 Both BIO_gets() and BIO_puts() are supported.
  33
  34 Calling BIO_reset() on a buffering BIO clears any buffered data.
  35
  36 BIO_get_buffer_num_lines() returns the number of lines currently buffered.
  37
  38 BIO_set_read_buffer_size(), BIO_set_write_buffer_size() and BIO_set_buffer_size()
  39 set the read, write or both read and write buffer sizes to B<size>. The initial
  40 buffer size is DEFAULT_BUFFER_SIZE, currently 4096. Any attempt to reduce the
  41 buffer size below DEFAULT_BUFFER_SIZE is ignored. Any buffered data is cleared
  42 when the buffer is resized.
  43
  44 BIO_set_buffer_read_data() clears the read buffer and fills it with B<num>
  45 bytes of B<buf>. If B<num> is larger than the current buffer size the buffer
  46 is expanded.
  47
  48 =head1 NOTES
  49
  50 These functions, other than BIO_f_buffer(), are implemented as macros.
  51
  52 Buffering BIOs implement BIO_read_ex() and BIO_gets() by using
  53 BIO_read_ex() operations on the next BIO in the chain and storing the
  54 result in an internal buffer, from which bytes are given back to the
  55 caller as appropriate for the call; a BIO_gets() is guaranteed to give
  56 the caller a whole line, and BIO_read_ex() is guaranteed to give the
  57 caller the number of bytes it asks for, unless there's an error or end
  58 of communication is reached in the next BIO.  By prepending a
  59 buffering BIO to a chain it is therefore possible to provide
  60 BIO_gets() or exact size BIO_read_ex() functionality if the following
  61 BIOs do not support it.
  62
  63 Do not add more than one BIO_f_buffer() to a BIO chain.  The result of
  64 doing so will force a full read of the size of the internal buffer of
  65 the top BIO_f_buffer(), which is 4 KiB at a minimum.
  66
  67 Data is only written to the next BIO in the chain when the write buffer fills
  68 or when BIO_flush() is called. It is therefore important to call BIO_flush()
  69 whenever any pending data should be written such as when removing a buffering
  70 BIO using BIO_pop(). BIO_flush() may need to be retried if the ultimate
  71 source/sink BIO is non blocking.
  72
  73 =head1 RETURN VALUES
  74
  75 BIO_f_buffer() returns the buffering BIO method.
  76
  77 BIO_get_buffer_num_lines() returns the number of lines buffered (may be 0).
  78
  79 BIO_set_read_buffer_size(), BIO_set_write_buffer_size() and BIO_set_buffer_size()
  80 return 1 if the buffer was successfully resized or 0 for failure.
  81
  82 BIO_set_buffer_read_data() returns 1 if the data was set correctly or 0 if
  83 there was an error.
  84
  85 =head1 SEE ALSO
  86
  87 L<bio(7)>,
  88 L<BIO_reset(3)>,
  89 L<BIO_flush(3)>,
  90 L<BIO_pop(3)>,
  91 L<BIO_ctrl(3)>.
  92
  93 =head1 COPYRIGHT
  94
  95 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  96
  97 Licensed under the Apache License 2.0 (the "License").  You may not use
  98 this file except in compliance with the License.  You can obtain a copy
  99 in the file LICENSE in the source distribution or at
 100 L<https://www.openssl.org/source/license.html>.
 101
 102 =cut