doc/ssl/SSL_CTX_set_read_ahead.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CTX_set_read_ahead, SSL_CTX_set_default_read_ahead, SSL_CTX_get_read_ahead,
   6 SSL_CTX_get_default_read_ahead, SSL_set_read_ahead, SSL_get_read_ahead
   7 - manage whether to read as many input bytes as possible
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/ssl.h>
  12
  13  int SSL_get_read_ahead(const SSL *s);
  14  void SSL_set_read_ahead(SSL *s, int yes);
  15
  16  #define SSL_CTX_get_default_read_ahead(ctx)
  17  #define SSL_CTX_set_default_read_ahead(ctx,m)
  18  #define SSL_CTX_get_read_ahead(ctx)
  19  #define SSL_CTX_set_read_ahead(ctx,m)
  20
  21 =head1 DESCRIPTION
  22
  23 SSL_CTX_set_read_ahead() and SSL_set_read_ahead() set whether we should read as
  24 many input bytes as possible (for non-blocking reads) or not. For example if
  25 B<x> bytes are currently required by OpenSSL, but B<y> bytes are available from
  26 the underlying BIO (where B<y> > B<x>), then OpenSSL will read all B<y> bytes
  27 into its buffer (providing that the buffer is large enough) if reading ahead is
  28 on, or B<x> bytes otherwise. The parameter B<yes> or B<m> should be 0 to ensure
  29 reading ahead is off, or non zero otherwise.
  30
  31 SSL_CTX_set_default_read_ahead is a synonym for SSL_CTX_set_read_ahead, and
  32 SSL_CTX_get_default_read_ahead is a synonym for SSL_CTX_get_read_ahead.
  33
  34 SSL_CTX_get_read_ahead() and SSL_get_read_ahead() indicate whether reading
  35 ahead has been set or not.
  36
  37 =head1 NOTES
  38
  39 These functions have no impact when used with DTLS. The return values for
  40 SSL_CTX_get_read_head() and SSL_get_read_ahead() are undefined for DTLS. Setting
  41 B<read_ahead> can impact the behaviour of the SSL_pending() function
  42 (see L<SSL_pending()>).
  43
  44 =head1 RETURN VALUES
  45
  46 SSL_get_read_ahead and SSL_CTX_get_read_ahead return 0 if reading ahead is off,
  47 and non zero otherwise.
  48
  49 =head1 SEE ALSO
  50
  51 L<ssl(3)>, L<SSL_pending(3)>
  52
  53 =cut