Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QQmlProfilerClient Class Reference

#include <qqmlprofilerclient_p.h>

+ Inheritance diagram for QQmlProfilerClient:
+ Collaboration diagram for QQmlProfilerClient:

Signals

void complete (qint64 maximumTime)
 
void traceFinished (qint64 timestamp, const QList< int > &engineIds)
 
void traceStarted (qint64 timestamp, const QList< int > &engineIds)
 
void recordingChanged (bool arg)
 
void recordedFeaturesChanged (quint64 features)
 
void cleared ()
 
- Signals inherited from QQmlDebugClient
void stateChanged (State state)
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QQmlProfilerClient (QQmlDebugConnection *connection, QQmlProfilerEventReceiver *eventReceiver, quint64 features=std::numeric_limits< quint64 >::max())
 
 ~QQmlProfilerClient ()
 
bool isRecording () const
 
void setRecording (bool)
 
quint64 recordedFeatures () const
 
virtual void messageReceived (const QByteArray &) override
 
void clearEvents ()
 
void clearAll ()
 
void sendRecordingStatus (int engineId=-1)
 
void setRequestedFeatures (quint64 features)
 
void setFlushInterval (quint32 flushInterval)
 
- Public Member Functions inherited from QQmlDebugClient
 QQmlDebugClient (const QString &name, QQmlDebugConnection *parent)
 
 ~QQmlDebugClient ()
 
QString name () const
 
float serviceVersion () const
 
State state () const
 
void sendMessage (const QByteArray &message)
 
QQmlDebugConnectionconnection () const
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Protected Member Functions

 QQmlProfilerClient (QQmlProfilerClientPrivate &dd)
 
void onStateChanged (State status)
 
- Protected Member Functions inherited from QQmlDebugClient
 QQmlDebugClient (QQmlDebugClientPrivate &dd)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Properties

bool recording
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Types inherited from QQmlDebugClient
enum  State { NotConnected , Unavailable , Enabled }
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 28 of file qqmlprofilerclient_p.h.

Constructor & Destructor Documentation

◆ QQmlProfilerClient() [1/2]

QQmlProfilerClient::QQmlProfilerClient ( QQmlDebugConnection * connection,
QQmlProfilerEventReceiver * eventReceiver,
quint64 features = std::numeric_limits<quint64>::max() )

Definition at line 134 of file qqmlprofilerclient.cpp.

References QObject::connect(), d, QQmlEngineControlClient::engineAboutToBeAdded(), QQmlEngineControlClient::engineAboutToBeRemoved(), onStateChanged(), sendRecordingStatus(), setRequestedFeatures(), QQmlDebugClient::stateChanged(), and traceFinished().

+ Here is the call graph for this function:

◆ ~QQmlProfilerClient()

QQmlProfilerClient::~QQmlProfilerClient ( )

Definition at line 162 of file qqmlprofilerclient.cpp.

References isRecording(), and setRecording().

+ Here is the call graph for this function:

◆ QQmlProfilerClient() [2/2]

QQmlProfilerClient::QQmlProfilerClient ( QQmlProfilerClientPrivate & dd)
protected

Definition at line 269 of file qqmlprofilerclient.cpp.

References QObject::connect(), d, QQmlEngineControlClient::engineAboutToBeAdded(), and sendRecordingStatus().

+ Here is the call graph for this function:

Member Function Documentation

◆ clearAll()

void QQmlProfilerClient::clearAll ( )

Definition at line 183 of file qqmlprofilerclient.cpp.

References clearEvents(), and d.

+ Here is the call graph for this function:

◆ cleared

void QQmlProfilerClient::cleared ( )
signal

Referenced by clearEvents().

+ Here is the caller graph for this function:

◆ clearEvents()

void QQmlProfilerClient::clearEvents ( )

Definition at line 170 of file qqmlprofilerclient.cpp.

References cleared(), d, emit, and recordedFeaturesChanged().

Referenced by clearAll().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ complete

void QQmlProfilerClient::complete ( qint64 maximumTime)
signal

Referenced by messageReceived().

+ Here is the caller graph for this function:

◆ isRecording()

bool QQmlProfilerClient::isRecording ( ) const

Definition at line 210 of file qqmlprofilerclient.cpp.

References d.

Referenced by ~QQmlProfilerClient().

+ Here is the caller graph for this function:

◆ messageReceived()

void QQmlProfilerClient::messageReceived ( const QByteArray & data)
overridevirtual

Reimplemented from QQmlDebugClient.

Definition at line 301 of file qqmlprofilerclient.cpp.

References complete(), Complete, d, emit, EndTrace, qMax(), StartTrace, traceFinished(), traceStarted(), and Event::type.

+ Here is the call graph for this function:

◆ onStateChanged()

void QQmlProfilerClient::onStateChanged ( State status)
protected

Definition at line 290 of file qqmlprofilerclient.cpp.

References d, QQmlDebugClient::Enabled, and sendRecordingStatus().

Referenced by QQmlProfilerClient().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ recordedFeatures()

quint64 QQmlProfilerClient::recordedFeatures ( ) const

Definition at line 230 of file qqmlprofilerclient.cpp.

References d.

◆ recordedFeaturesChanged

void QQmlProfilerClient::recordedFeaturesChanged ( quint64 features)
signal

Referenced by clearEvents().

+ Here is the caller graph for this function:

◆ recordingChanged

void QQmlProfilerClient::recordingChanged ( bool arg)
signal

Referenced by setRecording().

+ Here is the caller graph for this function:

◆ sendRecordingStatus()

void QQmlProfilerClient::sendRecordingStatus ( int engineId = -1)

Definition at line 204 of file qqmlprofilerclient.cpp.

References d.

Referenced by QQmlProfilerClient(), QQmlProfilerClient(), onStateChanged(), and setRecording().

+ Here is the caller graph for this function:

◆ setFlushInterval()

void QQmlProfilerClient::setFlushInterval ( quint32 flushInterval)

Definition at line 263 of file qqmlprofilerclient.cpp.

References d.

◆ setRecording()

void QQmlProfilerClient::setRecording ( bool v)

Definition at line 216 of file qqmlprofilerclient.cpp.

References d, emit, QQmlDebugClient::Enabled, recordingChanged(), sendRecordingStatus(), and QQmlDebugClient::state().

Referenced by ~QQmlProfilerClient().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setRequestedFeatures()

void QQmlProfilerClient::setRequestedFeatures ( quint64 features)

Definition at line 236 of file qqmlprofilerclient.cpp.

References QObject::connect(), QQmlDebugClient::connection(), context, d, QQmlDebugMessageClient::message(), ProfileDebugMessages, and text.

Referenced by QQmlProfilerClient().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ traceFinished

void QQmlProfilerClient::traceFinished ( qint64 timestamp,
const QList< int > & engineIds )
signal

Referenced by QQmlProfilerClient(), and messageReceived().

+ Here is the caller graph for this function:

◆ traceStarted

void QQmlProfilerClient::traceStarted ( qint64 timestamp,
const QList< int > & engineIds )
signal

Referenced by messageReceived().

+ Here is the caller graph for this function:

Property Documentation

◆ recording

bool QQmlProfilerClient::recording
readwrite

Definition at line 32 of file qqmlprofilerclient_p.h.


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