Loading...
Searching...
No Matches
TraceCollectionAvailable Class Reference

A TfNotice that is sent when the TraceCollector creates a TraceCollection. More...

#include <collectionNotice.h>

+ Inheritance diagram for TraceCollectionAvailable:

Public Member Functions

 TraceCollectionAvailable (const std::shared_ptr< TraceCollection > &collection)
 Constructor.
 
virtual TRACE_API ~TraceCollectionAvailable ()
 Destructor.
 
const std::shared_ptr< TraceCollection > & GetCollection () const
 Returns the TraceCollection which was produced.
 
- Public Member Functions inherited from TfNotice
TF_API size_t Send () const
 Deliver the notice to interested listeners, returning the number of interested listeners.
 
template<typename SenderPtr >
size_t Send (SenderPtr const &s) const
 Deliver the notice to interested listeners, returning the number of interested listeners.
 
TF_API size_t SendWithWeakBase (const TfWeakBase *senderWeakBase, const void *senderUniqueId, const std::type_info &type) const
 Variant of Send() that takes a specific sender in the form of a TfWeakBase pointer and a typeid.
 

Additional Inherited Members

- Public Types inherited from TfNotice
typedef TfWeakPtr< ProbeWeakProbePtr
 
typedef std::vector< KeyKeys
 A TfNotice::Key container.
 
- Static Public Member Functions inherited from TfNotice
static TF_API void InsertProbe (const WeakProbePtr &probe)
 Register a probe that will be invoked when notices are sent and delivered.
 
static TF_API void RemoveProbe (const WeakProbePtr &probe)
 Remove a probe that was previously registered with InsertProbe.
 
template<class LPtr , class MethodPtr >
static TfNotice::Key Register (LPtr const &listener, MethodPtr method)
 Register a listener as being interested in a TfNotice.
 
template<class LPtr , class MethodPtr , class SenderPtr >
static TfNotice::Key Register (LPtr const &listener, MethodPtr method, SenderPtr const &sender)
 
template<class LPtr , class MethodPtr >
static TfNotice::Key Register (LPtr const &listener, MethodPtr method, const TfType &noticeType, const TfAnyWeakPtr &sender)
 
static TF_API bool Revoke (TfNotice::Key &key)
 Revoke interest by a listener.
 
static TF_API void Revoke (TfNotice::Keys *keys)
 Revoke interest by listeners.
 

Detailed Description

A TfNotice that is sent when the TraceCollector creates a TraceCollection.

This can potentially be sent from multiple threads. Listeners must be thread safe.

Definition at line 42 of file collectionNotice.h.

Constructor & Destructor Documentation

◆ TraceCollectionAvailable()

TraceCollectionAvailable ( const std::shared_ptr< TraceCollection > &  collection)
inline

Constructor.

Definition at line 46 of file collectionNotice.h.

◆ ~TraceCollectionAvailable()

virtual TRACE_API ~TraceCollectionAvailable ( )
virtual

Destructor.

Member Function Documentation

◆ GetCollection()

const std::shared_ptr< TraceCollection > & GetCollection ( ) const
inline

Returns the TraceCollection which was produced.

Definition at line 54 of file collectionNotice.h.


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