SSL_CTX_set_read_ahead.pod revision 302408
1=pod 2 3=head1 NAME 4 5SSL_CTX_set_read_ahead, SSL_CTX_set_default_read_ahead, SSL_CTX_get_read_ahead, 6SSL_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 23SSL_CTX_set_read_ahead() and SSL_set_read_ahead() set whether we should read as 24many input bytes as possible (for non-blocking reads) or not. For example if 25B<x> bytes are currently required by OpenSSL, but B<y> bytes are available from 26the underlying BIO (where B<y> > B<x>), then OpenSSL will read all B<y> bytes 27into its buffer (providing that the buffer is large enough) if reading ahead is 28on, or B<x> bytes otherwise. The parameter B<yes> or B<m> should be 0 to ensure 29reading ahead is off, or non zero otherwise. 30 31SSL_CTX_set_default_read_ahead is a synonym for SSL_CTX_set_read_ahead, and 32SSL_CTX_get_default_read_ahead is a synonym for SSL_CTX_get_read_ahead. 33 34SSL_CTX_get_read_ahead() and SSL_get_read_ahead() indicate whether reading 35ahead has been set or not. 36 37=head1 NOTES 38 39These functions have no impact when used with DTLS. The return values for 40SSL_CTX_get_read_head() and SSL_get_read_ahead() are undefined for DTLS. 41 42=head1 RETURN VALUES 43 44SSL_get_read_ahead and SSL_CTX_get_read_ahead return 0 if reading ahead is off, 45and non zero otherwise. 46 47=head1 SEE ALSO 48 49L<ssl(3)|ssl(3)> 50 51=cut 52