Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

PStatMonitor Class Reference

This is an abstract class that presents the interface to any number of different front-ends for the stats monitor. More...

#include <pStatMonitor.h>

Inheritance diagram for PStatMonitor:

List of all members.


Public Member Functions
	PStatMonitor ()
virtual	~PStatMonitor ()
void	hello_from (const string &hostname, const string &progname)
	Called shortly after startup time with the greeting from the client.
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	set_client_data (PStatClientData *client_data)
	Called by the PStatServer at setup time to set the new data pointer for the first time.
bool	is_alive () const
	Returns true if the client is alive and connected, false otherwise.
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_collector_name (int collector_index)
	Returns the name of the indicated collector, if it is known.
const RGBColorf &	get_collector_color (int collector_index)
	Returns the color associated with the indicated collector.
bool	is_client_known () const
	Returns true if we've yet received the "hello" message from the client indicating its name, etc.
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.
PStatView &	get_view (int thread_index)
	Returns a view on the given thread index.
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
virtual void	initialized ()
	Called after the monitor has been fully set up.
virtual void	got_hello ()
	Called when the "hello" message has been received from the client.
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	new_collector (int collector_index)
	Called whenever a new Collector definition is received from the client.
virtual void	new_thread (int thread_index)
	Called whenever a new Thread 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	lost_connection ()
	Called whenever the connection to the client has been lost.
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 bool	has_idle ()
	Should be redefined to return true if you want to redefine idle() and expect it to be called.
virtual bool	is_thread_safe ()
	Should be redefined to return true if this monitor class can handle running in a sub-thread.
int	get_ref_count () const
int	ref () const
int	unref () const
void	test_ref_count_integrity () const
Static Public Member Functions
TypeHandle	get_class_type ()
void	init_type ()
Protected Attributes
int	_ref_count
Static Protected Attributes
TypeHandle	_type_handle
Private Types
typedef pmap< int, PStatView >	Views
typedef pmap< int, Views >	LevelViews
typedef pmap< int, RGBColorf >	Colors
Private Attributes
PointerTo< PStatClientData >	_client_data
bool	_client_known
string	_client_hostname
string	_client_progname
Views	_views
LevelViews	_level_views
Colors	_colors

Detailed Description

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 59 of file pStatMonitor.h.

Member Typedef Documentation

typedef pmap<int, RGBColorf> PStatMonitor::Colors [private]

Definition at line 122 of file pStatMonitor.h.

typedef pmap<int, Views> PStatMonitor::LevelViews [private]

Definition at line 119 of file pStatMonitor.h.

typedef pmap<int, PStatView> PStatMonitor::Views [private]

Definition at line 117 of file pStatMonitor.h.

Constructor & Destructor Documentation

PStatMonitor::PStatMonitor ( )

Definition at line 35 of file pStatMonitor.cxx.

PStatMonitor::~PStatMonitor ( ) [virtual]

Definition at line 47 of file pStatMonitor.cxx.
References _client_hostname, _client_known, _client_progname, and got_hello().

Member Function Documentation

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 87 of file pStatMonitor.cxx.

void PStatMonitor::close ( )

Closes the client connection if it is active.

Definition at line 141 of file pStatMonitor.cxx.
References _colors.
Referenced by GtkStatsMonitor::lost_connection().

const PStatClientData * PStatMonitor::get_client_data ( ) const [inline]

Returns the client data associated with this monitor.

Definition at line 32 of file pStatMonitor.I.
References _client_data, INLINE, and PointerTo< PStatClientData >::is_null().
Referenced by PStatStripChart::new_data().

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 87 of file pStatMonitor.I.
Referenced by TextMonitor::get_monitor_name(), and TextMonitor::got_hello().

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 108 of file pStatMonitor.I.
Referenced by TextMonitor::get_monitor_name(), 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 164 of file pStatMonitor.cxx.
References _client_data, and _views.
Referenced by GtkStatsStripChart::get_labels().

string PStatMonitor::get_collector_name ( int collector_index ) [inline]

Returns the name of the indicated collector, if it is known.

Definition at line 47 of file pStatMonitor.I.
References _client_known, and INLINE.

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 233 of file pStatMonitor.cxx.

virtual string PStatMonitor::get_monitor_name ( ) [pure virtual]

Implemented in GtkStatsMonitor, and TextMonitor.

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 208 of file pStatMonitor.cxx.

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, and TextMonitor.
Definition at line 312 of file pStatMonitor.cxx.
Referenced by hello_from().

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, and TextMonitor.
Definition at line 288 of file pStatMonitor.cxx.
Referenced by ~PStatMonitor().

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.
Definition at line 432 of file pStatMonitor.cxx.

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 63 of file pStatMonitor.cxx.
References _client_hostname, _client_known, _client_progname, and got_bad_version().

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.
Definition at line 418 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.
Definition at line 272 of file pStatMonitor.cxx.

bool PStatMonitor::is_alive ( ) const

Returns true if the client is alive and connected, false otherwise.

Definition at line 124 of file pStatMonitor.cxx.
References _client_data, _colors, PStatCollectorDef::_suggested_color, PointerTo< PStatClientData >::is_null(), RGBColorf, and zero.

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 66 of file pStatMonitor.I.
References _client_hostname.

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 GtkStatsMonitor, and TextMonitor.
Definition at line 457 of file pStatMonitor.cxx.

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, and TextMonitor.
Definition at line 402 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.
Definition at line 336 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 gurantee 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, and TextMonitor.
Definition at line 384 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.
Definition at line 360 of file pStatMonitor.cxx.

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 108 of file pStatMonitor.cxx.
References _client_data, and PointerTo< PStatClientData >::is_null().

Member Data Documentation

PointerTo< PStatClientData > PStatMonitor::_client_data [private]

Definition at line 111 of file pStatMonitor.h.
Referenced by get_client_data(), get_collector_color(), is_alive(), and set_client_data().

string PStatMonitor::_client_hostname [private]

Definition at line 114 of file pStatMonitor.h.
Referenced by hello_from(), is_client_known(), and ~PStatMonitor().

bool PStatMonitor::_client_known [private]

Definition at line 113 of file pStatMonitor.h.
Referenced by get_collector_name(), hello_from(), and ~PStatMonitor().

string PStatMonitor::_client_progname [private]

Definition at line 115 of file pStatMonitor.h.
Referenced by hello_from(), and ~PStatMonitor().

Colors PStatMonitor::_colors [private]

Definition at line 123 of file pStatMonitor.h.
Referenced by close(), and is_alive().

LevelViews PStatMonitor::_level_views [private]

Definition at line 120 of file pStatMonitor.h.

Views PStatMonitor::_views [private]

Definition at line 118 of file pStatMonitor.h.
Referenced by get_collector_color().

The documentation for this class was generated from the following files:

pandatool/src/pstatserver/pStatMonitor.h
pandatool/src/pstatserver/pStatMonitor.cxx
pandatool/src/pstatserver/pStatMonitor.I

Generated on Fri May 2 03:27:51 2003 for Panda-Tool by

1.3

PStatMonitor Class Reference

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation