DSIExtNoncancelableMemoryContext Class Reference

Implementation of IMemoryContext which can be used when there's no access to the data engine context. More...

Inherits Simba::DSI::IMemoryContext.

List of all members.

Public Member Functions

 DSIExtNoncancelableMemoryContext (DSIExtDataEngineContext *in_engineCtx)
 Use this constructor to wrap an existing memory context (i.e. a DSIExtDataEngineContext).
 DSIExtNoncancelableMemoryContext (Simba::DSI::IStatement *in_statement)
 Use this constructor if no existing context to wrap is available. Scopes to the statement.
virtual Simba::DSI::MemoryToken GetQuerySpecificID () const
 Provides a unique ID for the memory manager to identify different consumers that come from the same query.
virtual simba_uint32 GetQueryTimeOut () const
 Returns the time-out value, the query will wait max time-out value on memory and then it throws a memory error if it cannot reserve the requested memory.
virtual const volatile bool & IsCanceled () const
 Determines if the cancel has been called on the requester.
virtual ~DSIExtNoncancelableMemoryContext ()

Detailed Description

Implementation of IMemoryContext which can be used when there's no access to the data engine context.

When the first constructor is used, this creates a statement-wide context (or shares an existing one). This statement-wide context is not destroyed (i.e. cleaned w/ Simba::DSI::MemoryManager::CleanupMemoryRecords) until all such-created DSIExtNoncancelableMemoryContext objects created with the given statement are destroyed.\

In either case, this class will return a reference to a static, always-false boolean from Iscanceled(), and 0 from GetQueryTimeout.


Constructor & Destructor Documentation

Use this constructor if no existing context to wrap is available. Scopes to the statement.

Use this constructor to wrap an existing memory context (i.e. a DSIExtDataEngineContext).

virtual ~DSIExtNoncancelableMemoryContext (  )  [virtual]

Member Function Documentation

virtual Simba::DSI::MemoryToken GetQuerySpecificID (  )  const [virtual]

Provides a unique ID for the memory manager to identify different consumers that come from the same query.

Returns:
A query specific unique ID.

Implements IMemoryContext.

virtual simba_uint32 GetQueryTimeOut (  )  const [virtual]

Returns the time-out value, the query will wait max time-out value on memory and then it throws a memory error if it cannot reserve the requested memory.

Returns:
The time out value in milliseconds.

Implements IMemoryContext.

virtual const volatile bool& IsCanceled (  )  const [virtual]

Determines if the cancel has been called on the requester.

Returns:
A reference to the canceled flag.

Implements IMemoryContext.


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

Generated on Wed May 17 14:21:17 2017 for SimbaEngine 10.1.3.1011 by simba