HandshakeMessage Class Reference

Handshake between client and server to check server available. Server will use this message to pass a session ID to identify a client.

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

Inheritance diagram for HandshakeMessage:

Public Member Functions
	HandshakeMessage ()
	~HandshakeMessage () override
quint32	getMessageTypeId () const override
bool	readMessageDataFrom (QDataStream &) override
QString	serverID () const
qint64	serverTimeMSecsSinceEPoch () const
QString	sessionID () const
void	setServerID (const QString &serverID)
void	setSessionID (const QString &sessionID)
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 &)

Protected Attributes
QString	serverID_
qint64	serverTimeMSecsSinceEpoch_
QString	sessionID_
Protected Attributes inherited from SchedulerTcpMessage
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

HandshakeMessage()

HandshakeMessage

(

)

~HandshakeMessage()

~HandshakeMessage ( )

overridedefault

Member Function Documentation

getMessageTypeId()

quint32 getMessageTypeId ( ) const

overridevirtual

Returns the message's type identifier.

Reimplemented from TcpMessage.

readMessageDataFrom()

bool readMessageDataFrom ( QDataStream &  stream )

overridevirtual

This method should be overridden in TcpMessage derived messages to provide message specific reading.

See also

writeMessageDataTo()

Reimplemented from TcpMessage.

serverID()

QString serverID ( ) const

inline

Returns

a token to identify a server.

serverTimeMSecsSinceEPoch()

qint64 serverTimeMSecsSinceEPoch ( ) const

inline

Returns

time of server when it sends this message.

sessionID()

QString sessionID ( ) const

inline

Returns

a token to identify a client.

setServerID()

void setServerID ( const QString &  serverID )

inline

Parameters

serverID

a token to identify a server.

setSessionID()

void setSessionID ( const QString &  sessionID )

inline

Parameters

sessionID

a token to identify a client.

writeMessageDataTo()

void writeMessageDataTo ( QDataStream &  stream )

overrideprotectedvirtual

This method should be overridden in TcpMessage derived messages to provide message specific writing.

See also

readMessageDataFrom()

Reimplemented from TcpMessage.

Member Data Documentation

serverID_

QString serverID_

protected

serverTimeMSecsSinceEpoch_

qint64 serverTimeMSecsSinceEpoch_

protected

sessionID_

QString sessionID_

protected