csl::ThreadUtil Class Reference

#include <ThreadedFrameStream.h>

Inheritance diagram for csl::ThreadUtil:

List of all members.

---

Detailed Description

ThreadUtil class -- supports reader and writer

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? ring buffer used to store frames
Protected Attributes
Synch *	mSynch
Thread *	mThread
Buffer	mBuffer
	buffer used to cache or accumulate

---

Member Function Documentation

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

methods

void ThreadUtil::setThreshold (  unsigned  threshold  )

void ThreadUtil::setChannels (  unsigned  numChannels  )

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

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

void ThreadUtil::start (   )  [virtual]

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

void ThreadUtil::stop (   )  [virtual]

Reimplemented in csl::ThreadedWriter.

---

Member Data Documentation

unsigned csl::ThreadUtil::mNumChannels

number of channels I handle

unsigned csl::ThreadUtil::mNumBufferFrames

number of frames I store

bool csl::ThreadUtil::mIsRunning

am I running?

int csl::ThreadUtil::mNumAvailableFrames

unsigned csl::ThreadUtil::mAvailableFrameThreshold

v how many frames are available?

RingBuffer csl::ThreadUtil::mRingBuffer

v when do I call my input for more? ring buffer used to store frames

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

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

Buffer csl::ThreadUtil::mBuffer [protected]

buffer used to cache or accumulate

---

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

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

---