Apache log4cxx  Version 0.11.0
log4cxx::helpers::FileInputStream Class Reference

InputStream implemented on top of APR file IO. More...

#include <fileinputstream.h>

Inheritance diagram for log4cxx::helpers::FileInputStream:
log4cxx::helpers::InputStream log4cxx::helpers::ObjectImpl log4cxx::helpers::Object

Public Member Functions

 FileInputStream (const LogString &filename)
 Creates a FileInputStream by opening a connection to an actual file, the file named by the path name name in the file system. More...
 
 FileInputStream (const logchar *filename)
 
 FileInputStream (const File &aFile)
 Creates a FileInputStream by opening a connection to an actual file, the file named by the File object file in the file system. More...
 
virtual void close ()
 Closes this file input stream and releases any system resources associated with the stream.
 
virtual int read (ByteBuffer &buf)
 Reads a sequence of bytes into the given buffer. More...
 
- Public Member Functions inherited from log4cxx::helpers::ObjectImpl
void addRef () const
 
void releaseRef () const
 
- Public Member Functions inherited from log4cxx::helpers::Object
virtual bool instanceof (const Class &clazz) const =0
 
virtual const void * cast (const Class &clazz) const =0
 

Additional Inherited Members

- Protected Attributes inherited from log4cxx::helpers::ObjectImpl
unsigned int volatile ref
 

Detailed Description

InputStream implemented on top of APR file IO.

Constructor & Destructor Documentation

◆ FileInputStream() [1/2]

log4cxx::helpers::FileInputStream::FileInputStream ( const LogString &  filename)

Creates a FileInputStream by opening a connection to an actual file, the file named by the path name name in the file system.

Parameters
filenameThe system-dependent file name.

◆ FileInputStream() [2/2]

log4cxx::helpers::FileInputStream::FileInputStream ( const File aFile)

Creates a FileInputStream by opening a connection to an actual file, the file named by the File object file in the file system.

Parameters
aFileThe file to be opened for reading.

Member Function Documentation

◆ read()

virtual int log4cxx::helpers::FileInputStream::read ( ByteBuffer buf)
virtual

Reads a sequence of bytes into the given buffer.

Parameters
bufThe buffer into which bytes are to be transferred.
Returns
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.

Implements log4cxx::helpers::InputStream.


The documentation for this class was generated from the following file: