Main MRPT website > C++ reference for MRPT 1.3.2
List of all members | Public Member Functions | Private Attributes
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

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

Definition at line 30 of file MT_buffer.h.

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

Definition at line 32 of file MT_buffer.h.

Member Function Documentation

void mrpt::synch::MT_buffer::appendData ( const vector_byte d)
inline
Parameters
dAppend new data to the stream

Definition at line 51 of file MT_buffer.h.

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

void mrpt::synch::MT_buffer::clear ( void  )
inline
void mrpt::synch::MT_buffer::read ( vector_byte d)
inline
Parameters
dRead the whole buffer.

Definition at line 66 of file MT_buffer.h.

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

void mrpt::synch::MT_buffer::readAndClear ( vector_byte d)
inline
Parameters
dRead 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_t mrpt::synch::MT_buffer::size ( )
inline

Member Data Documentation

CCriticalSection mrpt::synch::MT_buffer::m_cs
private

Definition at line 27 of file MT_buffer.h.

vector_byte mrpt::synch::MT_buffer::m_data
private

Definition at line 26 of file MT_buffer.h.

Referenced by read().




Page generated by Doxygen 1.8.11 for MRPT 1.3.2 SVN: at Mon May 9 06:50:38 UTC 2016