diff options
author | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2022-06-28 12:06:52 +0200 |
---|---|---|
committer | Hugo Landau <hlandau@openssl.org> | 2022-07-06 08:21:53 +0100 |
commit | 7d5019c15af8f88443a7edddd4b150a7dafeda5d (patch) | |
tree | 6041dbf6cef56c42367021a2f0aaf2de426045b6 /doc/man3/OSSL_HTTP_transfer.pod | |
parent | 059a4ad0999dd6dbd7340b5e4f7566812d51bb1e (diff) |
http_client.c: fix comment and documentation of the memory BIOs used
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Hugo Landau <hlandau@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/18674)
Diffstat (limited to 'doc/man3/OSSL_HTTP_transfer.pod')
-rw-r--r-- | doc/man3/OSSL_HTTP_transfer.pod | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/man3/OSSL_HTTP_transfer.pod b/doc/man3/OSSL_HTTP_transfer.pod index e44ee9761e..3df2f07d3d 100644 --- a/doc/man3/OSSL_HTTP_transfer.pod +++ b/doc/man3/OSSL_HTTP_transfer.pod @@ -202,7 +202,7 @@ an ASN.1-encoded response is expected, which should include a total length, the length indications received are checked for consistency and for not exceeding any given maximum response length. If an ASN.1-encoded response is expected, the function returns on success -the contents as a memory BIO, which does not support streaming. +the contents buffered in a memory BIO, which does not support streaming. Otherwise it returns directly the read BIO that holds the response contents, which allows a response of indefinite length and may support streaming. The caller is responsible for freeing the BIO pointer obtained. @@ -257,8 +257,8 @@ OSSL_HTTP_proxy_connect() and OSSL_HTTP_set1_request() return 1 on success, 0 on error. On success, OSSL_HTTP_exchange(), OSSL_HTTP_get(), and OSSL_HTTP_transfer() -return a memory BIO containing the data received if an ASN.1-encoded response -is expected, else a BIO that may support streaming. +return a memory BIO that buffers all the data received if an ASN.1-encoded +response is expected, otherwise a BIO that may support streaming. The BIO must be freed by the caller. On failure, they return NULL. Failure conditions include connection/transfer timeout, parse errors, etc. |