#include <Workspace/DataExecution/Execution/Schedulers/Tcp/tcpscheduler.h>

Inheritance diagram for TcpScheduler:

Public Member Functions
	TcpScheduler ()

	~TcpScheduler () override

const QString &	getAuthenticationCredentials () const

const QString &	getAuthenticationProvider () const

const QString &	getAuthenticationProviderVersion () const

double	getCurrentWorkload () const override

SchedulerFeatures	getOccupiedFeatures () const override

QString	getTypeId () const override

QString	getUserField (QString key) const override

QStringList	getUserFieldList () const override

bool	getUseSecureConnection () const

QString	getVersion () const override

QFuture< ObjectDictionary >	getWorkflowOutputs (QString uuid) override
	Query if a workflow has finished execution.

bool	isConnected () const override

void	load (const QJsonDocument &) override

void	load (QDataStream &) override

void	save (QDataStream &) const override

void	save (QJsonDocument &) const override

void	scheduleRequest (SchedulerRequest &) override

void	setAuthenticationCredentials (const QString &credentials)

void	setAuthenticationProvider (const QString &method)

void	setAuthenticationProviderVersion (const QString &version)

void	setHostName (const QString &host) override

void	setUserField (QString key, QString value) override

void	setUseSecureConnection (bool secure)

void	stopRequest (SchedulerRequest &) override

Public Member Functions inherited from AbstractScheduler
	AbstractScheduler ()

	AbstractScheduler (const Scope scope, const QString &hostName, quint16 port, int cpuCount, bool enabled)

	~AbstractScheduler () override

virtual bool	canChangeServerType () const

virtual bool	canConfigure () const

virtual bool	canDelegateTo () const

virtual bool	canEditConcurrencyCount () const

virtual bool	canEditFeatures () const

virtual bool	canEditHostName () const

virtual bool	canEditMaxServerTimeDiff () const

virtual bool	canEditPort () const

virtual bool	canEditScope () const

virtual bool	canEnable () const

virtual bool	canRemove () const

virtual bool	contributesToTotalWorkload () const

virtual int	getActiveCount () const

virtual int	getConcurrencyCount () const

virtual double	getCurrentWorkload () const

virtual const QString &	getDescription () const

virtual bool	getEnabled () const

virtual const SchedulerFeatures &	getFeatures ()

virtual const QString &	getHostName () const

virtual int	getMaxServerTimeDiff () const

virtual SchedulerFeatures	getOccupiedFeatures () const

virtual quint16	getPort () const

virtual Scope	getScope () const

virtual bool	getTemporarilyDisabled ()

virtual int	getTimeout () const

virtual QString	getTypeId () const =0

virtual QString	getUserField (QString) const

virtual QStringList	getUserFieldList () const

virtual const QString &	getUuid () const

virtual QString	getVersion () const =0

virtual QFuture< ObjectDictionary >	getWorkflowOutputs (QString uuid)
	Query for a workflows results.

virtual bool	isConnected () const

virtual bool	isLocalWorker () const

virtual void	load (const QJsonDocument &)

virtual void	load (QDataStream &)

void	notifyFailure (SchedulerRequest &, const AbortReason &abortReason, const QString &text="")

void	notifyProgress (SchedulerRequest &, int percentComplete)
	Triggers a progress notification event on a request.

void	notifyStarted (SchedulerRequest &)

void	notifySuccess (SchedulerRequest &)

virtual void	save (QDataStream &) const

virtual void	save (QJsonDocument &) const

void	schedule (SchedulerRequest &request)

virtual void	setConcurrencyCount (int cpuCount)

virtual void	setDescription (const QString &description)

virtual void	setEnabled (bool enabled)

virtual void	setFeatures (const SchedulerFeatures &features)

virtual void	setHostName (const QString &host)

virtual void	setMaxServerTimeDiff (int maxServerTimeDiff)

virtual void	setPort (const quint16 port)

virtual void	setScope (const Scope scope)

virtual void	setTemporarilyDisabled (bool)

virtual void	setTimeout (int timeout)

virtual void	setUserField (QString key, QString value)

virtual void	setUuid (const QString &uuid)

virtual void	start ()

virtual void	stop ()

void	stop (SchedulerRequest &request)

virtual bool	supports (const SchedulerFeatures &features) const

Static Public Attributes
static const QString	featureMandatoryHost

Static Public Attributes inherited from AbstractScheduler
static const int	temporarilyDisabledTime = 3000

Protected Member Functions
void	connect () override

void	disconnect () override

Protected Member Functions inherited from AbstractScheduler
virtual void	connect ()

virtual void	destroyRequest (SchedulerRequest &)

virtual void	disconnect ()

bool	isSchedulerBusy () const

virtual void	scheduleRequest (SchedulerRequest &)=0

virtual void	stopRequest (SchedulerRequest &)=0

Additional Inherited Members
Public Types inherited from AbstractScheduler
enum	Scope { User , System , UserExternalFile , SystemExternalFile }

Protected Slots inherited from AbstractScheduler
virtual void	onConnected ()

virtual void	onDisconnected ()

virtual void	onError (const QString &description)

void	setVersion (const QString &version)

Protected Attributes inherited from AbstractScheduler
QAtomicInt	activeCount_

int	cpuCount_

QString	description_

bool	enabled_

