PStatClient

from panda3d.core import PStatClient
class PStatClient

Bases: DTOOL_SUPER_BASE

Inheritance diagram

Inheritance diagram of PStatClient

__init__(*args, **kwargs)
clientConnect()

C++ Interface: client_connect(const PStatClient self, str hostname, int port)

/**

  • The nonstatic implementation of connect().

*/

clientDisconnect()

C++ Interface: client_disconnect(const PStatClient self)

/**

  • The nonstatic implementation of disconnect().

*/

clientIsConnected()

C++ Interface: client_is_connected(PStatClient self)

/**

  • The nonstatic implementation of is_connected().

*/

clientMainTick()

C++ Interface: client_main_tick(const PStatClient self)

/**

  • A convenience function to call new_frame() on the given PStatClient’s main

  • thread, and any other threads with a sync_name of “Main”.

*/

clientResumeAfterPause()

C++ Interface: client_resume_after_pause(const PStatClient self)

/**

  • Resumes the PStatClient after the simulation has been paused for a while.

  • This allows the stats to continue exactly where it left off, instead of

  • leaving a big gap that would represent a chug.

*/

clientThreadTick()

C++ Interface: client_thread_tick(const PStatClient self) client_thread_tick(const PStatClient self, str sync_name)

/**

  • A convenience function to call new_frame() on the current thread.

*/

/**

  • A convenience function to call new_frame() on all of the threads with the

  • indicated sync name.

*/

client_connect()

C++ Interface: client_connect(const PStatClient self, str hostname, int port)

/**

  • The nonstatic implementation of connect().

*/

client_disconnect()

C++ Interface: client_disconnect(const PStatClient self)

/**

  • The nonstatic implementation of disconnect().

*/

client_is_connected()

C++ Interface: client_is_connected(PStatClient self)

/**

  • The nonstatic implementation of is_connected().

*/

client_main_tick()

C++ Interface: client_main_tick(const PStatClient self)

/**

  • A convenience function to call new_frame() on the given PStatClient’s main

  • thread, and any other threads with a sync_name of “Main”.

*/

client_name
client_resume_after_pause()

C++ Interface: client_resume_after_pause(const PStatClient self)

/**

  • Resumes the PStatClient after the simulation has been paused for a while.

  • This allows the stats to continue exactly where it left off, instead of

  • leaving a big gap that would represent a chug.

*/

client_thread_tick()

C++ Interface: client_thread_tick(const PStatClient self) client_thread_tick(const PStatClient self, str sync_name)

/**

  • A convenience function to call new_frame() on the current thread.

*/

/**

  • A convenience function to call new_frame() on all of the threads with the

  • indicated sync name.

*/

collectors
connect()

C++ Interface: connect(str hostname, int port)

/**

  • Attempts to establish a connection to the indicated PStatServer. Returns

  • true if successful, false on failure.

*/

current_thread
disconnect()

C++ Interface: disconnect()

/**

  • Closes the connection previously established.

*/

getClientName()

C++ Interface: get_client_name(PStatClient self)

/**

  • Retrieves the name of the client as set.

*/

getCollector()

C++ Interface: get_collector(PStatClient self, int index)

/**

  • Returns the nth collector.

*/

getCollectorFullname()

C++ Interface: get_collector_fullname(PStatClient self, int index)

/**

  • Returns the “full name” of the indicated collector. This will be the

  • concatenation of all of the collector’s parents’ names (except Frame) and

  • the collector’s own name.

*/

getCollectorName()

C++ Interface: get_collector_name(PStatClient self, int index)

/**

  • Returns the name of the indicated collector.

*/

getCollectors()
getCurrentThread()

C++ Interface: get_current_thread(PStatClient self)

/**

  • Returns a handle to the currently-executing thread. This is the thread

  • that PStatCollectors will be counted in if they do not specify otherwise.

*/

getGlobalPstats()

C++ Interface: get_global_pstats()

/**

  • Returns a pointer to the global PStatClient object. It’s legal to declare

  • your own PStatClient locally, but it’s also convenient to have a global one

  • that everyone can register with. This is the global one.

*/

getMainThread()

C++ Interface: get_main_thread(PStatClient self)

/**

  • Returns a handle to the client’s Main thread. This is the thread that

  • started the application.

*/

getMaxRate()

C++ Interface: get_max_rate(PStatClient self)

/**

  • Returns the maximum number of packets that will be sent to the server per

  • second, per thread. See set_max_rate().

*/

getNumCollectors()

C++ Interface: get_num_collectors(PStatClient self)

/**

  • Returns the total number of collectors the Client knows about.

*/

getNumThreads()

C++ Interface: get_num_threads(PStatClient self)

/**

  • Returns the total number of threads the Client knows about.

*/

getRealTime()

C++ Interface: get_real_time(PStatClient self)

/**

  • Returns the time according to to the PStatClient’s clock object. It keeps

  • its own clock, instead of using the global clock object, so the stats won’t

  • get mucked up if you put the global clock in non-real-time mode or

  • something.

*/

getThread()

C++ Interface: get_thread(PStatClient self, int index)

/**

  • Returns the nth thread.

*/

getThreadName()

C++ Interface: get_thread_name(PStatClient self, int index)

/**

  • Returns the name of the indicated thread.

*/

getThreadObject()

C++ Interface: get_thread_object(PStatClient self, int index)

/**

  • Returns the Panda Thread object associated with the indicated PStatThread.

*/

getThreadSyncName()

C++ Interface: get_thread_sync_name(PStatClient self, int index)

/**

  • Returns the sync_name of the indicated thread.

*/

getThreads()
get_client_name()

C++ Interface: get_client_name(PStatClient self)

/**

  • Retrieves the name of the client as set.

*/

