Main MRPT website > C++ reference
MRPT logo

MT_buffer.h

Go to the documentation of this file.
00001 /* +---------------------------------------------------------------------------+
00002    |          The Mobile Robot Programming Toolkit (MRPT) C++ library          |
00003    |                                                                           |
00004    |                   http://mrpt.sourceforge.net/                            |
00005    |                                                                           |
00006    |   Copyright (C) 2005-2011  University of Malaga                           |
00007    |                                                                           |
00008    |    This software was written by the Machine Perception and Intelligent    |
00009    |      Robotics Lab, University of Malaga (Spain).                          |
00010    |    Contact: Jose-Luis Blanco  <jlblanco@ctima.uma.es>                     |
00011    |                                                                           |
00012    |  This file is part of the MRPT project.                                   |
00013    |                                                                           |
00014    |     MRPT is free software: you can redistribute it and/or modify          |
00015    |     it under the terms of the GNU General Public License as published by  |
00016    |     the Free Software Foundation, either version 3 of the License, or     |
00017    |     (at your option) any later version.                                   |
00018    |                                                                           |
00019    |   MRPT is distributed in the hope that it will be useful,                 |
00020    |     but WITHOUT ANY WARRANTY; without even the implied warranty of        |
00021    |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         |
00022    |     GNU General Public License for more details.                          |
00023    |                                                                           |
00024    |     You should have received a copy of the GNU General Public License     |
00025    |     along with MRPT.  If not, see <http://www.gnu.org/licenses/>.         |
00026    |                                                                           |
00027    +---------------------------------------------------------------------------+ */
00028 #ifndef  mrpt_synch_mt_buffer_H
00029 #define  mrpt_synch_mt_buffer_H
00030 
00031 #include <mrpt/synch/CCriticalSection.h>
00032 
00033 namespace mrpt
00034 {
00035 namespace synch
00036 {
00037 
00038 /** This class is a bulk sequence of bytes with MultiThread (MT)-safe read and write operations.
00039   */
00040 class MT_buffer
00041 {
00042 private:
00043         vector_byte       m_data;
00044         CCriticalSection  m_cs;
00045 
00046 public:
00047         MT_buffer()  //!< Default constructor
00048         {}
00049         virtual ~MT_buffer()  //!< Destructor
00050         {}
00051 
00052         void clear()  //!< Empty the buffer
00053         {
00054                 m_cs.enter();
00055                 m_data.clear();
00056                 m_cs.leave();
00057         }
00058 
00059         size_t size()  //!< Return the number of available bytes at this moment.
00060         {
00061                 size_t s;
00062                 m_cs.enter();
00063                 s = m_data.size();
00064                 m_cs.leave();
00065                 return s;
00066         }
00067 
00068         void appendData(const vector_byte &d)  //!< Append new data to the stream
00069         {
00070                 m_cs.enter();
00071                 m_data.insert( m_data.begin(), d.begin(),d.end() );
00072                 m_cs.leave();
00073         }
00074 
00075         void readAndClear(vector_byte &d)  //!< Read the whole buffer and empty it.
00076         {
00077                 m_cs.enter();
00078                 d.clear();
00079                 m_data.swap(d);
00080                 m_cs.leave();
00081         }
00082 
00083         void read(vector_byte &d)  //!< Read the whole buffer.
00084         {
00085                 m_cs.enter();
00086                 d = m_data;
00087                 m_cs.leave();
00088         }
00089 
00090 }; // end of MT_buffer
00091 
00092 
00093 } // End of namespace
00094 } // End of namespace
00095 
00096 #endif



Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:16:28 UTC 2011