pqServerLauncher manages launching of server process using the details specified in the server configuration. More...

#include <pqServerLauncher.h>

Inherits QObject.

Public Member Functions
	pqServerLauncher (const pqServerConfiguration &configuration, QObject *parent=nullptr)

	~pqServerLauncher () override

bool	connectToServer (bool showConnectionDialog=true)
	This method will launch the server process based on the configuration and connect to the server. More...

pqServer *	connectedServer () const
	on successful call to connectToServer() this method can be used to obtain pqServer connection. More...

Static Public Member Functions
static const QMetaObject *	setServerDefaultLauncherType (const QMetaObject *)
	Custom applications may want to extend the pqServerLauncher to customize connecting to servers. More...

static const QMetaObject *	defaultServerLauncherType ()

static pqServerLauncher *	newInstance (const pqServerConfiguration &configuration, QObject *parent=nullptr)
	Creates a new instance using the default launcher type specified. More...

Protected Slots
void	processFailed (QProcess::ProcessError)

void	readStandardOutput ()

void	readStandardError ()

void	launchServerForReverseConnection ()

Protected Member Functions
bool	promptOptions ()
	Request the user for user-configurable options, if any. More...

virtual bool	launchServer (bool show_status_dialog)
	Called when starting a server processes using a command-startup. More...

bool	processCommand (QString command, double processWait, double delay, const QProcessEnvironment *options=nullptr)
	An utility method to execute a command using a QProcess. More...

virtual bool	connectToPrelaunchedServer (bool showConnectionDialog=true)

bool	isReverseConnection () const

virtual void	prepareDialogForPromptOptions (QDialog &)
	Subclasses can override this method to further customize the dialog being shown to the user to prompt for options in pqServerLauncher::promptOptions. More...

pqServerConfiguration &	configuration () const
	Provides access to the pqServerConfiguration passed to the constructor. More...

QProcessEnvironment &	options () const
	Provide access to the QProcessEnvironment. More...

virtual void	updateOptionsUsingUserSelections ()
	Use this method to update the process environment using current user selections. More...

virtual void	handleProcessStandardOutput (const QByteArray &data)
	Subclasses can override this to handle output and error messages from the QProcess launched for command-startup configurations. More...

virtual void	handleProcessErrorOutput (const QByteArray &data)

Detailed Description

pqServerLauncher manages launching of server process using the details specified in the server configuration.

pqServerConfiguration can be simple, i.e the user is expected to launch the pvserver, or complex, i.e. the user is prompted for several options a pvserver process is launched automatically. All this is handled by this class.

When launching processes or during reverse-connect, this class also shows message box that can be used by the user to abort the waiting for connection.

Definition at line 29 of file pqServerLauncher.h.

Constructor & Destructor Documentation

◆ pqServerLauncher()

pqServerLauncher::pqServerLauncher	(	const pqServerConfiguration &	configuration,
		QObject *	parent = `nullptr`
	)

◆ ~pqServerLauncher()

pqServerLauncher::~pqServerLauncher ( )

override

Member Function Documentation

◆ setServerDefaultLauncherType()

static const QMetaObject* pqServerLauncher::setServerDefaultLauncherType ( const QMetaObject * )

static

Custom applications may want to extend the pqServerLauncher to customize connecting to servers.

Such application can set the QMetaObject to use using this method. If none is set, pqServerLauncher will be created, by default. Returns the previous QMetaObject instance set, if any.

◆ defaultServerLauncherType()

static const QMetaObject* pqServerLauncher::defaultServerLauncherType ( )

static

◆ newInstance()

static pqServerLauncher* pqServerLauncher::newInstance	(	const pqServerConfiguration &	configuration,
		QObject *	parent = `nullptr`
	)

static

Creates a new instance using the default launcher type specified.

If none is specified, pqServerLauncher is created.

◆ connectToServer()

