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

Message for when a watch is cancelled.

#include <Workspace/Application/Web/TcpMessages/watchcancelmsg.h>

Inheritance diagram for WatchCancelMsg:
[legend]

Public Member Functions

 WatchCancelMsg ()
 
quint32 getMessageTypeId () const override
 
const QUuid & getWatchId () const
 
bool readMessageDataFrom (QDataStream &) override
 
void setWatchId (const QUuid &watchId)
 
bool visitHandler (WebTcpMessageHandler &handler, QTcpSocket *socket) override
 
virtual bool visitHandler (WebTcpMessageHandler &handler, QTcpSocket *socket)=0
 
- 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
 
virtual void writeMessageDataTo (QDataStream &)
 

Additional Inherited Members

- Static Public Member Functions inherited from TcpMessage
static void configureStream (QDataStream &)
 

Constructor & Destructor Documentation

◆ WatchCancelMsg()

WatchCancelMsg ( )
default

Member Function Documentation

◆ getMessageTypeId()

quint32 getMessageTypeId ( ) const
inlineoverridevirtual

Returns the message's type identifier.

Reimplemented from TcpMessage.

◆ getWatchId()

const QUuid & getWatchId ( ) const

◆ 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.

◆ setWatchId()

void setWatchId ( const QUuid &  watchId)

◆ visitHandler()

bool visitHandler ( WebTcpMessageHandler handler,
QTcpSocket *  socket 
)
overridevirtual

Implements WebTcpMessage.

◆ 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.