# README #

hmbdc is an open source headers only C++ framework and library built on top of 
various real-world tested lockfree algorithms that facilitate 
ultra low latency and high throughput messaging 
(inter-thread, inter-process and thru network) programming. 
It aims to take most out of the allocated hardware resources 
(memory, cores, NICs and switches) to achieve latency 
and throughput goals. It works as a framework but it can 
also be used as libraries to collaborate with other 
frameworks or extend existing middleware capability with
'zero-copy', 'reliable multicast', 'kernel bypassing' etc, etc.

Please refer to: 
https://www.hummingbirdcode.net
for reliability, scalability, performance and design 
information.

Keywords and features:
- Supports x86_64, aarch64, Linux, gcc(>=8.4.1), clang(>=10) 
  and QNX/qcc(>=11, beta)
- multithreaded without the headache
- low latency / high throughput / supports kernel bypassing
- support multiple types of transport mechanisms with
  the consistent look and feel C++17 API:
    interthread
    interprocess
    UDP multicast
    TCP
    netmap multicast
    reliable multicast
    reliable netmap
- support easy to use symetric (no broker process) C++ type based message 
  (both reliable and latest only) publish / subscribe with 
  automatic pub/sub topology visualization and message recording / playback tools
- other high performance computing features:
  high speed async logging, timer, rate control ...
- straightforward integration with any other programming 
  languages that supports Linux piping
- provide performance measurement tools

### What is this repository for? ###
* it is used in areas that are cpu / network 
  intensive with high performance (latency / throughput) 
  requirements such as high frequency 
  trading, high performance server-backend, robotics, 
  multi-core real-time systems, etc. 
  hmbdc helps you get it done quick and fast.

### How do I build code in example and tools dir ###
0. make sure you have the required lib in place: boost-dev package
  make sure you have the QNX or aarch64 cross compiling tools ready 
  if you are building for them
  for QNX, source the qnx set env script now
1. in hmbdc root dir, type
  make

If you had to use your own building tool:
1. use the following recommneded g++ (>= 8.4.1) or clang (>=10) 
options to build the executables:
g++ <cpp-file> -std=c++1z -fconcepts -D BOOST_BIND_GLOBAL_PLACEHOLDERS -O3 
-Wall -Werror -pthread -isystem <boost-include> 
-I. -s 
<boost-lib>/libboost_program_options.a <boost-lib>/libboost_system.a 
<boost-lib>/libboost_iostreams.a  
-lrt -o <output-executable> # libboost_*.a is only needed for tools build

clang++  <cpp-file> -std=c++2a -stdlib=libstdc++ -Wno-parentheses 
-D BOOST_BIND_GLOBAL_PLACEHOLDERS -O3 
-Wall -Werror -pthread -I. -isystem <boost-include> 
-I. -s 
<boost-lib>/libboost_program_options.a <boost-lib>/libboost_system.a 
<boost-lib>/libboost_iostreams.a  
-lrt -o <output-executable> # libboost_*.a is only needed for tools build

for example:
g++ tools/tips-ping-pong.cpp  -std=c++1z -fconcepts \
-D BOOST_BIND_GLOBAL_PLACEHOLDERS -O3 -D NDEBUG -Wall -Werror -pthread \
-isystem /usr/local/boost/include -I. -s \
/usr/local/boost/lib/libboost_program_options.a \
/usr/local/boost/lib/libboost_system.a \
/usr/local/boost/lib/libboost_iostreams.a  -lrt -o /tmp/tips-ping-pong-lat

### Contribution guidelines ###
* all suggestions and issue reports are welcome
* please report the issue using the issues function on 
  the downloading website, or contact 
  [email protected] or [email protected]

### Who do I talk to? ###
* MIT Licensed
* please direct questions to [email protected] or 
  [email protected] 
  and thank you for your interests in hmbdc!
  
### Notes ###
* build qnx / aarch64 version of boost
./b2 toolset=qcc target-os=qnxnto threadapi=pthread link=static -l240 --layout=system --without-python cxxflags="-V gcc_ntox86_64_gpp -Wc,-std=gnu++0x -D_LITTLE_ENDIAN" linkflags="-V gcc_ntox86_64_gpp -lang-c++"