The AbstractNodeInfo class contains information about client or server connection and tcp socket of node. All node Info classes must be initialized in the AbstractNode::createNodeInfo methods. This implementation of nodeInf contains only trust of node and network socket. More...

#include <abstractnodeinfo.h>

Inheritance diagram for QH::AbstractNodeInfo:

Collaboration diagram for QH::AbstractNodeInfo:

Public Slots
virtual void	removeSocket ()
	removeSocket This method use for remove socket. You can override this method for handle this event.

Signals
void	sigConnected (QH::AbstractNodeInfo *thisNode)
	sigConnected This is wrapper signal for the QAbstractSocket::connetced signal.

void	sigDisconnected (QH::AbstractNodeInfo *thisNode)
	sigDisconnected This is wrapper signal for the QAbstractSocket::disconnected signal.

void	sigReadyRead (QH::AbstractNodeInfo *thisNode)
	sigReadyRead This is wrapper signal for the QAbstractSocket::readyRead signal.

void	sigErrorOccurred (QH::AbstractNodeInfo *thisNode, QAbstractSocket::SocketError socketError, QString message)
	sigErrorOccurred This is wrapper signal for the QAbstractSocket::errorOccurred signal.

void	sigConfirmed (QH::AbstractNodeInfo *thisNode)
	sigConfirmed This signal emitted when node is confirmnd. The confirm status sets in the confirmData method.

void	statusChaned (QH::AbstractNodeInfo *thisNode, QH::NodeCoonectionStatus status)
	statusChaned This signal emitted when nodes status is changed.

Public Member Functions
	AbstractNodeInfo (QAbstractSocket sct=nullptr, const HostAddress address=nullptr)
	AbstractNodeInfo.

virtual	~AbstractNodeInfo ()
	~AbstractNodeInfo

QAbstractSocket *	sct () const
	sct This method return socket of connection.

virtual void	ban ()
	ban This node, set trust value to 0.

virtual bool	isBanned () const
	isBanned - check node which banned.

virtual void	unBan ()
	unBan - Set trust value of node to TrustNode::Restore. See TrustNode enum for more information.

virtual int	trust () const
	trust - Show current value of trust level node or client.

virtual void	setTrust (int trust)
	setTrust This method set manually value of this node trust.

virtual bool	isValid () const
	isValid - Check valid of node. This method check connect status of socket.

virtual bool	isConnected () const
	isConnected - Check of node connect status.

virtual void	reset ()
	reset This method reset all fields of the nodeInfo.

QHostInfo *	info () const
	info - This method return Host domain information. For more information see the Qt Documentation about QHostInfo.

void	setInfo (const QHostInfo &info)
	setInfo - Set new host info for this node.

HostAddress	networkAddress () const
	networkAddress This method return network address of current node or client.

void	setNetworkAddress (const HostAddress &networkAddress)
	setNetworkAddress This method update network address of the current node.

NodeCoonectionStatus	status () const
	status This method return status of the node connection.

void	setStatus (const NodeCoonectionStatus &status)
	setStatus This method Sets new value of status node.

void	updateConfirmStatus ()
	updateConfirmStatus This method invoked after process a received package and update confirm status of the node.

bool	isLocal () const
	isLocal return true if connection opened on this node.

void	setIsLocal (bool isLocal)
	setIsLocal This method sets local status for this Node.

void	setSct (QAbstractSocket *sct)
	setSct This method sets a new socket for this node or client.

const VersionData &	version () const
	version This method return version data structure;

void	setVersion (const VersionData &newVersion)
	setVersion This method sets new version data structure.

bool	fVersionReceived () const
	fVersionReceived This method return true if this node receive version information.

void	setFVersionReceived (bool newFVersionReceived)
	setFVersionReceived This method change the fVersionReceived flag.

bool	fVersionDelivered () const
	fVersionDelivered This method return true if this node delivere own version to the distanation node.

void	setFVersionDelivered (bool newFVersionDelivered)
	setFVersionDelivered This method change the fVersionDelivered flag.

QSharedPointer< QH::iParser >	getParser (unsigned short cmd)
	getParser This method return parser of choosed command.

QSharedPointer< QH::iParser >	getParser (const QString &type)
	getParser This method return parser of choosed command.

void	addParser (unsigned short cmd, QSharedPointer< QH::iParser > parser)
	addParser This method add to cache new parser for command .

void	addParser (QSharedPointer< QH::iParser > parser)
	addParser This method add to cache new parser for command .

