---

syn::SampleBufferQueue Class Reference

SampleBuffer Queue. More...

#include <SampleBufferQueue.h>

Inheritance diagram for syn::SampleBufferQueue:

[legend]Collaboration diagram for syn::SampleBufferQueue:

[legend]List of all members.

Public Methods
	SampleBufferQueue ()
virtual	~SampleBufferQueue ()
bool	done ()
	If done, then reader shouldn't wait for more data before processing. More...
void	setDone (bool d)
	if you're writting to this buffer, set this flag to indicate whether other modules should wait for your data, or go on without you. More...

---

Detailed Description

SampleBuffer Queue.

Implements the producer/consumer pattern.

NOTE: The queue has high and low water marks. This metric allows modules to evaluate when to produce more data for the queue. It also has a "done" state, so consumers know when to wait on it.

Definition at line 51 of file SampleBufferQueue.h.

---

Constructor & Destructor Documentation

syn::SampleBufferQueue::SampleBufferQueue ( ) [inline]

Definition at line 54 of file SampleBufferQueue.h.

syn::SampleBufferQueue::~SampleBufferQueue ( ) [inline, virtual]

Definition at line 58 of file SampleBufferQueue.h.

---

Member Function Documentation

bool syn::SampleBufferQueue::done ( ) [inline]

If done, then reader shouldn't wait for more data before processing. Otherwise, reader should assume that more data is coming and should wait for this buffer to have more data before it continues processing. Definition at line 78 of file SampleBufferQueue.h.

void syn::SampleBufferQueue::setDone ( bool d ) [inline]

if you're writting to this buffer, set this flag to indicate whether other modules should wait for your data, or go on without you. Definition at line 90 of file SampleBufferQueue.h.

---

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

• /root/src/subsynth/syn/Core/SampleBufferQueue.h

---