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 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
--><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Apache log4cxx: FileInputStream Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespacelog4cxx.html">log4cxx</a>::<a class="el" href="namespacelog4cxx_1_1helpers.html">helpers</a>::<a class="el" href="classlog4cxx_1_1helpers_1_1_file_input_stream.html">FileInputStream</a></div>
<h1>FileInputStream Class Reference</h1><!-- doxytag: class="log4cxx::helpers::FileInputStream" --><!-- doxytag: inherits="log4cxx::helpers::InputStream" -->Inherits <a class="el" href="classlog4cxx_1_1helpers_1_1_input_stream.html">InputStream</a>.
<p>
<a href="classlog4cxx_1_1helpers_1_1_file_input_stream-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classlog4cxx_1_1helpers_1_1_input_stream.html">InputStream</a> implemented on top of APR file IO.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_input_stream.html#3f7a68d6f98444cf4b6d3f79d9eb075d">FileInputStream</a> (const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classlog4cxx_1_1helpers_1_1_file_input_stream.html">FileInputStream</a> by opening a connection to an actual file, the file named by the path name name in the file system. <a href="#3f7a68d6f98444cf4b6d3f79d9eb075d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_input_stream.html#7d2f5ede24b4c1b0ba8a96cf6079d5fd">FileInputStream</a> (const logchar *filename)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_input_stream.html#cb6db16c899d855aa9f7f9988d8873bf">FileInputStream</a> (const <a class="el" href="classlog4cxx_1_1_file.html">File</a> &aFile)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classlog4cxx_1_1helpers_1_1_file_input_stream.html">FileInputStream</a> by opening a connection to an actual file, the file named by the <a class="el" href="classlog4cxx_1_1_file.html">File</a> object file in the file system. <a href="#cb6db16c899d855aa9f7f9988d8873bf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_input_stream.html#bc95bbd7d71fe1f3aaa4d35eb4b4edd5">~FileInputStream</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_input_stream.html#47feccb1873356363e4d0e302bc3822c">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes this file input stream and releases any system resources associated with the stream. <a href="#47feccb1873356363e4d0e302bc3822c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_input_stream.html#deae5de19976d662d368c68ae538508f">read</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_byte_buffer.html">ByteBuffer</a> &buf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads a sequence of bytes into the given buffer. <a href="#deae5de19976d662d368c68ae538508f"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="3f7a68d6f98444cf4b6d3f79d9eb075d"></a><!-- doxytag: member="log4cxx::helpers::FileInputStream::FileInputStream" ref="3f7a68d6f98444cf4b6d3f79d9eb075d" args="(const LogString &filename)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_input_stream.html">FileInputStream</a> </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>filename</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Creates a <a class="el" href="classlog4cxx_1_1helpers_1_1_file_input_stream.html">FileInputStream</a> by opening a connection to an actual file, the file named by the path name name in the file system.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>The system-dependent file name. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="7d2f5ede24b4c1b0ba8a96cf6079d5fd"></a><!-- doxytag: member="log4cxx::helpers::FileInputStream::FileInputStream" ref="7d2f5ede24b4c1b0ba8a96cf6079d5fd" args="(const logchar *filename)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_input_stream.html">FileInputStream</a> </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const logchar * </td>
<td class="mdname1" valign="top" nowrap> <em>filename</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="cb6db16c899d855aa9f7f9988d8873bf"></a><!-- doxytag: member="log4cxx::helpers::FileInputStream::FileInputStream" ref="cb6db16c899d855aa9f7f9988d8873bf" args="(const File &aFile)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_input_stream.html">FileInputStream</a> </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classlog4cxx_1_1_file.html">File</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>aFile</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Creates a <a class="el" href="classlog4cxx_1_1helpers_1_1_file_input_stream.html">FileInputStream</a> by opening a connection to an actual file, the file named by the <a class="el" href="classlog4cxx_1_1_file.html">File</a> object file in the file system.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aFile</em> </td><td>The file to be opened for reading. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="bc95bbd7d71fe1f3aaa4d35eb4b4edd5"></a><!-- doxytag: member="log4cxx::helpers::FileInputStream::~FileInputStream" ref="bc95bbd7d71fe1f3aaa4d35eb4b4edd5" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ~<a class="el" href="classlog4cxx_1_1helpers_1_1_file_input_stream.html">FileInputStream</a> </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="47feccb1873356363e4d0e302bc3822c"></a><!-- doxytag: member="log4cxx::helpers::FileInputStream::close" ref="47feccb1873356363e4d0e302bc3822c" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void close </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Closes this file input stream and releases any system resources associated with the stream.
<p>
<p>
Implements <a class="el" href="classlog4cxx_1_1helpers_1_1_input_stream.html#f6ee7eacbde6b379b68d954e44f6e549">InputStream</a>. </td>
</tr>
</table>
<a class="anchor" name="deae5de19976d662d368c68ae538508f"></a><!-- doxytag: member="log4cxx::helpers::FileInputStream::read" ref="deae5de19976d662d368c68ae538508f" args="(ByteBuffer &buf)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual int read </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1_byte_buffer.html">ByteBuffer</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>buf</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Reads a sequence of bytes into the given buffer.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>The buffer into which bytes are to be transferred. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached. </dd></dl>
<p>
Implements <a class="el" href="classlog4cxx_1_1helpers_1_1_input_stream.html#cd578c11fcc2ddfc9f3bb0d208bd8152">InputStream</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="fileinputstream_8h.html">fileinputstream.h</a></ul>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
</BODY>
</HTML>
|