AbortedWorkspaceUpdateMessage Class Reference

Represents a message sent by a remote scheduler to a workspace client indicating that the remotely executing workspace has aborted updating.

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

Inheritance diagram for AbortedWorkspaceUpdateMessage:

Public Member Functions
	AbortedWorkspaceUpdateMessage ()
	AbortedWorkspaceUpdateMessage (const QString &uuid, const AbortReason &abortReason)
	~AbortedWorkspaceUpdateMessage () override
const AbortReason &	getAbortReason () const
quint32	getMessageTypeId () const override
bool	readMessageDataFrom (QDataStream &) override
Public Member Functions inherited from SchedulerTcpMessage
	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
Protected Member Functions inherited from SchedulerTcpMessage
void	writeMessageDataTo (QDataStream &) override
virtual void	writeMessageDataTo (QDataStream &)

Additional Inherited Members
Static Public Member Functions inherited from TcpMessage
static void	configureStream (QDataStream &)
Protected Attributes inherited from SchedulerTcpMessage
QString	authenticationFrameworkVersion_
QString	authenticationProvider_
QString	authenticationProviderVersion_
QString	credentials_
QString	messageToken_
QString	schedulerVersion_
QString	uuid_

Constructor & Destructor Documentation

AbortedWorkspaceUpdateMessage() [1/2]

AbortedWorkspaceUpdateMessage ( )

default

AbortedWorkspaceUpdateMessage() [2/2]

AbortedWorkspaceUpdateMessage	(	const QString &	uuid,
		const AbortReason &	abortReason
	)

~AbortedWorkspaceUpdateMessage()

~AbortedWorkspaceUpdateMessage ( )

overridedefault

Member Function Documentation

getAbortReason()

const AbortReason & getAbortReason ( ) const

inline

getMessageTypeId()

quint32 getMessageTypeId ( ) const

overridevirtual

Returns the message's type identifier.

Reimplemented from TcpMessage.

readMessageDataFrom()

bool readMessageDataFrom ( QDataStream &  stream )

overridevirtual

Reads a AbortedWorkspaceUpdateMessage's data from a stream.

Parameters

stream

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

Reimplemented from TcpMessage.

writeMessageDataTo()

void writeMessageDataTo ( QDataStream &  messageDataStream )

overrideprotectedvirtual

Writes a AbortedWorkspaceUpdateMessage's data to a stream.

Parameters

messageDataStream

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

Reimplemented from TcpMessage.