Fix BIO_f_buffer().

[openssl.git] / crypto / bio / bio.h

diff --git a/crypto/bio/bio.h b/crypto/bio/bio.h
index 152802fbdf2c9ba080ddc50ad640248ef65ac5c4..ab47abcf143d397236bfb929eb33eb1a16b9a78a 100644 (file)
--- a/crypto/bio/bio.h
+++ b/crypto/bio/bio.h
@@ -306,6 +306,15 @@ DECLARE_STACK_OF(BIO)
 
 typedef struct bio_f_buffer_ctx_struct
        {
+       /* Buffers are setup like this:
+        *
+        * <---------------------- size ----------------------->
+        * +---------------------------------------------------+
+        * | consumed | remaining          | free space        |
+        * +---------------------------------------------------+
+        * <-- off --><------- len ------->
+        */
+
        /* BIO *bio; */ /* this is now in the BIO struct */
        int ibuf_size;  /* how big is the input buffer */
        int obuf_size;  /* how big is the output buffer */