The CloseConnection class - This commanad is request for close connection on parent node of connection. This is necessary because QAbstractSocket emit error when connection closed from remote node. More...

#include <closeconnection.h>

Inheritance diagram for QH::PKG::CloseConnection:

Collaboration diagram for QH::PKG::CloseConnection:

Public Member Functions
	CloseConnection ()

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.

Protected Member Functions
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.

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.

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

Detailed Description

The CloseConnection class - This commanad is request for close connection on parent node of connection. This is necessary because QAbstractSocket emit error when connection closed from remote node.

From QtDocumentation:

If the remote host closes the connection, QAbstractSocket will emit errorOccurred(QAbstractSocket::RemoteHostClosedError), during which the socket state will still be ConnectedState, and then the disconnected() signal will be emitted.

Definition at line 28 of file closeconnection.h.

Constructor & Destructor Documentation

◆ CloseConnection()

QH::PKG::CloseConnection::CloseConnection ( )

Definition at line 14 of file closeconnection.cpp.

Member Function Documentation

◆ fromStream()

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

overrideprotectedvirtual

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 18 of file closeconnection.cpp.

◆ toStream()

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

overrideprotectedvirtual

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 22 of file closeconnection.cpp.

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

src/public/packages/closeconnection.h
src/public/packages/closeconnection.cpp

Public Member Functions