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