get_collector()

C++ Interface: get_collector(PStatClient self, int index)

/**

  • Returns the nth collector.

*/

get_collector_fullname()

C++ Interface: get_collector_fullname(PStatClient self, int index)

/**

  • Returns the “full name” of the indicated collector. This will be the

  • concatenation of all of the collector’s parents’ names (except Frame) and

  • the collector’s own name.

*/

get_collector_name()

C++ Interface: get_collector_name(PStatClient self, int index)

/**

  • Returns the name of the indicated collector.

*/

get_collectors()
get_current_thread()

C++ Interface: get_current_thread(PStatClient self)

/**

  • Returns a handle to the currently-executing thread. This is the thread

  • that PStatCollectors will be counted in if they do not specify otherwise.

*/

get_global_pstats()

C++ Interface: get_global_pstats()

/**

  • Returns a pointer to the global PStatClient object. It’s legal to declare

  • your own PStatClient locally, but it’s also convenient to have a global one

  • that everyone can register with. This is the global one.

*/

get_main_thread()

C++ Interface: get_main_thread(PStatClient self)

/**

  • Returns a handle to the client’s Main thread. This is the thread that

  • started the application.

*/

get_max_rate()

C++ Interface: get_max_rate(PStatClient self)

/**

  • Returns the maximum number of packets that will be sent to the server per

  • second, per thread. See set_max_rate().

*/

get_num_collectors()

C++ Interface: get_num_collectors(PStatClient self)

/**

  • Returns the total number of collectors the Client knows about.

*/

get_num_threads()

C++ Interface: get_num_threads(PStatClient self)

/**

  • Returns the total number of threads the Client knows about.

*/

get_real_time()

C++ Interface: get_real_time(PStatClient self)

/**

  • Returns the time according to to the PStatClient’s clock object. It keeps

  • its own clock, instead of using the global clock object, so the stats won’t

  • get mucked up if you put the global clock in non-real-time mode or

  • something.

*/

get_thread()

C++ Interface: get_thread(PStatClient self, int index)

/**

  • Returns the nth thread.

*/

get_thread_name()

C++ Interface: get_thread_name(PStatClient self, int index)

/**

  • Returns the name of the indicated thread.

*/

get_thread_object()

C++ Interface: get_thread_object(PStatClient self, int index)

/**

  • Returns the Panda Thread object associated with the indicated PStatThread.

*/

get_thread_sync_name()

C++ Interface: get_thread_sync_name(PStatClient self, int index)

/**

  • Returns the sync_name of the indicated thread.

*/

get_threads()
isConnected()

C++ Interface: is_connected()

/**

  • Returns true if the client believes it is connected to a working

  • PStatServer, false otherwise.

*/

is_connected()

C++ Interface: is_connected()

/**

  • Returns true if the client believes it is connected to a working

  • PStatServer, false otherwise.

*/

mainTick()

C++ Interface: main_tick()

/**

  • A convenience function to call new_frame() on the global PStatClient’s main

  • thread, and any other threads with a sync_name of “Main”.

*/

main_thread
main_tick()

C++ Interface: main_tick()

/**

  • A convenience function to call new_frame() on the global PStatClient’s main

  • thread, and any other threads with a sync_name of “Main”.

*/

max_rate
real_time
resumeAfterPause()

C++ Interface: resume_after_pause()

/**

  • Resumes the PStatClient after the simulation has been paused for a while.

  • This allows the stats to continue exactly where it left off, instead of

  • leaving a big gap that would represent a chug.

  • @deprecated Do not use this, it creates inaccurate timing information.

*/

resume_after_pause()

C++ Interface: resume_after_pause()

/**

  • Resumes the PStatClient after the simulation has been paused for a while.

  • This allows the stats to continue exactly where it left off, instead of

  • leaving a big gap that would represent a chug.

  • @deprecated Do not use this, it creates inaccurate timing information.

*/

setClientName()

C++ Interface: set_client_name(const PStatClient self, str name)

/**

  • Sets the name of the client. This is reported to the PStatsServer, and

  • will presumably be written in the title bar or something.

*/

setMaxRate()

C++ Interface: set_max_rate(const PStatClient self, double rate)

/**

  • Controls the number of packets that will be sent to the server. Normally,

  • one packet is sent per frame, but this can flood the server with more

  • packets than it can handle if the frame rate is especially good (e.g. if

  • nothing is onscreen at the moment). Set this parameter to a reasonable

  • number to prevent this from happening.

  • This number specifies the maximum number of packets that will be sent to

  • the server per second, per thread.

*/

set_client_name()

C++ Interface: set_client_name(const PStatClient self, str name)

/**

  • Sets the name of the client. This is reported to the PStatsServer, and

  • will presumably be written in the title bar or something.

*/

set_max_rate()

C++ Interface: set_max_rate(const PStatClient self, double rate)

/**

  • Controls the number of packets that will be sent to the server. Normally,

  • one packet is sent per frame, but this can flood the server with more

  • packets than it can handle if the frame rate is especially good (e.g. if

  • nothing is onscreen at the moment). Set this parameter to a reasonable

  • number to prevent this from happening.

  • This number specifies the maximum number of packets that will be sent to

  • the server per second, per thread.

*/

threadTick()

C++ Interface: thread_tick() thread_tick(str sync_name)

/**

  • A convenience function to call new_frame() for the current thread.

*/

/**

  • A convenience function to call new_frame() on any threads with the

  • indicated sync_name

*/

thread_tick()

C++ Interface: thread_tick() thread_tick(str sync_name)

/**

  • A convenience function to call new_frame() for the current thread.

*/

/**

  • A convenience function to call new_frame() on any threads with the

  • indicated sync_name

*/

threads