Panda3D
|
A class to manage a loose queue of isolated tasks, which can be performed either synchronously (in the foreground thread) or asynchronously (by a background thread). More...
#include "asyncTaskManager.h"
Classes | |
class | AsyncTaskSortName |
Public Member Functions | |
AsyncTaskManager (const string &name) | |
void | add (AsyncTask *task) |
Adds the indicated task to the active queue. | |
TypedObject * | as_typed_object () |
Returns the object, upcast (if necessary) to a TypedObject pointer. | |
const TypedObject * | as_typed_object () const |
Returns the object, upcast (if necessary) to a TypedObject pointer. | |
void | cleanup () |
Stops all threads and messily empties the task list. | |
void | clear_name () |
Resets the Namable's name to empty. | |
AsyncTask * | find_task (const string &name) const |
Returns the first task found with the indicated name, or NULL if there is no task with the indicated name. | |
AsyncTaskChain * | find_task_chain (const string &name) |
Searches a new AsyncTaskChain of the indicated name and returns it if it exists, or NULL otherwise. | |
AsyncTaskCollection | find_tasks (const string &name) const |
Returns the list of tasks found with the indicated name. | |
AsyncTaskCollection | find_tasks_matching (const GlobPattern &pattern) const |
Returns the list of tasks found whose name matches the indicated glob pattern, e.g. | |
virtual TypeHandle | force_init_type () |
AsyncTaskCollection | get_active_tasks () const |
Returns the set of tasks that are active (and not sleeping) on the task manager, at the time of the call. | |
int | get_best_parent_from_Set (const std::set< int > &) const |
ClockObject * | get_clock () |
Returns the clock pointer used within the AsyncTaskManager. | |
const string & | get_name () const |
double | get_next_wake_time () const |
Returns the scheduled time (on the manager's clock) of the next sleeping task, on any task chain, to awaken. | |
int | get_num_task_chains () const |
Returns the number of different task chains. | |
int | get_num_tasks () const |
Returns the number of tasks that are currently active or sleeping within the task manager. | |
int | get_ref_count () const |
Returns the current reference count. | |
AsyncTaskCollection | get_sleeping_tasks () const |
Returns the set of tasks that are sleeping (and not active) on the task manager, at the time of the call. | |
AsyncTaskChain * | get_task_chain (int n) const |
Returns the nth task chain. | |
AsyncTaskCollection | get_tasks () const |
Returns the set of tasks that are active or sleeping on the task manager, at the time of the call. | |
virtual TypeHandle | get_type () const |
int | get_type_index () const |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. | |
WeakReferenceList * | get_weak_list () const |
Returns the WeakReferenceList associated with this ReferenceCount object. | |
bool | has_name () const |
Returns true if the Namable has a nonempty name set, false if the name is empty. | |
bool | has_task (AsyncTask *task) const |
Returns true if the indicated task has been added to this AsyncTaskManager, false otherwise. | |
bool | has_weak_list () const |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. | |
bool | is_exact_type (TypeHandle handle) const |
Returns true if the current object is the indicated type exactly. | |
bool | is_of_type (TypeHandle handle) const |
Returns true if the current object is or derives from the indicated type. | |
void | local_object () |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. | |
MAKE_SEQ (get_task_chains, get_num_task_chains, get_task_chain) | |
AsyncTaskChain * | make_task_chain (const string &name) |
Creates a new AsyncTaskChain of the indicated name and stores it within the AsyncTaskManager. | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *, void *) |
void * | operator new (size_t size, void *ptr) |
void * | operator new (size_t size) |
void * | operator new (size_t size) |
void * | operator new (size_t size, void *ptr) |
void * | operator new[] (size_t size) |
void * | operator new[] (size_t size) |
void * | operator new[] (size_t size, void *ptr) |
void * | operator new[] (size_t size, void *ptr) |
virtual void | output (ostream &out) const |
Outputs the Namable. | |
void | poll () |
Runs through all the tasks in the task list, once, if the task manager is running in single-threaded mode (no threads available). | |
void | ref () const |
Explicitly increments the reference count. | |
bool | remove (AsyncTask *task) |
Removes the indicated task from the active queue. | |
int | remove (const AsyncTaskCollection &tasks) |
Removes all of the tasks in the AsyncTaskCollection. | |
bool | remove_task_chain (const string &name) |
Removes the AsyncTaskChain of the indicated name. | |
void | set_clock (ClockObject *clock) |
Replaces the clock pointer used within the AsyncTaskManager. | |
void | set_name (const string &name) |
void | start_threads () |
Starts any requested threads to service the tasks on the queue. | |
void | stop_threads () |
Stops any threads that are currently running. | |
bool | test_ref_count_integrity () const |
Does some easy checks to make sure that the reference count isn't completely bogus. | |
bool | test_ref_count_nonzero () const |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus. | |
virtual bool | unref () const |
Explicitly decrements the reference count. | |
void | wait_for_tasks () |
Blocks until the task list is empty. | |
void | weak_ref (WeakPointerToVoid *ptv) |
Adds the indicated PointerToVoid as a weak reference to this object. | |
void | weak_unref (WeakPointerToVoid *ptv) |
Removes the indicated PointerToVoid as a weak reference to this object. | |
virtual void | write (ostream &out, int indent_level=0) const |
Static Public Member Functions | |
static TypeHandle | get_class_type () |
static AsyncTaskManager * | get_global_ptr () |
Returns a pointer to the global AsyncTaskManager. | |
static void | init_type () |
Protected Types | |
typedef ov_set< PT(AsyncTaskChain), IndirectCompareNames < AsyncTaskChain > > | TaskChains |
typedef pmultiset< AsyncTask *, AsyncTaskSortName > | TasksByName |
Protected Member Functions | |
void | add_task_by_name (AsyncTask *task) |
Adds the task to the _tasks_by_name index, if it has a nonempty name. | |
AsyncTaskChain * | do_find_task_chain (const string &name) |
Searches a new AsyncTaskChain of the indicated name and returns it if it exists, or NULL otherwise. | |
bool | do_has_task (AsyncTask *task) const |
Returns true if the task is on one of the task lists, false if it is not (false may mean that the task is currently being serviced). | |
AsyncTaskChain * | do_make_task_chain (const string &name) |
Creates a new AsyncTaskChain of the indicated name and stores it within the AsyncTaskManager. | |
virtual void | do_output (ostream &out) const |
bool | do_test_ref_count_integrity () const |
Does some easy checks to make sure that the reference count isn't completely bogus. | |
bool | do_test_ref_count_nonzero () const |
Returns true if the reference count is nonzero, false otherwise. | |
PT (ClockObject) _clock | |
void | remove_task_by_name (AsyncTask *task) |
Removes the task from the _tasks_by_name index, if it has a nonempty name. | |
Static Protected Member Functions | |
static | PT (AsyncTaskManager) _global_ptr |
Protected Attributes | |
ConditionVarFull | _frame_cvar |
Mutex | _lock |
int | _num_tasks |
TaskChains | _task_chains |
TasksByName | _tasks_by_name |
Friends | |
class | AsyncTask |
class | AsyncTaskChain |
class | AsyncTaskChain::AsyncTaskChainThread |
class | AsyncTaskSequence |
A class to manage a loose queue of isolated tasks, which can be performed either synchronously (in the foreground thread) or asynchronously (by a background thread).
The AsyncTaskManager is actually a collection of AsyncTaskChains, each of which maintains a list of tasks. Each chain can be either foreground or background (it may run only in the main thread, or it may be serviced by one or more background threads). See AsyncTaskChain for more information.
If you do not require background processing, it is perfectly acceptable to create only one AsyncTaskChain, which runs in the main thread. This is a common configuration.
Definition at line 54 of file asyncTaskManager.h.
void AsyncTaskManager::add | ( | AsyncTask * | task | ) |
Adds the indicated task to the active queue.
It is an error if the task is already added to this or any other active queue.
Definition at line 203 of file asyncTaskManager.cxx.
References MutexDirect::acquire(), AsyncTaskChain::do_add(), do_find_task_chain(), do_has_task(), do_make_task_chain(), AsyncTask::is_runnable(), MutexDirect::release(), and AsyncTask::upon_birth().
Referenced by NonlinearImager::add_viewer(), PandaFramework::get_graphics_engine(), and PandaFramework::open_framework().
void AsyncTaskManager::add_task_by_name | ( | AsyncTask * | task | ) | [inline, protected] |
Adds the task to the _tasks_by_name index, if it has a nonempty name.
Definition at line 77 of file asyncTaskManager.I.
Referenced by AsyncTaskChain::do_add().
TypedObject * TypedObject::as_typed_object | ( | ) | [inline, inherited] |
Returns the object, upcast (if necessary) to a TypedObject pointer.
Definition at line 99 of file typedObject.I.
const TypedObject * TypedObject::as_typed_object | ( | ) | const [inline, inherited] |
Returns the object, upcast (if necessary) to a TypedObject pointer.
Definition at line 110 of file typedObject.I.
void AsyncTaskManager::cleanup | ( | ) |
Stops all threads and messily empties the task list.
This is intended to be called on destruction only.
Definition at line 64 of file asyncTaskManager.cxx.
References ordered_vector< Key, Compare >::empty(), ordered_vector< Key, Compare >::pop_back(), and ordered_vector< Key, Compare >::size().
void Namable::clear_name | ( | ) | [inline, inherited] |
AsyncTaskChain * AsyncTaskManager::do_find_task_chain | ( | const string & | name | ) | [protected] |
Searches a new AsyncTaskChain of the indicated name and returns it if it exists, or NULL otherwise.
Assumes the lock is held.
Definition at line 648 of file asyncTaskManager.cxx.
References ordered_vector< Key, Compare >::end().
Referenced by add(), find_task_chain(), AsyncTask::jump_to_task_chain(), AsyncTask::set_priority(), and AsyncTask::set_sort().
bool AsyncTaskManager::do_has_task | ( | AsyncTask * | task | ) | const [protected] |
Returns true if the task is on one of the task lists, false if it is not (false may mean that the task is currently being serviced).
Assumes the lock is currently held.
Definition at line 698 of file asyncTaskManager.cxx.
References ordered_vector< Key, Compare >::begin(), AsyncTaskChain::do_has_task(), and ordered_vector< Key, Compare >::end().
Referenced by add(), has_task(), and remove().
AsyncTaskChain * AsyncTaskManager::do_make_task_chain | ( | const string & | name | ) | [protected] |
Creates a new AsyncTaskChain of the indicated name and stores it within the AsyncTaskManager.
If a task chain with this name already exists, returns it instead.
Assumes the lock is held.
Definition at line 632 of file asyncTaskManager.cxx.
Referenced by add(), AsyncTask::jump_to_task_chain(), and make_task_chain().
bool ReferenceCount::do_test_ref_count_integrity | ( | ) | const [protected, inherited] |
Does some easy checks to make sure that the reference count isn't completely bogus.
Returns true if ok, false otherwise.
Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.
Definition at line 29 of file referenceCount.cxx.
Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().
bool ReferenceCount::do_test_ref_count_nonzero | ( | ) | const [protected, inherited] |
Returns true if the reference count is nonzero, false otherwise.
Definition at line 56 of file referenceCount.cxx.
References ReferenceCount::do_test_ref_count_integrity().
Referenced by ReferenceCount::test_ref_count_nonzero().
AsyncTask * AsyncTaskManager::find_task | ( | const string & | name | ) | const |
Returns the first task found with the indicated name, or NULL if there is no task with the indicated name.
If there are multiple tasks with the same name, returns one of them arbitrarily.
Definition at line 279 of file asyncTaskManager.cxx.
References ReferenceCount::local_object().
AsyncTaskChain * AsyncTaskManager::find_task_chain | ( | const string & | name | ) |
Searches a new AsyncTaskChain of the indicated name and returns it if it exists, or NULL otherwise.
Definition at line 154 of file asyncTaskManager.cxx.
References do_find_task_chain().
AsyncTaskCollection AsyncTaskManager::find_tasks | ( | const string & | name | ) | const |
Returns the list of tasks found with the indicated name.
Definition at line 298 of file asyncTaskManager.cxx.
References AsyncTaskCollection::add_task(), and ReferenceCount::local_object().
AsyncTaskCollection AsyncTaskManager::find_tasks_matching | ( | const GlobPattern & | pattern | ) | const |
Returns the list of tasks found whose name matches the indicated glob pattern, e.g.
"my_task_*".
Definition at line 319 of file asyncTaskManager.cxx.
References AsyncTaskCollection::add_task(), GlobPattern::get_const_prefix(), ReferenceCount::local_object(), and GlobPattern::matches().
AsyncTaskCollection AsyncTaskManager::get_active_tasks | ( | ) | const |
Returns the set of tasks that are active (and not sleeping) on the task manager, at the time of the call.
Definition at line 490 of file asyncTaskManager.cxx.
References AsyncTaskCollection::add_tasks_from(), ordered_vector< Key, Compare >::begin(), AsyncTaskChain::do_get_active_tasks(), and ordered_vector< Key, Compare >::end().
ClockObject * AsyncTaskManager::get_clock | ( | ) | [inline] |
Returns the clock pointer used within the AsyncTaskManager.
See set_clock().
Definition at line 39 of file asyncTaskManager.I.
Referenced by AsyncTask::unlock_and_do_task().
AsyncTaskManager * AsyncTaskManager::get_global_ptr | ( | ) | [inline, static] |
Returns a pointer to the global AsyncTaskManager.
This is the AsyncTaskManager that most code should use for queueing tasks and suchlike.
Definition at line 63 of file asyncTaskManager.I.
Referenced by NonlinearImager::add_viewer(), and GraphicsEngine::remove_all_windows().
double AsyncTaskManager::get_next_wake_time | ( | ) | const |
Returns the scheduled time (on the manager's clock) of the next sleeping task, on any task chain, to awaken.
Returns -1 if there are no sleeping tasks.
Definition at line 562 of file asyncTaskManager.cxx.
References ordered_vector< Key, Compare >::begin(), AsyncTaskChain::do_get_next_wake_time(), and ordered_vector< Key, Compare >::end().
int AsyncTaskManager::get_num_task_chains | ( | ) | const |
Returns the number of different task chains.
Definition at line 116 of file asyncTaskManager.cxx.
References ordered_vector< Key, Compare >::size().
int AsyncTaskManager::get_num_tasks | ( | ) | const [inline] |
Returns the number of tasks that are currently active or sleeping within the task manager.
Definition at line 50 of file asyncTaskManager.I.
int ReferenceCount::get_ref_count | ( | ) | const [inline, inherited] |
Returns the current reference count.
Definition at line 155 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by TransformState::clear_cache(), RenderState::clear_cache(), RenderState::finalize(), RenderEffects::finalize(), RenderEffect::finalize(), RenderAttrib::finalize(), InternalName::finalize(), TransformState::get_num_unused_states(), RenderState::get_num_unused_states(), TransformState::list_cycles(), RenderState::list_cycles(), GeomVertexFormat::remove_column(), TransformState::unref(), RenderState::unref(), RenderState::~RenderState(), and TransformState::~TransformState().
AsyncTaskCollection AsyncTaskManager::get_sleeping_tasks | ( | ) | const |
Returns the set of tasks that are sleeping (and not active) on the task manager, at the time of the call.
Definition at line 513 of file asyncTaskManager.cxx.
References AsyncTaskCollection::add_tasks_from(), ordered_vector< Key, Compare >::begin(), AsyncTaskChain::do_get_sleeping_tasks(), and ordered_vector< Key, Compare >::end().
AsyncTaskChain * AsyncTaskManager::get_task_chain | ( | int | n | ) | const |
Returns the nth task chain.
Definition at line 127 of file asyncTaskManager.cxx.
References ordered_vector< Key, Compare >::size().
AsyncTaskCollection AsyncTaskManager::get_tasks | ( | ) | const |
Returns the set of tasks that are active or sleeping on the task manager, at the time of the call.
Definition at line 466 of file asyncTaskManager.cxx.
References AsyncTaskCollection::add_tasks_from(), ordered_vector< Key, Compare >::begin(), AsyncTaskChain::do_get_active_tasks(), AsyncTaskChain::do_get_sleeping_tasks(), and ordered_vector< Key, Compare >::end().
int TypedObject::get_type_index | ( | ) | const [inline, inherited] |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
This is equivalent to get_type().get_index().
Definition at line 52 of file typedObject.I.
References TypeHandle::get_index().
WeakReferenceList * ReferenceCount::get_weak_list | ( | ) | const [inline, inherited] |
Returns the WeakReferenceList associated with this ReferenceCount object.
If there has never been a WeakReferenceList associated with this object, creates one now.
Definition at line 307 of file referenceCount.I.
Referenced by ReferenceCount::weak_ref().
bool Namable::has_name | ( | ) | const [inline, inherited] |
Returns true if the Namable has a nonempty name set, false if the name is empty.
Definition at line 75 of file namable.I.
Referenced by XFileNode::add_child(), EggComponentData::add_name(), Texture::do_read_dds_file(), Texture::do_read_one(), Character::fillin(), EggGroupUniquifier::get_category(), EggXfmSAnim::optimize(), NodePathComponent::output(), AsyncTask::output(), EggNamedObject::output(), EggSAnimData::write(), EggPrimitive::write_body(), ParametricCurveCollection::write_egg(), ParametricCurve::write_egg(), EggNamedObject::write_header(), XFileDataNodeTemplate::write_text(), and XFileDataDef::write_text().
bool AsyncTaskManager::has_task | ( | AsyncTask * | task | ) | const |
Returns true if the indicated task has been added to this AsyncTaskManager, false otherwise.
Definition at line 252 of file asyncTaskManager.cxx.
References do_has_task().
bool ReferenceCount::has_weak_list | ( | ) | const [inline, inherited] |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).
Definition at line 294 of file referenceCount.I.
Referenced by ReferenceCount::weak_unref().
bool TypedObject::is_exact_type | ( | TypeHandle | handle | ) | const [inline, inherited] |
Returns true if the current object is the indicated type exactly.
Definition at line 74 of file typedObject.I.
References TypeHandle::get_name().
Referenced by GraphicsStateGuardian::async_reload_texture(), PortalNode::combine_with(), PandaNode::combine_with(), GeomNode::combine_with(), CollisionNode::combine_with(), Character::combine_with(), PGItem::cull_callback(), FactoryParams::get_param_of_type(), CollisionHandlerPusher::handle_entries(), SceneGraphReducer::r_flatten(), ConnectionWriter::send(), FltToEggLevelState::set_transform(), and VirtualFileSystem::unmount().
bool TypedObject::is_of_type | ( | TypeHandle | handle | ) | const [inline, inherited] |
Returns true if the current object is or derives from the indicated type.
Definition at line 63 of file typedObject.I.
References TypeHandle::is_derived_from().
Referenced by EggSliderData::add_back_pointer(), EggJointData::add_back_pointer(), CIntervalManager::add_c_interval(), XFileNode::add_child(), CollisionTraverser::add_collider(), CollisionHandlerPhysical::add_collider(), EggXfmSAnim::add_data(), CharacterJointBundle::add_node(), NonlinearImager::add_screen(), EggGroupNode::apply_first_attribute(), EggGroupNode::apply_last_attribute(), DeferredNodeProperty::apply_to_node(), RecorderController::begin_playback(), NodePath::clear_clip_plane(), EggGroupNode::clear_connected_shading(), NodePath::clear_light(), EggBase::convert_paths(), NodePath::decode_from_bam_stream(), VrpnClient::disconnect_device(), PhysicsManager::do_physics(), GraphicsStateGuardian::fetch_specified_part(), EggRenderState::fill_state(), AnimBundleNode::find_anim_bundle(), EggGroupNode::find_coordsys_entry(), XFile::find_data_object(), Character::find_joint(), EggGroupNode::find_materials(), Character::find_slider(), XFile::find_template(), EggGroupNode::find_textures(), EggMaterialCollection::find_used_materials(), EggTextureCollection::find_used_textures(), EggGroupNode::force_filenames(), EggJointData::force_initial_rest_frame(), WindowFramework::get_aspect_2d(), EggPoolUniquifier::get_category(), EggGroupUniquifier::get_category(), EggGroupNode::get_connected_shading(), PandaFramework::get_mouse(), FactoryParams::get_param_of_type(), EggGroupNode::has_absolute_pathnames(), NodePath::has_clip_plane(), NodePath::has_clip_plane_off(), NodePath::has_light(), PandaFramework::hide_collision_solids(), x11GraphicsWindow::open_window(), eglGraphicsWindow::open_window(), EggNode::parse_egg(), CharacterMaker::part_to_node(), EggGroupNode::post_apply_flat_attribute(), EggBinner::prepare_node(), PortalClipper::prepare_portal(), NodePath::project_texture(), EggMatrixTablePointer::quantize_channels(), ParametricCurveCollection::r_add_curves(), SceneGraphReducer::r_collect_vertex_data(), EggGroupNode::r_load_externals(), EggGroupNode::rebuild_vertex_pools(), EggGroupNode::recompute_polygon_normals(), EggGroupNode::remove_invalid_primitives(), EggGroupNode::remove_unused_vertices(), EggLoader::reparent_decals(), EggMaterialCollection::replace_materials(), EggTextureCollection::replace_textures(), EggGroupNode::resolve_filenames(), EggGroupNode::reverse_vertex_ordering(), NodePath::set_clip_plane(), NodePath::set_clip_plane_off(), NodePath::set_light(), ProjectionScreen::set_projector(), NonlinearImager::set_source_camera(), EggXfmSAnim::set_value(), NonlinearImager::set_viewer_camera(), PandaFramework::show_collision_solids(), BamCache::store(), XFileToEggConverter::strip_nodes(), EggGroupNode::strip_normals(), DataGraphTraverser::traverse(), DataGraphTraverser::traverse_below(), EggGroupNode::triangulate_polygons(), EggGroupNode::unify_attributes(), EggNameUniquifier::uniquify(), NodeCullCallbackData::upcall(), PhysicsCollisionHandler::validate_target(), EggXfmSAnim::write(), EggGroup::write(), EggToDXFLayer::write_3d_face(), and EggToDXFLayer::write_entities().
void ReferenceCount::local_object | ( | ) | [inline, inherited] |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.
Definition at line 276 of file referenceCount.I.
Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), find_task(), find_tasks(), and find_tasks_matching().
AsyncTaskChain * AsyncTaskManager::make_task_chain | ( | const string & | name | ) |
Creates a new AsyncTaskChain of the indicated name and stores it within the AsyncTaskManager.
If a task chain with this name already exists, returns it instead.
Definition at line 142 of file asyncTaskManager.cxx.
References do_make_task_chain().
void AsyncTaskManager::output | ( | ostream & | out | ) | const [virtual] |
Outputs the Namable.
This function simply writes the name to the output stream; most Namable derivatives will probably redefine this.
Reimplemented from Namable.
Definition at line 593 of file asyncTaskManager.cxx.
void AsyncTaskManager::poll | ( | ) |
Runs through all the tasks in the task list, once, if the task manager is running in single-threaded mode (no threads available).
This method does nothing in threaded mode, so it may safely be called in either case.
Definition at line 538 of file asyncTaskManager.cxx.
References AsyncTaskChain::do_poll(), ConditionVarFullDirect::notify_all(), and ordered_vector< Key, Compare >::size().
Referenced by PandaFramework::do_frame().
void ReferenceCount::ref | ( | ) | const [inline, inherited] |
Explicitly increments the reference count.
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
Definition at line 179 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().
int AsyncTaskManager::remove | ( | const AsyncTaskCollection & | tasks | ) |
Removes all of the tasks in the AsyncTaskCollection.
Returns the number of tasks removed.
Definition at line 361 of file asyncTaskManager.cxx.
References MutexDirect::acquire(), do_has_task(), AsyncTaskCollection::get_num_tasks(), AsyncTaskCollection::get_task(), and MutexDirect::release().
bool AsyncTaskManager::remove | ( | AsyncTask * | task | ) |
Removes the indicated task from the active queue.
Returns true if the task is successfully removed, or false if it wasn't there.
Definition at line 345 of file asyncTaskManager.cxx.
References AsyncTaskCollection::add_task().
Referenced by AsyncTask::remove().
void AsyncTaskManager::remove_task_by_name | ( | AsyncTask * | task | ) | [protected] |
Removes the task from the _tasks_by_name index, if it has a nonempty name.
Definition at line 666 of file asyncTaskManager.cxx.
Referenced by AsyncTaskChain::cleanup_task().
bool AsyncTaskManager::remove_task_chain | ( | const string & | name | ) |
Removes the AsyncTaskChain of the indicated name.
If the chain still has tasks, this will block until all tasks are finished.
Returns true if successful, or false if the chain did not exist.
Definition at line 170 of file asyncTaskManager.cxx.
References ordered_vector< Key, Compare >::end().
void AsyncTaskManager::set_clock | ( | ClockObject * | clock | ) | [inline] |
Replaces the clock pointer used within the AsyncTaskManager.
This is used to control when tasks with a set_delay() specified will be scheduled. It can also be ticked automatically each epoch, if set_tick_clock() is true.
The default is the global clock pointer.
Definition at line 28 of file asyncTaskManager.I.
void AsyncTaskManager::start_threads | ( | ) |
Starts any requested threads to service the tasks on the queue.
This is normally not necessary, since adding a task will start the threads automatically.
Definition at line 446 of file asyncTaskManager.cxx.
References AsyncTaskChain::do_start_threads(), and ordered_vector< Key, Compare >::size().
void AsyncTaskManager::stop_threads | ( | ) |
Stops any threads that are currently running.
If any tasks are still pending and have not yet been picked up by a thread, they will not be serviced unless poll() or start_threads() is later called.
Definition at line 426 of file asyncTaskManager.cxx.
References AsyncTaskChain::do_stop_threads(), and ordered_vector< Key, Compare >::size().
Referenced by GraphicsEngine::remove_all_windows().
bool ReferenceCount::test_ref_count_integrity | ( | ) | const [inline, inherited] |
Does some easy checks to make sure that the reference count isn't completely bogus.
Returns true if ok, false otherwise.
Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.
Definition at line 236 of file referenceCount.I.
References ReferenceCount::do_test_ref_count_integrity().
Referenced by EggGroupNode::add_child(), InternalName::find_ancestor(), InternalName::get_ancestor(), ReferenceCount::get_ref_count(), InternalName::get_top(), ReferenceCount::ref(), EggVertex::test_gref_integrity(), EggVertex::test_pref_integrity(), EggNode::test_under_integrity(), EggPrimitive::test_vref_integrity(), EggGroup::test_vref_integrity(), MouseWatcher::throw_event_pattern(), ReferenceCount::unref(), and EggNode::update_under().
bool ReferenceCount::test_ref_count_nonzero | ( | ) | const [inline, inherited] |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
Returns true if ok, false otherwise.
Definition at line 252 of file referenceCount.I.
References ReferenceCount::do_test_ref_count_nonzero().
Referenced by CopyOnWritePointer::test_ref_count_nonzero().
bool ReferenceCount::unref | ( | ) | const [inline, virtual, inherited] |
Explicitly decrements the reference count.
Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete().
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is true if the new reference count is nonzero, false if it is zero.
Reimplemented in GeomVertexArrayFormat, GeomVertexFormat, InternalName, RenderAttrib, RenderEffects, RenderState, and TransformState.
Definition at line 214 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by CachedTypedWritableReferenceCount::cache_unref(), TypedWritable::decode_raw_from_bam_stream(), RenderEffect::finalize(), NodeCachedReferenceCount::node_unref(), NodeReferenceCount::node_unref(), TransformState::unref(), RenderState::unref(), RenderEffects::unref(), RenderAttrib::unref(), InternalName::unref(), GeomVertexFormat::unref(), and GeomVertexArrayFormat::unref().
void AsyncTaskManager::wait_for_tasks | ( | ) |
Blocks until the task list is empty.
Definition at line 402 of file asyncTaskManager.cxx.
References AsyncTaskChain::do_wait_for_tasks(), and ordered_vector< Key, Compare >::size().
void ReferenceCount::weak_ref | ( | WeakPointerToVoid * | ptv | ) | [inline, inherited] |
Adds the indicated PointerToVoid as a weak reference to this object.
Definition at line 321 of file referenceCount.I.
References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().
void ReferenceCount::weak_unref | ( | WeakPointerToVoid * | ptv | ) | [inline, inherited] |
Removes the indicated PointerToVoid as a weak reference to this object.
It must have previously been added via a call to weak_ref().
Definition at line 334 of file referenceCount.I.
References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().