IWriter Class Reference
[C++ IOStream Fixups And Utilities]

Search Toolkit Book for IWriter

#include <reader_writer.hpp>

Inheritance diagram for IWriter:

Inheritance graph
[legend]
List of all members.

Detailed Description

A very basic data-write interface.

Definition at line 98 of file reader_writer.hpp.

Public Member Functions

virtual ERW_Result Write (const void *buf, size_t count, size_t *bytes_written=0)=0
 Write up to "count" bytes from the buffer pointed to by "buf" argument onto output device.
virtual ERW_Result Flush (void)=0
 Flush pending data (if any) down to output device.
virtual ~IWriter ()


Constructor & Destructor Documentation

virtual IWriter::~IWriter  )  [inline, virtual]
 

Definition at line 113 of file reader_writer.hpp.


Member Function Documentation

virtual ERW_Result IWriter::Flush void   )  [pure virtual]
 

Flush pending data (if any) down to output device.

Implemented in CSocketReaderWriter, CStringOrBlobStorageWriter, CFileWriter, CFileReaderWriter, CBDB_BlobReaderWriter, CBlobWriter, CWriter_HTMLEncoder, CMultiWriter, CTransmissionWriter, CMD5StreamWriter, CBufferWriter< Buffer >, CCGIStreamWriter, CNetCacheWriter, CBDB_CacheIWriter, CDBAPI_CacheIWriter, CxBlobWriter, and CNullWriter.

Referenced by CTransmissionWriter::Flush(), and CRWStreambuf::overflow().

virtual ERW_Result IWriter::Write const void *  buf,
size_t  count,
size_t *  bytes_written = 0
[pure virtual]
 

Write up to "count" bytes from the buffer pointed to by "buf" argument onto output device.

Store the number of bytes actually written, or 0 if "count" has been passed as 0 ("buf" is ignored in this case), via the "bytes_written" pointer, if provided non-NULL.

Implemented in CSocketReaderWriter, CStringOrBlobStorageWriter, CFileWriter, CFileReaderWriter, CBDB_BlobReaderWriter, CBlobWriter, CWriter_HTMLEncoder, CMultiWriter, CTransmissionWriter, CMD5StreamWriter, CBufferWriter< Buffer >, CCGIStreamWriter, CNetCacheWriter, CBDB_CacheIWriter, CDBAPI_CacheIWriter, CxBlobWriter, and CNullWriter.

Referenced by CWriterSourceCollector::AddChunk(), CTransmissionWriter::CTransmissionWriter(), CRWStreambuf::overflow(), CTransmissionWriter::x_WritePacket(), and CTransmissionWriter::~CTransmissionWriter().


The documentation for this class was generated from the following file:
Generated on Mon Dec 7 15:42:41 2009 for NCBI C++ ToolKit by  doxygen 1.4.6
Modified on Mon Dec 07 16:24:27 2009 by modify_doxy.py rev. 173732