diff options
author | Matt Caswell <matt@openssl.org> | 2022-10-25 15:55:38 +0100 |
---|---|---|
committer | Pauli <pauli@openssl.org> | 2023-02-24 10:58:19 +1100 |
commit | 89ed54456ec79bfc3c2f8c5e216efb5976a07525 (patch) | |
tree | 38fe4578d45a6eb7c967572907ada58cd2b6457e /doc | |
parent | 1d06598f0e9d9e39f9c206a2520777e696150257 (diff) |
Update the pipelining docs
Document the effect on the internal read buffer when using pipelining.
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/20208)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/SSL_CTX_set_split_send_fragment.pod | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/man3/SSL_CTX_set_split_send_fragment.pod b/doc/man3/SSL_CTX_set_split_send_fragment.pod index 5097404398..d4c7c1a3f7 100644 --- a/doc/man3/SSL_CTX_set_split_send_fragment.pod +++ b/doc/man3/SSL_CTX_set_split_send_fragment.pod @@ -56,7 +56,7 @@ of pipelines that will be used at any one time. This value applies to both used (i.e. normal non-parallel operation). The number of pipelines set must be in the range 1 - SSL_MAX_PIPELINES (32). Setting this to a value > 1 will also automatically turn on "read_ahead" (see L<SSL_CTX_set_read_ahead(3)>). This is -explained further below. OpenSSL will only every use more than one pipeline if +explained further below. OpenSSL will only ever use more than one pipeline if a cipher suite is negotiated that uses a pipeline capable cipher provided by an engine. @@ -96,7 +96,10 @@ into the buffer. Without this set data is read into the read buffer one record at a time. The more data that can be read, the more opportunity there is for parallelising the processing at the cost of increased memory overhead per connection. Setting B<read_ahead> can impact the behaviour of the SSL_pending() -function (see L<SSL_pending(3)>). +function (see L<SSL_pending(3)>). In addition the default size of the internal +read buffer is multiplied by the number of pipelines available to ensure that we +can read multiple records in one go. This can therefore have a significant +impact on memory usage. The SSL_CTX_set_default_read_buffer_len() and SSL_set_default_read_buffer_len() functions control the size of the read buffer that will be used. The B<len> |