QH::PKG::BadRequest Class Reference

The BadRequest class send response about error to client. More...

#include <badrequest.h>

Inheritance diagram for QH::PKG::BadRequest:

Collaboration diagram for QH::PKG::BadRequest:

Public Member Functions
	BadRequest (unsigned char errocode=ErrorCodes::InvalidRequest, const QString &err="")
	BadRequest.
	BadRequest (const ErrorData &data)
	BadRequest Init BadRequest from the ErrorData struct.
	BadRequest (const Package &package)
QString	err () const
	err This method return a text of error message.
void	setErr (const QString &err)
	setErr - Set a error message.
QDataStream &	fromStream (QDataStream &stream) override
	fromStream This method should be read all bytes from the stream object and full the current object.
QDataStream &	toStream (QDataStream &stream) const override
	fromStream This method should be write all members of the current object to the stream object.
unsigned char	errCode () const
	errCode This method return code of error.
void	setErrCode (unsigned char code)
	setErrCode This method set error code.
Public Member Functions inherited from QH::PKG::AbstractData
	~AbstractData () override
virtual unsigned short	cmd () const =0
	cmd - This is command of this object, (for generate cmd use macross QH_PACKAGE)
virtual QString	cmdString () const =0
	cmdString - This is command string of this object, (for generate cmd use macross QH_PACKAGE)
virtual bool	toPackage (Package &package, const DistVersion &reqVersion, unsigned int triggerHash=0) const
	toPackage This method convert this class object to the package. For more info see Package class.
virtual bool	isValid () const
	isValid This method check current object to valid.
QString	toString () const override
	toString - Return a string implementation for this object.
template<class C , class... Args>
C *	create (Args &&... args) const
	create - This is factory method for create a new object.
void	fromPakcage (const Package &pkg)
	fromPakcage - This method initialize the current object from a package class object.
Public Member Functions inherited from QH::StreamBase
	StreamBase ()
virtual	~StreamBase ()
bool	fromBytes (const QByteArray &data)
	fromBytes This method provide initialization of object from byte array.
QByteArray	toBytes () const
	toBytes This method convert a current object to bytes array.
bool	fromBase64 (const QString &data)
	fromBase64 This method provide initialization of object from the base64 string.
bool	fromBase64 (const QByteArray &data)
	fromBase64 This method provide initialization of object from the base64 string.
QByteArray	toBase64 () const
	toBase64 This method convert a current object to the base64 string.
template<class T >
T &	copy (const StreamBase &right)
	copy This is base copy method for all StreamBase structures. Default implementation it is copy from byteArray.
template<class T >
bool	compare (const T &right)
	compare This method compare array signatures of this and right objects.

Additional Inherited Members
Static Public Member Functions inherited from QH::PKG::AbstractData
static unsigned int	command ()
	command This static method that return glaball code of this object.
static QString	commandText ()
	commandText This method return text of package command
Protected Member Functions inherited from QH::PKG::AbstractData
	AbstractData ()
	AbstractData - Base constructor of this object.
Protected Member Functions inherited from QH::StreamBase
virtual int	parsingVersion () const
	parsingVersion this method return parsing version of Qt. By Default is 0 (last available parsing). see https://doc.qt.io/qt-6/qdatastream.html#Version-enum
virtual unsigned int	typeId () const
	typeId This method return id of type.

Detailed Description

The BadRequest class send response about error to client.

Definition at line 34 of file badrequest.h.

Constructor & Destructor Documentation

BadRequest() [1/3]

QH::PKG::BadRequest::BadRequest ( unsigned char  errocode = ErrorCodes::InvalidRequest, const QString &  err = ""  )

explicit

BadRequest.

Parameters

errocode	This is error code.
err	This is error message.

Definition at line 16 of file badrequest.cpp.

Here is the call graph for this function:

BadRequest() [2/3]

QH::PKG::BadRequest::BadRequest ( const ErrorData &  data )

explicit

BadRequest Init BadRequest from the ErrorData struct.

Parameters

data	This is error data. for more information see the ErrorData struct.

Definition at line 21 of file badrequest.cpp.

BadRequest() [3/3]

QH::PKG::BadRequest::BadRequest ( const Package &  package )

explicit

Definition at line 25 of file badrequest.cpp.

Here is the call graph for this function:

Member Function Documentation

err()

QString QH::PKG::BadRequest::err

(

)

const

err This method return a text of error message.

Returns

Text of error message.

Definition at line 54 of file badrequest.cpp.

Here is the caller graph for this function:

errCode()

unsigned char QH::PKG::BadRequest::errCode

(

)

const

errCode This method return code of error.

Returns

Code of error.

Definition at line 45 of file badrequest.cpp.

fromStream()

QDataStream & QH::PKG::BadRequest::fromStream ( QDataStream &  stream )

overridevirtual

fromStream This method should be read all bytes from the stream object and full the current object.

Note

The implementation of this method should be invoke a method of base class.

Parameters

stream

This is Qt stream object.

Returns

Qt stream object.

Examle of base simple implementation:

QDataStream &ExampleClass::fromStream(QDataStream &stream) const {
    StreamBase::toStream(stream);
    stream >> exampleMember;
    return stream;
}

Implements QH::StreamBase.

Definition at line 30 of file badrequest.cpp.

setErr()

void QH::PKG::BadRequest::setErr

(

const QString &

err

)

setErr - Set a error message.

Parameters

err	- Message of error.

Definition at line 58 of file badrequest.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

setErrCode()

void QH::PKG::BadRequest::setErrCode

(

unsigned char

code

)

setErrCode This method set error code.

Parameters

code	This is new value of error.

Definition at line 50 of file badrequest.cpp.

Here is the caller graph for this function:

toStream()

QDataStream & QH::PKG::BadRequest::toStream ( QDataStream &  stream ) const

overridevirtual

fromStream This method should be write all members of the current object to the stream object.

Note

The implementation of this method should be invoke a method of base class.

Parameters

stream

This is Qt stream object.

Returns

Qt stream object.

Examle of base simple implementation:

QDataStream &ExampleClass::toStream(QDataStream &stream) const {
    StreamBase::toStream(stream);
    stream << exampleMember;
    return stream;
}

Implements QH::StreamBase.

Definition at line 37 of file badrequest.cpp.

---

The documentation for this class was generated from the following files:

• src/public/packages/badrequest.h
• src/public/packages/badrequest.cpp