Change spelling back to "behaviour" and "flavour" instead of the
[openssl.git] / 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_read() and BIO_write() read or write the underlying descriptor.
24 BIO_puts() is supported but BIO_gets() is not.
25
26 If the close flag is set then then close() is called on the underlying
27 file descriptor when the BIO is freed.
28
29 BIO_reset() attempts to change the file pointer to the start of file
30 using lseek(fd, 0, 0).
31
32 BIO_set_fd() sets the file descriptor of BIO B<b> to B<fd> and the close
33 flag to B<c>.
34
35 BIO_get_fd() places the file descriptor in B<c> if it is not NULL, it also
36 returns the file descriptor. If B<c> is not NULL it should be of type
37 (int *).
38
39 BIO_new_fd() returns a file descriptor BIO using B<fd> and B<close_flag>.
40
41 =head1 NOTES
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_reset() returns zero for success and -1 if an error occurred.
57 BIO_seek() and BIO_tell() return the current file position or -1
58 is an error occurred. These values reflect the underlying lseek()
59 behaviour.
60
61 BIO_set_fd() always returns 1.
62
63 BIO_get_fd() returns the file descriptor or -1 if the BIO has not
64 been initialized.
65
66 BIO_new_fd() returns the newly allocated BIO or NULL is an error
67 occurred.
68
69 =head1 EXAMPLE
70
71 This is a file descriptor BIO version of "Hello World":
72
73  BIO *out;
74  out = BIO_new_fd(fileno(stdout), BIO_NOCLOSE);
75  BIO_printf(out, "Hello World\n");
76  BIO_free(out);
77
78 =head1 SEE ALSO
79
80 L<BIO_seek(3)|BIO_seek(3)>, L<BIO_tell(3)|BIO_tell(3)>, TBA