DataStructures::SingleProducerConsumer< SingleProducerConsumerType > Class Template Reference

A single producer consumer implementation without critical sections. More...

#include <SingleProducerConsumer.h>

Collaboration diagram for DataStructures::SingleProducerConsumer< SingleProducerConsumerType >:

List of all members.

Classes
struct	DataPlusPtr
Public Member Functions
	SingleProducerConsumer ()
	~SingleProducerConsumer ()
SingleProducerConsumerType *	WriteLock (void)
void	CancelWriteLock (SingleProducerConsumerType *cancelToLocation)
void	WriteUnlock (void)
	Call when you are done writing to a block of memory returned by WriteLock().
SingleProducerConsumerType *	ReadLock (void)
void	CancelReadLock (SingleProducerConsumerType *cancelToLocation)
	param[in] Which ReadLock() to cancel.
void	ReadUnlock (void)
void	Clear (void)
	Clear is not thread-safe and none of the lock or unlock functions should be called while it is running.
int	Size (void) const
bool	CheckReadUnlockOrder (const SingleProducerConsumerType *data) const
bool	ReadIsLocked (void) const

---

Detailed Description

template<class SingleProducerConsumerType>
class DataStructures::SingleProducerConsumer< SingleProducerConsumerType >

A single producer consumer implementation without critical sections.

Definition at line 25 of file SingleProducerConsumer.h.

---

Constructor & Destructor Documentation

template<class SingleProducerConsumerType >

DataStructures::SingleProducerConsumer< SingleProducerConsumerType >::SingleProducerConsumer

(

)

Definition at line 92 of file SingleProducerConsumer.h.

template<class SingleProducerConsumerType >

DataStructures::SingleProducerConsumer< SingleProducerConsumerType >::~SingleProducerConsumer

(

)

Definition at line 115 of file SingleProducerConsumer.h.

Here is the call graph for this function:

---

Member Function Documentation

template<class SingleProducerConsumerType>

void DataStructures::SingleProducerConsumer< SingleProducerConsumerType >::CancelReadLock

(

SingleProducerConsumerType *

cancelToLocation

)

param[in] Which ReadLock() to cancel.

Definition at line 185 of file SingleProducerConsumer.h.

template<class SingleProducerConsumerType>

void DataStructures::SingleProducerConsumer< SingleProducerConsumerType >::CancelWriteLock

(

SingleProducerConsumerType *

cancelToLocation

)

Call if you don't want to write to a block of data from WriteLock() after all. Cancelling locks cancels all locks back up to the data passed. So if you lock twice and cancel using the first lock, the second lock is ignored

Parameters:

[in]

cancelToLocation

Which WriteLock() to cancel.

Definition at line 148 of file SingleProducerConsumer.h.

template<class SingleProducerConsumerType>

bool DataStructures::SingleProducerConsumer< SingleProducerConsumerType >::CheckReadUnlockOrder

(

const SingleProducerConsumerType *

data

)

const

Make sure that the pointer we done reading for the call to ReadUnlock is the right pointer. param[in] A previous pointer returned by ReadLock()

Definition at line 246 of file SingleProducerConsumer.h.

template<class SingleProducerConsumerType >

void DataStructures::SingleProducerConsumer< SingleProducerConsumerType >::Clear

(

void

)

Clear is not thread-safe and none of the lock or unlock functions should be called while it is running.

Definition at line 208 of file SingleProducerConsumer.h.

Here is the call graph for this function:

template<class SingleProducerConsumerType >

bool DataStructures::SingleProducerConsumer< SingleProducerConsumerType >::ReadIsLocked

(

void

)

const

Returns if ReadUnlock was called before ReadLock

Returns:

If the read is locked

Definition at line 253 of file SingleProducerConsumer.h.

template<class SingleProducerConsumerType >

SingleProducerConsumerType * DataStructures::SingleProducerConsumer< SingleProducerConsumerType >::ReadLock

(

void

)

ReadLock must be immediately followed by ReadUnlock. These two functions must be called in the same thread.

Return values:

	0	No data is availble to read
	Non-zero	The data previously written to, in another thread, by WriteLock followed by WriteUnlock.

Definition at line 170 of file SingleProducerConsumer.h.

Here is the caller graph for this function:

template<class SingleProducerConsumerType >

void DataStructures::SingleProducerConsumer< SingleProducerConsumerType >::ReadUnlock

(

void

)

Signals that we are done reading the the data from the least recent call of ReadLock. At this point that pointer is no longer valid, and should no longer be read.

Definition at line 194 of file SingleProducerConsumer.h.

template<class SingleProducerConsumerType >

int DataStructures::SingleProducerConsumer< SingleProducerConsumerType >::Size

(

void

)

const

This function will estimate how many elements are waiting to be read. It's threadsafe enough that the value returned is stable, but not threadsafe enough to give accurate results.

Returns:

An ESTIMATE of how many data elements are waiting to be read

Definition at line 240 of file SingleProducerConsumer.h.

template<class SingleProducerConsumerType >

SingleProducerConsumerType * DataStructures::SingleProducerConsumer< SingleProducerConsumerType >::WriteLock

(

void

)

WriteLock must be immediately followed by WriteUnlock. These two functions must be called in the same thread.

Returns:

A pointer to a block of data you can write to.

Definition at line 129 of file SingleProducerConsumer.h.

Here is the caller graph for this function:

template<class SingleProducerConsumerType >

void DataStructures::SingleProducerConsumer< SingleProducerConsumerType >::WriteUnlock

(

void

)

Call when you are done writing to a block of memory returned by WriteLock().

Definition at line 154 of file SingleProducerConsumer.h.

Here is the caller graph for this function:

---

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

• SingleProducerConsumer.h