diff options
author | Richard Levitte <levitte@openssl.org> | 2000-09-16 23:32:33 +0000 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2000-09-16 23:32:33 +0000 |
commit | da542e1bf762507bc6630847e4c3dd18de81359d (patch) | |
tree | bb525a055ebaab7f5db17c827e08b856f967acaa /doc/crypto/BIO_s_fd.pod | |
parent | 93fe6e13a379c5902dddb49f3d331e795d049a43 (diff) |
Move text that isn't really descriptions of the functions in the page
to the NOTES section, and add references to the functions mentioned
(and perhaps a few more).
Diffstat (limited to 'doc/crypto/BIO_s_fd.pod')
-rw-r--r-- | doc/crypto/BIO_s_fd.pod | 29 |
1 files changed, 14 insertions, 15 deletions
diff --git a/doc/crypto/BIO_s_fd.pod b/doc/crypto/BIO_s_fd.pod index 4681e5e13b..61789fd2c1 100644 --- a/doc/crypto/BIO_s_fd.pod +++ b/doc/crypto/BIO_s_fd.pod @@ -20,15 +20,6 @@ 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_set_fd() sets the file descriptor of BIO B<b> to B<fd> and the close flag to B<c>. @@ -40,6 +31,15 @@ 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,11 +53,6 @@ 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 @@ -77,4 +72,8 @@ This is a file descriptor BIO version of "Hello World": =head1 SEE ALSO -L<BIO_seek(3)|BIO_seek(3)>, L<BIO_tell(3)|BIO_tell(3)>, TBA +L<BIO_seek(3)|BIO_seek(3)>, L<BIO_tell(3)|BIO_tell(3)>, +L<BIO_reset(3)|BIO_reset(3)>, L<BIO_read(3)|BIO_read(3)>, +L<BIO_write(3)|BIO_write(3)>, L<BIO_puts(3)|BIO_puts(3)>, +L<BIO_gets(3)|BIO_gets(3)>, L<BIO_printf(3)|BIO_printf(3)>, +L<BIO_set_close(3)|BIO_set_close(3)>, L<BIO_get_close(3)|BIO_get_close(3)> |