QxOrm 1.4.9
C++ Object Relational Mapping library
Loading...
Searching...
No Matches
QxHttpServer.h
Go to the documentation of this file.
1/****************************************************************************
2**
3** https://www.qxorm.com/
4** Copyright (C) 2013 Lionel Marty (contact@qxorm.com)
5**
6** This file is part of the QxOrm library
7**
8** This software is provided 'as-is', without any express or implied
9** warranty. In no event will the authors be held liable for any
10** damages arising from the use of this software
11**
12** Commercial Usage
13** Licensees holding valid commercial QxOrm licenses may use this file in
14** accordance with the commercial license agreement provided with the
15** Software or, alternatively, in accordance with the terms contained in
16** a written agreement between you and Lionel Marty
17**
18** GNU General Public License Usage
19** Alternatively, this file may be used under the terms of the GNU
20** General Public License version 3.0 as published by the Free Software
21** Foundation and appearing in the file 'license.gpl3.txt' included in the
22** packaging of this file. Please review the following information to
23** ensure the GNU General Public License version 3.0 requirements will be
24** met : http://www.gnu.org/copyleft/gpl.html
25**
26** If you are unsure which license is appropriate for your use, or
27** if you have questions regarding the use of this file, please contact :
28** contact@qxorm.com
29**
30****************************************************************************/
31
32#ifdef Q_MOC_RUN
33#include <QxCommon/QxConfig.h> // Need to include this file for the 'moc' process
34#endif // Q_MOC_RUN
35
36#ifdef _QX_ENABLE_QT_NETWORK
37#ifndef _QX_HTTP_SERVER_H_
38#define _QX_HTTP_SERVER_H_
39
40#ifdef _MSC_VER
41#pragma once
42#endif
43
51#ifdef _QX_NO_PRECOMPILED_HEADER
52#ifndef Q_MOC_RUN
53#include <QxPrecompiled.h> // Need to include precompiled header for the generated moc file
54#endif // Q_MOC_RUN
55#endif // _QX_NO_PRECOMPILED_HEADER
56
60
61#ifndef Q_MOC_RUN
63#include <QxService/QxConnect.h>
64#include <QxService/QxServer.h>
65#endif // Q_MOC_RUN
66
67#if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
68class QAbstractEventDispatcher;
69#endif // (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
70
71namespace qx {
72
77class QX_DLL_EXPORT QxHttpServer : public QObject
78{
79
80 Q_OBJECT
81
82public:
83
85
86private:
87
88 struct QxHttpServerImpl;
89 std::unique_ptr<QxHttpServerImpl> m_pImpl;
90
91public:
92
93 QxHttpServer(QObject * parent = NULL);
94 virtual ~QxHttpServer();
95
96 Q_INVOKABLE void startServer();
97 Q_INVOKABLE void stopServer();
98
100 QxHttpServer & dispatch(const QString & command, const QString & path, type_fct_custom_request_handler fct, long position = -1);
104
105#if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
106 void setEventDispatcher(QAbstractEventDispatcher * pEventDispatcher);
107#endif // (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
108
109 static void buildResponseStaticFile(qx::QxHttpRequest & request, qx::QxHttpResponse & response, const QString & serverPath, qlonglong chunkedSize = 0);
111
112Q_SIGNALS:
113
114 void error(const QString & err, qx::QxHttpTransaction_ptr transaction);
117 void serverStatusChanged(bool bIsRunning);
118
119private Q_SLOTS:
120
121 void onError(const QString & err, qx::service::QxTransaction_ptr transaction);
122 void onServerIsRunning(bool bIsRunning, qx::service::QxServer * pServer);
126
127};
128
129typedef std::shared_ptr<QxHttpServer> QxHttpServer_ptr;
130
131} // namespace qx
132
134
135#endif // _QX_HTTP_SERVER_H_
136#endif // _QX_ENABLE_QT_NETWORK
List of parameters to compile and build QxOrm library.
Define connection parameters used by QxService module of QxOrm library.
HTTP request (headers + body)
HTTP response (headers + body)
qx::QxHttpServer qx_http_server
HTTP transaction (contains request from client and reply from server)
#define QX_DLL_EXPORT
Definition QxMacro.h:182
Server side to manage a thread pool of incoming connections (new request from client)
Transaction of QxService module (contains request from client and reply from server)
qx::QxHttpRequest : HTTP request (headers + body)
qx::QxHttpResponse : HTTP response (headers + body)
qx::QxHttpServer : HTTP server which manages connections in a multi-threaded environment (support SSL...
void onError(const QString &err, qx::service::QxTransaction_ptr transaction)
std::unique_ptr< QxHttpServerImpl > m_pImpl
Private implementation idiom.
Q_INVOKABLE void startServer()
QxHttpServer(QObject *parent=NULL)
void onCustomRequestHandler(qx::service::QxTransaction_ptr transaction)
void onTransactionFinished(qx::service::QxTransaction_ptr transaction)
void beforeDispatching(type_fct_custom_request_handler fct)
void clearDispatcher()
virtual ~QxHttpServer()
void error(const QString &err, qx::QxHttpTransaction_ptr transaction)
void transactionStarted(qx::QxHttpTransaction_ptr transaction)
void onServerIsRunning(bool bIsRunning, qx::service::QxServer *pServer)
std::function< void(qx::QxHttpRequest &, qx::QxHttpResponse &)> type_fct_custom_request_handler
QxHttpServer & dispatch(const QString &command, const QString &path, type_fct_custom_request_handler fct, long position=-1)
Q_INVOKABLE void stopServer()
void transactionFinished(qx::QxHttpTransaction_ptr transaction)
static void buildResponseQxRestApi(qx::QxHttpRequest &request, qx::QxHttpResponse &response)
void serverStatusChanged(bool bIsRunning)
void afterDispatching(type_fct_custom_request_handler fct)
void setCustomRequestHandler(type_fct_custom_request_handler fct)
static void buildResponseStaticFile(qx::QxHttpRequest &request, qx::QxHttpResponse &response, const QString &serverPath, qlonglong chunkedSize=0)
void onTransactionStarted(qx::service::QxTransaction_ptr transaction)
void setEventDispatcher(QAbstractEventDispatcher *pEventDispatcher)
qx::service::QxServer : server side to manage a thread pool of incoming connections (new request from...
Definition QxServer.h:62
std::shared_ptr< QxTransaction > QxTransaction_ptr
Root namespace for all QxOrm library features.
std::shared_ptr< QxHttpServer > QxHttpServer_ptr
std::shared_ptr< QxHttpTransaction > QxHttpTransaction_ptr