mirror of
https://github.com/QuasarApp/Heart.git
synced 2025-05-14 02:19:41 +00:00
fix docx
This commit is contained in:
parent
107a9510b9
commit
930288d3ab
2321
Heart/AbstractSpace/Diagrams/Async.svg
Normal file
2321
Heart/AbstractSpace/Diagrams/Async.svg
Normal file
File diff suppressed because it is too large
Load Diff
After (image error) Size: 121 KiB |
@ -25,19 +25,14 @@
|
||||
* @brief The QH namespace - QuasarApp Heart namespace. This namespace contains all classes of the Heart library.
|
||||
* Usage:
|
||||
* 1. First one you need to create a package for transporting data betwin server and client. For this you need to do Inheritance with the
|
||||
* QF::PKG::AbstrcatData class. So You need to override 2 serialization methods of AbstrcatData and method copyFrom.
|
||||
* Example package for transporting text data.
|
||||
* QF::PKG::AbstrcatData class. So, You need to override 2 serialization methods of AbstrcatData and the copyFrom method.
|
||||
* Example: The package for transporting text data.
|
||||
* \code{cpp}
|
||||
class MyPackage: public QH::AbstractData
|
||||
{
|
||||
public:
|
||||
MyPackage();
|
||||
|
||||
// constructor for create object from package
|
||||
MyPackage(const Package& from): QH::AbstractData(from) {
|
||||
|
||||
};
|
||||
|
||||
// override this method for validation your package class
|
||||
bool isValid() const {
|
||||
return AbstractData::isValid();
|
||||
@ -73,7 +68,7 @@ protected:
|
||||
|
||||
};
|
||||
* \endcode
|
||||
* @note The method copyFrom is not nicessery method so yo can be skip it.
|
||||
* @note The method copyFrom is not necessary method so you can be skip it. Bud if you want override it then you need to override like in example, with check of object type. If you do not override this method or override it not correctly then copy data from another package do not work correctly. In base case method copy From not using, but it is necessary for DBObject class
|
||||
* 2. You need to create a Server class. For this you need to do Inheritance with the QF::AbstrcatData class
|
||||
* Example:
|
||||
* \code{cpp}
|
||||
@ -82,7 +77,7 @@ class TestingServer: public QH::AbstractNode {
|
||||
protected:
|
||||
// override this method for processed received data.
|
||||
ParserResult parsePackage(const Package &pkg,
|
||||
const AbstractNodeInfo *sender) {
|
||||
const AbstractNodeInfo *sender) {
|
||||
|
||||
auto parentResult = AbstractNode::parsePackage(pkg, sender);
|
||||
if (parentResult != ParserResult::NotProcessed) {
|
||||
@ -127,7 +122,7 @@ class TestingClient: public QH::AbstractNode {
|
||||
protected:
|
||||
// parsing incoming packages
|
||||
ParserResult parsePackage(const Package &pkg,
|
||||
const AbstractNodeInfo *sender) {
|
||||
const AbstractNodeInfo *sender) {
|
||||
|
||||
auto parentResult = AbstractNode::parsePackage(pkg, sender);
|
||||
if (parentResult != ParserResult::NotProcessed) {
|
||||
@ -153,8 +148,27 @@ protected:
|
||||
}
|
||||
};
|
||||
* \endcode
|
||||
*
|
||||
* The basic principle of the library.
|
||||
*
|
||||
* Node - it is server or client implementation of any of AbstractNode class of it child classes.
|
||||
* - The node receive raw data from another network connection.
|
||||
* - After parsing a raw data the node conwert a bytes array to QH::Package.
|
||||
* - The Package create a new thread fot working with received request, so, all working of pacakge working in own threads.
|
||||
* - Next, the Node invoke a QH::AbstractNode::parsePackage method. This method must be return QH::ParserResult.
|
||||
* @note Do not forget invoke the super class parsePackage method.
|
||||
* - The Lasst step it is invoke your overridet parsePackage method on your server or client class.
|
||||
* IF you need to send responce then use a bool sendData(PKG::AbstractData *resp, const HostAddress& addere, const Header *req = nullptr).
|
||||
*
|
||||
* Work scheme:
|
||||
*\image html Async.svg width=800px
|
||||
*/
|
||||
namespace QH {
|
||||
|
||||
/** @brief The PKG namesapce - this namespace contains all default packages of the Heart library.
|
||||
* If you want create a pool request for Heart Library with own implemented packages
|
||||
* you need to create a new package into a PKG namesapce.
|
||||
*/
|
||||
namespace PKG {
|
||||
|
||||
}
|
||||
|
13
doxygen.conf
13
doxygen.conf
@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
|
||||
# title of most generated pages and in a few other places.
|
||||
# The default value is: My Project.
|
||||
|
||||
PROJECT_NAME = Heart
|
||||
PROJECT_NAME = Heart BackEnd Library
|
||||
|
||||
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
|
||||
# could be handy for archiving the generated documentation or if some version
|
||||
@ -195,7 +195,7 @@ JAVADOC_AUTOBRIEF = NO
|
||||
# requiring an explicit \brief command for a brief description.)
|
||||
# The default value is: NO.
|
||||
|
||||
QT_AUTOBRIEF = NO
|
||||
QT_AUTOBRIEF = YES
|
||||
|
||||
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
|
||||
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
|
||||
@ -790,8 +790,9 @@ WARN_LOGFILE =
|
||||
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
||||
# Note: If this tag is empty the current directory is searched.
|
||||
|
||||
INPUT = ./Heart \
|
||||
./Doc
|
||||
INPUT = Heart \
|
||||
Doc
|
||||
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
|
||||
@ -928,7 +929,7 @@ EXAMPLE_RECURSIVE = NO
|
||||
# that contain images that are to be included in the documentation (see the
|
||||
# \image command).
|
||||
|
||||
IMAGE_PATH =
|
||||
IMAGE_PATH = ./Heart/AbstractSpace/Diagrams
|
||||
|
||||
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
||||
# invoke to filter for each input file. Doxygen will invoke the filter program
|
||||
@ -1393,7 +1394,7 @@ QCH_FILE =
|
||||
# The default value is: org.doxygen.Project.
|
||||
# This tag requires that the tag GENERATE_QHP is set to YES.
|
||||
|
||||
QHP_NAMESPACE = org.doxygen.Project
|
||||
QHP_NAMESPACE = QuasarAppj
|
||||
|
||||
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
|
||||
# Help Project output. For more information please see Qt Help Project / Virtual
|
||||
|
Loading…
x
Reference in New Issue
Block a user