TcpRemoteScheduler Class Reference

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

Inheritance diagram for TcpRemoteScheduler:

Classes
class	TcpServer

Public Types
enum	LogMessageId { msgIdStartup = 1 , msgIdShutdown , msgIdClient , msgIdQueue }

Public Slots
void	pause () override
void	processCommand (int code)
void	resume () override
bool	start () override
void	stop () override

Public Member Functions
	TcpRemoteScheduler ()
	~TcpRemoteScheduler () override
const QString &	getListenHost () const
int	getListenPort () const
const QString &	getMailHost () const
const QString &	getMailSender () const
const QString &	getPrivateKeyPath () const
const QString &	getPublicKeyPath () const
QString	getTypeId () const override
bool	getUseSecureConnection () const
bool	isAcceptingConnections () const
bool	load (const Authentication::SettingContainer &settings) override
void	save (Authentication::SettingContainer &settings) const override
void	setListenHost (const QString &host)
void	setListenPort (int listenPort)
void	setMailHost (const QString &mailHost)
void	setMailSender (const QString &mailSender)
void	setPrivateKeyPath (const QString &privateKeyPath)
void	setPublicKeyPath (const QString &publicKeyPath)
void	setup (Authentication::SettingContainer &settings) const override
void	setUseSecureConnection (bool useSecureConnection)
Application::WorkspaceQueue &	workspaceQueue ()
Public Member Functions inherited from AbstractRemoteScheduler
QString	getServerUuid () const
virtual QString	getTypeId () const =0
virtual bool	load (const Authentication::SettingContainer &settings)=0
virtual void	pause ()
virtual void	resume ()
virtual void	save (Authentication::SettingContainer &settings) const =0
virtual void	setup (Authentication::SettingContainer &settings) const =0
virtual bool	start ()=0
virtual void	stop ()=0

Static Public Attributes
static const Application::LogManager::MessageCategory	LOG_SERVERERROR
static const Application::LogManager::MessageCategory	LOG_SERVERINFO

Additional Inherited Members
Protected Member Functions inherited from AbstractRemoteScheduler
	AbstractRemoteScheduler ()
AbstractRemoteServer &	getServer ()
bool	isLimitedByFeatureNumber (const SchedulerFeatures &) const
bool	isSchedulerBusy () const

Member Enumeration Documentation

LogMessageId

enum LogMessageId

Message identifiers. These are used by the Windows event viewer to help categorize logged messages. Their usefulness is limited for other platforms, possibly ignored altogether.

Enumerator
msgIdStartup
msgIdShutdown
msgIdClient
msgIdQueue

Constructor & Destructor Documentation

TcpRemoteScheduler()

TcpRemoteScheduler

(

)

~TcpRemoteScheduler()

~TcpRemoteScheduler ( )

override

Ensures the server is stopped cleanly before destroying the object.

Member Function Documentation

getListenHost()

const QString & getListenHost ( ) const

inline

getListenPort()

int getListenPort ( ) const

inline

getMailHost()

const QString & getMailHost

(

)

const

Returns

SMTP mail host.

getMailSender()

const QString & getMailSender

(

)

const

Returns

mail sender.

getPrivateKeyPath()

const QString & getPrivateKeyPath ( ) const

inline

getPublicKeyPath()

const QString & getPublicKeyPath ( ) const

inline

getTypeId()

QString getTypeId ( ) const

overridevirtual

Implements AbstractRemoteScheduler.

getUseSecureConnection()

bool getUseSecureConnection ( ) const

inline

isAcceptingConnections()

bool isAcceptingConnections

(

)

const

load()

bool load ( const Authentication::SettingContainer &  settings )

overridevirtual

Implements AbstractRemoteScheduler.

pause

void pause ( )

overrideslot

Temporarily prevents the server from accepting incoming connections.

processCommand

void processCommand ( int  code )

slot

May be used in a future version to allow user commands to be passed to the remote scheduler.

resume

void resume ( )

overrideslot

Re-enables the server to accept incoming connections.

save()

void save ( Authentication::SettingContainer &  settings ) const

overridevirtual

Implements AbstractRemoteScheduler.

setListenHost()

void setListenHost ( const QString &  host )

inline

setListenPort()

void setListenPort ( int  listenPort )

inline

setMailHost()

void setMailHost

(

const QString &

mailHost

)

Parameters

mailHost

Address of the SMTP mail host.

setMailSender()

void setMailSender

(

const QString &

mailSender

)

Parameters

mailSender

Email address of the mail sender appear in the mail.

setPrivateKeyPath()

void setPrivateKeyPath ( const QString &  privateKeyPath )

inline

setPublicKeyPath()

void setPublicKeyPath ( const QString &  publicKeyPath )

inline

setup()

void setup ( Authentication::SettingContainer &  settings ) const

overridevirtual

Implements AbstractRemoteScheduler.

setUseSecureConnection()

void setUseSecureConnection ( bool  useSecureConnection )

inline

start

bool start ( )

overrideslot

Starts the server.

Returns

True if the server was started successfully or was already running. If it fails, it will return false after logging diagnostic information about the reason for the failure to start.

stop

void stop ( )

overrideslot

Stops the server from listening for incoming connections on the assigned port. If the server is already not running at the time of the call, then the function does nothing.

workspaceQueue()

Application::WorkspaceQueue & workspaceQueue ( )

inline

Member Data Documentation

LOG_SERVERERROR

const Application::LogManager::MessageCategory LOG_SERVERERROR

static

LOG_SERVERINFO

const Application::LogManager::MessageCategory LOG_SERVERINFO

static