Panda3D
|
This is an abstract class that presents the interface to any number of different front-ends for the stats monitor. More...
#include "pStatMonitor.h"
Public Member Functions | |
PStatMonitor (PStatServer *server) | |
void | bad_version (const string &hostname, const string &progname, int client_major, int client_minor, int server_major, int server_minor) |
Called shortly after startup time with the greeting from the client. | |
void | close () |
Closes the client connection if it is active. | |
const PStatClientData * | get_client_data () const |
Returns the client data associated with this monitor. | |
string | get_client_hostname () const |
Returns the hostname of the client we're connected to, if known. | |
string | get_client_progname () const |
Returns the program name of the client we're connected to, if known. | |
const RGBColorf & | get_collector_color (int collector_index) |
Returns the color associated with the indicated collector. | |
string | get_collector_name (int collector_index) |
Returns the name of the indicated collector, if it is known. | |
PStatView & | get_level_view (int collector_index, int thread_index) |
Returns a view on the level value (as opposed to elapsed time) for the given collector over the given thread. | |
virtual string | get_monitor_name ()=0 |
int | get_ref_count () const |
Returns the current reference count. | |
PStatServer * | get_server () |
Returns the server that owns this monitor. | |
PStatView & | get_view (int thread_index) |
Returns a view on the given thread index. | |
WeakReferenceList * | get_weak_list () const |
Returns the WeakReferenceList associated with this ReferenceCount object. | |
virtual void | got_bad_version (int client_major, int client_minor, int server_major, int server_minor) |
Like got_hello(), this is called when the "hello" message has been received from the client. | |
virtual void | got_hello () |
Called when the "hello" message has been received from the client. | |
virtual bool | has_idle () |
Should be redefined to return true if you want to redefine idle() and expect it to be called. | |
bool | has_weak_list () const |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. | |
void | hello_from (const string &hostname, const string &progname) |
Called shortly after startup time with the greeting from the client. | |
virtual void | idle () |
If has_idle() returns true, this will be called periodically to allow the monitor to update its display or whatever it needs to do. | |
virtual void | initialized () |
Called after the monitor has been fully set up. | |
bool | is_alive () const |
Returns true if the client is alive and connected, false otherwise. | |
bool | is_client_known () const |
Returns true if we've yet received the "hello" message from the client indicating its name, etc. | |
virtual bool | is_thread_safe () |
Should be redefined to return true if this monitor class can handle running in a sub-thread. | |
void | local_object () |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. | |
virtual void | lost_connection () |
Called whenever the connection to the client has been lost. | |
virtual void | new_collector (int collector_index) |
Called whenever a new Collector definition is received from the client. | |
virtual void | new_data (int thread_index, int frame_number) |
Called as each frame's data is made available. | |
virtual void | new_thread (int thread_index) |
Called whenever a new Thread definition is received from the client. | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *, void *) |
void * | operator new (size_t size) |
void * | operator new (size_t size, void *ptr) |
void * | operator new[] (size_t size, void *ptr) |
void * | operator new[] (size_t size) |
void | ref () const |
Explicitly increments the reference count. | |
void | set_client_data (PStatClientData *client_data) |
Called by the PStatServer at setup time to set the new data pointer for the first time. | |
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. | |
virtual void | user_guide_bars_changed () |
Called when the user guide bars have been changed. | |
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. | |
Static Public Member Functions | |
static TypeHandle | get_class_type () |
static void | init_type () |
Protected Member Functions | |
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. | |
Protected Attributes | |
PStatServer * | _server |
This is an abstract class that presents the interface to any number of different front-ends for the stats monitor.
One of these will be created by the PStatMonitor as each client is connected; this class is responsible for opening up a new strip-chart graph or whatever is appropriate. It defines a number of empty virtual functions that will be called as new data becomes available.
Definition at line 43 of file pStatMonitor.h.
void PStatMonitor::bad_version | ( | const string & | hostname, |
const string & | progname, | ||
int | client_major, | ||
int | client_minor, | ||
int | server_major, | ||
int | server_minor | ||
) |
Called shortly after startup time with the greeting from the client.
In this case, the client seems to have an incompatible version and will be automatically disconnected; the server should issue a message to that effect.
Definition at line 64 of file pStatMonitor.cxx.
References got_bad_version().
void PStatMonitor::close | ( | ) |
Closes the client connection if it is active.
Definition at line 107 of file pStatMonitor.cxx.
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().
const PStatClientData * PStatMonitor::get_client_data | ( | ) | const [inline] |
Returns the client data associated with this monitor.
Definition at line 32 of file pStatMonitor.I.
Referenced by WinStatsChartMenu::add_to_menu_bar(), GtkStatsChartMenu::add_to_menu_bar(), WinStatsStripChart::clicked_label(), GtkStatsStripChart::clicked_label(), WinStatsChartMenu::do_update(), GtkStatsChartMenu::do_update(), WinStatsMonitor::idle(), GtkStatsMonitor::idle(), TextMonitor::new_data(), and PStatStripChart::update().
string PStatMonitor::get_client_hostname | ( | ) | const [inline] |
Returns the hostname of the client we're connected to, if known.
This may not be known immediately at creation time, but should be learned shortly thereafter when we receive the client's "hello" message. See is_client_known().
Definition at line 72 of file pStatMonitor.I.
Referenced by WinStatsMonitor::got_bad_version(), TextMonitor::got_bad_version(), GtkStatsMonitor::got_bad_version(), TextMonitor::got_hello(), WinStatsMonitor::lost_connection(), and GtkStatsMonitor::lost_connection().
string PStatMonitor::get_client_progname | ( | ) | const [inline] |
Returns the program name of the client we're connected to, if known.
This may not be known immediately at creation time, but should be learned shortly thereafter when we receive the client's "hello" message. See is_client_known().
Definition at line 86 of file pStatMonitor.I.
Referenced by WinStatsMonitor::got_bad_version(), TextMonitor::got_bad_version(), GtkStatsMonitor::got_bad_version(), and TextMonitor::got_hello().
const RGBColorf & PStatMonitor::get_collector_color | ( | int | collector_index | ) |
Returns the color associated with the indicated collector.
If the collector has no associated color, or is unknown, a new color will be made up on the spot and associated with this collector for the rest of the session.
Definition at line 123 of file pStatMonitor.cxx.
References LVecBase3f::zero().
Referenced by WinStatsGraph::get_collector_brush(), and GtkStatsGraph::get_collector_gc().
string PStatMonitor::get_collector_name | ( | int | collector_index | ) | [inline] |
Returns the name of the indicated collector, if it is known.
Definition at line 43 of file pStatMonitor.I.
PStatView & PStatMonitor::get_level_view | ( | int | collector_index, |
int | thread_index | ||
) |
Returns a view on the level value (as opposed to elapsed time) for the given collector over the given thread.
If there is no such view already for the indicated thread, this will create one.
Definition at line 193 of file pStatMonitor.cxx.
Referenced by WinStatsChartMenu::do_update(), GtkStatsChartMenu::do_update(), and TextMonitor::new_data().
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().
PStatServer * PStatMonitor::get_server | ( | ) | [inline] |
Returns the server that owns this monitor.
Reimplemented in TextMonitor.
Definition at line 22 of file pStatMonitor.I.
PStatView & PStatMonitor::get_view | ( | int | thread_index | ) |
Returns a view on the given thread index.
If there is no such view already for the indicated thread, this will create one. This view can be used to examine the accumulated data for the given thread.
Definition at line 174 of file pStatMonitor.cxx.
Referenced by WinStatsChartMenu::check_update(), GtkStatsChartMenu::check_update(), WinStatsChartMenu::do_update(), GtkStatsChartMenu::do_update(), and TextMonitor::new_data().
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().
void PStatMonitor::got_bad_version | ( | int | client_major, |
int | client_minor, | ||
int | server_major, | ||
int | server_minor | ||
) | [virtual] |
Like got_hello(), this is called when the "hello" message has been received from the client.
At this time, the client's hostname and program name will be known. However, the client appears to be an incompatible version and the connection will be terminated; the monitor should issue a message to that effect.
Reimplemented in GtkStatsMonitor, TextMonitor, and WinStatsMonitor.
Definition at line 249 of file pStatMonitor.cxx.
Referenced by bad_version().
void PStatMonitor::got_hello | ( | ) | [virtual] |
Called when the "hello" message has been received from the client.
At this time, the client's hostname and program name will be known.
Reimplemented in GtkStatsMonitor, TextMonitor, and WinStatsMonitor.
Definition at line 234 of file pStatMonitor.cxx.
Referenced by hello_from().
bool PStatMonitor::has_idle | ( | ) | [virtual] |
Should be redefined to return true if you want to redefine idle() and expect it to be called.
Reimplemented in GtkStatsMonitor, and WinStatsMonitor.
Definition at line 327 of file pStatMonitor.cxx.
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().
void PStatMonitor::hello_from | ( | const string & | hostname, |
const string & | progname | ||
) |
Called shortly after startup time with the greeting from the client.
This indicates the client's reported hostname and program name.
Definition at line 47 of file pStatMonitor.cxx.
References got_hello().
void PStatMonitor::idle | ( | ) | [virtual] |
If has_idle() returns true, this will be called periodically to allow the monitor to update its display or whatever it needs to do.
Reimplemented in GtkStatsMonitor, and WinStatsMonitor.
Definition at line 317 of file pStatMonitor.cxx.
void PStatMonitor::initialized | ( | ) | [virtual] |
Called after the monitor has been fully set up.
At this time, it will have a valid _client_data pointer, and things like is_alive() and close() will be meaningful. However, we may not yet know who we're connected to (is_client_known() may return false), and we may not know anything about the threads or collectors we're about to get data on.
Reimplemented in GtkStatsMonitor, and WinStatsMonitor.
Definition at line 223 of file pStatMonitor.cxx.
Referenced by set_client_data().
bool PStatMonitor::is_alive | ( | ) | const |
Returns true if the client is alive and connected, false otherwise.
Definition at line 93 of file pStatMonitor.cxx.
bool PStatMonitor::is_client_known | ( | ) | const [inline] |
Returns true if we've yet received the "hello" message from the client indicating its name, etc.
Definition at line 58 of file pStatMonitor.I.
bool PStatMonitor::is_thread_safe | ( | ) | [virtual] |
Should be redefined to return true if this monitor class can handle running in a sub-thread.
This is not related to the question of whether it can handle multiple different PStatThreadDatas; this is strictly a question of whether or not the monitor itself wants to run in a sub-thread.
Reimplemented in TextMonitor.
Definition at line 343 of file pStatMonitor.cxx.
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(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().
void PStatMonitor::lost_connection | ( | ) | [virtual] |
Called whenever the connection to the client has been lost.
This is a permanent state change. The monitor should update its display to represent this, and may choose to close down automatically.
Reimplemented in GtkStatsMonitor, TextMonitor, and WinStatsMonitor.
Definition at line 306 of file pStatMonitor.cxx.
void PStatMonitor::new_collector | ( | int | collector_index | ) | [virtual] |
Called whenever a new Collector definition is received from the client.
Generally, the client will send all of its collectors over shortly after connecting, but there's no guarantee that they will all be received before the first frames are received. The monitor should be prepared to accept new Collector definitions midstream.
Reimplemented in GtkStatsMonitor, and WinStatsMonitor.
Definition at line 264 of file pStatMonitor.cxx.
void PStatMonitor::new_data | ( | int | thread_index, |
int | frame_number | ||
) | [virtual] |
Called as each frame's data is made available.
There is no guarantee the frames will arrive in order, or that all of them will arrive at all. The monitor should be prepared to accept frames received out-of-order or missing. The use of the PStatFrameData / PStatView objects to report the data will facilitate this.
Reimplemented in GtkStatsMonitor, TextMonitor, and WinStatsMonitor.
Definition at line 294 of file pStatMonitor.cxx.
void PStatMonitor::new_thread | ( | int | thread_index | ) | [virtual] |
Called whenever a new Thread definition is received from the client.
Generally, the client will send all of its threads over shortly after connecting, but there's no guarantee that they will all be received before the first frames are received. The monitor should be prepared to accept new Thread definitions midstream.
Reimplemented in GtkStatsMonitor, and WinStatsMonitor.
Definition at line 279 of file pStatMonitor.cxx.
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().
void PStatMonitor::set_client_data | ( | PStatClientData * | client_data | ) |
Called by the PStatServer at setup time to set the new data pointer for the first time.
Definition at line 81 of file pStatMonitor.cxx.
References initialized().
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 PStatMonitor::user_guide_bars_changed | ( | ) | [virtual] |
Called when the user guide bars have been changed.
Reimplemented in GtkStatsMonitor, and WinStatsMonitor.
Definition at line 353 of file pStatMonitor.cxx.
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().