All Classes Namespaces Files Functions Variables Typedefs Macros
cliz::Save Class Reference

#include <clizSave.h>

Public Member Functions

 Save ()
 
void pushFront (ChunkPtrStruct *chunk)
 
void popBack (ChunkPtrStruct &chunk)
 
void diarrhea (ChunkPtrStruct *&chunk, unsigned int &n)
 

Detailed Description

A Save is used to send ChunkPtrStructs from one module to another in a thread save way (one writer and one reader). pushFront Input module uses this function to push a ChunkPtrStruct on the stack. popBack Output module uses this function to receive a ChunkPtrStruct. If the stack is empty, the module (its thread) waits until data is available. diarrhea Output module uses this function to receive all ChunkPtrStructs that are currently on the stack. If the stack is empty, function will return without stalling execution.

Constructor & Destructor Documentation

cliz::Save::Save ( )
inline

Member Function Documentation

void cliz::Save::diarrhea ( ChunkPtrStruct *&  chunk,
unsigned int &  n 
)
inline
void cliz::Save::popBack ( ChunkPtrStruct chunk)
inline
void cliz::Save::pushFront ( ChunkPtrStruct chunk)
inline

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