X-Git-Url: https://git.openssl.org/?a=blobdiff_plain;f=doc%2Fcrypto%2FBIO_s_fd.pod;h=b1de1d1015496b587f2a4ac690389892aa1721c3;hb=6a8ba34f9d63fca67382a0b6764c4d29a4d7f3ca;hp=6f0341e1ed429c0cadff1738f27c0ba785a599ae;hpb=e117a890caecc402ea57fb5ea26bcfddbedee6ce;p=openssl.git diff --git a/doc/crypto/BIO_s_fd.pod b/doc/crypto/BIO_s_fd.pod index 6f0341e1ed..b1de1d1015 100644 --- a/doc/crypto/BIO_s_fd.pod +++ b/doc/crypto/BIO_s_fd.pod @@ -2,7 +2,7 @@ =head1 NAME -BIO_s_fd - file descriptor BIO +BIO_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd - file descriptor BIO =head1 SYNOPSIS @@ -10,9 +10,6 @@ BIO_s_fd - file descriptor BIO BIO_METHOD * BIO_s_fd(void); - #define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL) - #define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL) - #define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd) #define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c) @@ -20,7 +17,7 @@ BIO_s_fd - file descriptor BIO =head1 DESCRIPTION -BIO_f_fd() returns the file descriptor BIO method. This is a wrapper +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. @@ -44,11 +41,11 @@ BIO_get_fd() places the file descriptor in B if it is not NULL, it also returns the file descriptor. If B is not NULL it should be of type (int *). -BIO_new_fd() returns a file desciptor BIO using B and B. +BIO_new_fd() returns a file descriptor BIO using B and B. =head1 NOTES -The behaviour of BIO_read() and BIO_write() depends on the behaviour of the +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 manner described in the L and L @@ -69,7 +66,7 @@ behaviour. BIO_set_fd() always returns 1. BIO_get_fd() returns the file descriptor or -1 if the BIO has not -been initialised. +been initialized. BIO_new_fd() returns the newly allocated BIO or NULL is an error occurred. @@ -85,4 +82,8 @@ This is a file descriptor BIO version of "Hello World": =head1 SEE ALSO -TBA +L, L, +L, L, +L, L, +L, L, +L, L