IMPORTANT: This repository is no longer maintained, because in context of issue kitsudaiki/Hanami#31 the content was moved into the main-repository (https://github.com/kitsudaiki/Hanami-AI).
This library provides a simple session-layer-protocol, which I created for data-transfers in my projects.
It suppots sessions, which can base on Unix-Domain-Sockets, TCP or TLS encrypted TCP.
The following messages-types are supported:
-
stream-messages
This are very simple and fast messages. For these messages, there is no additional memory allocation and the receiver of the messages gets only little parts. The data are only inside the message-ring-buffer of the socket, so the receiver have to process them instantly, or they will be overwritten. These messages are for cases, when the layer above should handle the data and wants as minimal overhead as possible.
-
request-response-messages:
This are a special case of the standalone-messages. The request-call sends a standalone-message to the receiver with an ID and blocks the thread, which has called the request-method, until the other side sends a response-message with the ID back. The request-message returns after its release the received data. This way it can force a synchronized communication to implement for example RPC-calls.
| name | repository | version | task |
|---|---|---|---|
| g++ | g++ | >= 8.0 | Compiler for the C++ code. |
| make | make | >= 4.0 | process the make-file, which is created by qmake to build the programm with g++ |
| qmake | qt5-qmake | >= 5.0 | This package provides the tool qmake, which is similar to cmake and create the make-file for compilation. |
| ssl library | libssl-dev | >= 1.1 | encryption for tls connections |
Installation on Ubuntu/Debian:
sudo apt-get install g++ make qt5-qmake libssl-devIMPORTANT: All my projects are only tested on Linux.
| Repository-Name | Version-Tag | Download-Path |
|---|---|---|
| libKitsunemimiCommon | develop | https://github.com/kitsudaiki/libKitsunemimiCommon.git |
| libKitsunemimiNetwork | develop | https://github.com/kitsudaiki/libKitsunemimiNetwork.git |
HINT: These Kitsunemimi-Libraries will be downloaded and build automatically with the build-script below.
In all of my repositories you will find a build.sh. You only have to run this script. It doesn't required sudo, because you have to install required tool via apt, for example, by yourself. But if other projects from me are required, it download them from github and build them in the correct version too. This script is also use by the ci-pipeline, so its tested with every commit.
Run the following commands:
git clone https://github.com/kitsudaiki/libKitsunemimiSakuraNetwork.git
cd libKitsunemimiSakuraNetwork
./build.sh
cd ../result
It create automatic a build and result directory in the directory, where you have cloned the project. At first it build all into the build-directory and after all build-steps are finished, it copy the include directory from the cloned repository and the build library into the result-directory. So you have all in one single place.
Tested on Debian and Ubuntu. If you use Centos, Arch, etc and the build-script fails on your machine, then please write me a mail and I will try to fix the script.
(sorry, docu comes later)
Please give me as many inputs as possible: Bugs, bad code style, bad documentation and so on.
This project is licensed under the Apache License Version 2.0 - see the LICENSE file for details