ITargetBuffer< T > Class Template Reference

Basic target buffer interface. More...

#include <buffer.h>

Inheritance diagram for ITargetBuffer< T >:

Public Member Functions
virtual std::recursive_mutex &	getLock ()=0
	Function return locking object. More...
virtual size_t	getRemainingSize ()=0
	Function returns remaining size in samples. More...
virtual size_t	writeSamples (const T *samples, size_t samplesCount, bool incrementPosition=true)=0
	Function pushes the samples into buffer. More...
virtual void	incrementWritePosition (size_t pos)=0
	Function increments write position for N samples. More...

Detailed Description

template<typename T>
class ITargetBuffer< T >

Basic target buffer interface.

Member Function Documentation

getLock()

template<typename T>

virtual std::recursive_mutex& ITargetBuffer< T >::getLock ( )

pure virtual

Function return locking object.

Returns

Locking object

Implemented in FifoBufferBase< T >.

getRemainingSize()

template<typename T>

virtual size_t ITargetBuffer< T >::getRemainingSize ( )

pure virtual

Function returns remaining size in samples.

Returns

Size in samples.

Implemented in ArrayBufferTargetDesc< T >, and FifoBufferBase< T >.

incrementWritePosition()

template<typename T>

virtual void ITargetBuffer< T >::incrementWritePosition ( size_t  pos )

pure virtual

Function increments write position for N samples.

Parameters

pos	an increment value

Returns

void

Implemented in ArrayBufferTargetDesc< T >, and FifoBufferBase< T >.

writeSamples()

template<typename T>

virtual size_t ITargetBuffer< T >::writeSamples ( const T *  samples, size_t  samplesCount, bool  incrementPosition = true  )

pure virtual

Function pushes the samples into buffer.

Parameters

samples	a pointer to the first sample
samplesCount	a number of samples to be added
incrementPosition	an option if change position

Returns

number of added samples

Implemented in IDirectArrayTargetBuffer< T >.

---

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

• C:/CProjects/Libs/CommonLib/include/commonlib/memory/buffer.h