csl::ThreadUtil Class Reference

#include <ThreadedFrameStream.h>

Inheritance diagram for csl::ThreadUtil:

List of all members.

Public Member Functions
void	setSize (unsigned numChannels, unsigned numBufferFrames)
	methods
void	setThreshold (unsigned threshold)
void	setChannels (unsigned numChannels)
virtual void	init (unsigned numChannels, unsigned numBufferFrames)=0
virtual void	start ()
virtual void	stop ()
Public Attributes
unsigned	mNumChannels
	number of channels I handle
unsigned	mNumBufferFrames
	number of frames I store
bool	mIsRunning
	am I running?
int	mNumAvailableFrames
unsigned	mAvailableFrameThreshold
	v how many frames are available?
RingBuffer	mRingBuffer
	v when do I call my input for more?
Protected Attributes
Synch *	mSynch
Thread *	mThread
Buffer	mBuffer
	buffer used to cache or accumulate

---

Detailed Description

ThreadUtil class -- supports reader and writer

---

Member Function Documentation

void ThreadUtil::setSize	(	unsigned	numChannels,
		unsigned	numBufferFrames
	)

methods

References csl::RingBuffer::mBuffer, mIsRunning, mNumAvailableFrames, mNumBufferFrames, mNumChannels, mRingBuffer, and csl::Buffer::setSize().

Referenced by csl::ThreadedWriter::init(), and csl::ThreadedReader::init().

void ThreadUtil::setThreshold

(

unsigned

threshold

)

References mAvailableFrameThreshold.

void ThreadUtil::setChannels

(

unsigned

numChannels

)

References mNumChannels.

virtual void csl::ThreadUtil::init	(	unsigned	numChannels,
		unsigned	numBufferFrames
	)			[pure virtual]

Implemented in csl::ThreadedReader, and csl::ThreadedWriter.

void ThreadUtil::start

(

void

)

[virtual]

Reimplemented in csl::ThreadedReader, and csl::ThreadedWriter.

References csl::Buffer::allocateBuffers(), csl::Buffer::mAreBuffersAllocated, csl::RingBuffer::mBuffer, mBuffer, mIsRunning, and mRingBuffer.

void ThreadUtil::stop

(

void

)

[virtual]

Reimplemented in csl::ThreadedWriter.

References csl::Synch::condSignal(), mIsRunning, and mSynch.

---

Member Data Documentation

unsigned csl::ThreadUtil::mNumChannels

number of channels I handle

Referenced by csl::ThreadedWriter::init(), setChannels(), and setSize().

unsigned csl::ThreadUtil::mNumBufferFrames

number of frames I store

Referenced by csl::ThreadedReader::FeederFunction(), and setSize().

bool csl::ThreadUtil::mIsRunning

am I running?

Referenced by csl::ThreadedWriter::FeederFunction(), csl::ThreadedReader::FeederFunction(), setSize(), start(), stop(), and csl::ThreadedWriter::writeBuffer().

int csl::ThreadUtil::mNumAvailableFrames

Referenced by csl::ThreadedWriter::FeederFunction(), csl::ThreadedReader::FeederFunction(), csl::ThreadedReader::readIntoBuffer(), setSize(), csl::ThreadedWriter::stop(), csl::ThreadedWriter::writeBuffer(), and csl::ThreadedWriter::writeToOutput().

unsigned csl::ThreadUtil::mAvailableFrameThreshold

v how many frames are available?

Referenced by csl::ThreadedWriter::init(), csl::ThreadedReader::init(), setThreshold(), and csl::ThreadedWriter::writeBuffer().

RingBuffer csl::ThreadUtil::mRingBuffer

v when do I call my input for more?

ring buffer used to store frames

Referenced by csl::ThreadedReader::readIntoBuffer(), setSize(), start(), csl::ThreadedWriter::writeBuffer(), and csl::ThreadedWriter::writeToOutput().

Synch* csl::ThreadUtil::mSynch [protected]

Referenced by csl::ThreadedWriter::FeederFunction(), csl::ThreadedReader::FeederFunction(), csl::ThreadedWriter::init(), csl::ThreadedReader::init(), stop(), csl::ThreadedWriter::writeBuffer(), csl::ThreadedReader::~ThreadedReader(), and csl::ThreadedWriter::~ThreadedWriter().

Thread* csl::ThreadUtil::mThread [protected]

Referenced by csl::ThreadedWriter::init(), csl::ThreadedReader::init(), csl::ThreadedWriter::start(), csl::ThreadedReader::start(), csl::ThreadedReader::~ThreadedReader(), and csl::ThreadedWriter::~ThreadedWriter().

Buffer csl::ThreadUtil::mBuffer [protected]

buffer used to cache or accumulate

Referenced by csl::ThreadedWriter::FeederFunction(), csl::ThreadedReader::FeederFunction(), csl::ThreadedWriter::init(), csl::ThreadedReader::init(), csl::ThreadedReader::readIntoBuffer(), start(), csl::ThreadedWriter::writeToOutput(), csl::ThreadedReader::~ThreadedReader(), and csl::ThreadedWriter::~ThreadedWriter().

---

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

• CSL/Utilities/OLD/ThreadedFrameStream.h
• CSL/Utilities/OLD/ThreadedFrameStream.cpp