Mako 7.5.0 API
Loading...
Searching...
No Matches
IEDLTempStoreObject Class Referenceabstract

A mechanism for storing and accessing temporary data for use with Jaws Mako. More...

#include <iedltempstore.h>

Inheritance diagram for IEDLTempStoreObject:

Public Member Functions

virtual IRAOutputStreamPtr createWriter ()=0
 Create a writer that may be used to write to this temporary object. Multiple writers writing to a single temporary store object is not supported, and the writer may not be cloned.
 
virtual IRAInputStreamPtr createReader (bool buffered=true)=0
 Create a reader that may be used to read from this temporary object Many readers can simultaneously perform reads.
 
virtual IRAInputOutputStreamPtr createReaderWriter ()=0
 Create a stream that may be used to simulatneously read and write from this temporary object. Multiple writers writing to a single temporary object store is not supported. Clones of this object type will be read only. This is convenient for some cases that require simultaneous reading and writing. Reads from this stream will be unbuffered, so for best performance, please consider creating a reader writer pair instead.
 
- 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.
 

Additional Inherited Members

- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

A mechanism for storing and accessing temporary data for use with Jaws Mako.

A temporary, file-like object, stored with an IEDLTempStore. Exceptions of type IEDLError are thrown on failures.

Member Function Documentation

◆ createReader()

virtual IRAInputStreamPtr IEDLTempStoreObject::createReader ( bool buffered = true)
pure virtual

Create a reader that may be used to read from this temporary object Many readers can simultaneously perform reads.

Parameters
buffered- If set to false, the resulting reader will not buffer read data. Useful if a reader and writer are being used on the same IEDLTempStoreObject, as it allows changes made by a writer to be immediately available to users of the reader.
Returns
IRAInputStreamPtr The reader.

◆ createWriter()

virtual IRAOutputStreamPtr IEDLTempStoreObject::createWriter ( )
pure virtual

Create a writer that may be used to write to this temporary object. Multiple writers writing to a single temporary store object is not supported, and the writer may not be cloned.

Returns
IRAOutputStreamPtr The writer.

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