Workspace 6.21.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ClientHeartbeatMessage Class Reference

Heartbeat between client and server to check server available. Client will constantly send this and server should reply as soon as possible.

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

Inheritance diagram for ClientHeartbeatMessage:
[legend]

Public Member Functions

 ClientHeartbeatMessage ()
 
 ~ClientHeartbeatMessage () override
 
quint32 getMessageTypeId () const override
 
bool readMessageDataFrom (QDataStream &) override
 
qint64 serverTimeMSecsSinceEPoch () const
 
- 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
 
TcpMessageoperator= (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

qint64 serverTimeMSecsSinceEpoch_
 
- 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

◆ ClientHeartbeatMessage()

◆ ~ClientHeartbeatMessage()

~ClientHeartbeatMessage ( )
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.

◆ serverTimeMSecsSinceEPoch()

qint64 serverTimeMSecsSinceEPoch ( ) const
inline
Returns
time of server when it sends this message.

◆ 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

◆ serverTimeMSecsSinceEpoch_

qint64 serverTimeMSecsSinceEpoch_
protected