ListResponseMsg Class Reference

When a list request has been completed, a list response is returned to the server containing the details of the requested items.

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

Inheritance diagram for ListResponseMsg:

Public Member Functions
	ListResponseMsg ()
ListMsg::IOType	getIOType () const
const QUuid &	getListId () const
quint32	getMessageTypeId () const override
const QString &	getResultsList () const
bool	readMessageDataFrom (QDataStream &) override
void	setIOType (ListMsg::IOType type)
void	setListId (const QUuid &listId)
void	setResultsList (const QString &resultsList)
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
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 &)

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

Constructor & Destructor Documentation

ListResponseMsg()

ListResponseMsg

(

)

Member Function Documentation

getIOType()

ListMsg::IOType getIOType

(

)

const

getListId()

const QUuid & getListId

(

)

const

getMessageTypeId()

quint32 getMessageTypeId ( ) const

inlineoverridevirtual

Returns the message's type identifier.

Reimplemented from TcpMessage.

getResultsList()

const QString & getResultsList

(

)

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.

setIOType()

void setIOType

(

ListMsg::IOType

type

)

setListId()

void setListId

(

const QUuid &

listId

)

setResultsList()

void setResultsList

(

const QString &

resultsList

)

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.