const PackagesVersionData &	multiVersionPackages () const
	multiVersionPackages This is list of packages of one api package tah support multiple versions.

void	setMultiVersionPackages (const PackagesVersionData &newMultiVersionPackages)
	setMultiVersionPackages This method sets new list of multi-version packages.

Protected Member Functions
virtual bool	confirmData () const
	confirmData This method check all data of node and return true. If node is confirmed.

Detailed Description

The AbstractNodeInfo class contains information about client or server connection and tcp socket of node. All node Info classes must be initialized in the AbstractNode::createNodeInfo methods. This implementation of nodeInf contains only trust of node and network socket.

Definition at line 67 of file abstractnodeinfo.h.

Constructor & Destructor Documentation

◆ AbstractNodeInfo()

QH::AbstractNodeInfo::AbstractNodeInfo	(	QAbstractSocket *	sct = `nullptr`,
		const HostAddress *	address = `nullptr`
	)

AbstractNodeInfo.

Parameters

sct	Socket of connection
address	- Address of socket

Definition at line 19 of file abstractnodeinfo.cpp.

Here is the call graph for this function:

◆ ~AbstractNodeInfo()

QH::AbstractNodeInfo::~AbstractNodeInfo ( )

virtual

~AbstractNodeInfo

Definition at line 27 of file abstractnodeinfo.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ addParser() [1/2]

void QH::AbstractNodeInfo::addParser ( QSharedPointer< QH::iParser > parser )

addParser This method add to cache new parser for command .

Parameters

parser This is added parser.

Note: All parsers will be removed after reconnect of this node.

◆ addParser() [2/2]

void QH::AbstractNodeInfo::addParser	(	unsigned short	cmd,
		QSharedPointer< QH::iParser >	parser
	)

addParser This method add to cache new parser for command .

Parameters

cmd	This is any command that support this parser.
parser	This is added parser.

Note: All parsers will be removed after reconnect of this node.

Definition at line 249 of file abstractnodeinfo.cpp.

◆ ban()

void QH::AbstractNodeInfo::ban ( )

virtual

ban This node, set trust value to 0.

Definition at line 59 of file abstractnodeinfo.cpp.

Here is the call graph for this function:

◆ confirmData()

bool QH::AbstractNodeInfo::confirmData ( ) const

protectedvirtual

confirmData This method check all data of node and return true. If node is confirmed.

Returns: true if node is confirmed.

Definition at line 130 of file abstractnodeinfo.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fVersionDelivered()

bool QH::AbstractNodeInfo::fVersionDelivered ( ) const

fVersionDelivered This method return true if this node delivere own version to the distanation node.

Returns: true if this node delivere own version to the distanation node.

Definition at line 142 of file abstractnodeinfo.cpp.

Here is the caller graph for this function:

◆ fVersionReceived()

bool QH::AbstractNodeInfo::fVersionReceived ( ) const

fVersionReceived This method return true if this node receive version information.

Returns: true if this node receive version information.

Definition at line 150 of file abstractnodeinfo.cpp.

Here is the caller graph for this function:

◆ getParser() [1/2]

QSharedPointer< iParser > QH::AbstractNodeInfo::getParser ( const QString & type )

getParser This method return parser of choosed command.

Parameters

type	This is type of api parser.

Returns: parser by type.

Definition at line 243 of file abstractnodeinfo.cpp.

◆ getParser() [2/2]

QSharedPointer< QH::iParser > QH::AbstractNodeInfo::getParser ( unsigned short cmd )

getParser This method return parser of choosed command.

Parameters

cmd	This is command that need to parse.

Returns: parser of the cmd comand.

Definition at line 237 of file abstractnodeinfo.cpp.

◆ info()

QHostInfo * QH::AbstractNodeInfo::info ( ) const

info - This method return Host domain information. For more information see the Qt Documentation about QHostInfo.

Returns: Host info of this node.

Definition at line 199 of file abstractnodeinfo.cpp.

Here is the caller graph for this function:

◆ isBanned()

bool QH::AbstractNodeInfo::isBanned ( ) const

virtual

isBanned - check node which banned.

Returns: true if the node is banned.

Definition at line 64 of file abstractnodeinfo.cpp.

Here is the caller graph for this function:

◆ isConnected()

bool QH::AbstractNodeInfo::isConnected ( ) const

virtual

isConnected - Check of node connect status.

Returns: true if the socket connected.

Definition at line 221 of file abstractnodeinfo.cpp.

Here is the caller graph for this function:

◆ isLocal()

bool QH::AbstractNodeInfo::isLocal ( ) const

