SwapDevice Class Reference

Defines the interface for a class that swaps RowBlocks to an external device. More...

Inherited by DiskSwapDevice.

List of all members.

Public Member Functions

virtual void FlushBlock (Simba::DSI::RowBlock &in_rowBlock)=0
 Flush the given RowBlock to the device if should write is true. Otherwise, call back into the s.
virtual std::pair
< simba_uint64, simba_uint32 > 
ReadBlock (simba_uint64 in_rowNumber, Simba::DSI::RowBlock &io_rowBlock)=0
 Read the RowBlock from the device that contains the given row into io_rowBlock.
virtual void Reset ()=0
 Reset the Swap Device to an empty state.
virtual ~SwapDevice ()
 Destructor.

Protected Member Functions

void * GetRowBlockBuffer (SwapManager &in_swapManager, RowBlock &in_block, simba_int64 in_length)
 Get the row block's buffer for storing serialized data.
void SerializeRowBlock (SwapManager &in_swapManager, RowBlock &in_rowBlock, void *&out_buffer, simba_int64 &out_length)
 Fill a buffer with the raw data from the input row block and output it to the caller.
 SwapDevice ()
 Constructor.

Detailed Description

Defines the interface for a class that swaps RowBlocks to an external device.


Constructor & Destructor Documentation

virtual ~SwapDevice (  )  [inline, virtual]

Destructor.

SwapDevice (  )  [inline, protected]

Constructor.


Member Function Documentation

virtual void FlushBlock ( Simba::DSI::RowBlock in_rowBlock  )  [pure virtual]

Flush the given RowBlock to the device if should write is true. Otherwise, call back into the s.

Parameters:
in_rowBlock The RowBlock to flush to disk.

Implemented in DiskSwapDevice.

void* GetRowBlockBuffer ( SwapManager in_swapManager,
RowBlock in_block,
simba_int64  in_length 
) [protected]

Get the row block's buffer for storing serialized data.

Parameters:
in_swapManager The swap manager that will perform the operation.
in_length The length in bytes that the buffer must be.
in_block The block that owns the buffer.
Returns:
the requested buffer. (NOT OWN)
virtual std::pair<simba_uint64, simba_uint32> ReadBlock ( simba_uint64  in_rowNumber,
Simba::DSI::RowBlock io_rowBlock 
) [pure virtual]

Read the RowBlock from the device that contains the given row into io_rowBlock.

Parameters:
in_rowNumber The row number that the block must contain.
io_rowBlock The RowBlock which will be filled with data.
Returns:
The start row number and count of the block this is read in.

Implemented in DiskSwapDevice.

virtual void Reset (  )  [pure virtual]

Reset the Swap Device to an empty state.

Implemented in DiskSwapDevice.

void SerializeRowBlock ( SwapManager in_swapManager,
RowBlock in_rowBlock,
void *&  out_buffer,
simba_int64 &  out_length 
) [protected]

Fill a buffer with the raw data from the input row block and output it to the caller.

Parameters:
io_rowBlock The row block to get the data from.
out_buffer Output the filled buffer. (NOT OWN)
out_length Output the length in bytes of the data in the buffer.

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