pubnub / c-core Goto Github PK

This repository has the source for the C/C++ client libraries, designed mostly for embedded systems, but perfectly suitable for "regular" (POSIX, Windows) systems, too.

Docs for C/C++ for Posix, Windows, as well as FreeRTOS and other embedded platforms are available at https://www.pubnub.com/docs/posix-c/pubnub-c-sdk

Our repository can be build via two different approaches:

You can build repository using CMake using our CMakeLists.txt file.

• Unix:

mkdir build && cd build
cmake ..
make

• Windows (MSVS tools required):

mkdir build && cd build
cmake .. -G "NMake Makefiles"
nmake 

• for other platforms you can search for information in FreeRTOS or QT READMEs.

There are several options to be selected via switches (using GUI) or by using command line.

cmake .. -DOPENSSL=ON -DEXAMPLES=ON <etc...>

Check the CMakeLists file for more info.

You can build our SDK using standard tooling depending on OS you're using. For more info check those links:

• posix,
• windows,
• openssl,
• freertos,

depending on what fits you best.

The directories of the library repository are:

• core : The core part, with modules portable to all, or most, libraries for specific platforms

• lib : Modules for libraries that are available on more than one platform

• windows : Modules and Makefile for the Windows platform

• posix : Modules and Makefile for POSIX OSes (tested mostly on Linux)

• openssl: Modules and Makefile(s) for OpenSSL (on POSIX and Windows)

• mbedtls: Modules for MBedTLS

• cpp: Modules, Makefile(s) and examples for the C++ wrapper

• qt: Modules, Qt projects and examples for Qt

• freertos : Modules and Makefile for the FreeRTOS and ESP32 platforms

• microchip_harmony : Modules and project for Microchip MPLAB Harmony

• unreal : Unreal Engine integration module

In this root directory we have some files, too:

• posix.mk: a "master" Makefile for POSIX - will build all the POSIX Makefiles there are (doesn't build Qt - you might not have Qt)
• windows.mk: a "master" Makefile for Windows - will build all the Windows Makefiles there are (doesn't build Qt, you might not have Qt). For UWP support, use uwp.mk Makefile.
• .pubnub.yml: Standard Pubnub library description in YAML
• .travis.yml: Configuration for Travis CI (POSIX: Linux and MacOS)
• .appveyor.yml: Configuration for Appveyor CI (Windows)
• .clang-format: Configuration for Clang-format tool that we use to format C/C++ source code

Please read the Contribution Guidelines.