mrpt::synch::MT_buffer Class Reference

Detailed Description

This class is a bulk sequence of bytes with MultiThread (MT)-safe read and write operations.

Definition at line 23 of file MT_buffer.h.

#include <mrpt/synch/MT_buffer.h>

Public Member Functions
	MT_buffer ()
virtual	~MT_buffer ()
void	clear ()
size_t	size ()
void	appendData (const vector_byte &d)
void	readAndClear (vector_byte &d)
void	read (vector_byte &d)

Private Attributes
vector_byte	m_data
CCriticalSection	m_cs

Constructor & Destructor Documentation

MT_buffer()

mrpt::synch::MT_buffer::MT_buffer ( )

inline

Definition at line 30 of file MT_buffer.h.

~MT_buffer()

virtual mrpt::synch::MT_buffer::~MT_buffer ( )

inlinevirtual

Definition at line 32 of file MT_buffer.h.

Member Function Documentation

appendData()

void mrpt::synch::MT_buffer::appendData ( const vector_byte &  d )

inline

Parameters

d	Append new data to the stream

Definition at line 51 of file MT_buffer.h.

References mrpt::synch::CCriticalSection::enter(), and mrpt::synch::CCriticalSection::leave().

clear()

void mrpt::synch::MT_buffer::clear ( void  )

inline

Definition at line 35 of file MT_buffer.h.

References mrpt::synch::CCriticalSection::enter(), and mrpt::synch::CCriticalSection::leave().

read()

void mrpt::synch::MT_buffer::read ( vector_byte &  d )

inline

Parameters

d	Read the whole buffer.

Definition at line 66 of file MT_buffer.h.

References mrpt::synch::CCriticalSection::enter(), mrpt::synch::CCriticalSection::leave(), and m_data.

readAndClear()

void mrpt::synch::MT_buffer::readAndClear ( vector_byte &  d )

inline

Parameters

d	Read the whole buffer and empty it.

Definition at line 58 of file MT_buffer.h.

References mrpt::synch::CCriticalSection::enter(), and mrpt::synch::CCriticalSection::leave().

size()

size_t mrpt::synch::MT_buffer::size ( )

inline

Definition at line 42 of file MT_buffer.h.

References mrpt::synch::CCriticalSection::enter(), and mrpt::synch::CCriticalSection::leave().

Member Data Documentation

m_cs

CCriticalSection mrpt::synch::MT_buffer::m_cs

private

Definition at line 27 of file MT_buffer.h.

m_data

vector_byte mrpt::synch::MT_buffer::m_data

private

Definition at line 26 of file MT_buffer.h.

Referenced by read().