The APIVersionParser class This is main parser forthe main command. This parsers work only with the APIVersion packge;. More...

#include <apiversionparser.h>

Inheritance diagram for QH::APIVersionParser:

Collaboration diagram for QH::APIVersionParser:

Signals
void	sigNoLongerSupport (const QString &ApiKey, unsigned short version)
	sigNoLongerSupport This signal will be emit when node receive incomplite versions.

Public Member Functions
	APIVersionParser (AbstractNode *node)

ParserResult	parsePackage (const QSharedPointer< PKG::AbstractData > &pkg, const Header &pkgHeader, AbstractNodeInfo *sender) override
	parsePackage This is main method of all childs classes of an AbstractNode class. This method work on own thread. If you ovveride this method you need to create this than an example:

int	version () const override
	version This method return version of parser object

QString	parserId () const override
	parserId This is id of the parsers. All parser will be synced betwin nodes by ids.

QString	toString () const override
	toString This method show all supported commands and them names.

QSharedPointer< PKG::AbstractData >	searchPackage (unsigned short cmd, AbstractNodeInfo *sender) const
	searchPackage This method search package recursive in all registered pararsers. Searching will be in compatibility versions. Before search methd choose compatibly verson.

QSharedPointer< iParser >	getSelectedApiParser (const QString &apiKey, QH::AbstractNodeInfo *node) const
	getSelectedApiParser This method return apiParser for selected node

const QSharedPointer< QH::iParser > &	addApiParser (const QSharedPointer< QH::iParser > &parserObject)
	addApiParser This method add new Api parser for this node.

QHash< QString, QSharedPointer< QH::iParser > >	selectParser (const VersionData &distVersion) const
	selectParser This method select api parser betwin nodes.

unsigned int	parsersTypedCount () const
	parsersTypedCount This method return count of the parsers types.

QSharedPointer< QH::iParser >	selectParser (unsigned short cmd, AbstractNodeInfo *sender) const
	selectParser This method select parser by command and sender.

QSharedPointer< QH::iParser >	selectParser (const QString &parserKey, unsigned short version) const
	selectParser This method select parser by command and sender.

QSharedPointer< QH::iParser >	selectParser (const QString &parserKey, AbstractNodeInfo *sender) const
	selectParser This method select parser by command and sender.

unsigned short	maximumApiVersion (const QString &apiKey) const
	maximumApiVersion This method return maximum supported api version of this node.

unsigned short	minimumApiVersion (const QString &apiKey) const
	minimumApiVersion This method return minimum supported api version of this node.

bool	sendSupportedAPI (AbstractNodeInfo *dist) const
	sendSupportedAPI This method sents all ainformation about suppported api.

unsigned short	selectPackageVersion (const VersionData &local, const VersionData &dist)

Public Member Functions inherited from QH::iParser
	iParser (AbstractNode *parentNode)

virtual	~iParser ()=default

template<class T >
void	registerPackageType ()
	registerPackageType This method register package type T. This is need to prepare pacakge for parsing in the parsePackage method.

template<class PackageClass , class HandlerType , class HandlerMethod >
ParserResult	commandHandler (HandlerType handlerObject, HandlerMethod method, const QSharedPointer< QH::PKG::AbstractData > &pkg, QH::AbstractNodeInfo *sender, const QH::Header &pkgHeader)
	commandHandler This method it is simple wrapper for the handle pacakges in the AbstractNode::parsePackage method. Exmaple of use :

const PacksMap &	registeredTypes () const
	registeredTypes This method return list of registered command.

QSharedPointer< PKG::AbstractData >	genPackage (unsigned short cmd) const
	genPackage This is factory method that generate data pacakge objects by command. All object should be registered before using this method.

bool	checkCommand (unsigned short cmd) const
	checkCommand This method check command are if registered type or not.

virtual void	initSupportedCommands ()
	initSupportedCommands This method will be invoked before add a parser into parser's storage. Use this method to register your command for this parser object. By default, this method does nothing, You still can register your command in the class constructor. But if you use inheritance between your APIs versions to you must use this method, because your constructors both all your commands, this broken API selector of your node.

QString	toString () const override

const PackagesVersionData &	multiVersionPackages () const
	multiVersionPackages return list of the supported multiversions packages.

Additional Inherited Members
Static Public Member Functions inherited from QH::iParser
static QString	pareseResultToString (const ParserResult &parseResult)
	pareseResultToString This method convert ParserResult value to string.

