SchedulerTcpMessage Class Reference

The base class of tcp messages sent by a scheduler.

#include <Workspace/DataExecution/Execution/schedulertcpmessage.h>

Inheritance diagram for SchedulerTcpMessage:

Public Member Functions
	SchedulerTcpMessage ()
	SchedulerTcpMessage (const QString &)
	~SchedulerTcpMessage () override
const QString &	getAuthenticationFrameworkVersion () const
const QString &	getAuthenticationProvider () const
const QString &	getAuthenticationProviderVersion () const
const QString &	getCredentials () const
const QString &	getMessageToken () const
const QString &	getSchedulerVersion () const
const QString &	getUuid ()
bool	readMessageDataFrom (QDataStream &) override
void	setAuthenticationProvider (const QString &)
void	setAuthenticationProviderVersion (const QString &)
void	setCredentials (const QString &)
void	setMessageToken (const QString &)
void	setSchedulerVersion (const QString &)
void	setUuid (const QString &)
Public Member Functions inherited from TcpMessage
	TcpMessage ()
	TcpMessage (const TcpMessage &rhs)
virtual	~TcpMessage ()
quint32	getLength () const
const QByteArray &	getMessageData () const
virtual quint32	getMessageTypeId () const
bool	hasBeenFullyRead () const
TcpMessage &	operator= (const TcpMessage &)
void	readFrom (QIODevice &)
virtual bool	readMessageDataFrom (QDataStream &)
void	writeTo (QIODevice &)

Protected Member Functions
void	writeMessageDataTo (QDataStream &) override
virtual void	writeMessageDataTo (QDataStream &)

Protected Attributes
QString	authenticationFrameworkVersion_
QString	authenticationProvider_
QString	authenticationProviderVersion_
QString	credentials_
QString	messageToken_
QString	schedulerVersion_
QString	uuid_

Additional Inherited Members
Static Public Member Functions inherited from TcpMessage
static void	configureStream (QDataStream &)

Constructor & Destructor Documentation

SchedulerTcpMessage() [1/2]

SchedulerTcpMessage ( )

default

Constructs a SchedulerTcpMessage.

SchedulerTcpMessage() [2/2]

SchedulerTcpMessage ( const QString &  uuid )

explicit

Constructs a SchedulerTcpMessage.

~SchedulerTcpMessage()

~SchedulerTcpMessage ( )

overridedefault

SchedulerTcpMessage destructor.

Member Function Documentation

getAuthenticationFrameworkVersion()

const QString & getAuthenticationFrameworkVersion

(

)

const

Returns the authentication framework version.

Returns

the authentication framework version.

getAuthenticationProvider()

const QString & getAuthenticationProvider

(

)

const

Gets the provider associated with this message.

Returns

the provider.

getAuthenticationProviderVersion()

const QString & getAuthenticationProviderVersion

(

)

const

Gets the provider version associated with this message.

Returns

the provider version.

getCredentials()

const QString & getCredentials

(

)

const

Gets the credentials associated with this message.

Returns

the credentials.

getMessageToken()

const QString & getMessageToken

(

)

const

Gets the message token associated with this message.

Returns

the message token.

getSchedulerVersion()

const QString & getSchedulerVersion

(

)

const

Sets the version of the scheduler from which this message originated.

Returns

the scheduler version that generated this message.

getUuid()

const QString & getUuid

(

)

Returns the uuid associated with this message.

Returns

the message's uuid.

readMessageDataFrom()

bool readMessageDataFrom ( QDataStream &  stream )

overridevirtual

Reads a SchedulerTcpMessage's data from a stream.

Parameters

stream

the stream from which a SchedulerTcpMessage's data is to be read.

Reimplemented from TcpMessage.

Reimplemented in ScheduleWorkspaceExecutionMessage, ServerLoadMessage, WorkspaceLogMessage, and WorkspaceTcpMessage.

setAuthenticationProvider()

void setAuthenticationProvider

(

const QString &

val

)

Sets the provider associated with this message.

Parameters

val	the provider.

setAuthenticationProviderVersion()

void setAuthenticationProviderVersion

(

const QString &

val

)

Sets the provider version associated with this message.

Parameters

val	the provider version.

setCredentials()

void setCredentials

(

const QString &

val

)

Sets the credentials associated with this message.

Parameters

val	the credentials.

setMessageToken()

void setMessageToken

(

const QString &

val

)

Sets the message token associated with this message.

Parameters

val	the message token.

setSchedulerVersion()

void setSchedulerVersion

(

const QString &

version

)

Sets the version of the scheduler from which this message originated.

Parameters

version

the scheduler version that generated this message.

setUuid()

void setUuid

(

const QString &

uuid

)

Sets the SchedulerTcpMessage's uuid.

Parameters

uuid	the uuid to set

writeMessageDataTo()

void writeMessageDataTo ( QDataStream &  messageDataStream )

overrideprotectedvirtual

Writes a SchedulerTcpMessage's data to a stream.

Parameters

messageDataStream

the stream to which a SchedulerTcpMessage's data is written.

Reimplemented from TcpMessage.

Reimplemented in ScheduleWorkspaceExecutionMessage, ServerLoadMessage, WorkspaceLogMessage, and WorkspaceTcpMessage.

Member Data Documentation

authenticationFrameworkVersion_

QString authenticationFrameworkVersion_

protected

authenticationProvider_

QString authenticationProvider_

protected

authenticationProviderVersion_

QString authenticationProviderVersion_

protected

credentials_

QString credentials_

protected

messageToken_

QString messageToken_

protected

schedulerVersion_

QString schedulerVersion_

protected

uuid_

QString uuid_

protected