libbobcat-dev 4.08.02-2build1 / usr / share / doc / libbobcat4-dev / man / ibase64streambuf.3.html

This file is indexed.

/usr/share/doc/libbobcat4-dev/man/ibase64streambuf.3.html is in libbobcat-dev 4.08.02-2build1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<!DOCTYPE html><html><head>
<meta charset="UTF-8">
<title>FBB::IBase64Streambuf(3bobcat)</title>
<style type="text/css">
    figure {text-align: center;}
    img {vertical-align: center;}
    .XXfc {margin-left:auto;margin-right:auto;}
    .XXtc {text-align: center;}
    .XXtl {text-align: left;}
    .XXtr {text-align: right;}
    .XXvt {vertical-align: top;}
    .XXvb {vertical-align: bottom;}
</style>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr/>
<h1 id="title">FBB::IBase64Streambuf(3bobcat)</h1>
<h2 id="author">Base64 converting Stream Buffer<br/>(libbobcat-dev_4.08.02-x.tar.gz)</h2>
<h2 id="date">2005-2017</h2>


<p>
<h2 >NAME</h2>FBB::IBase64Streambuf - Input Filtering stream buffer doing base64 conversion
<p>
<h2 >SYNOPSIS</h2>
    <strong >#include &lt;bobcat/ibase64streambuf&gt;</strong><br/>
    Linking option: <em >-lbobcat</em> 
<p>
<h2 >DESCRIPTION</h2>
    The information made available by <strong >IBase64Streambuf</strong> objects has been
subject to base64 encoding or decoding. The information to be converted is
made available to <strong >IBase64Streambuf</strong> object via <em >std::istream</em> objects.
<p>
The <em >class IBase64Streambuf</em> is a class template, using a
<em >FBB::CryptType</em> template non-type parameter. Objects of the class
<em >FBB::IBase64Streambuf&lt;FBB::ENCRYPT&gt;</em> base64 encode the information they
receive, objects of the class <em >FBB::IBase64Streambuf&lt;FBB::DECRYPT&gt;</em> base64
decode the information they receive. See also section <strong >ENUMERATION</strong> below.
<p>
<h2 >NAMESPACE</h2>
    <strong >FBB</strong><br/>
    All constructors, members, operators and manipulators, mentioned in this
man-page, are defined in the namespace <strong >FBB</strong>.
<p>
<h2 >INHERITS FROM</h2>
    <strong >FBB::IFilterStreambuf</strong>
<p>
<h2 >MEMBER FUNCTIONS</h2>
     All members of <strong >FBB::IFilterStreambuf</strong> are available, as
<strong >IBase64Streambuf</strong> inherits from this class.
<p>
Overloaded move and/or copy assignment operators are not available.
<p>
<h2 >ENUMERATION</h2>
<p>
<strong >IBase64Streambuf</strong> objects either base64 encode or decode
information. <strong >IBase64Streambuf</strong> objects of the class
<strong >FBB::IBase64Streambuf&lt;FBB::ENCRYPT&gt;</strong> base64 encode the data they receive,
<strong >IBase64Streambuf</strong> objects of the class
<strong >FBB::IBase64Streambuf&lt;FBB::DECRYPT&gt;</strong> base64 decode the data they receive.
<p>
The values <em >ENCRYPT</em> and <em >DECRYPT</em> are defined in the <em >enum CryptType</em>,
which is defined in the <em >FBB</em> namespace.
<p>
<h2 >CONSTRUCTOR</h2>
    <ul>
    <li> <strong >IBase64Streambuf&lt;CryptType&gt;(std::istream &amp;in, size_t bufSize = 1000)</strong>:<br/>
        This constructor initializes the streambuf.
<p>
- <em >IBase64Streambuf&lt;ENCRYPT&gt;</em> objects perform base64 encoding;<br/>
    - <em >IBase64Streambuf&lt;DECRYPT&gt;</em> objects perform base64 decoding;<br/>
    - <em >IBase64Streambuf&lt;CryptType&gt;</em> objects obtain the bytes to encode or
decode from <em >std::istream &amp;in</em>;<br/>
    - The <em >IFilterStreambuf</em> base class is initialized with a buffer of
