/usr/include/raul/Maid.hpp is in libraul-dev 0.8.0+dfsg0-0.1+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 | /* This file is part of Raul.
* Copyright (C) 2007-2009 David Robillard <http://drobilla.net>
*
* Raul is free software; you can redistribute it and/or modify it under the
* terms of the GNU General Public License as published by the Free Software
* Foundation; either version 2 of the License, or (at your option) any later
* version.
*
* Raul is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef RAUL_MAID_HPP
#define RAUL_MAID_HPP
#include <boost/utility.hpp>
#include "raul/SharedPtr.hpp"
#include "raul/SRSWQueue.hpp"
#include "raul/Deletable.hpp"
#include "raul/List.hpp"
namespace Raul {
/** Explicitly driven garbage collector.
*
* This is used by realtime threads to allow hard realtime deletion of objects
* (push() is realtime safe).
*
* You can also manage a SharedPtr, so cleanup() will delete it when all
* references are dropped (except the one held by the Maid itself).
* This allows using a SharedPtr freely in hard realtime threads without having
* to worry about deletion accidentally occuring in the realtime thread.
*
* cleanup() should be called periodically to free memory, often enough to
* prevent the queue from overflowing. This is probably best done by the main
* thread to avoid the overhead of having a thread just to delete things.
*
* \ingroup raul
*/
class Maid : boost::noncopyable
{
public:
explicit Maid(size_t size);
~Maid();
/** Push a raw pointer to be deleted when cleanup() is called next.
* Realtime safe.
*/
inline void push(Raul::Deletable* obj) {
if (obj)
_objects.push(obj);
}
void manage(SharedPtr<Raul::Deletable> ptr);
void cleanup();
private:
typedef Raul::SRSWQueue<Raul::Deletable*> Objects;
typedef Raul::List<SharedPtr<Raul::Deletable> > Managed;
Objects _objects;
Managed _managed;
};
} // namespace Raul
#endif // RAUL_MAID_HPP
|