DWFCore::DWFOutputStream Interface Reference

#include "dwfcore/OutputStream.h"

Inheritance diagram for DWFCore::DWFOutputStream:

Inheritance graph
[legend]
List of all members.

Detailed Description

Interface for output (writer) streams.

Since:
1.0.1
This class defines a contract for a streamable data sink. Implementors of this interface are considered valid targets to which output data may be written.
Examples:

Files/Files.cpp.

Definition at line 48 of file OutputStream.h.

Public Member Functions

virtual _DWFCORE_API ~DWFOutputStream () throw ()
virtual _DWFCORE_API void flush ()=0 throw ( DWFException )
virtual _DWFCORE_API size_t write (const void *pBuffer, size_t nBytesToWrite)=0 throw ( DWFException )

Protected Member Functions

_DWFCORE_API DWFOutputStream () throw ()


Constructor & Destructor Documentation

virtual _DWFCORE_API DWFCore::DWFOutputStream::~DWFOutputStream  )  throw () [inline, virtual]
 

Destructor

Exceptions:
None 

Definition at line 59 of file OutputStream.h.

_DWFCORE_API DWFCore::DWFOutputStream::DWFOutputStream  )  throw () [inline, protected]
 

Constructor

Exceptions:
None 

Definition at line 98 of file OutputStream.h.


Member Function Documentation

virtual _DWFCORE_API void DWFCore::DWFOutputStream::flush  )  throw ( DWFException ) [pure virtual]
 

Writes any remaining bytes from the stream into the data sink. This method may not have any function for some implementations. It is recommended that, rather than throwing an exception, the method simply return.

Exceptions:
DWFException 

Implemented in DWFCore::DWFBufferOutputStream, DWFCore::DWFDigestOutputStream, DWFCore::DWFFileOutputStream, DWFCore::DWFUTF8EncodingOutputStream, DWFCore::DWFXMLEncodingOutputStream, and DWFCore::DWFZippingOutputStream.

Examples:
Files/Files.cpp.

virtual _DWFCORE_API size_t DWFCore::DWFOutputStream::write const void *  pBuffer,
size_t  nBytesToWrite
throw ( DWFException ) [pure virtual]
 

Writes at most nBytesToWrite into the stream from the buffer provided.

Parameters:
pBuffer A pointer to a block of memory whose data will be written into the stream. Any implementation receiving a NULL buffer pointer should throw a DWFInvalidArgumentException.
nBytesToWrite The number of bytes to copy from pBuffer.
Returns:
The number of bytes actually written.
Exceptions:
DWFException 

Implemented in DWFCore::DWFBufferOutputStream, DWFCore::DWFDigestOutputStream, DWFCore::DWFXMLSerializer::XMLOutputStream, DWFCore::DWFFileOutputStream, DWFCore::DWFUTF8EncodingOutputStream, DWFCore::DWFXMLEncodingOutputStream, and DWFCore::DWFZippingOutputStream.

Examples:
Files/Files.cpp.


The documentation for this interface was generated from the following file:
Generated on Tue Jan 6 22:39:38 2009 for Autodesk DWF Core Library by  doxygen 1.4.5