IEDLTempStore Class Reference

A self-cleaning area for storage of temporary data in the form of streams. One per session, obtainable from an ISession. Exceptions of type IEDLError are thrown on failures. More...

#include <iedltempstore.h>

Inheritance diagram for IEDLTempStore:

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual IEDLTempStoreObjectPtr	createTemporaryObject ()=0
	Create a temporary object, which is similar in concept to a file.
virtual IEDLTempStoreObjectPtr	createTemporaryObjectWithContents (const IInputStreamPtr &stream)=0
	Create a temporary object with the contents of an existing input stream.
virtual IRAInputStreamPtr	createTemporaryStreamWithContents (const IInputStreamPtr &stream)=0
	Copy the given stream into a temporary store object and return a buffered reader. Convenience.
virtual void	createTemporaryReaderWriterPair (IRAInputStreamPtr &reader, IRAOutputStreamPtr &writer)=0
	Create a temporary object and provide a reader/writer pair. Convenience method.
virtual IRAInputOutputStreamPtr	createTemporaryReaderWriter ()=0
	Create a temporary object and provide a consolidated reader/writer. Convenience method.
virtual bool	getWasExhausted () const =0
	Determine if the temporary store has been exhausted since the last time this flag was cleared. To clear this, use clearExhaustedFlag() below. Note that this means that this flag can be true even if there is currently available space in the temp store.
virtual void	clearExhaustedFlag ()=0
	Clear the exhausted flag. See getWasExhausted() above.
virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Clone - not available for objects of this type.
Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.
virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static const CClassID &	classID ()
	Retrieves class id of IEDLTempStore.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

A self-cleaning area for storage of temporary data in the form of streams. One per session, obtainable from an ISession. Exceptions of type IEDLError are thrown on failures.

Member Function Documentation

classID()

static const CClassID & IEDLTempStore::classID ( )

inlinestatic

Retrieves class id of IEDLTempStore.

Returns

CClassID class id of the object

createTemporaryObject()

virtual IEDLTempStoreObjectPtr IEDLTempStore::createTemporaryObject ( )

pure virtual

Create a temporary object, which is similar in concept to a file.

Returns

IEDLTempStoreObjectPtr The new temporary object.

createTemporaryObjectWithContents()

virtual IEDLTempStoreObjectPtr IEDLTempStore::createTemporaryObjectWithContents ( const IInputStreamPtr & stream )

pure virtual

Create a temporary object with the contents of an existing input stream.

Parameters

stream

Reference to the source stream.

Returns

IEDLTempStoreObjectPtr The new temporary object

createTemporaryReaderWriter()

virtual IRAInputOutputStreamPtr IEDLTempStore::createTemporaryReaderWriter ( )

pure virtual

Create a temporary object and provide a consolidated reader/writer. Convenience method.

Returns

IRAInputOutputStreamPtr The consolidated reader/writer for the temporary object.

createTemporaryReaderWriterPair()

virtual void IEDLTempStore::createTemporaryReaderWriterPair ( IRAInputStreamPtr & reader, IRAOutputStreamPtr & writer )

pure virtual

Create a temporary object and provide a reader/writer pair. Convenience method.

Parameters

reader	reference to receive a reader for the temporary object.
writer	reference to receive a writer for the temporary object.

createTemporaryStreamWithContents()

virtual IRAInputStreamPtr IEDLTempStore::createTemporaryStreamWithContents ( const IInputStreamPtr & stream )

pure virtual

Copy the given stream into a temporary store object and return a buffered reader. Convenience.

Parameters

stream

Reference to the source stream.

Returns

IRAInputStreamPtr The result stream.

getWasExhausted()

virtual bool IEDLTempStore::getWasExhausted ( ) const

pure virtual

Determine if the temporary store has been exhausted since the last time this flag was cleared. To clear this, use clearExhaustedFlag() below. Note that this means that this flag can be true even if there is currently available space in the temp store.

Note that Mako will not currently clear this flag itself, so it may be used to detect that an exhaustion issue has occurred.

Returns

bool Returns true if the temp store was exhausted since the last time the flag was cleared, false otherwise.

---

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

• iedltempstore.h