This class represents a connection to a PStatsClient and manages the data exchange with the client. More...
#include "gtkStatsMonitor.h"
Classes | |
class | MenuDef |
Public Member Functions | |
GtkStatsMonitor (GtkStatsServer *server) | |
const MenuDef * | add_menu (const MenuDef &menu_def) |
Adds a new MenuDef to the monitor, or returns an existing one if there is already one just like it. More... | |
virtual std::string | get_monitor_name () |
Should be redefined to return a descriptive name for the type of PStatsMonitor this is. More... | |
GtkWidget * | get_window () const |
Returns the window handle to the monitor's window. More... | |
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. More... | |
virtual void | got_hello () |
Called when the "hello" message has been received from the client. More... | |
virtual bool | has_idle () |
Should be redefined to return true if you want to redefine idle() and expect it to be called. More... | |
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. More... | |
virtual void | initialized () |
Called after the monitor has been fully set up. More... | |
virtual void | lost_connection () |
Called whenever the connection to the client has been lost. More... | |
virtual void | new_collector (int collector_index) |
Called whenever a new Collector definition is received from the client. More... | |
virtual void | new_data (int thread_index, int frame_number) |
Called as each frame's data is made available. More... | |
virtual void | new_thread (int thread_index) |
Called whenever a new Thread definition is received from the client. More... | |
void | open_piano_roll (int thread_index) |
Opens a new piano roll showing the indicated data. More... | |
void | open_strip_chart (int thread_index, int collector_index, bool show_level) |
Opens a new strip chart showing the indicated data. More... | |
void | set_pause (bool pause) |
Called when the user selects a pause on or pause off option from the menu. More... | |
void | set_scroll_speed (double scroll_speed) |
Called when the user selects a new scroll speed from the monitor pulldown menu, this should adjust the speeds for all graphs to the indicated value. More... | |
void | set_time_units (int unit_mask) |
Called when the user selects a new time units from the monitor pulldown menu, this should adjust the units for all graphs to the indicated mask if it is a time-based graph. More... | |
virtual void | user_guide_bars_changed () |
Called when the user guide bars have been changed. More... | |
Public Member Functions inherited from PStatMonitor | |
PStatMonitor (PStatServer *server) | |
void | bad_version (const std::string &hostname, const std::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. More... | |
void | close () |
Closes the client connection if it is active. More... | |
const PStatClientData * | get_client_data () const |
Returns the client data associated with this monitor. More... | |
std::string | get_client_hostname () const |
Returns the hostname of the client we're connected to, if known. More... | |
std::string | get_client_progname () const |
Returns the program name of the client we're connected to, if known. More... | |
const LRGBColor & | get_collector_color (int collector_index) |
Returns the color associated with the indicated collector. More... | |
std::string | get_collector_name (int collector_index) |
Returns the name of the indicated collector, if it is known. More... | |
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. More... | |
PStatServer * | get_server () |
Returns the server that owns this monitor. More... | |
PStatView & | get_view (int thread_index) |
Returns a view on the given thread index. More... | |
void | hello_from (const std::string &hostname, const std::string &progname) |
Called shortly after startup time with the greeting from the client. More... | |
bool | is_alive () const |
Returns true if the client is alive and connected, false otherwise. More... | |
bool | is_client_known () const |
Returns true if we've yet received the "hello" message from the client indicating its name, etc. More... | |
virtual bool | is_thread_safe () |
Should be redefined to return true if this monitor class can handle running in a sub-thread. More... | |
void | set_client_data (PStatClientData *client_data) |
Called by the PStatServer at setup time to set the new data pointer for the first time. More... | |
Public Member Functions inherited from ReferenceCount | |
int | get_ref_count () const |
WeakReferenceList * | get_weak_list () const |
Returns the WeakReferenceList associated with this ReferenceCount object. More... | |
bool | has_weak_list () const |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More... | |
void | local_object () |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More... | |
void | ref () const |
Explicitly increments the reference count. More... | |
bool | ref_if_nonzero () const |
Atomically increases the reference count of this object if it is not zero. More... | |
bool | test_ref_count_integrity () const |
Does some easy checks to make sure that the reference count isn't completely bogus. More... | |
bool | test_ref_count_nonzero () const |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More... | |
virtual bool | unref () const |
Explicitly decrements the reference count. More... | |
WeakReferenceList * | weak_ref () |
Adds the indicated PointerToVoid as a weak reference to this object. More... | |
void | weak_unref () |
Removes the indicated PointerToVoid as a weak reference to this object. More... | |
Friends | |
class | GtkStatsGraph |
Additional Inherited Members | |
Static Public Member Functions inherited from ReferenceCount | |
static TypeHandle | get_class_type () |
static void | init_type () |
Public Attributes inherited from ReferenceCount | |
get_ref_count | |
Returns the current reference count. More... | |
This class represents a connection to a PStatsClient and manages the data exchange with the client.
Definition at line 35 of file gtkStatsMonitor.h.
const GtkStatsMonitor::MenuDef * GtkStatsMonitor::add_menu | ( | const MenuDef & | menu_def | ) |
Adds a new MenuDef to the monitor, or returns an existing one if there is already one just like it.
Definition at line 281 of file gtkStatsMonitor.cxx.
Referenced by GtkStatsChartMenu::do_update().
|
virtual |
Should be redefined to return a descriptive name for the type of PStatsMonitor this is.
Implements PStatMonitor.
Definition at line 71 of file gtkStatsMonitor.cxx.
GtkWidget * GtkStatsMonitor::get_window | ( | ) | const |
Returns the window handle to the monitor's window.
Definition at line 245 of file gtkStatsMonitor.cxx.
|
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 from PStatMonitor.
Definition at line 104 of file gtkStatsMonitor.cxx.
References PStatMonitor::get_client_hostname(), and PStatMonitor::get_client_progname().
|
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 from PStatMonitor.
Definition at line 91 of file gtkStatsMonitor.cxx.
References open_strip_chart().
|
virtual |
Should be redefined to return true if you want to redefine idle() and expect it to be called.
Reimplemented from PStatMonitor.
Definition at line 225 of file gtkStatsMonitor.cxx.
|
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 from PStatMonitor.
Definition at line 202 of file gtkStatsMonitor.cxx.
References PStatMonitor::get_client_data(), PStatThreadData::get_frame_rate(), and PStatClientData::get_thread_data().
|
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 from PStatMonitor.
Definition at line 83 of file gtkStatsMonitor.cxx.
|
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 from PStatMonitor.
Definition at line 191 of file gtkStatsMonitor.cxx.
|
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 from PStatMonitor.
Definition at line 139 of file gtkStatsMonitor.cxx.
References GtkStatsGraph::new_collector().
|
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.
Reimplemented from PStatMonitor.
Definition at line 176 of file gtkStatsMonitor.cxx.
References GtkStatsGraph::new_data().
|
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 from PStatMonitor.
Definition at line 161 of file gtkStatsMonitor.cxx.
References GtkStatsChartMenu::add_to_menu_bar().
void GtkStatsMonitor::open_piano_roll | ( | int | thread_index | ) |
Opens a new piano roll showing the indicated data.
Definition at line 267 of file gtkStatsMonitor.cxx.
References GtkStatsGraph::set_pause(), GtkStatsGraph::set_scroll_speed(), and GtkStatsPianoRoll::set_time_units().
void GtkStatsMonitor::open_strip_chart | ( | int | thread_index, |
int | collector_index, | ||
bool | show_level | ||
) |
Opens a new strip chart showing the indicated data.
Definition at line 253 of file gtkStatsMonitor.cxx.
References GtkStatsGraph::set_pause(), GtkStatsStripChart::set_scroll_speed(), and GtkStatsStripChart::set_time_units().
Referenced by GtkStatsPianoRoll::clicked_label(), and got_hello().
void GtkStatsMonitor::set_pause | ( | bool | pause | ) |
Called when the user selects a pause on or pause off option from the menu.
Definition at line 329 of file gtkStatsMonitor.cxx.
References GtkStatsGraph::set_pause().
void GtkStatsMonitor::set_scroll_speed | ( | double | scroll_speed | ) |
Called when the user selects a new scroll speed from the monitor pulldown menu, this should adjust the speeds for all graphs to the indicated value.
Definition at line 314 of file gtkStatsMonitor.cxx.
References GtkStatsGraph::set_scroll_speed().
void GtkStatsMonitor::set_time_units | ( | int | unit_mask | ) |
Called when the user selects a new time units from the monitor pulldown menu, this should adjust the units for all graphs to the indicated mask if it is a time-based graph.
Definition at line 298 of file gtkStatsMonitor.cxx.
References GtkStatsGraph::set_time_units().
|
virtual |
Called when the user guide bars have been changed.
Reimplemented from PStatMonitor.
Definition at line 233 of file gtkStatsMonitor.cxx.
References GtkStatsGraph::user_guide_bars_changed().