SchedulerFeatures	features_

QString	host_

int	maxServerTimeDiff_

quint16	port_

Scope	scope_

bool	temporarilyDisabled_

QTime	temporarilyDisabledTimer_

int	timeout_

QString	uuid_

QString	version_

Static Protected Attributes inherited from AbstractScheduler
static int	DEFAULT_CPUCOUNT = 2

static QString	DEFAULT_HOST = "127.0.0.1"

static int	DEFAULT_MAXSERVERTIMEDIFF = 5000

static quint16	DEFAULT_PORT = 42150

static Scope	DEFAULT_SCOPE = AbstractScheduler::User

static int	DEFAULT_TIMEOUT = 3000

Constructor & Destructor Documentation

◆ TcpScheduler()

TcpScheduler ( )

◆ ~TcpScheduler()

~TcpScheduler ( )

override

Destructs the TcpScheduler.

Member Function Documentation

◆ connect()

void connect ( )

overrideprotectedvirtual

Establishes a connection to the TcpScheduler.

Reimplemented from AbstractScheduler.

◆ disconnect()

void disconnect ( )

overrideprotectedvirtual

Disconnects the TcpScheduler.

Reimplemented from AbstractScheduler.

◆ getAuthenticationCredentials()

const QString & getAuthenticationCredentials ( ) const

◆ getAuthenticationProvider()

const QString & getAuthenticationProvider ( ) const

◆ getAuthenticationProviderVersion()

const QString & getAuthenticationProviderVersion ( ) const

◆ getCurrentWorkload()

double getCurrentWorkload ( ) const

overridevirtual

Normalized workload. 0 is free, 1 is busy.

See also: SchedulerClient::getWorkload()

Reimplemented from AbstractScheduler.

◆ getOccupiedFeatures()

SchedulerFeatures getOccupiedFeatures ( ) const

overridevirtual

Summary of occupied features, if any.

Reimplemented from AbstractScheduler.

◆ getTypeId()

QString getTypeId ( ) const

overridevirtual

Implements AbstractScheduler.

◆ getUserField()

QString getUserField ( QString key ) const

overridevirtual

Reimplemented from AbstractScheduler.

◆ getUserFieldList()

QStringList getUserFieldList ( ) const

overridevirtual

Reimplemented from AbstractScheduler.

◆ getUseSecureConnection()

bool getUseSecureConnection ( ) const

◆ getVersion()

QString getVersion ( ) const

overridevirtual

Implements AbstractScheduler.

◆ getWorkflowOutputs()

QFuture< ObjectDictionary > getWorkflowOutputs ( QString uuid )

overridevirtual

Reimplemented from AbstractScheduler.

◆ isConnected()

bool isConnected ( ) const

overridevirtual

Returns true if the TcpScheduler is connected, false if not.

Returns: True if connected, False if not.

Reimplemented from AbstractScheduler.

◆ load() [1/2]

void load ( const QJsonDocument & doc )

overridevirtual

Reimplemented from AbstractScheduler.

◆ load() [2/2]

void load ( QDataStream & stream )

overridevirtual

Reimplemented from AbstractScheduler.

◆ save() [1/2]

void save ( QDataStream & stream ) const

overridevirtual

Reimplemented from AbstractScheduler.

◆ save() [2/2]

void save ( QJsonDocument & doc ) const

overridevirtual

Reimplemented from AbstractScheduler.

◆ scheduleRequest()

void scheduleRequest ( SchedulerRequest & request )

overridevirtual

Implements AbstractScheduler.

◆ setAuthenticationCredentials()

void setAuthenticationCredentials ( const QString & credentials )

◆ setAuthenticationProvider()

void setAuthenticationProvider ( const QString & method )

◆ setAuthenticationProviderVersion()

void setAuthenticationProviderVersion ( const QString & version )

◆ setHostName()

void setHostName ( const QString & host )

overridevirtual

Reimplemented from AbstractScheduler.

◆ setUserField()

void setUserField	(	QString	key,
		QString	value
	)

overridevirtual

Reimplemented from AbstractScheduler.

◆ setUseSecureConnection()

void setUseSecureConnection ( bool secure )

◆ stopRequest()

void stopRequest ( SchedulerRequest & request )

overridevirtual

Implements AbstractScheduler.

Member Data Documentation

◆ featureMandatoryHost

const QString featureMandatoryHost

static

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ TcpScheduler()

◆ ~TcpScheduler()

Member Function Documentation

◆ connect()

◆ disconnect()

◆ getAuthenticationCredentials()

◆ getAuthenticationProvider()

◆ getAuthenticationProviderVersion()

◆ getCurrentWorkload()

◆ getOccupiedFeatures()

◆ getTypeId()

◆ getUserField()

◆ getUserFieldList()

◆ getUseSecureConnection()

◆ getVersion()

◆ getWorkflowOutputs()

◆ isConnected()

◆ load() [1/2]

◆ load() [2/2]

◆ save() [1/2]

◆ save() [2/2]

◆ scheduleRequest()

◆ setAuthenticationCredentials()

◆ setAuthenticationProvider()

◆ setAuthenticationProviderVersion()

◆ setHostName()

◆ setUserField()

◆ setUseSecureConnection()

◆ stopRequest()

Member Data Documentation

◆ featureMandatoryHost