QH::iParser Class Reference

The iParser class This class provide functions for parsing income packages. For yousing just override the iParser::parsePackage method. More...

#include <iparser.h>

Inheritance diagram for QH::iParser:

Collaboration diagram for QH::iParser:

Public Member Functions
	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.
virtual ParserResult	parsePackage (const QSharedPointer< PKG::AbstractData > &pkg, const Header &pkgHeader, AbstractNodeInfo *sender)=0
	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:
virtual int	version () const =0
	version This method return version of parser object
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 QString	parserId () const =0
	parserId This is id of the parsers. All parser will be synced betwin nodes by ids.
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.

Static Public Member Functions
static QString	pareseResultToString (const ParserResult &parseResult)
	pareseResultToString This method convert ParserResult value to string.

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

Friends
class	BigDataParserOld
class	AbstractNodeParserOld
class	AbstractNode

Detailed Description

The iParser class This class provide functions for parsing income packages. For yousing just override the iParser::parsePackage method.

See also

AbstractNode::parsePackage

AbstractNode

Definition at line 50 of file iparser.h.

Constructor & Destructor Documentation

iParser()

QH::iParser::iParser

(

AbstractNode *

parentNode

)

Definition at line 17 of file iparser.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

~iParser()

virtual QH::iParser::~iParser ( )

virtualdefault

Member Function Documentation

checkCommand()

bool QH::iParser::checkCommand

(

unsigned short

cmd

)

const

checkCommand This method check command are if registered type or not.

cmd This is command of a verifiable package.

Returns

True if the package is registered in a node.

Definition at line 42 of file iparser.cpp.

commandHandler()

template<class PackageClass, class HandlerType, class HandlerMethod>

ParserResult QH::iParser::commandHandler ( HandlerType handlerObject, HandlerMethod method, const QSharedPointer< QH::PKG::AbstractData > & pkg, QH::AbstractNodeInfo * sender, const QH::Header & pkgHeader )

inline

commandHandler This method it is simple wrapper for the handle pacakges in the AbstractNode::parsePackage method. Exmaple of use :

auto result = commandHandler<MyPackage>(this, &MyClass::processMyPackage, pkg, sender, pkgHeader);
if (result != QH::ParserResult::NotProcessed) {
    return result;
}
...

Template Parameters

PackageClass	This is class name that you want handle. All classes mist be inhert of the QH::PKG::AbstractData class.
HandlerType	This is type of the handler object that will invoke HandlerMethod method.
HandlerMethod	This is name of the handler method. The handler method should be support next signature: bool Method(const QSharedPointer<QH::PKG::PackageClass> &, const QH::Header &pkgHeader, const QH::AbstractNodeInfo *sender).

Parameters

handlerObject	This is pointer to handler object.
method	This is handler method.
pkg	This is package data from the AbstractNode::parsePackage argumetns
pkgHeader	This is header of an incomming package.
sender	This is socket object of a sender that send this package.

Returns

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

See also

iParser::parsePackage

ParserResult

Definition at line 167 of file iparser.h.

Here is the caller graph for this function:

genPackage()

QSharedPointer< PKG::AbstractData > QH::iParser::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.

Parameters

cmd	This is command of pacakge see Header::command.

Returns

shared pointer to new data object.

See also

AbstractNode::registerPackageType

Header::command

Definition at line 38 of file iparser.cpp.

Here is the caller graph for this function:

initSupportedCommands()

void QH::iParser::initSupportedCommands ( )

virtual

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.

See also

registerPackageType

Definition at line 66 of file iparser.cpp.

Here is the caller graph for this function:

multiVersionPackages()

const PackagesVersionData & QH::iParser::multiVersionPackages

(

)

const

multiVersionPackages return list of the supported multiversions packages.

Returns

list of the supported multiversions packages.

Definition at line 62 of file iparser.cpp.

Here is the caller graph for this function:

node()

AbstractNode * QH::iParser::node ( ) const

protected

Definition at line 46 of file iparser.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

pareseResultToString()

QString QH::iParser::pareseResultToString ( const ParserResult & parseResult )

static

pareseResultToString This method convert ParserResult value to string.

Returns

The String value of pareseresult.

Definition at line 22 of file iparser.cpp.

Here is the caller graph for this function:

parsePackage()

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

pure virtual

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

Implemented in QH::AbstractNodeParser, QH::APIVersionParser, and QH::BigDataParser.

Here is the call graph for this function:

parserId()

virtual QString QH::iParser::parserId ( ) const

pure virtual

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

Returns

parser id.

Implemented in QH::AbstractNodeParser, QH::APIVersionParser, and QH::BigDataParser.

Here is the call graph for this function:

Here is the caller graph for this function:

registeredTypes()

const PacksMap & QH::iParser::registeredTypes

(

)

const

registeredTypes This method return list of registered command.

Returns

list of registered command.

See also

iParser::registerPackageType

Definition at line 34 of file iparser.cpp.

registerPackageType()

template<class T>

void QH::iParser::registerPackageType ( )

inline

registerPackageType This method register package type T. This is need to prepare pacakge for parsing in the parsePackage method.

See also

initSupportedCommands

Definition at line 62 of file iparser.h.

Here is the caller graph for this function:

sendData() [1/2]

unsigned int QH::iParser::sendData ( const PKG::AbstractData * resp, const AbstractNodeInfo * node, const Header * req = nullptr ) const

protectedvirtual

sendData This method send data object another to node

Parameters

resp	This is pointer to sendet object.
address	This is target addres for sending.
req	This is header of request.

Returns

hash of the sendet package. If function is failed then return 0.

Note

This method is a just wraper of the AbstractNode::sendData method.

Definition at line 56 of file iparser.cpp.

Here is the call graph for this function:

sendData() [2/2]

unsigned int QH::iParser::sendData ( const PKG::AbstractData * resp, const HostAddress & address, const Header * req = nullptr ) const

protectedvirtual

sendData This method send data object another to node

Parameters

resp	This is pointer to sendet object.
address	This is target addres for sending.
req	This is header of request.

Returns

hash of the sendet package. If function is failed then return 0.

Note

This method is a just wraper of the AbstractNode::sendData method.

Definition at line 50 of file iparser.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

toString()

QString QH::iParser::toString ( ) const

override

Definition at line 68 of file iparser.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

version()

virtual int QH::iParser::version ( ) const

pure virtual

version This method return version of parser object

Returns

version of parsed object.

Implemented in QH::AbstractNodeParser, QH::APIVersionParser, and QH::BigDataParser.

Friends And Related Symbol Documentation

AbstractNode

friend class AbstractNode

friend

Definition at line 266 of file iparser.h.

AbstractNodeParserOld

friend class AbstractNodeParserOld

friend

Definition at line 265 of file iparser.h.

BigDataParserOld

friend class BigDataParserOld

friend

Definition at line 264 of file iparser.h.

---

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

• src/public/iparser.h
• src/public/iparser.cpp