doc/crypto/BIO_s_fd.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 BIO_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd - file descriptor BIO
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/bio.h>
  10
  11  BIO_METHOD *   BIO_s_fd(void);
  12
  13  #define BIO_set_fd(b,fd,c)     BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
  14  #define BIO_get_fd(b,c)        BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c)
  15
  16  BIO *BIO_new_fd(int fd, int close_flag);
  17
  18 =head1 DESCRIPTION
  19
  20 BIO_s_fd() returns the file descriptor BIO method. This is a wrapper
  21 round the platforms file descriptor routines such as read() and write().
  22
  23 BIO_set_fd() sets the file descriptor of BIO B<b> to B<fd> and the close
  24 flag to B<c>.
  25
  26 BIO_get_fd() places the file descriptor in B<c> if it is not NULL, it also
  27 returns the file descriptor. If B<c> is not NULL it should be of type
  28 (int *).
  29
  30 BIO_new_fd() returns a file descriptor BIO using B<fd> and B<close_flag>.
  31
  32 =head1 NOTES
  33
  34 If the close flag is set then then close() is called on the underlying
  35 file descriptor when the BIO is freed.
  36
  37 BIO_reset() attempts to change the file pointer to the start of file
  38 using lseek(fd, 0, 0).
  39
  40 BIO_read() and BIO_write() read or write the underlying descriptor.
  41 BIO_puts() is supported but BIO_gets() is not.
  42
  43 The behaviour of BIO_read() and BIO_write() depends on the behavior of the
  44 platforms read() and write() calls on the descriptor. If the underlying
  45 file descriptor is in a non blocking mode then the BIO will behave in the
  46 manner described in the L<BIO_read(3)|BIO_read(3)> and L<BIO_should_retry(3)|BIO_should_retry(3)>
  47 manual pages.
  48
  49 File descriptor BIOs should not be used for socket I/O. Use socket BIOs
  50 instead.
  51
  52 =head1 RETURN VALUES
  53
  54 BIO_s_fd() returns the file descriptor BIO method.
  55
  56 BIO_set_fd() always returns 1.
  57
  58 BIO_get_fd() returns the file descriptor or -1 if the BIO has not
  59 been initialized.
  60
  61 BIO_new_fd() returns the newly allocated BIO or NULL is an error
  62 occurred.
  63
  64 =head1 EXAMPLE
  65
  66 This is a file descriptor BIO version of "Hello World":
  67
  68  BIO *out;
  69  out = BIO_new_fd(fileno(stdout), BIO_NOCLOSE);
  70  BIO_printf(out, "Hello World\n");
  71  BIO_free(out);
  72
  73 =head1 SEE ALSO
  74
  75 L<BIO_seek(3)|BIO_seek(3)>, L<BIO_tell(3)|BIO_tell(3)>,
  76 L<BIO_reset(3)|BIO_reset(3)>, L<BIO_read(3)|BIO_read(3)>,
  77 L<BIO_write(3)|BIO_write(3)>, L<BIO_puts(3)|BIO_puts(3)>,
  78 L<BIO_gets(3)|BIO_gets(3)>, L<BIO_printf(3)|BIO_printf(3)>,
  79 L<BIO_set_close(3)|BIO_set_close(3)>, L<BIO_get_close(3)|BIO_get_close(3)>