NCBI C++ ToolKit
Public Member Functions | Protected Member Functions | List of all members
CCompressionIOStream Class Reference

Search Toolkit Book for CCompressionIOStream

#include <util/compress/stream.hpp>

+ Inheritance diagram for CCompressionIOStream:
+ Collaboration diagram for CCompressionIOStream:

Public Member Functions

 CCompressionIOStream (CNcbiIos &stream, CCompressionStreamProcessor *read_sp, CCompressionStreamProcessor *write_sp, TOwnership ownership=0)
 
CCompressionProcessor::EStatus GetStatus (CCompressionStream::EDirection dir)
 Get status of last compression/decompression stream operation. More...
 
bool GetError (CCompressionStream::EDirection dir, int &status, string &description)
 Get error code and description of last compressor/decompressor stream operation. More...
 
size_t GetProcessedSize (CCompressionStream::EDirection dir)
 Get total number of bytes processed by specified "stream_processor". More...
 
size_t GetOutputSize (CCompressionStream::EDirection dir)
 Get total number of bytes, that "stream_processor" returns. More...
 
virtual void Finalize (CCompressionStream::EDirection dir=CCompressionStream::eReadWrite)
 Finalize stream's compression/decompression process for read/write. More...
 
size_t Read (void *buf, size_t len)
 Auxiliary method to read from stream. More...
 
size_t Write (const void *buf, size_t len)
 Auxiliary method to write into stream. More...
 
- Public Member Functions inherited from CCompressionStream
 CCompressionStream (CNcbiIos &stream, CCompressionStreamProcessor *read_sp, CCompressionStreamProcessor *write_sp, TOwnership ownership=0)
 Constructor. More...
 
virtual ~CCompressionStream (void)
 Destructor. More...
 

Protected Member Functions

 CCompressionIOStream (void)
 Default constructor. More...
 
- Protected Member Functions inherited from CCompressionStream
 CCompressionStream (void)
 Default constructor. More...
 
void Create (CNcbiIos &stream, CCompressionStreamProcessor *read_sp, CCompressionStreamProcessor *write_sp, TOwnership ownership=0)
 Create stream with specific characteristics later, not necessary in the constructor. More...
 
CCompressionProcessor::EStatus x_GetStatus (CCompressionStream::EDirection dir)
 Get status of last compression/decompression stream operation. More...
 
bool x_GetError (CCompressionStream::EDirection dir, int &status, string &description)
 Get error code and description of last compressor/decompressor stream operation. More...
 
size_t x_GetProcessedSize (CCompressionStream::EDirection dir)
 Return number of processed bytes. More...
 
size_t x_GetOutputSize (CCompressionStream::EDirection dir)
 Return number of output bytes. More...
 

Additional Inherited Members

- Public Types inherited from CCompressionStream
enum  EDirection { eRead , eWrite , eReadWrite }
 Stream processing direction. More...
 
enum  EOwnership {
  fOwnStream = (1<<1) , fOwnReader = (1<<2) , fOwnWriter = (1<<3) , fOwnProcessor = fOwnReader + fOwnWriter ,
  fOwnAll = fOwnStream + fOwnProcessor
}
 Which of the objects (passed in the constructor) should be deleted on this object's destruction. More...
 
typedef int TOwnership
 Bitwise OR of EOwnership. More...
 
- Protected Attributes inherited from CCompressionStream
CNcbiIosm_Stream
 Underlying stream. More...
 
CCompressionStreambufm_StreamBuf
 Stream buffer. More...
 
CCompressionStreamProcessorm_Reader
 Read processor. More...
 
CCompressionStreamProcessorm_Writer
 Write processor. More...
 
TOwnership m_Ownership
 Bitwise OR of EOwnership. More...
 

Detailed Description

Definition at line 434 of file stream.hpp.


The documentation for this class was generated from the following files:
Modified on Mon Feb 26 04:05:46 2024 by modify_doxy.py rev. 669887