ispell and some other nit-picking
[openssl.git] / doc / crypto / BIO_ctrl.pod
1 =pod
2
3 =head1 NAME
4
5 BIO_ctrl, BIO_callback_ctrl, BIO_ptr_ctrl, BIO_int_ctrl, BIO_reset,
6 BIO_flush, BIO_eof, BIO_set_close, BIO_get_close, BIO_pending,
7 BIO_wpending, BIO_ctrl_pending, BIO_ctrl_wpending, BIO_get_info_callback,
8 BIO_set_info_callback - BIO control operations
9
10 =head1 SYNOPSIS
11
12  #include <openssl/bio.h>
13
14  long BIO_ctrl(BIO *bp,int cmd,long larg,void *parg);
15  long BIO_callback_ctrl(BIO *b, int cmd, void (*fp)(struct bio_st *, int, const char *, int, long, long));
16  char * BIO_ptr_ctrl(BIO *bp,int cmd,long larg);
17  long BIO_int_ctrl(BIO *bp,int cmd,long larg,int iarg);
18
19  int BIO_reset(BIO *b);
20  int BIO_flush(BIO *b);
21  int BIO_eof(BIO *b);
22  int BIO_set_close(BIO *b,long flag);
23  int BIO_get_close(BIO *b);
24  int BIO_pending(BIO *b);
25  int BIO_wpending(BIO *b);
26  size_t BIO_ctrl_pending(BIO *b);
27  size_t BIO_ctrl_wpending(BIO *b);
28
29  int BIO_get_info_callback(BIO *b,bio_info_cb **cbp);
30  int BIO_set_info_callback(BIO *b,bio_info_cb *cb);
31
32  typedef void bio_info_cb(BIO *b, int oper, const char *ptr, int arg1, long arg2, long arg3);
33
34 =head1 DESCRIPTION
35
36 BIO_ctrl(), BIO_callback_ctrl(), BIO_ptr_ctrl() and BIO_int_ctrl()
37 are BIO "control" operations taking arguments of various types.
38 These functions are not normally called directly, various macros
39 are used instead. The standard macros are described below, macros
40 specific to a particular type of BIO are described in the specific
41 BIOs manual page as well as any special features of the standard
42 calls.
43
44 BIO_reset() typically reset a BIO to some initial state, in the case
45 of file related BIOs for example it rewinds the file pointer.
46
47 BIO_flush() normally writes out any internally buffered data, in some
48 cases it is used to signal EOF and that no more data will be written.
49
50 BIO_eof() returns 1 if the BIO has read EOF, the precise meaning of
51 "EOF" varies according to the BIO type.
52
53 BIO_set_close() sets the BIO B<b> close flag to B<flag>. B<flag> can
54 take the value BIO_CLOSE or BIO_NOCLOSE. Typically BIO_CLOSE is used
55 in a source/sink BIO to indicate that the underlying I/O stream should
56 be closed when the BIO is freed.
57
58 BIO_get_close() returns the BIOs close flag.
59
60 BIO_pending(), BIO_ctrl_pending(), BIO_wpending() and BIO_ctrl_wpending()
61 return the number of pending characters in the BIOs read and write buffers.
62 Not all BIOs support these calls. BIO_ctrl_pending() and BIO_ctrl_wpending()
63 return a size_t type and are functions, BIO_pending() and BIO_wpending() are
64 macros which call BIO_ctrl().
65
66 =head1 RETURN VALUES
67
68 BIO_reset() returns 1 for success and 0 for failure.
69
70 BIO_flush() returns 1 for success and 0 or -1 for failure.
71
72 BIO_eof() returns 1 if EOF has been reached 0 otherwise.
73
74 BIO_set_close() always returns 1.
75
76 BIO_get_close() returns the close flag value: BIO_CLOSE or BIO_NOCLOSE.
77
78 BIO_pending(), BIO_ctrl_pending(), BIO_wpending() and BIO_ctrl_wpending()
79 return the amount of pending data.
80
81 =head1 NOTES
82
83 BIO_flush(), because it can write data may return 0 or -1 indicating
84 that the call should be retried later in a similar manner to BIO_write(). 
85 The BIO_should_retry() call should be used and appropriate action taken
86 is the call fails.
87
88 The return values of BIO_pending() and BIO_wpending() may not reliably
89 determine the amount of pending data in all cases. For example in the
90 case of a file BIO some data may be available in the FILE structures
91 internal buffers but it is not possible to determine this in a
92 portably way. For other types of BIO they may not be supported.
93
94 Filter BIOs if the do not internally handle a particular BIO_ctrl()
95 operation usually pass the operation to the next BIO in the chain.
96 This often means there is no need to locate the required BIO for
97 a particular operation, it can be called on a chain and it will
98 be automatically passed to the relevant BIO.
99
100 Source/sink BIOs will return an error if the do not recognize the
101 BIO_ctrl() operation.
102
103 =head1 SEE ALSO
104
105 TBA