vrforces5.1.1/classref/_dt_locked_buffered_queue_8h_source.html

 /******************************************************************************

 ** Copyright (c) 2007 MAK Technologies, Inc.

 ** All rights reserved.

 ******************************************************************************/


 #ifndef DtLockedBufferedQueue_H_

 #define DtLockedBufferedQueue_H_


 #include <vrvUtil/vrvUtil.h>

 #include <vlutil/vlMutex.h>

 #include <vector>


 namespace makVrv

 {

    template <typename T>

    class DtLockedBufferedQueue

    {

    public:

       DtLockedBufferedQueue();


       ~DtLockedBufferedQueue();


       unsigned int push(T value);


       unsigned int push( std::vector<T>& valueVector );


       void getForReading(std::vector<T>*& output);


       void deleteAllPointers();


       void nullAllPointers();


       void clearBuffers();


    protected:


       void swapBuffers();


       std::vector<T> myFirstBuffer;

       std::vector<T> mySecondBuffer;

       std::vector<T>* myCurrentBuffer;


       DtMutex myBufferMutex;

    };


 }


 #define DtLockedBufferedQueue_INL_

 #include <vrvUtil/DtLockedBufferedQueue.inl>

 #undef DtLockedBufferedQueue_INL_


 #endif


makVrv::DtLockedBufferedQueue::nullAllPointers
void nullAllPointers()
Helper function for setting all member pointers to null in both buffers (for reference pointers...

makVrv::DtLockedBufferedQueue::getForReading
void getForReading(std::vector< T > *&output)
Get a vector for reading. This function should only be called by the reader thread. The pointer reference is written to, and can be initially null. The pointer is guaranteed to be valid and not NULL after a call to getForReading. The pointer is only valid until the next call to getForReading. There is no need to clear the buffer when reading is done. The contents of the output will not change until the next call to getForReading. All iterators are invalidated with the next call to getForReading.

makVrv::DtLockedBufferedQueue::~DtLockedBufferedQueue
~DtLockedBufferedQueue()
DTOR If the type T is a pointer memory must be explicitly deleting by iterating throug both vectors c...

makVrv::DtLockedBufferedQueue::swapBuffers
void swapBuffers()
Internal function for swapping buffers and clearing the write buffer.

vrvUtil.h
Contains DLL export macros.

makVrv::DtLockedBufferedQueue::push
unsigned int push(T value)
Add a value to to the buffer. This function is thread safe and reentrant. The return value is the cur...

makVrv::DtLockedBufferedQueue::myFirstBuffer
std::vector< T > myFirstBuffer
Definition: DtLockedBufferedQueue.h:91

makVrv::DtLockedBufferedQueue
A locked buffered queue which allows multiple writers and a single reader. Internally the queue is st...
Definition: DtLockedBufferedQueue.h:24

makVrv::DtLockedBufferedQueue::deleteAllPointers
void deleteAllPointers()
Helper function for deleting all member pointers in both buffers. This function is not valid if T is ...

makVrv::DtLockedBufferedQueue::DtLockedBufferedQueue
DtLockedBufferedQueue()

makVrv::DtLockedBufferedQueue::myBufferMutex
DtMutex myBufferMutex
Definition: DtLockedBufferedQueue.h:95

makVrv::DtLockedBufferedQueue::mySecondBuffer
std::vector< T > mySecondBuffer
Definition: DtLockedBufferedQueue.h:92

makVrv::DtLockedBufferedQueue::clearBuffers
void clearBuffers()
Helper function to clear all the buffers, if the buffers contain pointers call deleteAllPointers() fi...

makVrv::DtLockedBufferedQueue::myCurrentBuffer
std::vector< T > * myCurrentBuffer
Definition: DtLockedBufferedQueue.h:93