GammaRay::ClientConnectionManager Class Reference

Pre-MainWindow connection setup logic. More...

#include <clientconnectionmanager.h>

Inheritance diagram for GammaRay::ClientConnectionManager:

Public Slots
QMainWindow *	createMainWindow ()
	Brings up a client main window for the current connection.
void	disconnectFromHost ()
	Disconnect GammaRay.
void	handlePersistentConnectionError (const QString &msg)
	Standard persistent connection error handler.

Signals
void	disconnected ()
	Emitted when the connection to the target has been closed, for whatever reason.
void	persistentConnectionError (const QString &msg)
	Emitted when there has been a persistent connection error.
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.

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.
QString	endPointKey () const
QString	endPointLabel () const
qint64	endPointPid () const
QMainWindow *	mainWindow () const
GammaRay::ProcessTrackerBackend *	processTrackerBackend () const
qint64	processTrackerPid () const
void	setProcessTrackerBackend (GammaRay::ProcessTrackerBackend *backend)
void	setProcessTrackerPid (qint64 pid)
ClientToolManager *	toolManager () const

Static Public Member Functions
static void	init ()
	One-time initialization of stream operators and factory callbacks.
static void	showSplashScreen ()
	Manually show the splash screen.

Detailed Description

Pre-MainWindow connection setup logic.

This is useful for embedding the GammaRay client into another application

Since

2.3

Member Function Documentation

createMainWindow

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().

disconnected

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().

handlePersistentConnectionError

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

slot

Standard persistent connection error handler.

See also

persistentConnectionError()

persistentConnectionError

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.

ready

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.