StatementMemoryContext Class Reference

Used to represent a statement-wide memory context. Uses SharedPtr to ensure that there is only 1 context per-statement at a time. More...

Inherits Simba::DSI::IMemoryContext.

List of all members.

Public Member Functions

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.
IStatementGetStatement () const
virtual const volatile bool & IsCanceled () const
 Determines if the cancel has been called on the requester.
void SetCancelFlag (bool in_isCanceled)
 Set the cancel flag.

Static Public Member Functions

static SharedPtr
< StatementMemoryContext
Create (IStatement *in_statement)
 Factory function.

Detailed Description

Used to represent a statement-wide memory context. Uses SharedPtr to ensure that there is only 1 context per-statement at a time.


Member Function Documentation

static SharedPtr<StatementMemoryContext> Create ( IStatement in_statement  )  [static]

Factory function.

Parameters:
The statement to get/create the memory context for. Must not be NULL. (NOT OWN)
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:
The unique ID for this memory context.

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.

IStatement& GetStatement (  )  const [inline]
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.

void SetCancelFlag ( bool  in_isCanceled  ) 

Set the cancel flag.


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

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