OSRTFileInputStream Class Reference

#include <OSRTFileInputStream.h>

Inheritance diagram for OSRTFileInputStream:

Public Member Functions
EXTRTMETHOD	OSRTFileInputStream (const char *pFilename)
EXTRTMETHOD	OSRTFileInputStream (OSRTContext *pContext, const char *pFilename)
EXTRTMETHOD	OSRTFileInputStream (FILE *file)
EXTRTMETHOD	OSRTFileInputStream (OSRTContext *pContext, FILE *file)
virtual OSBOOL	isA (StreamID id) const
Public Member Functions inherited from OSRTInputStream
EXTRTMETHOD	OSRTInputStream ()
EXTRTMETHOD	OSRTInputStream (OSRTContext *mpContext, OSBOOL attachStream=FALSE)
virtual EXTRTMETHOD	~OSRTInputStream ()
virtual EXTRTMETHOD int	close ()
virtual EXTRTMETHOD size_t	currentPos ()
virtual EXTRTMETHOD int	flush ()
virtual OSRTCtxtPtr	getContext ()
virtual OSCTXT *	getCtxtPtr ()
virtual char *	getErrorInfo ()
virtual char *	getErrorInfo (char *pBuf, size_t &bufSize)
virtual int	getPosition (size_t *ppos)
virtual int	getStatus () const
virtual EXTRTMETHOD OSBOOL	isOpened ()
virtual EXTRTMETHOD OSBOOL	markSupported ()
virtual EXTRTMETHOD int	mark (size_t readAheadLimit)
void	printErrorInfo ()
void	resetErrorInfo ()
virtual EXTRTMETHOD long	read (OSOCTET *pDestBuf, size_t maxToRead)
virtual EXTRTMETHOD long	readBlocking (OSOCTET *pDestBuf, size_t toReadBytes)
virtual EXTRTMETHOD int	reset ()
virtual int	setPosition (size_t pos)
virtual EXTRTMETHOD int	skip (size_t n)
Public Member Functions inherited from OSRTStream
virtual EXTRTMETHOD	~OSRTStream ()
int	getStatus () const
OSBOOL	isInitialized ()
void	printErrorInfo ()
void	resetErrorInfo ()

Additional Inherited Members
Protected Member Functions inherited from OSRTStream
EXTRTMETHOD	OSRTStream (OSRTContext *pContext, OSBOOL attachStream=FALSE)
EXTRTMETHOD	OSRTStream (OSRTStream &original)
EXTRTMETHOD	OSRTStream ()
EXTRTMETHOD char *	getErrorInfo (size_t *pBufSize)
Protected Attributes inherited from OSRTStream
OSRTCtxtHolder	mCtxtHolder
OSBOOL	mbAttached
int	mStatus
int	mInitStatus

Detailed Description

Generic file input stream. This class opens an existing file for input in binary mode and reads data from it.

Constructor & Destructor Documentation

OSRTFileInputStream() [1/4]

EXTRTMETHOD OSRTFileInputStream::OSRTFileInputStream

(

const char *

pFilename

)

Creates and initializes a file input stream using the name of file.

Parameters

pFilename

Name of file.

See also

rtxStreamFileOpen

OSRTFileInputStream() [2/4]

EXTRTMETHOD OSRTFileInputStream::OSRTFileInputStream	(	OSRTContext *	pContext,
		const char *	pFilename
	)

Creates and initializes a file input stream using the name of file.

Parameters

pContext	Pointer to a context to use.
pFilename	Name of file.

See also

rtxStreamFileOpen

OSRTFileInputStream() [3/4]

EXTRTMETHOD OSRTFileInputStream::OSRTFileInputStream

(

FILE *

file

)

Initializes the file input stream using the opened FILE structure descriptor.

Parameters

file	Pointer to FILE structure.

See also

rtxStreamFileAttach

OSRTFileInputStream() [4/4]

EXTRTMETHOD OSRTFileInputStream::OSRTFileInputStream	(	OSRTContext *	pContext,
		FILE *	file
	)

Initializes the file input stream using the opened FILE structure descriptor.

Parameters

pContext	Pointer to a context to use.
file	Pointer to FILE structure.

See also

rtxStreamFileAttach

Member Function Documentation

isA()

virtual OSBOOL OSRTFileInputStream::isA ( StreamID  id ) const

inlinevirtual

This method is used to query a stream object in order to determine its actual type.

Parameters

id	Enumerated stream identifier

Returns

True if the stream matches the identifier

Reimplemented from OSRTInputStream.

---

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

• OSRTFileInputStream.h