threadtimes_counter Class Reference
[Performance Library]

#include <winstl/performance/threadtimes_counter.hpp>

List of all members.

---

Detailed Description

A performance counter that provides thread-specific performance timings.

This class uses the operating system's performance monitoring facilities to provide timing information pertaining to the calling thread only, irrespective of the activities of other threads on the system. This class does not provide meaningful timing information on operating systems that do not provide thread-specific monitoring.

Public Types
typedef threadtimes_counter	class_type
	This type.
typedef ws_sint64_t	interval_type
	The interval type.
Public Member Functions
	threadtimes_counter ()
	Constructor.
void	start ()
	Starts measurement.
void	stop ()
	Ends measurement.
interval_type	get_kernel_period_count () const
	The elapsed count in the measurement period for kernel mode activity.
interval_type	get_kernel_seconds () const
	The number of whole seconds in the measurement period for kernel mode activity.
interval_type	get_kernel_milliseconds () const
	The number of whole milliseconds in the measurement period for kernel mode activity.
interval_type	get_kernel_microseconds () const
	The number of whole microseconds in the measurement period for kernel mode activity.
interval_type	get_user_period_count () const
	The elapsed count in the measurement period for user mode activity.
interval_type	get_user_seconds () const
	The number of whole seconds in the measurement period for user mode activity.
interval_type	get_user_milliseconds () const
	The number of whole milliseconds in the measurement period for user mode activity.
interval_type	get_user_microseconds () const
	The number of whole microseconds in the measurement period for user mode activity.
interval_type	get_period_count () const
	The elapsed count in the measurement period.
interval_type	get_seconds () const
	The number of whole seconds in the measurement period.
interval_type	get_milliseconds () const
	The number of whole milliseconds in the measurement period.
interval_type	get_microseconds () const
	The number of whole microseconds in the measurement period.

---

Member Typedef Documentation

typedef threadtimes_counter class_type

This type.

typedef ws_sint64_t interval_type

The interval type.

The type of the interval measurement, a 64-bit signed integer

---

Constructor & Destructor Documentation

threadtimes_counter

(

)

Constructor.

Creates an instance of the class, and caches the thread token so that measurements will be taken with respect to the thread in which the class was created.

---

Member Function Documentation

void start

(

)

Starts measurement.

Begins the measurement period

void stop

(

)

Ends measurement.

Ends the measurement period

interval_type get_kernel_period_count

(

)

const

The elapsed count in the measurement period for kernel mode activity.

This represents the extent, in machine-specific increments, of the measurement period for kernel mode activity

interval_type get_kernel_seconds

(

)

const

The number of whole seconds in the measurement period for kernel mode activity.

This represents the extent, in whole seconds, of the measurement period for kernel mode activity

interval_type get_kernel_milliseconds

(

)

const

The number of whole milliseconds in the measurement period for kernel mode activity.

This represents the extent, in whole milliseconds, of the measurement period for kernel mode activity

interval_type get_kernel_microseconds

(

)

const

The number of whole microseconds in the measurement period for kernel mode activity.

This represents the extent, in whole microseconds, of the measurement period for kernel mode activity

interval_type get_user_period_count

(

)

const

The elapsed count in the measurement period for user mode activity.

This represents the extent, in machine-specific increments, of the measurement period for user mode activity

interval_type get_user_seconds

(

)

const

The number of whole seconds in the measurement period for user mode activity.

This represents the extent, in whole seconds, of the measurement period for user mode activity

interval_type get_user_milliseconds

(

)

const

The number of whole milliseconds in the measurement period for user mode activity.

This represents the extent, in whole milliseconds, of the measurement period for user mode activity

interval_type get_user_microseconds

(

)

const

The number of whole microseconds in the measurement period for user mode activity.

This represents the extent, in whole microseconds, of the measurement period for user mode activity

interval_type get_period_count

(

)

const

The elapsed count in the measurement period.

This represents the extent, in machine-specific increments, of the measurement period

interval_type get_seconds

(

)

const

The number of whole seconds in the measurement period.

This represents the extent, in whole seconds, of the measurement period

interval_type get_milliseconds

(

)

const

The number of whole milliseconds in the measurement period.

This represents the extent, in whole milliseconds, of the measurement period

interval_type get_microseconds

(

)

const

The number of whole microseconds in the measurement period.

This represents the extent, in whole microseconds, of the measurement period

---

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

• winstl/performance/threadtimes_counter.hpp