Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flaviomarcio/qrpc
Qt-Remote process call using http/rest, websocket, localsocket, tcp, udp, mqtt, amqp
https://github.com/flaviomarcio/qrpc
amqp cpp http iot mqtt mssql odbc oracle postgres psql qt rest rpc sqlite websocket
Last synced: 3 months ago
JSON representation
Qt-Remote process call using http/rest, websocket, localsocket, tcp, udp, mqtt, amqp
- Host: GitHub
- URL: https://github.com/flaviomarcio/qrpc
- Owner: flaviomarcio
- License: mpl-2.0
- Created: 2020-03-21T20:46:17.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-11-25T22:06:55.000Z (about 1 year ago)
- Last Synced: 2024-10-12T09:40:48.759Z (4 months ago)
- Topics: amqp, cpp, http, iot, mqtt, mssql, odbc, oracle, postgres, psql, qt, rest, rpc, sqlite, websocket
- Language: C++
- Homepage:
- Size: 814 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QRpc
**Client/Server to working remote process call.**
## Working architecture
>## Support
>>## Request
>> HTTP/REST, LocalSocket, TCP, UPD, WebSocket
>>## Streaming
>> Brokers Database, AMQP, MQTT, KAFKA
```mermaid
graph TD;
A[QRPCServer]
A --> B(QRPCListen)
B --> BA(QRPCListenHTTP/REST)--> C
B --> BB(QRPCListenLocalSocket)--> C
B --> BC(QRPCListenTCP)--> C
B --> BD(QRPCListenUDP)--> C
B --> BE(QRPCListenWebSocket)--> C
B --> BF(QRPCListenBrokerAMQP)--> C
B --> BG(QRPCListenBrokerDataBase)--> C
B --> BH(QRPCListenBrokerKAFKA)--> C
B --> BI(QRPCListenBrokerMQTT)--> C
C[QRPCListenQRPC]--> CA[QRPCListenQRPCSlot] --> CAA[QRPCController]
```
## Prerequisits
>```bash
> mkdir myproject;
> cd myproject;
> git clone [email protected]:flaviomarcio/qstm.git;
> git clone [email protected]:flaviomarcio/qrpc.git;
>```
>Check example in QRpc/example/server-rest
## CMake Build information
>```
>## initial CMake parameters
>
>-GNinja
>-DCMAKE_BUILD_TYPE:STRING=Debug
>-DCMAKE_PROJECT_INCLUDE_BEFORE:PATH=%{IDE:ResourcePath}/package-manager/auto-setup.cmake
>-DQT_QMAKE_EXECUTABLE:STRING=%{Qt:qmakeExecutable}
>-DCMAKE_PREFIX_PATH:STRING=%{Qt:QT_INSTALL_PREFIX}
>-DCMAKE_C_COMPILER:STRING=%{Compiler:Executable:C}
>-DCMAKE_CXX_COMPILER:STRING=%{Compiler:Executable:Cxx}
>-DCMAKE_INSTALL_PREFIX=~/build/qcrosscache/install/Debug
>```
>```bash
> cd qrpc
> mkdir build;
> cd build;
> cmake ..
> make;
> make install;
>```
## QMake Build information
>```bash
> cd qrpc
> qmake qrpc.pro
> make;
> make install;
> ls -l;
>```
## QMake project
>```c++
>QT -= gui
>
>CONFIG += c++17 console silent
>CONFIG -= app_bundle
>
>include($$PWD/../../../qstm/qstm.pri)
>include($$PWD/../../qrpc.pri)
>
>SOURCES += \
> controllerMethods.cpp \
> main.cpp
>
>RESOURCES += \
> settings.qrc
>
>HEADERS += \
> controllerMethods.h
>```
## Resource settings
>Settings http/rest server saved in setting.json and included in settings.qrc
>```json
>{
> "arguments":["ws"],
> "protocol":{
> "default":{
> "minThreads":1,
> "maxThreads":2000,
> "cleanupInterval":1000,
> "readTimeout":60000,
> "maxRequestSize":104857600,
> "maxMultiPartSize":1048576000,
> "enabled":false,
> "sslKeyFile":"",
> "sslCertFile":""
> },
> "http":{
> "enabled":true,"port":[8888]
> }
> },
> "connection":{
> "secret": "YzUxNDFhMDA5",
> "enviroment" : "debug",
> "paramaters" : {
> "debug":{
> "driver":"QPSQL",
> "hostName":"localhost",
> "userName":"localuser",
> "password":"localuser",
> "port":5432,
> "dataBaseName":"postgres",
> "schemaNames":"public"
> }
> }
> }
>}
>```
## HTTP/REST Server
>Check example in QRpc/example/server-rest
>```c++
>
>//main implementation
>#include
>#include
>
>int main(int argc, char *argv[])
>{
> QCoreApplication a(argc, argv);
>
> //server class
> QRpc::QRPCServer server;
>
> //set settings to run service
> if(!server.setSettingsFileName(QStringLiteral(":/settings.json"))){
> qWarning()<<"invalid settings";
> return 0;
> }
>
> //start service
> server.start();
>
> //start eventloop application
> return a.exec();
>}
>```
## Methods implementations
>Check example in QRpc/example/server-rest
>
>```c++
>#include
>
>//!
>//! \brief The ControllerMethods class
>//!
>//! inhetihed of QRpc::QRPCController
>class ControllerMethods : public QRpc::QRPCController
>{
> Q_OBJECT
>public:
> //!
> //! \brief ControllerMethods
> //! \param parent
> //!
> //! necessary Q_INVOKABLE
> Q_INVOKABLE explicit ControllerMethods(QObject *parent = nullptr);
>
>
> //!
> //! \brief authorization
> //! \return
> //!
> //! authorization validations
> //! check more authorization methods:
> //! canAuthorization
> //! beforeAuthorization
> //! afterAuthorization
> //!
> virtual bool authorization();
>
> //!
> //! \brief listObjects
> //! \return
> //!
> //! method to return object list, necessary Q_INVOKABLE
> //! check more Invoke methods:
> //! requestBeforeInvoke
> //! requestAfterInvoke
> Q_INVOKABLE QVariant listObjects();
>
>};
>
>//auto register interface
>QRPC_CONTROLLER_AUTO_REGISTER(ControllerMethods)
>```
## Example
>Check example in QRpc/example/server-rest
>```bash
> curl -i http://localhost:8888/listObjects?limit=1
> ```
>```bash
>HTTP/1.1 200 (OK)
>Vary: Accept-Encoding, Origin
>Date: Sat Jan 15 18:50:02 2022
>Content-Length: 59
>Server: Undef
>```
>
>```json
>[{"index":1,"uuid":"ba01138f-f7b0-4874-a879-caa591ab9e55"}]
>```