diff options
| author | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2021-12-03 11:34:23 +0100 |
|---|---|---|
| committer | Tomas Mraz <tomas@openssl.org> | 2021-12-07 11:26:49 +0100 |
| commit | 119f8145c3bde29aae5d5b18c44d1663df975ef5 (patch) | |
| tree | fe4c57bdc6ff40cc323705b01a489dfff794e5d7 /doc/man3 | |
| parent | 59b6b5a94f5a5f756aa323d1fb061697ca9eadf8 (diff) | |
OSSL_HTTP_open(): clarify doc of 'server' arg and its use of BIO_new_connect()
Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/17186)
Diffstat (limited to 'doc/man3')
| -rw-r--r-- | doc/man3/OSSL_HTTP_transfer.pod | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/man3/OSSL_HTTP_transfer.pod b/doc/man3/OSSL_HTTP_transfer.pod index b0ca394448..7fcd71dbe0 100644 --- a/doc/man3/OSSL_HTTP_transfer.pod +++ b/doc/man3/OSSL_HTTP_transfer.pod @@ -56,9 +56,10 @@ OSSL_HTTP_open() initiates an HTTP session using the I<bio> argument if not NULL, else by connecting to a given I<server> optionally via a I<proxy>. Typically the OpenSSL build supports sockets and the I<bio> parameter is NULL. -In this case I<rbio> must be NULL as well, and the -library creates a network BIO internally for connecting to the given I<server> -and the optionally given I<port>, defaulting to 80 for HTTP or 443 for HTTPS. +In this case I<rbio> must be NULL as well and the I<server> must be non-NULL. +The function creates a network BIO internally using L<BIO_new_connect(3)> +for connecting to the given server and the optionally given I<port>, +defaulting to 80 for HTTP or 443 for HTTPS. Then this internal BIO is used for setting up a connection and for exchanging one or more request and response. If I<bio> is given and I<rbio> is NULL then this I<bio> is used instead. @@ -255,7 +256,7 @@ OSSL_HTTP_close() returns 0 if anything went wrong while disconnecting, else 1. =head1 SEE ALSO -L<OSSL_HTTP_parse_url(3)>, L<BIO_set_conn_port(3)> +L<OSSL_HTTP_parse_url(3)>, L<BIO_new_connect(3)>, L<ASN1_item_i2d_mem_bio(3)>, L<ASN1_item_d2i_bio(3)>, L<OSSL_HTTP_is_alive(3)> |