QRpc

Client/Server to working remote process call.

Working architecture

Support

Request

HTTP/REST, LocalSocket, TCP, UPD, WebSocket

Streaming

Brokers Database, AMQP, MQTT, KAFKA

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]

Loading

Prerequisits

mkdir myproject;
cd myproject;
git clone git@github.com:flaviomarcio/qstm.git;
git clone git@github.com: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

cd qrpc
mkdir build;
cd build;
cmake ..
make;
make install;

QMake Build information

cd qrpc
qmake qrpc.pro
make;
make install;
ls -l;

QMake project

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

{
  "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

//main implementation
#include <QCoreApplication>
#include <QRpc/Server>

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

#include <QRpc/Server>

//!
//! \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

curl -i http://localhost:8888/listObjects?limit=1

HTTP/1.1 200 (OK)
Vary: Accept-Encoding, Origin
Date: Sat Jan 15 18:50:02 2022
Content-Length: 59
Server: Undef

[{"index":1,"uuid":"ba01138f-f7b0-4874-a879-caa591ab9e55"}]