Protected Member Functions inherited from QH::iParser
AbstractNode *	node () const

virtual unsigned int	sendData (const PKG::AbstractData resp, const HostAddress &address, const Header req=nullptr) const
	sendData This method send data object another to node

virtual unsigned int	sendData (const PKG::AbstractData resp, const AbstractNodeInfo node, const Header *req=nullptr) const
	sendData This method send data object another to node

Detailed Description

The APIVersionParser class This is main parser forthe main command. This parsers work only with the APIVersion packge;.

Definition at line 25 of file apiversionparser.h.

Constructor & Destructor Documentation

◆ APIVersionParser()

QH::APIVersionParser::APIVersionParser ( AbstractNode * node )

Definition at line 22 of file apiversionparser.cpp.

Member Function Documentation

◆ addApiParser()

const QSharedPointer< QH::iParser > & QH::APIVersionParser::addApiParser ( const QSharedPointer< QH::iParser > & parserObject )

addApiParser This method add new Api parser for this node.

Parameters

parserObject This is bew api parser.

Returns: added parser.

Definition at line 160 of file apiversionparser.cpp.

Here is the call graph for this function:

◆ getSelectedApiParser()

QSharedPointer< iParser > QH::APIVersionParser::getSelectedApiParser	(	const QString &	apiKey,
		QH::AbstractNodeInfo *	node
	)		const

getSelectedApiParser This method return apiParser for selected node

Parameters

apiKey	This is key of needed api.
node	This is distanation node.

Returns: needed parser of the distanation node.

Definition at line 115 of file apiversionparser.cpp.

Here is the call graph for this function:

◆ maximumApiVersion()

unsigned short QH::APIVersionParser::maximumApiVersion ( const QString & apiKey ) const

maximumApiVersion This method return maximum supported api version of this node.

Parameters

apiKey This is api key.

Returns: maximum supported api version of this node.

Definition at line 255 of file apiversionparser.cpp.

Here is the call graph for this function:

◆ minimumApiVersion()

unsigned short QH::APIVersionParser::minimumApiVersion ( const QString & apiKey ) const

minimumApiVersion This method return minimum supported api version of this node.

Parameters

apiKey This is api key.

Returns: minimum supported api version of this node.

Definition at line 265 of file apiversionparser.cpp.

Here is the call graph for this function:

◆ parsePackage()

ParserResult QH::APIVersionParser::parsePackage	(	const QSharedPointer< PKG::AbstractData > &	pkg,
		const Header &	pkgHeader,
		AbstractNodeInfo *	sender
	)

overridevirtual

parsePackage This is main method of all childs classes of an AbstractNode class. This method work on own thread. If you ovveride this method you need to create this than an example:

ParserResult DataBaseNode::parsePackage(PKG::AbstractData *pkg,
                                        const Header& pkgHeader,
                                        const AbstractNodeInfo* sender) {
    auto parentResult = AbstractNode::parsePackage(pkg, sender);
    if (parentResult != ParserResult::NotProcessed) {
        return parentResult;
    }
 
    // you can use parsing without the commandHandler method
    if (MyCommand::command() == pkg->cmd()) {
 
        BaseId requesterId = getSender(sender, &obj);
 
        ...
 
        if (FailCondition) {
            return ParserResult::Error;
        }
 
        ...
 
        return ParserResult::Processed;
 
    }
 
    // Or with the commandHandler method
 
    auto result = commandHandler<MyPackage>(this, &MyClass::processMyPackage, pkg, sender, pkgHeader);
    if (result != QH::ParserResult::NotProcessed) {
        return result;
    }
 
    return ParserResult::NotProcessed;
}

Parameters

pkg	This is package with incomming data.
sender	This is sender this pacakge.
pkgHeader	This is header of the incoming packet is used to create a response.

Returns: item of ParserResult. For more information see The ParserResult enum.

See also: AbstractNode::commandHandler; AbstractNode::sendData; AbstractNode::badRequest

Implements QH::iParser.

Definition at line 26 of file apiversionparser.cpp.

Here is the call graph for this function:

◆ parserId()

QString QH::APIVersionParser::parserId ( ) const

overridevirtual

parserId This is id of the parsers. All parser will be synced betwin nodes by ids.

Returns: parser id.

Implements QH::iParser.

Definition at line 65 of file apiversionparser.cpp.

