GammaRay API Documentation  2.11.0
Public Slots | Signals | Public Member Functions | Static Public Member Functions | List of all members
GammaRay::ClientConnectionManager Class Reference

Pre-MainWindow connection setup logic. More...

#include <clientconnectionmanager.h>

Inheritance diagram for GammaRay::ClientConnectionManager:
Inheritance graph
[legend]

Public Slots

QMainWindowcreateMainWindow ()
 Brings up a client main window for the current connection. More...
 
void disconnectFromHost ()
 Disconnect GammaRay. More...
 
void handlePersistentConnectionError (const QString &msg)
 Standard persistent connection error handler. More...
 

Signals

void disconnected ()
 Emitted when the connection to the target has been closed, for whatever reason. More...
 
void persistentConnectionError (const QString &msg)
 Emitted when there has been a persistent connection error. More...
 
void processTrackerBackendChanged (GammaRay::ProcessTrackerBackend *backend)
 
void processTrackerInfoChanged (const GammaRay::ProcessTrackerInfo &info)
 
void ready ()
 Emitted when the connection is established and the tool model is populated. More...
 

Public Member Functions

 ClientConnectionManager (QObject *parent=nullptr, bool showSplashScreenOnStartUp=true)
 
void connectToHost (const QUrl &url, int tryAgain=0)
 Connect to a GammaRay probe at url. More...
 
QString endPointKey () const
 
QString endPointLabel () const
 
qint64 endPointPid () const
 
QMainWindowmainWindow () const
 
GammaRay::ProcessTrackerBackendprocessTrackerBackend () const
 
qint64 processTrackerPid () const
 
void setProcessTrackerBackend (GammaRay::ProcessTrackerBackend *backend)
 
void setProcessTrackerPid (qint64 pid)
 
void showSplashScreen ()
 Manually show the splash screen. More...
 
ClientToolManagertoolManager () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectList & children () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectInfo ()
 
void dumpObjectTree () const const
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
virtual int qt_metacall (QMetaObject::Call, int, void **)
 
virtual void * qt_metacast (const char *)
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Static Public Member Functions

static void init ()
 One-time initialization of stream operators and factory callbacks. More...
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Pre-MainWindow connection setup logic.

This is useful for embedding the GammaRay client into another application

Since
2.3

Member Function Documentation

void GammaRay::ClientConnectionManager::connectToHost ( const QUrl url,
int  tryAgain = 0 
)

Connect to a GammaRay probe at url.

QMainWindow* GammaRay::ClientConnectionManager::createMainWindow ( )
slot

Brings up a client main window for the current connection.

If you want to use this, connect this slot to ready().

void GammaRay::ClientConnectionManager::disconnected ( )
signal

Emitted when the connection to the target has been closed, for whatever reason.

For a stand-alone client you probably want to connect this to QApplication::quit().

void GammaRay::ClientConnectionManager::disconnectFromHost ( )
slot

Disconnect GammaRay.

void GammaRay::ClientConnectionManager::handlePersistentConnectionError ( const QString msg)
slot

Standard persistent connection error handler.

See also
persistentConnectionError()
static void GammaRay::ClientConnectionManager::init ( )
static

One-time initialization of stream operators and factory callbacks.

void GammaRay::ClientConnectionManager::persistentConnectionError ( const QString msg)
signal

Emitted when there has been a persistent connection error.

You can connect this to handlePersistentConnectionError() for a standard message box and application exit handling.

void GammaRay::ClientConnectionManager::ready ( )
signal

Emitted when the connection is established and the tool model is populated.

If you want to bring up the standard main window, connect this to createMainWindow(), otherwise use this to show your own UI at this point.

void GammaRay::ClientConnectionManager::showSplashScreen ( )

Manually show the splash screen.


Klarälvdalens Datakonsult AB (KDAB)
"The Qt Experts"
https://www.kdab.com/
GammaRay
Qt-application inspection and manipulation tool
https://www.kdab.com/gammaray/