Remove explicit dependency on configdata.pm when processing .in files

[openssl.git] / doc / man3 / OCSP_sendreq_new.pod

diff --git a/doc/man3/OCSP_sendreq_new.pod b/doc/man3/OCSP_sendreq_new.pod
index 4807d39fdeee9c2053c76df8057057b489b82e21..f3224daa9295201daf579a138364ae034affdd56 100644 (file)
--- a/doc/man3/OCSP_sendreq_new.pod
+++ b/doc/man3/OCSP_sendreq_new.pod
@@ -10,22 +10,22 @@ OCSP_REQ_CTX_set1_req, OCSP_sendreq_bio - OCSP responder query functions
 
  #include <openssl/ocsp.h>
 
- OCSP_REQ_CTX *OCSP_sendreq_new(BIO *io, const char *path, OCSP_REQUEST *req,
-                                int maxline);
+ OCSP_REQ_CTX *OCSP_sendreq_new(BIO *io, const char *path,
+                                OCSP_REQUEST *req, int maxline);
 
  int OCSP_sendreq_nbio(OCSP_RESPONSE **presp, OCSP_REQ_CTX *rctx);
 
  void OCSP_REQ_CTX_free(OCSP_REQ_CTX *rctx);
 
- void OCSP_set_max_response_length(OCSP_REQ_CTX *rctx, unsigned long len);
+ void OCSP_set_max_response_length(OCSP_REQ_CTX *rctx,
+                                   unsigned long len);
 
  int OCSP_REQ_CTX_add1_header(OCSP_REQ_CTX *rctx,
                               const char *name, const char *value);
 
- int OCSP_REQ_CTX_set1_req(OCSP_REQ_CTX *rctx, OCSP_REQUEST *req);
+ int OCSP_REQ_CTX_set1_req(OCSP_REQ_CTX *rctx, const OCSP_REQUEST *req);
 
- OCSP_RESPONSE *OCSP_sendreq_bio(BIO *io, const char *path, OCSP_REQUEST *req,
-                                 int maxline);
+ OCSP_RESPONSE *OCSP_sendreq_bio(BIO *io, const char *path, OCSP_REQUEST *req);
 
 =head1 DESCRIPTION
 
@@ -35,14 +35,14 @@ response header maximum line length of B<maxline>. If B<maxline> is zero a
 default value of 4k is used. The OCSP request B<req> may be set to B<NULL>
 and provided later if required.
 
-OCSP_sendreq_nbio() performs non-blocking I/O on the OCSP request context
-B<rctx>. When the operation is complete it returns the response in B<*presp>.
+OCSP_sendreq_nbio() performs I/O on the OCSP request context B<rctx>.
+When the operation is complete it returns the response in B<*presp>.
 
 OCSP_REQ_CTX_free() frees up the OCSP context B<rctx>.
 
-OCSP_set_max_response_length() sets the maximum response length for B<rctx>
-to B<len>. If the response exceeds this length an error occurs. If not
-set a default value of 100k is used.
+OCSP_set_max_response_length() sets the maximum response length
+for B<rctx> to B<len>. If the response exceeds this length an error occurs.
+If not set a default value of 100k is used.
 
 OCSP_REQ_CTX_add1_header() adds header B<name> with value B<value> to the
 context B<rctx>. It can be called more than once to add multiple headers.
@@ -55,23 +55,21 @@ function should be called after any calls to OCSP_REQ_CTX_add1_header().
 
 OCSP_sendreq_bio() performs an OCSP request using the responder B<io>, the URL
 path B<path>, the OCSP request B<req> and with a response header maximum line
-length of B<maxline>. If B<maxline> is zero a default value of 4k is used.
+length 4k. It waits indefinitely on a response.
 
 =head1 RETURN VALUES
 
-OCSP_sendreq_new() returns a valid B<OCSP_REQ_CTX> structure or B<NULL> if
-an error occurred.
+OCSP_sendreq_new() returns a valid B<OCSP_REQ_CTX> structure or B<NULL>
+if an error occurred.
 
-OCSP_sendreq_nbio() returns B<1> if the operation was completed successfully,
-B<-1> if the operation should be retried and B<0> if an error occurred.
-
-OCSP_REQ_CTX_add1_header() and OCSP_REQ_CTX_set1_req() return B<1> for success
-and B<0> for failure.
+OCSP_sendreq_nbio(), OCSP_REQ_CTX_add1_header() and OCSP_REQ_CTX_set1_req()
+return B<1> for success and B<0> for failure.
 
 OCSP_sendreq_bio() returns the B<OCSP_RESPONSE> structure sent by the
 responder or B<NULL> if an error occurred.
 
-OCSP_REQ_CTX_free() and OCSP_set_max_response_length() do not return values.
+OCSP_REQ_CTX_free() and OCSP_set_max_response_length()
+do not return values.
 
 =head1 NOTES
 
@@ -92,14 +90,9 @@ a Host header for B<ocsp.com> you would call:
 
  OCSP_REQ_CTX_add1_header(ctx, "Host", "ocsp.com");
 
-If OCSP_sendreq_nbio() indicates an operation should be retried the
-corresponding BIO can be examined to determine which operation (read or
-write) should be retried and appropriate action taken (for example a select()
-call on the underlying socket).
-
-OCSP_sendreq_bio() does not support retries and so cannot handle non-blocking
-I/O efficiently. It is retained for compatibility and its use in new
-applications is not recommended.
+OCSP_sendreq_bio() does not support timeout nor setting extra headers.
+It is retained for compatibility.
+Better use B<OCSP_sendreq_nbio()> instead.
 
 =head1 SEE ALSO
 
@@ -112,7 +105,7 @@ L<OCSP_response_status(3)>
 
 =head1 COPYRIGHT
 
-Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2015-2020 The OpenSSL Project Authors. All Rights Reserved.
 
 Licensed under the Apache License 2.0 (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy