Apache log4cxx Version 0.10.0
FileInputStream Class Reference

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

#include <fileinputstream.h>

Inherits InputStream.

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.
 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.
virtual ~FileInputStream ()
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.
Public Member Functions inherited from ObjectImpl
 ObjectImpl ()
virtual ~ObjectImpl ()
void addRef () const
void releaseRef () const
Public Member Functions inherited from Object
virtual const helpers::ClassgetClass () const
virtual ~Object ()
virtual bool instanceof (const Class &clazz) const =0
virtual const void * cast (const Class &clazz) const =0

Additional Inherited Members

Static Public Member Functions inherited from Object
static const helpers::ClassgetStaticClass ()
static const log4cxx::helpers::ClassRegistrationregisterClass ()
Protected Member Functions inherited from InputStream
 InputStream ()
virtual ~InputStream ()
Protected Attributes inherited from ObjectImpl
unsigned int volatile ref

Detailed Description

InputStream implemented on top of APR file IO.

Constructor & Destructor Documentation

◆ FileInputStream() [1/3]

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/3]

FileInputStream ( const logchar * filename)

◆ FileInputStream() [3/3]

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.

◆ ~FileInputStream()

virtual ~FileInputStream ( )
virtual

Member Function Documentation

◆ close()

virtual void close ( )
virtual

Closes this file input stream and releases any system resources associated with the stream.

Implements InputStream.

◆ read()

virtual int 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 InputStream.


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