isLocal return true if connection opened on this node.

Returns: True if connection is opened on this host.

Definition at line 171 of file abstractnodeinfo.cpp.

Here is the caller graph for this function:

◆ isValid()

bool QH::AbstractNodeInfo::isValid ( ) const

virtual

isValid - Check valid of node. This method check connect status of socket.

Returns: true if node or client is valid.

Definition at line 217 of file abstractnodeinfo.cpp.

Here is the caller graph for this function:

◆ multiVersionPackages()

const PackagesVersionData & QH::AbstractNodeInfo::multiVersionPackages ( ) const

multiVersionPackages This is list of packages of one api package tah support multiple versions.

Returns: list of packages of one api package tah support multiple versions.

Definition at line 134 of file abstractnodeinfo.cpp.

Here is the caller graph for this function:

◆ networkAddress()

HostAddress QH::AbstractNodeInfo::networkAddress ( ) const

networkAddress This method return network address of current node or client.

Returns: network address of node.

Definition at line 175 of file abstractnodeinfo.cpp.

Here is the caller graph for this function:

◆ removeSocket

void QH::AbstractNodeInfo::removeSocket ( )

virtualslot

removeSocket This method use for remove socket. You can override this method for handle this event.

Note: This method woll be ignored when object distroed

Definition at line 35 of file abstractnodeinfo.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

void QH::AbstractNodeInfo::reset ( )

virtual

reset This method reset all fields of the nodeInfo.

Note: override this method if your node info has new fields.

Definition at line 225 of file abstractnodeinfo.cpp.

◆ sct()

QAbstractSocket * QH::AbstractNodeInfo::sct ( ) const

sct This method return socket of connection.

Returns: return socket of connection.

Definition at line 31 of file abstractnodeinfo.cpp.

Here is the caller graph for this function:

◆ setFVersionDelivered()

void QH::AbstractNodeInfo::setFVersionDelivered ( bool newFVersionDelivered )

setFVersionDelivered This method change the fVersionDelivered flag.

Parameters

newFVersionDelivered this is new value of the fVersionDelivered flag.

Definition at line 146 of file abstractnodeinfo.cpp.

◆ setFVersionReceived()

void QH::AbstractNodeInfo::setFVersionReceived ( bool newFVersionReceived )

setFVersionReceived This method change the fVersionReceived flag.

Parameters

newFVersionReceived this is new value of the fVersionReceived flag.

Definition at line 154 of file abstractnodeinfo.cpp.

◆ setInfo()

void QH::AbstractNodeInfo::setInfo ( const QHostInfo & info )

setInfo - Set new host info for this node.

Parameters

info	- host info.

Definition at line 192 of file abstractnodeinfo.cpp.

◆ setIsLocal()

void QH::AbstractNodeInfo::setIsLocal ( bool isLocal )

setIsLocal This method sets local status for this Node.

Parameters

isLocal This is a new value.

Definition at line 112 of file abstractnodeinfo.cpp.

Here is the call graph for this function:

◆ setMultiVersionPackages()

void QH::AbstractNodeInfo::setMultiVersionPackages ( const PackagesVersionData & newMultiVersionPackages )

setMultiVersionPackages This method sets new list of multi-version packages.

Parameters

newMultiVersionPackages This is new value of multi-version packages.

Definition at line 138 of file abstractnodeinfo.cpp.

◆ setNetworkAddress()

void QH::AbstractNodeInfo::setNetworkAddress ( const HostAddress & networkAddress )

setNetworkAddress This method update network address of the current node.

Parameters

networkAddress new address.

Definition at line 179 of file abstractnodeinfo.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSct()

void QH::AbstractNodeInfo::setSct ( QAbstractSocket * sct )

setSct This method sets a new socket for this node or client.

Parameters

sct	This is a new valuse of the socket.

Definition at line 72 of file abstractnodeinfo.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStatus()

void QH::AbstractNodeInfo::setStatus ( const NodeCoonectionStatus & status )

setStatus This method Sets new value of status node.

Parameters

status This is a new status of the node.

Definition at line 120 of file abstractnodeinfo.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTrust()

void QH::AbstractNodeInfo::setTrust ( int trust )

virtual

setTrust This method set manually value of this node trust.

Parameters

trust - new value.

Definition at line 207 of file abstractnodeinfo.cpp.

◆ setVersion()

void QH::AbstractNodeInfo::setVersion ( const VersionData & newVersion )

setVersion This method sets new version data structure.

Parameters

newVersion This is new values of the version.

Definition at line 162 of file abstractnodeinfo.cpp.

