nv::index::IEvent_tracing Class Reference

Main class that handles trace event collection and recording. More...

#include <ievent_tracing.h>

Inherits mi::base::Interface_declare< 0x5c604cf0, ... >.

Public Member Functions
virtual void	add_collection_handler (ITrace_collection_handler *handler)=0
	Add a notification handler for the availability of trace collection. More...
virtual void	remove_collection_handler (ITrace_collection_handler *handler)=0
	Removes a notification handler for the availability of trace collection. More...
virtual ITrace_collection *	get_collection (mi::Uint32 collection_id, bool raw=false)=0
	Get a specific collection id. More...
virtual void	record (const char *ns, mi::Sint32 ns_id, const char *name, mi::Uint64 value)=0
	Record a trace tuple of format <namespace, namespace_id, trace_name, trace_value> for Uint64. More...
virtual void	record (const char *ns, mi::Sint32 ns_id, const char *name, mi::Sint64 value)=0
	Record a trace tuple of format <namespace, namespace_id, trace_name, trace_value> for Sint64. More...
virtual void	record (const char *ns, mi::Sint32 ns_id, const char *name, mi::Float64 value)=0
	Record a trace tuple of format <namespace, namespace_id, trace_name, trace_value> for Float64. More...
virtual void	record_time_duration (const char *ns, mi::Sint32 ns_id, const char *name, mi::Uint64 start_timestamp, mi::Uint64 duration)=0
	Record a time duration trace of format <namespace, namespace_id, trace_name, start_timestamp, duration> More...
virtual void	record_time_interval (const char *ns, mi::Sint32 ns_id, const char *name, mi::Uint64 start_timestamp, mi::Uint64 end_timestamp)=0
	Record a time interval trace of format <namespace, namespace_id, trace_name, start_timestamp, end_timestamp> More...

Detailed Description

Main class that handles trace event collection and recording.

Member Function Documentation

add_collection_handler()

virtual void nv::index::IEvent_tracing::add_collection_handler ( ITrace_collection_handler *  handler )

pure virtual

Add a notification handler for the availability of trace collection.

Parameters

[in]

handler

Pointer to the notification handler.

get_collection()

virtual ITrace_collection * nv::index::IEvent_tracing::get_collection ( mi::Uint32  collection_id, bool  raw = false  )

pure virtual

Get a specific collection id.

Parameters

[in]	collection_id	The id of the collection. It currently maps to the frame id.
[in]	raw	Provide raw trace events (triggers collection from all hosts).

Returns

Returns a trace collection which could be empty.

record() [1/3]

virtual void nv::index::IEvent_tracing::record ( const char *  ns, mi::Sint32  ns_id, const char *  name, mi::Float64  value  )

pure virtual

Record a trace tuple of format <namespace, namespace_id, trace_name, trace_value> for Float64.

Parameters

[in]	ns	Namespace
[in]	ns_id	Namespace id
[in]	name	Event name
[in]	value	Event value.

Note

For ns and name please use string literals.

record() [2/3]

virtual void nv::index::IEvent_tracing::record ( const char *  ns, mi::Sint32  ns_id, const char *  name, mi::Sint64  value  )

pure virtual

Record a trace tuple of format <namespace, namespace_id, trace_name, trace_value> for Sint64.

Parameters

[in]	ns	Namespace
[in]	ns_id	Namespace id
[in]	name	Event name
[in]	value	Event value.

Note

For ns and name please use string literals.

record() [3/3]

virtual void nv::index::IEvent_tracing::record ( const char *  ns, mi::Sint32  ns_id, const char *  name, mi::Uint64  value  )

pure virtual

Record a trace tuple of format <namespace, namespace_id, trace_name, trace_value> for Uint64.

Parameters

[in]	ns	Namespace
[in]	ns_id	Namespace id
[in]	name	Event name
[in]	value	Event value.

Note

For ns and name please use string literals.

record_time_duration()

virtual void nv::index::IEvent_tracing::record_time_duration ( const char *  ns, mi::Sint32  ns_id, const char *  name, mi::Uint64  start_timestamp, mi::Uint64  duration  )

pure virtual

Record a time duration trace of format <namespace, namespace_id, trace_name, start_timestamp, duration>

Parameters

[in]	ns	Namespace
[in]	ns_id	Namespace id
[in]	name	Event name
[in]	start_timestamp	Start timestamp (nanoseconds).
[in]	duration	Duration of event (nanoseconds).

Note

For ns and name please use string literals.

record_time_interval()

virtual void nv::index::IEvent_tracing::record_time_interval ( const char *  ns, mi::Sint32  ns_id, const char *  name, mi::Uint64  start_timestamp, mi::Uint64  end_timestamp  )

pure virtual

Record a time interval trace of format <namespace, namespace_id, trace_name, start_timestamp, end_timestamp>

Parameters

[in]	ns	Namespace
[in]	ns_id	Namespace id
[in]	name	Event name
[in]	start_timestamp	Start timestamp (nanoseconds).
[in]	end_timestamp	End timestamp (nanoseconds.

Note

For ns and name please use string literals.

remove_collection_handler()

virtual void nv::index::IEvent_tracing::remove_collection_handler ( ITrace_collection_handler *  handler )

pure virtual

Removes a notification handler for the availability of trace collection.

Parameters

[in]

handler

Pointer to the notification handler.

---

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

• ievent_tracing.h