Debian Codegraph @

upstream/debian-unstable/man3/BIO_s_null.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "BIO_S_NULL 3SSL"
58 .TH BIO_S_NULL 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 BIO_s_null \- null data sink
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/bio.h>
69 \&
70 \& const BIO_METHOD *BIO_s_null(void);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBBIO_s_null()\fR returns the null sink BIO method. Data written to
75 the null sink is discarded, reads return EOF.
76 .SH NOTES
77 .IX Header "NOTES"
78 A null sink BIO behaves in a similar manner to the Unix /dev/null
79 device.
80 .PP
81 A null bio can be placed on the end of a chain to discard any data
82 passed through it.
83 .PP
84 A null sink is useful if, for example, an application wishes to digest some
85 data by writing through a digest bio but not send the digested data anywhere.
86 Since a BIO chain must normally include a source/sink BIO this can be achieved
87 by adding a null sink BIO to the end of the chain
88 .SH "RETURN VALUES"
89 .IX Header "RETURN VALUES"
90 \&\fBBIO_s_null()\fR returns the null sink BIO method.
91 .SH COPYRIGHT
92 .IX Header "COPYRIGHT"
93 Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
94 .PP
95 Licensed under the Apache License 2.0 (the "License"). You may not use
96 this file except in compliance with the License. You can obtain a copy
97 in the file LICENSE in the source distribution or at
98 <https://www.openssl.org/source/license.html>.