Upgrade to OpenSSL 0.9.8h.
[dragonfly.git] / secure / lib / libcrypto / man / BIO_s_fd.3
CommitLineData
aac4ff6f 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
aac4ff6f
PA
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb
JR
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 58..
8b0cefbb
JR
59. nr % 0
60. rr F
984263bc 61.\}
8b0cefbb 62.\"
aac4ff6f
PA
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
8b0cefbb
JR
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
984263bc 71.if n \{\
8b0cefbb
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
8b0cefbb
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
8b0cefbb 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
8b0cefbb
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
8b0cefbb
JR
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 101.\}
8b0cefbb 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
8b0cefbb 112. \" corrections for vroff
984263bc
MD
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
8b0cefbb 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
8b0cefbb
JR
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
8b0cefbb
JR
129.\" ========================================================================
130.\"
131.IX Title "BIO_s_fd 3"
aac4ff6f 132.TH BIO_s_fd 3 "2008-09-06" "0.9.8h" "OpenSSL"
984263bc 133.SH "NAME"
74dab6c2 134BIO_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd \- file descriptor BIO
984263bc 135.SH "SYNOPSIS"
8b0cefbb 136.IX Header "SYNOPSIS"
984263bc
MD
137.Vb 1
138\& #include <openssl/bio.h>
aac4ff6f
PA
139.Ve
140.PP
141.Vb 1
984263bc 142\& BIO_METHOD * BIO_s_fd(void);
aac4ff6f
PA
143.Ve
144.PP
145.Vb 2
984263bc
MD
146\& #define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
147\& #define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c)
aac4ff6f
PA
148.Ve
149.PP
150.Vb 1
984263bc
MD
151\& BIO *BIO_new_fd(int fd, int close_flag);
152.Ve
153.SH "DESCRIPTION"
8b0cefbb
JR
154.IX Header "DESCRIPTION"
155\&\fIBIO_s_fd()\fR returns the file descriptor \s-1BIO\s0 method. This is a wrapper
984263bc
MD
156round the platforms file descriptor routines such as \fIread()\fR and \fIwrite()\fR.
157.PP
8b0cefbb
JR
158\&\fIBIO_read()\fR and \fIBIO_write()\fR read or write the underlying descriptor.
159\&\fIBIO_puts()\fR is supported but \fIBIO_gets()\fR is not.
984263bc
MD
160.PP
161If the close flag is set then then \fIclose()\fR is called on the underlying
8b0cefbb 162file descriptor when the \s-1BIO\s0 is freed.
984263bc 163.PP
8b0cefbb
JR
164\&\fIBIO_reset()\fR attempts to change the file pointer to the start of file
165using lseek(fd, 0, 0).
984263bc 166.PP
8b0cefbb
JR
167\&\fIBIO_seek()\fR sets the file pointer to position \fBofs\fR from start of file
168using lseek(fd, ofs, 0).
984263bc 169.PP
8b0cefbb 170\&\fIBIO_tell()\fR returns the current file position by calling lseek(fd, 0, 1).
984263bc 171.PP
8b0cefbb 172\&\fIBIO_set_fd()\fR sets the file descriptor of \s-1BIO\s0 \fBb\fR to \fBfd\fR and the close
984263bc
MD
173flag to \fBc\fR.
174.PP
8b0cefbb
JR
175\&\fIBIO_get_fd()\fR places the file descriptor in \fBc\fR if it is not \s-1NULL\s0, it also
176returns the file descriptor. If \fBc\fR is not \s-1NULL\s0 it should be of type
984263bc
MD
177(int *).
178.PP
8b0cefbb 179\&\fIBIO_new_fd()\fR returns a file descriptor \s-1BIO\s0 using \fBfd\fR and \fBclose_flag\fR.
984263bc 180.SH "NOTES"
8b0cefbb 181.IX Header "NOTES"
984263bc
MD
182The behaviour of \fIBIO_read()\fR and \fIBIO_write()\fR depends on the behavior of the
183platforms \fIread()\fR and \fIwrite()\fR calls on the descriptor. If the underlying
8b0cefbb
JR
184file descriptor is in a non blocking mode then the \s-1BIO\s0 will behave in the
185manner described in the \fIBIO_read\fR\|(3) and \fIBIO_should_retry\fR\|(3)
984263bc
MD
186manual pages.
187.PP
188File descriptor BIOs should not be used for socket I/O. Use socket BIOs
189instead.
190.SH "RETURN VALUES"
8b0cefbb
JR
191.IX Header "RETURN VALUES"
192\&\fIBIO_s_fd()\fR returns the file descriptor \s-1BIO\s0 method.
984263bc 193.PP
8b0cefbb
JR
194\&\fIBIO_reset()\fR returns zero for success and \-1 if an error occurred.
195\&\fIBIO_seek()\fR and \fIBIO_tell()\fR return the current file position or \-1
984263bc
MD
196is an error occurred. These values reflect the underlying \fIlseek()\fR
197behaviour.
198.PP
8b0cefbb 199\&\fIBIO_set_fd()\fR always returns 1.
984263bc 200.PP
8b0cefbb 201\&\fIBIO_get_fd()\fR returns the file descriptor or \-1 if the \s-1BIO\s0 has not
984263bc
MD
202been initialized.
203.PP
8b0cefbb 204\&\fIBIO_new_fd()\fR returns the newly allocated \s-1BIO\s0 or \s-1NULL\s0 is an error
984263bc
MD
205occurred.
206.SH "EXAMPLE"
8b0cefbb
JR
207.IX Header "EXAMPLE"
208This is a file descriptor \s-1BIO\s0 version of \*(L"Hello World\*(R":
984263bc
MD
209.PP
210.Vb 4
211\& BIO *out;
212\& out = BIO_new_fd(fileno(stdout), BIO_NOCLOSE);
213\& BIO_printf(out, "Hello World\en");
214\& BIO_free(out);
215.Ve
216.SH "SEE ALSO"
74dab6c2 217.IX Header "SEE ALSO"
8b0cefbb
JR
218\&\fIBIO_seek\fR\|(3), \fIBIO_tell\fR\|(3),
219\&\fIBIO_reset\fR\|(3), \fIBIO_read\fR\|(3),
220\&\fIBIO_write\fR\|(3), \fIBIO_puts\fR\|(3),
221\&\fIBIO_gets\fR\|(3), \fIBIO_printf\fR\|(3),
222\&\fIBIO_set_close\fR\|(3), \fIBIO_get_close\fR\|(3)