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

Message for a list request (asking for a list of inputs / outputs / globalNames)

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

Inheritance diagram for ListMsg:
[legend]

Public Types

enum  IOType { IOInput = 0 , IOOutput = 1 , IOGlobalName = 2 }
 

Public Member Functions

 ListMsg ()
 
IOType getIOType () const
 
quint32 getMessageTypeId () const override
 
const QUuid & getRequestId () const
 
bool readMessageDataFrom (QDataStream &) override
 
void setIOType (IOType)
 
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 &)
 

Member Enumeration Documentation

◆ IOType

enum IOType
Enumerator
IOInput 
IOOutput 
IOGlobalName 

Constructor & Destructor Documentation

◆ ListMsg()

ListMsg ( )

Member Function Documentation

◆ getIOType()

ListMsg::IOType getIOType ( ) const

◆ getMessageTypeId()

quint32 getMessageTypeId ( ) const
inlineoverridevirtual

Returns the message's type identifier.

Reimplemented from TcpMessage.

◆ getRequestId()

const QUuid & getRequestId ( ) 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 ( IOType  type)

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