size <em >bufSize</em>, using a lower bound of 100.
<p>
The constructor uses a configurable buffer size for reading. Characters
that were read into the buffer but are not part of the actual base64 encoded
data are unavailable after completing the base64 decrypting. If information
beyond the base64 input block should remain available, then specify a
buffer size of 1.
    </ul>
<p>
Copy- and move constructors are not available.
<p>
<h2 >EXAMPLE</h2>
<p>
The example shows the construction of <em >IBase64Streambuf&lt;ENCRYPT&gt;</em>
objects <em >encode</em> which are used to initialize a <em >std::istream</em> object. The
information read from this <em >istream</em> is base64 encoded. 
<p>
<em >IBase64Streambuf&lt;DECRYPT&gt;</em> objects (<em >decode</em> reads base64 encoded
information from <em >std::istream</em> objects and decodes it again). 
<p>
The <em >std::istream din</em> object is initialized with the
<em >IBase64Streambuf&lt;DECRYPT&gt;</em> object, and its contents is sent to
<em >std::cout</em>. The information that is presented at <em >std::cin</em> and that
appears at <em >std::cout</em> should be identical.
<p>
<pre >
#include &lt;iostream&gt;
#include &lt;istream&gt;

#include &lt;bobcat/ibase64streambuf&gt;

using namespace std;
using namespace FBB;

int main(int argc, char **argv)
{
    switch (argv[1][0])
    {
        case 'e':
        {
            IBase64Streambuf&lt;ENCRYPT&gt; encode(cin);
            istream ein(&amp;encode);
            cout &lt;&lt; ein.rdbuf();
        }
        break;

        case 'd':
        {
            IBase64Streambuf&lt;DECRYPT&gt; decode(cin);
            istream din(&amp;decode);
            cout &lt;&lt; din.rdbuf();
        }
        break;
    
        case 'b':
        {
            IBase64Streambuf&lt;ENCRYPT&gt; encode(cin);
            istream ein(&amp;encode);

            IBase64Streambuf&lt;DECRYPT&gt; decode(ein);
            istream din(&amp;decode);
            cout &lt;&lt; din.rdbuf();
        }
        break;

        default:
            cout &lt;&lt; "Usage: " &lt;&lt; argv[0] &lt;&lt; " [edb] &lt; infile &gt; outfile\n"
                    "to base64 -e-ncode, -d-ecode or -b-oth\n";
        break;
    }
}

</pre>

<p>
<h2 >FILES</h2>
    <em >bobcat/ibase64streambuf</em> - defines the class interface
<p>
<h2 >SEE ALSO</h2>
    <strong >bobcat</strong>(7), <strong >isymcryptstreambuf</strong>(3bobcat),
<strong >ibase64stream</strong>(3bobcat), <strong >ifilterstreambuf</strong>(3bobcat),
<strong >ofilterstreambuf</strong>(3bobcat), <strong >std::streambuf</strong>.
<p>
<h2 >BUGS</h2>
    None reported.
<p>

<h2 >DISTRIBUTION FILES</h2>
    <ul>
    <li> <em >bobcat_4.08.02-x.dsc</em>: detached signature;
    <li> <em >bobcat_4.08.02-x.tar.gz</em>: source archive;
    <li> <em >bobcat_4.08.02-x_i386.changes</em>: change log;
    <li> <em >libbobcat1_4.08.02-x_*.deb</em>: debian package holding the
            libraries;
    <li> <em >libbobcat1-dev_4.08.02-x_*.deb</em>: debian package holding the
            libraries, headers and manual pages;
    <li> <em >http://sourceforge.net/projects/bobcat</em>: public archive location;
    </ul>
<p>
<h2 >BOBCAT</h2>
    Bobcat is an acronym of `Brokken's Own Base Classes And Templates'.
<p>
<h2 >COPYRIGHT</h2>
    This is free software, distributed under the terms of the 
    GNU General Public License (GPL).
<p>
<h2 >AUTHOR</h2>
    Frank B. Brokken (<strong >f.b.brokken@rug.nl</strong>).
<p>
</body>
</html>

APT Browse - Built by Thomas Orozco.