Fix i2d_X509_AUX, update docs and add tests

[openssl.git] / doc / crypto / BIO_s_bio.pod

diff --git a/doc/crypto/BIO_s_bio.pod b/doc/crypto/BIO_s_bio.pod
index 998796b138afd65a90b256dfaac18e6fa76ffb19..e6d5c4967c7f51d682e87903401338332ba3831b 100644 (file)
--- a/doc/crypto/BIO_s_bio.pod
+++ b/doc/crypto/BIO_s_bio.pod
@@ -11,7 +11,7 @@ BIO_ctrl_get_read_request, BIO_ctrl_reset_read_request - BIO pair BIO
 
  #include <openssl/bio.h>
 
 
  #include <openssl/bio.h>
 

- BIO_METHOD *BIO_s_bio(void);
+ const BIO_METHOD *BIO_s_bio(void);

 
  #define BIO_make_bio_pair(b1,b2)   (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
  #define BIO_destroy_bio_pair(b)    (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
 
  #define BIO_make_bio_pair(b1,b2)   (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
  #define BIO_destroy_bio_pair(b)    (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)


@@ -120,6 +120,9 @@ the application then waits for data to be available on the underlying transport
 before flushing the write buffer it will never succeed because the request was
 never sent!
 
 before flushing the write buffer it will never succeed because the request was
 never sent!
 

+BIO_eof() is true if no data is in the peer BIO and the peer BIO has been
+shutdown.
+

 =head1 RETURN VALUES
 
 BIO_new_bio_pair() returns 1 on success, with the new BIOs available in
 =head1 RETURN VALUES
 
 BIO_new_bio_pair() returns 1 on success, with the new BIOs available in


@@ -136,9 +139,9 @@ without having to go through the SSL-interface.
 
  BIO *internal_bio, *network_bio;
  ...
 
  BIO *internal_bio, *network_bio;
  ...

- BIO_new_bio_pair(internal_bio, 0, network_bio, 0);
+ BIO_new_bio_pair(&internal_bio, 0, &network_bio, 0);

  SSL_set_bio(ssl, internal_bio, internal_bio);
  SSL_set_bio(ssl, internal_bio, internal_bio);

- SSL_operations();
+ SSL_operations(); //e.g SSL_read and SSL_write

  ...
 
  application |   TLS-engine
  ...
 
  application |   TLS-engine


@@ -147,9 +150,13 @@ without having to go through the SSL-interface.
              |     /\    ||
              |     ||    \/
              |   BIO-pair (internal_bio)
              |     /\    ||
              |     ||    \/
              |   BIO-pair (internal_bio)

-    +----------< BIO-pair (network_bio)
+             |   BIO-pair (network_bio)
+             |     ||     /\
+             |     \/     ||
+    +-----------< BIO_operations()
+    |        |

     |        |
     |        |

-  socket     |
+   socket

 
   ...
   SSL_free(ssl);               /* implicitly frees internal_bio */
 
   ...
   SSL_free(ssl);               /* implicitly frees internal_bio */


@@ -168,7 +175,7 @@ SSL_operation() can successfully be continued.
 
 =head1 WARNING
 
 
 =head1 WARNING
 

-As the data is buffered, SSL_operation() may return with a ERROR_SSL_WANT_READ
+As the data is buffered, SSL_operation() may return with an ERROR_SSL_WANT_READ

 condition, but there is still data in the write buffer. An application must
 not rely on the error value of SSL_operation() but must assure that the
 write buffer is always flushed first. Otherwise a deadlock may occur as
 condition, but there is still data in the write buffer. An application must
 not rely on the error value of SSL_operation() but must assure that the
 write buffer is always flushed first. Otherwise a deadlock may occur as