summaryrefslogtreecommitdiffstats
path: root/raul/Maid.h
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2007-07-24 19:26:47 +0000
committerDavid Robillard <d@drobilla.net>2007-07-24 19:26:47 +0000
commit3b4a308ff647def75e647ac8f97e1e48b57672c3 (patch)
treea33e3a5c78f2ee7f23e151f39fe17ab39b0b81c8 /raul/Maid.h
parentfcb302e6248527b2f1fb655f4d0a64af18f5f059 (diff)
downloadraul-3b4a308ff647def75e647ac8f97e1e48b57672c3.tar.gz
raul-3b4a308ff647def75e647ac8f97e1e48b57672c3.tar.bz2
raul-3b4a308ff647def75e647ac8f97e1e48b57672c3.zip
Consistently rename all C++ files .cpp/.hpp.
Fix (some) inclusion guard names to not clash with other libs. git-svn-id: http://svn.drobilla.net/lad/raul@613 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'raul/Maid.h')
-rw-r--r--raul/Maid.h76
1 files changed, 0 insertions, 76 deletions
diff --git a/raul/Maid.h b/raul/Maid.h
deleted file mode 100644
index f8f6c29..0000000
--- a/raul/Maid.h
+++ /dev/null
@@ -1,76 +0,0 @@
-/* This file is part of Raul.
- * Copyright (C) 2007 Dave 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_H
-#define RAUL_MAID_H
-
-#include <boost/utility.hpp>
-#include "raul/SharedPtr.h"
-#include "raul/SRSWQueue.h"
-#include "raul/Deletable.h"
-#include "raul/List.h"
-
-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:
- 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_H
-