◆ sigConfirmed

void QH::AbstractNodeInfo::sigConfirmed ( QH::AbstractNodeInfo * thisNode )

signal

sigConfirmed This signal emitted when node is confirmnd. The confirm status sets in the confirmData method.

Parameters

thisNode This is pointer to current object.

◆ sigConnected

void QH::AbstractNodeInfo::sigConnected ( QH::AbstractNodeInfo * thisNode )

signal

sigConnected This is wrapper signal for the QAbstractSocket::connetced signal.

Parameters

thisNode This is pointer to current object.

Here is the caller graph for this function:

◆ sigDisconnected

void QH::AbstractNodeInfo::sigDisconnected ( QH::AbstractNodeInfo * thisNode )

signal

sigDisconnected This is wrapper signal for the QAbstractSocket::disconnected signal.

Parameters

thisNode This is pointer to current object.

Here is the caller graph for this function:

◆ sigErrorOccurred

void QH::AbstractNodeInfo::sigErrorOccurred	(	QH::AbstractNodeInfo *	thisNode,
		QAbstractSocket::SocketError	socketError,
		QString	message
	)

signal

sigErrorOccurred This is wrapper signal for the QAbstractSocket::errorOccurred signal.

Parameters

thisNode	This is pointer to current object.
socketError	This is socket error code.
message	This is a error string message. For more information see the QAbstractSocket::SocketError enum class.

Here is the caller graph for this function:

◆ sigReadyRead

void QH::AbstractNodeInfo::sigReadyRead ( QH::AbstractNodeInfo * thisNode )

signal

sigReadyRead This is wrapper signal for the QAbstractSocket::readyRead signal.

Parameters

thisNode This is pointer to current object.

Here is the caller graph for this function:

◆ status()

NodeCoonectionStatus QH::AbstractNodeInfo::status ( ) const

status This method return status of the node connection.

Returns: connection status for more info see NodeCoonectionStatus.

Definition at line 116 of file abstractnodeinfo.cpp.

Here is the caller graph for this function:

◆ statusChaned

void QH::AbstractNodeInfo::statusChaned	(	QH::AbstractNodeInfo *	thisNode,
		QH::NodeCoonectionStatus	status
	)

signal

statusChaned This signal emitted when nodes status is changed.

Parameters

thisNode	This is pointer to current object.
status	This is status of node. For more information see the NodeCoonectionStatus enum.

Here is the caller graph for this function:

◆ trust()

int QH::AbstractNodeInfo::trust ( ) const

virtual

trust - Show current value of trust level node or client.

Returns: current trust value.

Definition at line 203 of file abstractnodeinfo.cpp.

◆ unBan()

void QH::AbstractNodeInfo::unBan ( )

virtual

unBan - Set trust value of node to TrustNode::Restore. See TrustNode enum for more information.

Definition at line 68 of file abstractnodeinfo.cpp.

◆ updateConfirmStatus()

void QH::AbstractNodeInfo::updateConfirmStatus ( )

updateConfirmStatus This method invoked after process a received package and update confirm status of the node.

Definition at line 166 of file abstractnodeinfo.cpp.

Here is the call graph for this function:

◆ version()

const VersionData & QH::AbstractNodeInfo::version ( ) const

version This method return version data structure;

Returns: version data structure;

Definition at line 158 of file abstractnodeinfo.cpp.

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

src/public/abstractnodeinfo.h
src/public/abstractnodeinfo.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AbstractNodeInfo()

◆ ~AbstractNodeInfo()

Member Function Documentation

◆ addParser() [1/2]

◆ addParser() [2/2]

◆ ban()

◆ confirmData()

◆ fVersionDelivered()

◆ fVersionReceived()

◆ getParser() [1/2]

◆ getParser() [2/2]

◆ info()

◆ isBanned()

◆ isConnected()

◆ isLocal()

◆ isValid()

◆ multiVersionPackages()

◆ networkAddress()

◆ removeSocket

◆ reset()

◆ sct()

◆ setFVersionDelivered()

◆ setFVersionReceived()

◆ setInfo()

◆ setIsLocal()

◆ setMultiVersionPackages()

◆ setNetworkAddress()

◆ setSct()

◆ setStatus()

◆ setTrust()

◆ setVersion()

◆ sigConfirmed

◆ sigConnected

◆ sigDisconnected

◆ sigErrorOccurred

◆ sigReadyRead

◆ status()

◆ statusChaned

◆ trust()

◆ unBan()

◆ updateConfirmStatus()

◆ version()