bool pqServerLauncher::connectToServer ( bool showConnectionDialog = true )

This method will launch the server process based on the configuration and connect to the server.

Set showConnectionDialog to false to not show the modal connection dialog when connecting. Returns true if the connection was successful, otherwise returns false.

◆ connectedServer()

pqServer* pqServerLauncher::connectedServer ( ) const

on successful call to connectToServer() this method can be used to obtain pqServer connection.

◆ processFailed

void pqServerLauncher::processFailed ( QProcess::ProcessError )

protectedslot

◆ readStandardOutput

void pqServerLauncher::readStandardOutput ( )

protectedslot

◆ readStandardError

void pqServerLauncher::readStandardError ( )

protectedslot

◆ launchServerForReverseConnection

void pqServerLauncher::launchServerForReverseConnection ( )

protectedslot

◆ promptOptions()

bool pqServerLauncher::promptOptions ( )

protected

Request the user for user-configurable options, if any.

Returns false if the user cancelled the dialog asking the options. Returns true if there are not user-configurable options or the user has accepted the values.

◆ launchServer()

virtual bool pqServerLauncher::launchServer ( bool show_status_dialog )

protectedvirtual

Called when starting a server processes using a command-startup.

Returns true if launch was successful else returns false.

◆ processCommand()

bool pqServerLauncher::processCommand	(	QString	command,
		double	processWait,
		double	delay,
		const QProcessEnvironment *	options = `nullptr`
	)

protected

An utility method to execute a command using a QProcess.

◆ connectToPrelaunchedServer()

virtual bool pqServerLauncher::connectToPrelaunchedServer ( bool showConnectionDialog = true )

protectedvirtual

◆ isReverseConnection()

bool pqServerLauncher::isReverseConnection ( ) const

protected

◆ prepareDialogForPromptOptions()

virtual void pqServerLauncher::prepareDialogForPromptOptions ( QDialog & )

inlineprotectedvirtual

Subclasses can override this method to further customize the dialog being shown to the user to prompt for options in pqServerLauncher::promptOptions.

Definition at line 105 of file pqServerLauncher.h.

◆ configuration()

pqServerConfiguration& pqServerLauncher::configuration ( ) const

protected

Provides access to the pqServerConfiguration passed to the constructor.

Note this is clone of the pqServerConfiguration passed to the constructor and not the same instance.

◆ options()

QProcessEnvironment& pqServerLauncher::options ( ) const

protected

Provide access to the QProcessEnvironment.

◆ updateOptionsUsingUserSelections()

virtual void pqServerLauncher::updateOptionsUsingUserSelections ( )

protectedvirtual

Use this method to update the process environment using current user selections.

◆ handleProcessStandardOutput()

virtual void pqServerLauncher::handleProcessStandardOutput ( const QByteArray & data )

protectedvirtual

Subclasses can override this to handle output and error messages from the QProcess launched for command-startup configurations.

Default implementation simply dumps the text to the debug/error console.

◆ handleProcessErrorOutput()

virtual void pqServerLauncher::handleProcessErrorOutput ( const QByteArray & data )

protectedvirtual

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

/builds/gitlab-kitware-sciviz-ci/Qt/Components/pqServerLauncher.h

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ pqServerLauncher()

◆ ~pqServerLauncher()

Member Function Documentation

◆ setServerDefaultLauncherType()

◆ defaultServerLauncherType()

◆ newInstance()

◆ connectToServer()

◆ connectedServer()

◆ processFailed

◆ readStandardOutput

◆ readStandardError

◆ launchServerForReverseConnection

◆ promptOptions()

◆ launchServer()

◆ processCommand()

◆ connectToPrelaunchedServer()

◆ isReverseConnection()

◆ prepareDialogForPromptOptions()

◆ configuration()

◆ options()

◆ updateOptionsUsingUserSelections()

◆ handleProcessStandardOutput()

◆ handleProcessErrorOutput()