DWFCore::DWFDecryptingInputStream Class Reference

#include "dwfcore/DWFDecryptingInputStream.h"

Inheritance diagram for DWFCore::DWFDecryptingInputStream:

Inheritance graph
[legend]
Collaboration diagram for DWFCore::DWFDecryptingInputStream:

Collaboration graph
[legend]
List of all members.

Detailed Description

The interface for an input stream object that decrypts a password string.

Since:
1.5

Definition at line 44 of file DWFDecryptingInputStream.h.

Public Member Functions

_DWFCORE_API DWFDecryptingInputStream (DWFInputStream *pInputStream, const DWFString &rPassword) throw ()
virtual _DWFCORE_API ~DWFDecryptingInputStream () throw ()
virtual _DWFCORE_API size_t available () const throw ( DWFException )
virtual _DWFCORE_API size_t read (void *pBuffer, size_t nBytesToRead) throw ( DWFException )
virtual _DWFCORE_API off_t seek (int eOrigin, off_t nOffset) throw ( DWFException )


Constructor & Destructor Documentation

_DWFCORE_API DWFCore::DWFDecryptingInputStream::DWFDecryptingInputStream DWFInputStream pInputStream,
const DWFString rPassword
throw ()
 

Constructor.

Parameters:
pInputStream A pointer to a stream to chain to this object. If this pointer is NULL and another stream was previously chained to this object, it will be cleared (and deleted if owned.) This object should be allocated with the DWFCORE_ALLOC_OBJECT macro.
rPassword The password string that will be encrypted.
Exceptions:
None 

virtual _DWFCORE_API DWFCore::DWFDecryptingInputStream::~DWFDecryptingInputStream  )  throw () [virtual]
 

Destructor


Member Function Documentation

virtual _DWFCORE_API size_t DWFCore::DWFDecryptingInputStream::available  )  const throw ( DWFException ) [virtual]
 

Used to determine the availablity of data from the underlying input stream.

Returns:
The number of bytes available to read from the stream.
Exceptions:
DWFException 

Implements DWFCore::DWFInputStream.

virtual _DWFCORE_API size_t DWFCore::DWFDecryptingInputStream::read void *  pBuffer,
size_t  nBytesToRead
throw ( DWFException ) [virtual]
 

Reads at most nBytesToRead from the underlying input stream. If no input stream has been linked, this will throw a DWFIllegalStateException.

Parameters:
pBuffer A pointer to a block of memory to receive the bytes. Any implementation receiving a NULL buffer pointer should throw a DWFInvalidArgumentException.
nBytesToRead The number of bytes to copy. This value should not exceed the capacity of the memory block at pBuffer.
Returns:
The number of actual bytes read.
Exceptions:
DWFException 

Implements DWFCore::DWFInputStream.

virtual _DWFCORE_API off_t DWFCore::DWFDecryptingInputStream::seek int  eOrigin,
off_t  nOffset
throw ( DWFException ) [virtual]
 

Repositions the internal cursor on the linked input stream for subsequent read invocations. This method may fail and throw an exception if the request either exceeds the bounds of the underlying memory buffer, or exhausts the underlying stream or the underlying stream does not support the method itself. If no input stream has been linked, this will throw a DWFIllegalStateException.

Parameters:
eOrigin One of SEEK_SET, SEEK_CUR or SEEK_END.
nOffset The number of bytes from eOrigin to move the internal cursor.
Returns:
The previous cursor offset before the seek.
Exceptions:
DWFException 

Implements DWFCore::DWFInputStream.


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