Public Types | Public Member Functions | Static Public Member Functions | List of all members
Celartem::StdioStream Class Referenceabstract

#include <cel_stdstream.h>

Inheritance diagram for Celartem::StdioStream:
Inheritance graph
[legend]

Public Types

enum  FileMode { fmText = 0, fmBinary = 1 }
 

Public Member Functions

virtual void setMode (FileMode inMode)=0
 
- Public Member Functions inherited from Celartem::Stream
virtual size_t readBytes (void *buffer, size_t inSize, bool wouldBlock=false)=0
 
virtual void writeBytes (const void *buffer, size_t inSize)=0
 
virtual void flushBuffer ()=0
 
virtual bool isEof () const =0
 
virtual size_t duplicateStream (Stream *inStream, size_t inBufferSize=1024, DuplicateStreamCallback inCallback=NULL, void *inCallbackContext=NULL)
 
virtual size_t duplicateStreamBytes (Stream *inStream, size_t inMaximumByteSize, size_t inBufferSize=1024, DuplicateStreamCallback inCallback=NULL, void *inCallbackContext=NULL)
 
- Public Member Functions inherited from Celartem::Referable
 Referable ()
 
void addRef () const
 
void releaseRef () const
 
size_t getReferenceCount () const
 
- Public Member Functions inherited from Celartem::Lockable
virtual void lock () const =0
 
virtual void unlock () const =0
 

Static Public Member Functions

static AutoPtr< StdioStreamcreate (std::FILE *inFile, bool inCloseOnDelete=false)
 
- Static Public Member Functions inherited from Celartem::Referable
static void dumpDbgAllRefCount ()
 

Detailed Description

This class is provided for communication with stdin/stdout/stderr.

Member Enumeration Documentation

This enumeration defines Text Mode and Binary Mode.

Enumerator
fmText 

Text Mode.

fmBinary 

Binary Mode.

Member Function Documentation

static AutoPtr<StdioStream> Celartem::StdioStream::create ( std::FILE *  inFile,
bool  inCloseOnDelete = false 
)
static

This function creates a StdioStream instance.

Parameters
inFileA valid FILE pointer.
inCloseOnDeleteIf this value is true, the instance to be created finally closes the FILE handle in the destructor.
Pointerto the newly created StdioStream instance.
virtual void Celartem::StdioStream::setMode ( FileMode  inMode)
pure virtual

Set file mode of the StdioStream instance.
This function works only with Windows platform.

Parameters
inModeOne of fmText or fmBinary.

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

Cuminas DjVu SDK 3.0.33103
This document is made with doxygen 1.8.5 at Sun Dec 15 2013 19:38:06.
Cuminas Logo