◆ parsersTypedCount()

unsigned int QH::APIVersionParser::parsersTypedCount ( ) const

parsersTypedCount This method return count of the parsers types.

Returns: count of the parsers types.

Definition at line 192 of file apiversionparser.cpp.

◆ searchPackage()

QSharedPointer< PKG::AbstractData > QH::APIVersionParser::searchPackage	(	unsigned short	cmd,
		AbstractNodeInfo *	sender
	)		const

searchPackage This method search package recursive in all registered pararsers. Searching will be in compatibility versions. Before search methd choose compatibly verson.

Parameters

cmd	This is command for that shold be create pacakge object.
ver	This is version for that shold be create pacakge object.
sender	This is node that sent the cmd.

Returns: Package generated from cmd.

Definition at line 83 of file apiversionparser.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selectPackageVersion()

unsigned short QH::APIVersionParser::selectPackageVersion	(	const VersionData &	local,
		const VersionData &	dist
	)

◆ selectParser() [1/4]

QSharedPointer< iParser > QH::APIVersionParser::selectParser	(	const QString &	parserKey,
		AbstractNodeInfo *	sender
	)		const

selectParser This method select parser by command and sender.

Parameters

parserKey	this is key of the parser type..
sender	this is node that sent this command.

Returns: parser for the cmd command

Definition at line 206 of file apiversionparser.cpp.

Here is the call graph for this function:

◆ selectParser() [2/4]

QSharedPointer< iParser > QH::APIVersionParser::selectParser	(	const QString &	parserKey,
		unsigned short	version
	)		const

selectParser This method select parser by command and sender.

Parameters

parserKey	this is key of the parser type..
version	this is needed version.

Returns: parser for the cmd command

Definition at line 219 of file apiversionparser.cpp.

Here is the call graph for this function:

◆ selectParser() [3/4]

QHash< QString, QSharedPointer< iParser > > QH::APIVersionParser::selectParser ( const VersionData & distVersion ) const

selectParser This method select api parser betwin nodes.

Parameters

distVersion This is information about distanation node version.

Returns: hash map of needed parsers of the distanation node.

Definition at line 176 of file apiversionparser.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selectParser() [4/4]

QSharedPointer< iParser > QH::APIVersionParser::selectParser	(	unsigned short	cmd,
		AbstractNodeInfo *	sender
	)		const

selectParser This method select parser by command and sender.

Parameters

cmd	this is command that need to parse.
sender	this is node that sent this command.

Returns: parser for the cmd command

Definition at line 196 of file apiversionparser.cpp.

Here is the call graph for this function:

◆ sendSupportedAPI()

bool QH::APIVersionParser::sendSupportedAPI ( AbstractNodeInfo * dist ) const

sendSupportedAPI This method sents all ainformation about suppported api.

Parameters

dist	This is distanation node.

Returns: true if the information sent successful else false.

Definition at line 274 of file apiversionparser.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sigNoLongerSupport

void QH::APIVersionParser::sigNoLongerSupport	(	const QString &	ApiKey,
		unsigned short	version
	)

signal

sigNoLongerSupport This signal will be emit when node receive incomplite versions.

Parameters

ApiKey	This is key of not supported version.
version	This is version

Here is the caller graph for this function:

◆ toString()

QString QH::APIVersionParser::toString ( ) const

override

toString This method show all supported commands and them names.

Returns: list of the supported commands as a message

Definition at line 69 of file apiversionparser.cpp.

Here is the call graph for this function:

◆ version()

int QH::APIVersionParser::version ( ) const

overridevirtual

version This method return version of parser object

Returns: version of parsed object.

Implements QH::iParser.

Definition at line 61 of file apiversionparser.cpp.

Here is the caller graph for this function:

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

src/public/apiversionparser.h
src/public/apiversionparser.cpp

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ APIVersionParser()

Member Function Documentation

◆ addApiParser()

◆ getSelectedApiParser()

◆ maximumApiVersion()

◆ minimumApiVersion()

◆ parsePackage()

◆ parserId()

◆ parsersTypedCount()

◆ searchPackage()

◆ selectPackageVersion()

◆ selectParser() [1/4]

◆ selectParser() [2/4]

◆ selectParser() [3/4]

◆ selectParser() [4/4]

◆ sendSupportedAPI()

◆ sigNoLongerSupport

◆ toString()

◆ version()