Commit e17b7128 authored by Richard Levitte's avatar Richard Levitte
Browse files

Restore the descriptions to conform with the rest of the 

documentation.  We'll work on better documents after the release of
0.9.6.
parent 1d95fb65

doc/crypto/BIO_s_fd.pod

+19 −9
Original line number Diff line number Diff line
@@ -20,6 +20,20 @@ BIO_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd - file descriptor BIO 
BIO_s_fd() returns the file descriptor BIO method. This is a wrapper

round the platforms file descriptor routines such as read() and write().



BIO_read() and BIO_write() read or write the underlying descriptor.

BIO_puts() is supported but BIO_gets() is not.



If the close flag is set then then close() is called on the underlying

file descriptor when the BIO is freed.



BIO_reset() attempts to change the file pointer to the start of file

using lseek(fd, 0, 0).



BIO_seek() sets the file pointer to position B<ofs> from start of file

using lseek(fd, ofs, 0).



BIO_tell() returns the current file position by calling lseek(fd, 0, 1).



BIO_set_fd() sets the file descriptor of BIO B<b> to B<fd> and the close

flag to B<c>.
@@ -31,15 +45,6 @@ BIO_new_fd() returns a file descriptor BIO using B<fd> and B<close_flag>. 


=head1 NOTES



If the close flag is set then then close() is called on the underlying

file descriptor when the BIO is freed.



BIO_reset() attempts to change the file pointer to the start of file

using lseek(fd, 0, 0).



BIO_read() and BIO_write() read or write the underlying descriptor.

BIO_puts() is supported but BIO_gets() is not.



The behaviour of BIO_read() and BIO_write() depends on the behavior of the

platforms read() and write() calls on the descriptor. If the underlying 

file descriptor is in a non blocking mode then the BIO will behave in the
@@ -53,6 +58,11 @@ instead. 


BIO_s_fd() returns the file descriptor BIO method.



BIO_reset() returns zero for success and -1 if an error occurred.

BIO_seek() and BIO_tell() return the current file position or -1

is an error occurred. These values reflect the underlying lseek()

behaviour.



BIO_set_fd() always returns 1.



BIO_get_fd() returns the file descriptor or -1 if the BIO has not

doc/crypto/BIO_s_file.pod

+27 −14
Original line number Diff line number Diff line
@@ -28,6 +28,23 @@ BIO_s_file() returns the BIO file method. As its name implies it 
is a wrapper round the stdio FILE structure and it is a

source/sink BIO.



Calls to BIO_read() and BIO_write() read and write data to the

underlying stream. BIO_gets() and BIO_puts() are supported on file BIOs.



BIO_flush() on a file BIO calls the fflush() function on the wrapped

stream.



BIO_reset() attempts to change the file pointer to the start of file

using fseek(stream, 0, 0).



BIO_seek() sets the file pointer to position B<ofs> from start of file

using lseek(stream, ofs, 0).



BIO_eof() calls feof().



Setting the BIO_CLOSE flag calls fclose() on the stream when the BIO

is freed.



BIO_new_file() creates a new file BIO with mode B<mode> the meaning

of B<mode> is the same as the stdio function fopen(). The BIO_CLOSE

flag is set on the returned BIO.
@@ -42,26 +59,17 @@ meaning as in BIO_new_fp(), it is a macro. 


BIO_get_fp() retrieves the fp of a file BIO, it is a macro.



BIO_seek() is a macro that sets the position pointer to B<offset> bytes

from the start of file.



BIO_tell() returns the value of the position pointer.



BIO_read_filename(), BIO_write_filename(), BIO_append_filename() and

BIO_rw_filename() set the file BIO B<b> to use file B<name> for

reading, writing, append or read write respectively.



=head1 NOTES



Calls to BIO_read() and BIO_write() read and write data to the

underlying stream. BIO_gets() and BIO_puts() are supported on file BIOs.



BIO_flush() on a file BIO calls the fflush() function on the wrapped

stream.



BIO_reset() on a file BIO calls fseek() to reset the position indicator

to the start of the file.



BIO_eof() calls feof().



Setting the BIO_CLOSE flag calls fclose() on the stream when the BIO

is freed.



When wrapping stdout, stdin or stderr the underlying stream should not

normally be closed so the BIO_NOCLOSE flag should be set.
@@ -111,6 +119,11 @@ occurred. 
BIO_set_fp() and BIO_get_fp() return 1 for success or 0 for failure

(although the current implementation never return 0).



BIO_seek() returns the same value as the underlying fseek() function:

0 for success or -1 for failure.



BIO_tell() returns the current file position.



BIO_read_filename(), BIO_write_filename(),  BIO_append_filename() and

BIO_rw_filename() return 1 for success or 0 for failure.