pax_global_header00006660000000000000000000000064147372254250014525gustar00rootroot0000000000000052 comment=2150ba29d9df24ad1733c460eb099f292af84ee5 paho.mqtt.c-1.3.14/000077500000000000000000000000001473722542500137475ustar00rootroot00000000000000paho.mqtt.c-1.3.14/.cproject000066400000000000000000000647431473722542500155770ustar00rootroot00000000000000 make -j8 paho_c_pub true true true paho.mqtt.c-1.3.14/.github/000077500000000000000000000000001473722542500153075ustar00rootroot00000000000000paho.mqtt.c-1.3.14/.github/FUNDING.yml000066400000000000000000000000201473722542500171140ustar00rootroot00000000000000github: icraggs paho.mqtt.c-1.3.14/.github/ISSUE_TEMPLATE/000077500000000000000000000000001473722542500174725ustar00rootroot00000000000000paho.mqtt.c-1.3.14/.github/ISSUE_TEMPLATE/bug_report.md000066400000000000000000000015161473722542500221670ustar00rootroot00000000000000--- name: Bug report about: Create a report to help us improve title: '' labels: '' assignees: '' --- **Describe the bug** A clear and concise description of what the bug is. **To Reproduce** Take a library trace as outlined in the README, and/or have a program or describe the steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error **Expected behavior** A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. **Log files** Please try to attach log files rather than pasting the log contents. It makes the issues easier to read. ** Environment (please complete the following information):** - OS: [e.g. Linux] - Version [e.g. 22] **Additional context** Add any other context about the problem here. paho.mqtt.c-1.3.14/.github/ISSUE_TEMPLATE/feature_request.md000066400000000000000000000011231473722542500232140ustar00rootroot00000000000000--- name: Feature request about: Suggest an idea for this project title: '' labels: '' assignees: '' --- **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] **Describe the solution you'd like** A clear and concise description of what you want to happen. **Describe alternatives you've considered** A clear and concise description of any alternative solutions or features you've considered. **Additional context** Add any other context or screenshots about the feature request here. paho.mqtt.c-1.3.14/.github/workflows/000077500000000000000000000000001473722542500173445ustar00rootroot00000000000000paho.mqtt.c-1.3.14/.github/workflows/artifact_linux.yml000066400000000000000000000020161473722542500231020ustar00rootroot00000000000000name: "Upload release artifact for Linux" on: [workflow_dispatch] jobs: build: runs-on: ubuntu-latest steps: - name: Check out code uses: actions/checkout@v2 - name: Install dependencies run: | sudo apt-get update sudo apt-get install doxygen - name: Build run: | rm -rf build.paho mkdir build.paho cd build.paho echo "pwd $PWD" cmake -DPAHO_BUILD_STATIC=FALSE -DPAHO_BUILD_SHARED=TRUE -DCMAKE_BUILD_TYPE=Debug -DPAHO_WITH_SSL=TRUE -DOPENSSL_ROOT_DIR= -DPAHO_BUILD_DOCUMENTATION=FALSE -DPAHO_BUILD_SAMPLES=TRUE -DPAHO_HIGH_PERFORMANCE=TRUE .. cmake --build . - name: package run: | cd build.paho cpack --verbose - name: Upload artifact uses: actions/upload-artifact@v3 with: name: Eclipse-Paho-MQTT-C-1.3.14-Linux.tar.gz path: /home/runner/work/paho.mqtt.c/paho.mqtt.c/build.paho/Eclipse-Paho-MQTT-C-1.3.14-Linux.tar.gz paho.mqtt.c-1.3.14/.github/workflows/artifact_macos.yml000066400000000000000000000020211473722542500230410ustar00rootroot00000000000000name: "Upload release artifact for MacOS" on: [workflow_dispatch] jobs: build: runs-on: macos-latest steps: - name: Check out code uses: actions/checkout@v2 - name: Install dependencies run: | brew update brew install doxygen - name: Build run: | rm -rf build.paho mkdir build.paho cd build.paho echo "pwd $PWD" cmake -DPAHO_BUILD_STATIC=FALSE -DPAHO_BUILD_SHARED=TRUE -DCMAKE_BUILD_TYPE=Debug -DPAHO_WITH_SSL=TRUE -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl@1.1 -DPAHO_BUILD_DOCUMENTATION=FALSE -DPAHO_BUILD_SAMPLES=TRUE -DPAHO_HIGH_PERFORMANCE=TRUE .. cmake --build . - name: package run: | cd build.paho cpack --verbose - name: Upload artifact uses: actions/upload-artifact@v3 with: name: Eclipse-Paho-MQTT-C-1.3.14-Darwin.tar.gz path: /Users/runner/work/paho.mqtt.c/paho.mqtt.c/build.paho/Eclipse-Paho-MQTT-C-1.3.14-Darwin.tar.gz paho.mqtt.c-1.3.14/.github/workflows/build_linux.yml000066400000000000000000000024251473722542500224100ustar00rootroot00000000000000name: "Builds for Linux" on: [push, pull_request] jobs: build: runs-on: ubuntu-latest steps: - name: Check out code uses: actions/checkout@v2 - name: Install dependencies run: | sudo apt-get update sudo apt-get install doxygen - name: Build run: | rm -rf build.paho mkdir build.paho cd build.paho echo "pwd $PWD" cmake -DPAHO_BUILD_STATIC=FALSE -DPAHO_BUILD_SHARED=TRUE -DCMAKE_BUILD_TYPE=Debug -DPAHO_WITH_SSL=TRUE -DOPENSSL_ROOT_DIR= -DPAHO_BUILD_DOCUMENTATION=FALSE -DPAHO_BUILD_SAMPLES=TRUE -DPAHO_HIGH_PERFORMANCE=TRUE .. cmake --build . - name: Start test broker run: | git clone https://github.com/eclipse/paho.mqtt.testing.git cd paho.mqtt.testing/interoperability python3 startbroker.py -c localhost_testing.conf & - name: Start test proxy run: | python3 test/mqttsas.py & - name: run tests run: | cd build.paho ctest -VV --timeout 600 - name: clean up run: | killall python3 || true sleep 3 # allow broker time to terminate and report - name: package run: | cd build.paho cpack --verbose paho.mqtt.c-1.3.14/.github/workflows/build_macos.yml000066400000000000000000000024401473722542500223500ustar00rootroot00000000000000name: "Builds for MacOS" on: [push, pull_request] jobs: build: runs-on: macos-latest steps: - name: Check out code uses: actions/checkout@v2 - name: Install dependencies run: | brew update brew install doxygen - name: Build run: | rm -rf build.paho mkdir build.paho cd build.paho echo "pwd $PWD" cmake -DPAHO_BUILD_STATIC=FALSE -DPAHO_BUILD_SHARED=TRUE -DCMAKE_BUILD_TYPE=Debug -DPAHO_WITH_SSL=TRUE -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl@1.1 -DPAHO_BUILD_DOCUMENTATION=FALSE -DPAHO_BUILD_SAMPLES=TRUE -DPAHO_HIGH_PERFORMANCE=TRUE .. cmake --build . - name: Start test broker run: | git clone https://github.com/eclipse/paho.mqtt.testing.git cd paho.mqtt.testing/interoperability python3 startbroker.py -c localhost_testing.conf & - name: Start test proxy run: | python3 test/mqttsas.py & - name: run tests run: | cd build.paho ctest -VV --timeout 600 - name: clean up run: | killall python3 || true sleep 3 # allow broker time to terminate and report - name: package run: | cd build.paho cpack --verbose paho.mqtt.c-1.3.14/.github/workflows/covsync.yml000066400000000000000000000006321473722542500215540ustar00rootroot00000000000000name: "Synchronise Coverity Scan branches on a weekly basis" on: workflow_dispatch: schedule: - cron: "7 3 * * 0" jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 with: fetch-depth: 0 - run: | git checkout -b coverity-develop origin/develop git pull origin coverity-develop git push origin coverity-develop paho.mqtt.c-1.3.14/.github/workflows/test_libressl.yml000066400000000000000000000032431473722542500227470ustar00rootroot00000000000000name: "Test LibreSSL" on: [push, pull_request] jobs: nix: runs-on: ${{ matrix.os }} strategy: matrix: os: [ubuntu-latest, macos-latest] steps: - name: Check out code uses: actions/checkout@v2 - name: Build LibreSSL run: | curl -O https://ftp.openbsd.org/pub/OpenBSD/LibreSSL/libressl-3.8.2.tar.gz tar -xf libressl-3.8.2.tar.gz cd libressl-3.8.2 rm -rf build mkdir build cd build cmake .. -DLIBRESSL_APPS:BOOL=0 -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX:PATH=$(pwd)/../artifacts cmake --build . --config Release -j$(nproc) cmake --install . - name: Build run: | rm -rf build.paho mkdir build.paho cd build.paho echo "pwd $PWD" cmake -DPAHO_BUILD_STATIC=FALSE -DPAHO_BUILD_SHARED=TRUE -DCMAKE_BUILD_TYPE=Debug -DPAHO_WITH_LIBRESSL=TRUE -DLIBRESSL_ROOT_DIR=$(pwd)/../libressl-3.8.2/artifacts -DPAHO_BUILD_DOCUMENTATION=FALSE -DPAHO_BUILD_SAMPLES=TRUE -DPAHO_HIGH_PERFORMANCE=TRUE .. cmake --build . --config Debug -j$(nproc) - name: Start test broker run: | git clone https://github.com/eclipse/paho.mqtt.testing.git cd paho.mqtt.testing/interoperability python3 startbroker.py -c localhost_testing.conf & - name: Start test proxy run: | python3 test/mqttsas.py & - name: run tests run: | cd build.paho ctest -C Debug -VV --timeout 600 - name: clean up run: | killall python3 || true sleep 3 # allow broker time to terminate and report paho.mqtt.c-1.3.14/.gitignore000066400000000000000000000000731473722542500157370ustar00rootroot00000000000000/dep/ /build/ /build.paho/ *.swp *.pyc /build.paho .vscode/paho.mqtt.c-1.3.14/.gitreview000066400000000000000000000001441473722542500157540ustar00rootroot00000000000000[gerrit] host=git.eclipse.org port=29418 project=paho/org.eclipse.paho.mqtt.c defaultbranch=develop paho.mqtt.c-1.3.14/.project000066400000000000000000000017311473722542500154200ustar00rootroot00000000000000 org.eclipse.paho.mqtt.c org.python.pydev.PyDevBuilder org.eclipse.cdt.managedbuilder.core.genmakebuilder clean,full,incremental, org.eclipse.cdt.managedbuilder.core.ScannerConfigBuilder full,incremental, org.eclipse.cdt.core.cnature org.eclipse.cdt.core.ccnature org.eclipse.cdt.managedbuilder.core.managedBuildNature org.eclipse.cdt.managedbuilder.core.ScannerConfigNature org.python.pydev.pythonNature paho.mqtt.c-1.3.14/.pydevproject000066400000000000000000000004561473722542500164730ustar00rootroot00000000000000 Default python 2.7 paho.mqtt.c-1.3.14/.settings/000077500000000000000000000000001473722542500156655ustar00rootroot00000000000000paho.mqtt.c-1.3.14/.settings/org.eclipse.cdt.core.prefs000066400000000000000000000103011473722542500226330ustar00rootroot00000000000000eclipse.preferences.version=1 environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/BUILD_TYPE/delimiter=\: environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/BUILD_TYPE/operation=append environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/BUILD_TYPE/value=debug environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/CFLAGS/delimiter=\: environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/CFLAGS/operation=append environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/CFLAGS/value=-m32 environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/LDFLAGS/delimiter=\: environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/LDFLAGS/operation=append environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/LDFLAGS/value=-m32 environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/MACHINETYPE/delimiter=\: environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/MACHINETYPE/operation=append environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/MACHINETYPE/value=x86 environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/OSTYPE/delimiter=\: environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/OSTYPE/operation=append environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/OSTYPE/value=Linux environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/append=true environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.128299804/appendContributed=true environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/BUILD_TYPE/delimiter=\: environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/BUILD_TYPE/operation=append environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/BUILD_TYPE/value=debug environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/CC/delimiter=\: environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/CC/operation=append environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/CC/value=arm-linux-gnueabihf-gcc environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/CFLAGS/delimiter=\: environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/CFLAGS/operation=append environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/CFLAGS/value=-Idep/arm-linux-gnueabihf/include -Idep/arm-linux-gnueabihf/include/arm-linux-gnueabihf environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/LDFLAGS/delimiter=\: environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/LDFLAGS/operation=append environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/LDFLAGS/value=-Ldep/arm-linux-gnueabihf/lib environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/MACHINETYPE/delimiter=\: environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/MACHINETYPE/operation=append environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/MACHINETYPE/value=arm-linux-gnueabihf environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/OSTYPE/delimiter=\: environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/OSTYPE/operation=append environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/OSTYPE/value=Linux environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/append=true environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643.1588218084/appendContributed=true environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643/BUILD_TYPE/delimiter=\: environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643/BUILD_TYPE/operation=append environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643/BUILD_TYPE/value=debug environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643/append=true environment/project/cdt.managedbuild.toolchain.gnu.base.2116872643/appendContributed=true paho.mqtt.c-1.3.14/.travis.yml000066400000000000000000000054311473722542500160630ustar00rootroot00000000000000language: c jobs: include: - os: linux compiler: gcc dist: bionic env: OPENSSL_ROOT_DIR= PAHO_BUILD_STATIC=TRUE PAHO_BUILD_SHARED=FALSE PAHO_HIGH_PERFORMANCE=FALSE - os: linux compiler: gcc dist: xenial env: OPENSSL_ROOT_DIR= PAHO_BUILD_STATIC=TRUE PAHO_BUILD_SHARED=TRUE PAHO_HIGH_PERFORMANCE=TRUE - os: osx compiler: clang env: OPENSSL_ROOT_DIR=/usr/local/opt/openssl PAHO_BUILD_STATIC=FALSE PAHO_BUILD_SHARED=TRUE PAHO_HIGH_PERFORMANCE=FALSE - os: linux compiler: gcc dist: trusty env: OPENSSL_ROOT_DIR= PAHO_BUILD_STATIC=FALSE PAHO_BUILD_SHARED=TRUE PAHO_HIGH_PERFORMANCE=FALSE before_install: #- if [ "$DEPLOY" = "true" ]; then ./travis-setup-deploy.sh; fi - "./travis-install.sh" env: global: - secure: Ro53zVdGCjCQx9U4wvD9GBwB346tIQ7y1MWOAe1QrFWlmoQLC8KUeddQkc+27pdrOG9Fm9QQcI82EDlh0bfRBy1ITfWSVVZVfbNLv9sBWesND1F9YlnFpn/fag2OE+ULPSEJVJMxZoqiR9yiYWO3pTWue4YjCSuFAjpQNO6VnV3HiQJRG1jeaylx0QVLQWKAL/qkRbuqG9o4xpS1Kebaj86+q9UTHcL1a+Aj53u+Ajqnc9ZbUB/yBrfHyufTKpAD8Ef/FEIWXg2svtiWVEwEsPtdTn5P7AefJ2FNEyT4uMKIEBzWIPeWvUZLFF6U7QA07+uYDE0Ir4voPptBUlIYqQz1CUz9XCOPmM/N+GgqpyNyUjpMb4CM1b+iwBwcsHc0Z1JFcPz65ZMSt1D/WeUfQlaB/KxQBpz4lD2mxEmAuBIoGNrAG+FRULoY+xQSAf7V0W8am6QbHNnXif30mdkF3lgAhaAOwWO03JD7ctEJXqzRbMK8HrBkrgWfHsRRLFT50m8CrNLFz+3lCYuPHge2gHUMDfIHMxd4N9f2dlfV9GJkHQOQYwFfP5L2Y5Xq9KTnZX+bsglDC2WcOJu2F8h1LxTMV5Kku8zl1RZlEAt8Qa9EtCMczA3sL4NfGxazO22WpyOvHdwb26mhdJTgquI5oZsl71zcIf+WLGfgUAEq4/k= script: - if [[ "$COVERITY_SCAN_BRANCH" != 1 ]]; then ./travis-build.sh; fi addons: coverity_scan: project: name: eclipse/paho.mqtt.c notification_email: icraggs@gmail.com build_command_prepend: make clean build_command: make -j 4 branch_pattern: coverity-.* apt: packages: - cmake - cmake-data - doxygen ssh_known_hosts: build.eclipse.org after_success: - ls -l build.paho/*.tar.gz #- if [ "$DEPLOY" = "true" ]; then ./travis-deploy.sh; fi deploy: provider: releases api_key: secure: L5fp5Q+ZQvLt7jsQ6RUWbK6sm29ZNmfLmEXKZCg4g6+kaqxXmt3ijJT6VgNoZh209bP8TyfxDbbmdvfN542O4rM69WcyrBEIfsvkjs2thnyYpMz7PtDXUfiLdv/Wws4f8QCFOwy4xKmk4VFcrxPRoQRBGcQ23P3l1bcW56m4qB3JzupqHsj7/caMQmyk3gGKx/uSj9Vtvjl7z0pM1NuH2sxkdeUZ1FLDdb6HmY/Wo3v0ldO8gBUfrcjoi9zgjdV5AztxTafVhNu0LIbbAie1y6tMVGUqnXm2W4PqgfhtYAhM8VOfEykzh5sH0+DqA4G82X512aHHegdkK3/wt+DXZX6n/XK4tWBQR87vN8n8Lexj+uKC1Mmh7VTrO6f5QS/eXR1RvG5w+XBKIfHuOC6t6PS3NrRrGxUzY3DzgyBpUSaw+bNbL+auvN0bPz6lBjykiawdCZhjlqytNBOTsgNOyJaWJGE4fMTXQjVDcdZ8Cr/BOXHImXsm5cQ2clBwMg8RGwxBeX4nOcGaCfeYogI84z4uIRwTc5REnW4MCHeZgnZNvf3dG/hUCQpUPB2CIooqj84o36chjTp3at6mZxzKc1aATexmhu9UWRzqT3Ezs8KuaU4LxdlPI0UYO5bWf+BexRCmUwSkHlcqUwoZeRE/Fd4KXkm2r6anisyEJmywfD8= file_glob: true file: build.paho/*.tar.gz on: repo: eclipse/paho.mqtt.c tags: true skip_cleanup: true draft: false paho.mqtt.c-1.3.14/CMakeLists.txt000066400000000000000000000121571473722542500165150ustar00rootroot00000000000000#******************************************************************************* # Copyright (c) 2015, 2025 logi.cals GmbH, Frank Pagliughi and others # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Public License v2.0 # and Eclipse Distribution License v1.0 which accompany this distribution. # # The Eclipse Public License is available at # https://www.eclipse.org/legal/epl-2.0/ # and the Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Rainer Poisel - initial version # Genis Riera Perez - Add support for building debian package #*******************************************************************************/ cmake_minimum_required(VERSION 3.5) project("Eclipse Paho C" VERSION 1.3.14 LANGUAGES C ) message(STATUS "CMake version: " ${CMAKE_VERSION}) message(STATUS "CMake system name: " ${CMAKE_SYSTEM_NAME}) set(CMAKE_SCRIPTS "${PROJECT_SOURCE_DIR}/cmake") set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake/modules") ## Project Version ## Previously we read in the version from these files, but now we use the ## CMake project setting. We just make sure the files and CMake match. file(READ version.major PAHO_VERSION_MAJOR) file(READ version.minor PAHO_VERSION_MINOR) file(READ version.patch PAHO_VERSION_PATCH) set(CLIENT_VERSION ${PAHO_VERSION_MAJOR}.${PAHO_VERSION_MINOR}.${PAHO_VERSION_PATCH}) if(NOT (CLIENT_VERSION VERSION_EQUAL PROJECT_VERSION)) message(FATAL_ERROR "CMake project version does NOT match. CMake: ${PROJECT_VERSION}, Files: ${CLIENT_VERSION}") endif() include(GNUInstallDirs) string(TIMESTAMP BUILD_TIMESTAMP UTC) message(STATUS "Timestamp is ${BUILD_TIMESTAMP}") if(WIN32) add_definitions(-D_CRT_SECURE_NO_DEPRECATE -DWIN32_LEAN_AND_MEAN) elseif(${CMAKE_SYSTEM_NAME} STREQUAL "Darwin") add_definitions(-DOSX) endif() ## build options option(PAHO_WITH_SSL "Flag that defines whether to build ssl-enabled binaries too. " FALSE) option(PAHO_WITH_LIBRESSL "Flag that defines whether to build ssl-enabled binaries with LibreSSL instead of OpenSSL. " FALSE) option(PAHO_WITH_LIBUUID "Flag that defines whether libuuid or a custom uuid implementation should be used" FALSE) option(PAHO_BUILD_SHARED "Build shared library" TRUE) option(PAHO_BUILD_STATIC "Build static library" FALSE) option(PAHO_BUILD_DOCUMENTATION "Create and install the HTML based API documentation (requires Doxygen)" FALSE) option(PAHO_BUILD_SAMPLES "Build sample programs" FALSE) option(PAHO_BUILD_DEB_PACKAGE "Build debian package" FALSE) option(PAHO_ENABLE_TESTING "Build tests and run" TRUE) option(PAHO_ENABLE_CPACK "Enable CPack" TRUE) option(PAHO_HIGH_PERFORMANCE "Disable tracing and heap tracking" FALSE) option(PAHO_USE_SELECT "Revert to select system call instead of poll" FALSE) if(NOT WIN32) option(PAHO_WITH_UNIX_SOCKETS "Flag that defines whether to enable Unix-domain sockets" FALSE) if(PAHO_WITH_UNIX_SOCKETS) add_definitions(-DUNIXSOCK=1) endif() endif() if(PAHO_HIGH_PERFORMANCE) add_definitions(-DHIGH_PERFORMANCE=1) endif() if(PAHO_USE_SELECT) add_definitions(-DUSE_SELECT=1) endif() if(PAHO_WITH_LIBUUID) add_definitions(-DUSE_LIBUUID=1) endif() if(NOT PAHO_BUILD_SHARED AND NOT PAHO_BUILD_STATIC) message(FATAL_ERROR "You must set either PAHO_BUILD_SHARED, PAHO_BUILD_STATIC, or both") endif() if(PAHO_BUILD_SAMPLES AND NOT (PAHO_WITH_SSL OR PAHO_WITH_LIBRESSL)) message(WARNING "You must build with SSL to build the full set of samples") endif() if(PAHO_BUILD_DEB_PACKAGE) set(CMAKE_INSTALL_DOCDIR share/doc/libpaho-mqtt) set(CPACK_DEBIAN_PACKAGE_GENERATE_SHLIBS ON) set(CPACK_DEBIAN_PACKAGE_GENERATE_SHLIBS_POLICY ">=") endif() add_subdirectory(src) if(PAHO_BUILD_SAMPLES) add_subdirectory(src/samples) endif() if(PAHO_BUILD_DOCUMENTATION) add_subdirectory(doc) endif() if(PAHO_ENABLE_CPACK) ### packaging settings file(GLOB samples "src/samples/*.c") install(FILES ${samples} DESTINATION ${CMAKE_INSTALL_DOCDIR}/samples) set(CPACK_PACKAGE_VENDOR "Eclipse Paho") set(CPACK_PACKAGE_NAME "Eclipse-Paho-MQTT-C") install(FILES CONTRIBUTING.md epl-v20 edl-v10 README.md notice.html DESTINATION ${CMAKE_INSTALL_DOCDIR}) if(WIN32) set(CPACK_GENERATOR "ZIP") elseif(PAHO_BUILD_DEB_PACKAGE) install(FILES CONTRIBUTING.md epl-v20 edl-v10 README.md notice.html DESTINATION ${CMAKE_INSTALL_DOCDIR}) set(CPACK_GENERATOR "DEB") configure_file(${CMAKE_SCRIPTS}/CPackDebConfig.cmake.in ${CMAKE_BINARY_DIR}/CPackDebConfig.cmake @ONLY ) set(CPACK_PROJECT_CONFIG_FILE ${CMAKE_BINARY_DIR}/CPackDebConfig.cmake) else() set(CPACK_GENERATOR "TGZ") endif() else() file(GLOB samples "src/samples/*.c") install(FILES ${samples} DESTINATION ${CMAKE_INSTALL_DOCDIR}) endif() set(CPACK_PACKAGE_VERSION_MAJOR ${PROJECT_VERSION_MAJOR}) set(CPACK_PACKAGE_VERSION_MINOR ${PROJECT_VERSION_MINOR}) set(CPACK_PACKAGE_VERSION_PATCH ${PROJECT_VERSION_PATCH}) include(CPack) if(PAHO_ENABLE_TESTING) enable_testing() include_directories(test src) add_subdirectory(test) else() include_directories(src) endif() paho.mqtt.c-1.3.14/CODE_OF_CONDUCT.md000066400000000000000000000065441473722542500165570ustar00rootroot00000000000000# Community Code of Conduct **Version 1.2 August 19, 2020** ## Our Pledge In the interest of fostering an open and welcoming environment, we as community members, contributors, committers, and project leaders pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards Examples of behavior that contributes to creating a positive environment include: * Using welcoming and inclusive language * Being respectful of differing viewpoints and experiences * Gracefully accepting constructive criticism * Focusing on what is best for the community * Showing empathy towards other community members Examples of unacceptable behavior by participants include: * The use of sexualized language or imagery and unwelcome sexual attention or advances * Trolling, insulting/derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or electronic address, without explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities With the support of the Eclipse Foundation staff (the “Staffâ€), project committers and leaders are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project committers and leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. ## Scope This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the Eclipse Foundation project or its community in public spaces. Examples of representing a project or community include posting via an official social media account, or acting as a project representative at an online or offline event. Representation of a project may be further defined and clarified by project committers, leaders, or the EMO. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Staff at codeofconduct@eclipse.org. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The Staff is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project committers or leaders who do not follow the Code of Conduct in good faith may face temporary or permanent repercussions as determined by the Staff. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org) , version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct/) paho.mqtt.c-1.3.14/CONTRIBUTING.md000066400000000000000000000072111473722542500162010ustar00rootroot00000000000000# Contributing to Paho Thanks for your interest in this project! You can contribute bugfixes and new features by sending pull requests through GitHub. ## Legal In order for your contribution to be accepted, it must comply with the Eclipse Foundation IP policy. Please read the [Eclipse Foundation policy on accepting contributions via Git](http://wiki.eclipse.org/Development_Resources/Contributing_via_Git). 1. Sign the [Eclipse ECA](http://www.eclipse.org/legal/ECA.php) 1. Register for an Eclipse Foundation User ID. You can register [here](https://dev.eclipse.org/site_login/createaccount.php). 2. Log into the [Eclipse projects forge](https://www.eclipse.org/contribute/cla), and click on 'Eclipse Contributor Agreement'. 2. Go to your [account settings](https://dev.eclipse.org/site_login/myaccount.php#open_tab_accountsettings) and add your GitHub username to your account. 3. Make sure that you _sign-off_ your Git commits in the following format: ``` Signed-off-by: Alex Smith ``` This is usually at the bottom of the commit message. You can automate this by adding the '-s' flag when you make the commits. e.g. ```git commit -s -m "Adding a cool feature"``` 4. Ensure that the email address that you make your commits with is the same one you used to sign up to the Eclipse Foundation website with. ## Contributing a change 1. [Fork the repository on GitHub](https://github.com/eclipse/paho.mqtt.c/fork) 2. Clone the forked repository onto your computer: ``` git clone https://github.com//paho.mqtt.c.git ``` 3. Create a new branch from the latest ```develop``` branch with ```git checkout -b YOUR_BRANCH_NAME origin/develop``` 4. Make your changes 5. If developing a new feature, make sure to include JUnit tests. 6. Ensure that all new and existing tests pass. 7. Commit the changes into the branch: ``` git commit -s ``` Make sure that your commit message is meaningful and describes your changes correctly. 8. If you have a lot of commits for the change, squash them into a single / few commits. 9. Push the changes in your branch to your forked repository. 10. Finally, go to [https://github.com/eclipse/paho.mqtt.c](https://github.com/eclipse/paho.mqtt.c) and create a pull request from your "YOUR_BRANCH_NAME" branch to the ```develop``` one to request review and merge of the commits in your pushed branch. What happens next depends on the content of the patch. If it is 100% authored by the contributor with less than 1000 lines of new product code that meets the needs of the project (refactored, test code and sample code is excluded from the count), then it can be pulled into the main repository. When there are more than 1000 lines of new product code, more steps are required. More details are provided in the [handbook](https://www.eclipse.org/projects/handbook/#ip). ## Developer resources: Information regarding source code management, builds, coding standards, and more. - [https://projects.eclipse.org/projects/iot.paho/developer](https://projects.eclipse.org/projects/iot.paho/developer) Contact: -------- Contact the project developers via the project's development [mailing list](https://dev.eclipse.org/mailman/listinfo/paho-dev). Search for bugs: ---------------- This project uses GitHub Issues here: [github.com/eclipse/paho.mqtt.c/issues](https://github.com/eclipse/paho.mqtt.c/issues) to track ongoing development and issues. Create a new bug: ----------------- Be sure to search for existing bugs before you create another one. Remember that contributions are always welcome! - [Create new Paho bug](https://github.com/eclipse/paho.mqtt.c/issues/new) paho.mqtt.c-1.3.14/LICENSE000066400000000000000000000010101473722542500147440ustar00rootroot00000000000000Eclipse Public License - v 2.0 This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 and Eclipse Distribution License v1.0 which accompany this distribution. The Eclipse Public License is available at https://www.eclipse.org/legal/epl-2.0/ and the Eclipse Distribution License is available at http://www.eclipse.org/org/documents/edl-v10.php. For an explanation of what dual-licensing means to you, see: https://www.eclipse.org/legal/eplfaq.php#DUALLIC paho.mqtt.c-1.3.14/Makefile000066400000000000000000000362061473722542500154160ustar00rootroot00000000000000#******************************************************************************* # Copyright (c) 2009, 2021 IBM Corp. # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Public License v2.0 # and Eclipse Distribution License v1.0 which accompany this distribution. # # The Eclipse Public License is available at # https://www.eclipse.org/legal/epl-2.0/ # and the Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Ian Craggs - initial API and implementation and/or initial documentation # Allan Stockdill-Mander - SSL updates # Andy Piper - various fixes # Ian Craggs - OSX build # Rainer Poisel - support for multi-core builds and cross-compilation #*******************************************************************************/ # Note: on OS X you should install XCode and the associated command-line tools SHELL = /bin/sh .PHONY: clean mkdir install install-strip uninstall html strip-options MAJOR_VERSION := $(shell cat version.major) MINOR_VERSION := $(shell cat version.minor) PATCH_VERSION := $(shell cat version.patch) ifndef release.version release.version = $(MAJOR_VERSION).$(MINOR_VERSION).$(PATCH_VERSION) endif # determine current platform BUILD_TYPE ?= debug ifeq ($(OS),Windows_NT) OSTYPE ?= $(OS) MACHINETYPE ?= $(PROCESSOR_ARCHITECTURE) else OSTYPE ?= $(shell uname -s) MACHINETYPE ?= $(shell uname -m) build.level = $(shell date) endif # OS ifeq ($(OSTYPE),linux) OSTYPE = Linux endif # assume this is normally run in the main Paho directory ifndef srcdir srcdir = src endif ifndef blddir blddir = build/output endif ifndef blddir_work blddir_work = build endif ifndef docdir docdir = $(blddir)/doc endif ifndef docdir_work docdir_work = $(blddir)/../doc endif ifndef prefix prefix = /usr/local endif ifndef exec_prefix exec_prefix = ${prefix} endif bindir = $(exec_prefix)/bin includedir = $(prefix)/include libdir = $(exec_prefix)/lib datarootdir = $(prefix)/share mandir = $(datarootdir)/man man1dir = $(mandir)/man1 man2dir = $(mandir)/man2 man3dir = $(mandir)/man3 SOURCE_FILES = $(wildcard $(srcdir)/*.c) SOURCE_FILES_C = $(filter-out $(srcdir)/MQTTAsync.c $(srcdir)/MQTTAsyncUtils.c $(srcdir)/MQTTVersion.c $(srcdir)/SSLSocket.c, $(SOURCE_FILES)) SOURCE_FILES_CS = $(filter-out $(srcdir)/MQTTAsync.c $(srcdir)/MQTTAsyncUtils.c $(srcdir)/MQTTVersion.c, $(SOURCE_FILES)) SOURCE_FILES_A = $(filter-out $(srcdir)/MQTTClient.c $(srcdir)/MQTTVersion.c $(srcdir)/SSLSocket.c, $(SOURCE_FILES)) SOURCE_FILES_AS = $(filter-out $(srcdir)/MQTTClient.c $(srcdir)/MQTTVersion.c, $(SOURCE_FILES)) HEADERS = $(srcdir)/*.h HEADERS_C = $(filter-out $(srcdir)/MQTTAsync.h, $(HEADERS)) HEADERS_A = $(HEADERS) SAMPLE_FILES_C = MQTTClient_publish MQTTClient_publish_async MQTTClient_subscribe SYNC_SAMPLES = ${addprefix ${blddir}/samples/,${SAMPLE_FILES_C}} UTIL_FILES_CS = paho_cs_pub paho_cs_sub SYNC_UTILS = ${addprefix ${blddir}/samples/,${UTIL_FILES_CS}} SAMPLE_FILES_A = MQTTAsync_subscribe MQTTAsync_publish ASYNC_SAMPLES = ${addprefix ${blddir}/samples/,${SAMPLE_FILES_A}} UTIL_FILES_AS = paho_c_pub paho_c_sub ASYNC_UTILS = ${addprefix ${blddir}/samples/,${UTIL_FILES_AS}} TEST_FILES_C = test1 test15 test2 sync_client_test test_mqtt4sync test10 SYNC_TESTS = ${addprefix ${blddir}/test/,${TEST_FILES_C}} TEST_FILES_CS = test3 SYNC_SSL_TESTS = ${addprefix ${blddir}/test/,${TEST_FILES_CS}} TEST_FILES_A = test4 test45 test6 test9 test95 test_mqtt4async test11 ASYNC_TESTS = ${addprefix ${blddir}/test/,${TEST_FILES_A}} TEST_FILES_AS = test5 ASYNC_SSL_TESTS = ${addprefix ${blddir}/test/,${TEST_FILES_AS}} # The names of the four different libraries to be built MQTTLIB_C = paho-mqtt3c MQTTLIB_CS = paho-mqtt3cs MQTTLIB_A = paho-mqtt3a MQTTLIB_AS = paho-mqtt3as CC ?= gcc ifndef INSTALL INSTALL = install endif INSTALL_PROGRAM = $(INSTALL) INSTALL_DATA = $(INSTALL) -m 644 DOXYGEN_COMMAND = doxygen VERSION = ${MAJOR_VERSION}.${MINOR_VERSION} MQTTLIB_C_NAME = lib${MQTTLIB_C}.so.${VERSION} MQTTLIB_CS_NAME = lib${MQTTLIB_CS}.so.${VERSION} MQTTLIB_A_NAME = lib${MQTTLIB_A}.so.${VERSION} MQTTLIB_AS_NAME = lib${MQTTLIB_AS}.so.${VERSION} MQTTVERSION_NAME = paho_c_version PAHO_C_PUB_NAME = paho_c_pub PAHO_C_SUB_NAME = paho_c_sub PAHO_CS_PUB_NAME = paho_cs_pub PAHO_CS_SUB_NAME = paho_cs_sub MQTTLIB_C_TARGET = ${blddir}/${MQTTLIB_C_NAME} MQTTLIB_CS_TARGET = ${blddir}/${MQTTLIB_CS_NAME} MQTTLIB_A_TARGET = ${blddir}/${MQTTLIB_A_NAME} MQTTLIB_AS_TARGET = ${blddir}/${MQTTLIB_AS_NAME} MQTTVERSION_TARGET = ${blddir}/${MQTTVERSION_NAME} PAHO_C_PUB_TARGET = ${blddir}/samples/${PAHO_C_PUB_NAME} PAHO_C_SUB_TARGET = ${blddir}/samples/${PAHO_C_SUB_NAME} PAHO_CS_PUB_TARGET = ${blddir}/samples/${PAHO_CS_PUB_NAME} PAHO_CS_SUB_TARGET = ${blddir}/samples/${PAHO_CS_SUB_NAME} #CCFLAGS_SO = -g -fPIC $(CFLAGS) -Os -Wall -fvisibility=hidden -I$(blddir_work) #FLAGS_EXE = $(LDFLAGS) -I ${srcdir} -pthread -L ${blddir} #FLAGS_EXES = $(LDFLAGS) -I ${srcdir} ${START_GROUP} -pthread -lssl -lcrypto ${END_GROUP} -L ${blddir} CCFLAGS_SO = -g -fPIC $(CFLAGS) -D_GNU_SOURCE -Os -Wall -fvisibility=hidden -I$(blddir_work) -DPAHO_MQTT_EXPORTS=1 FLAGS_EXE = $(LDFLAGS) -I ${srcdir} ${START_GROUP} -pthread ${GAI_LIB} ${END_GROUP} -L ${blddir} FLAGS_EXES = $(LDFLAGS) -I ${srcdir} ${START_GROUP} -pthread ${GAI_LIB} -lssl -lcrypto ${END_GROUP} -L ${blddir} LDCONFIG ?= /sbin/ldconfig LDFLAGS_C = $(LDFLAGS) -shared -Wl,-init,$(MQTTCLIENT_INIT) $(START_GROUP) -pthread $(GAI_LIB) $(END_GROUP) LDFLAGS_CS = $(LDFLAGS) -shared $(START_GROUP) -pthread $(GAI_LIB) $(EXTRA_LIB) -lssl -lcrypto $(END_GROUP) -Wl,-init,$(MQTTCLIENT_INIT) LDFLAGS_A = $(LDFLAGS) -shared -Wl,-init,$(MQTTASYNC_INIT) $(START_GROUP) -pthread $(GAI_LIB) $(END_GROUP) LDFLAGS_AS = $(LDFLAGS) -shared $(START_GROUP) -pthread $(GAI_LIB) $(EXTRA_LIB) -lssl -lcrypto $(END_GROUP) -Wl,-init,$(MQTTASYNC_INIT) SED_COMMAND = sed \ -e "s/@CLIENT_VERSION@/${release.version}/g" \ -e "s/@BUILD_TIMESTAMP@/${build.level}/g" ifeq ($(OSTYPE),Linux) MQTTCLIENT_INIT = MQTTClient_init MQTTASYNC_INIT = MQTTAsync_init START_GROUP = -Wl,--start-group END_GROUP = -Wl,--end-group GAI_LIB = -lanl EXTRA_LIB = -ldl LDFLAGS_C += -Wl,-soname,lib$(MQTTLIB_C).so.${MAJOR_VERSION} LDFLAGS_CS += -Wl,-soname,lib$(MQTTLIB_CS).so.${MAJOR_VERSION} -Wl,-no-whole-archive LDFLAGS_A += -Wl,-soname,lib${MQTTLIB_A}.so.${MAJOR_VERSION} LDFLAGS_AS += -Wl,-soname,lib${MQTTLIB_AS}.so.${MAJOR_VERSION} -Wl,-no-whole-archive else ifeq ($(OSTYPE),Darwin) MQTTCLIENT_INIT = _MQTTClient_init MQTTASYNC_INIT = _MQTTAsync_init START_GROUP = END_GROUP = GAI_LIB = EXTRA_LIB = -ldl CCFLAGS_SO += -Wno-deprecated-declarations -DOSX -I /usr/local/opt/openssl/include LDFLAGS_C += -Wl,-install_name,lib$(MQTTLIB_C).so.${MAJOR_VERSION} LDFLAGS_CS += -Wl,-install_name,lib$(MQTTLIB_CS).so.${MAJOR_VERSION} -L /usr/local/opt/openssl/lib LDFLAGS_A += -Wl,-install_name,lib${MQTTLIB_A}.so.${MAJOR_VERSION} LDFLAGS_AS += -Wl,-install_name,lib${MQTTLIB_AS}.so.${MAJOR_VERSION} -L /usr/local/opt/openssl/lib FLAGS_EXE += -DOSX FLAGS_EXES += -L /usr/local/opt/openssl/lib LDCONFIG = echo endif all: build build: | mkdir ${MQTTLIB_C_TARGET} ${MQTTLIB_CS_TARGET} ${MQTTLIB_A_TARGET} ${MQTTLIB_AS_TARGET} ${MQTTVERSION_TARGET} ${SYNC_SAMPLES} ${SYNC_UTILS} ${ASYNC_SAMPLES} ${ASYNC_UTILS} ${SYNC_TESTS} ${SYNC_SSL_TESTS} ${ASYNC_TESTS} ${ASYNC_SSL_TESTS} clean: rm -rf ${blddir}/* rm -rf ${blddir_work}/* mkdir: -mkdir -p ${blddir}/samples -mkdir -p ${blddir}/test echo OSTYPE is $(OSTYPE) ${SYNC_TESTS}: ${blddir}/test/%: ${srcdir}/../test/%.c $(MQTTLIB_C_TARGET) ${CC} -DNOSTACKTRACE -DNOLOG_MESSAGES $(srcdir)/Thread.c -g -o $@ $< -l${MQTTLIB_C} ${FLAGS_EXE} ${SYNC_SSL_TESTS}: ${blddir}/test/%: ${srcdir}/../test/%.c $(MQTTLIB_CS_TARGET) ${CC} -g -o $@ $< -l${MQTTLIB_CS} ${FLAGS_EXES} ${ASYNC_TESTS}: ${blddir}/test/%: ${srcdir}/../test/%.c $(MQTTLIB_A_TARGET) ${CC} -g -o $@ $< -l${MQTTLIB_A} ${FLAGS_EXE} ${ASYNC_SSL_TESTS}: ${blddir}/test/%: ${srcdir}/../test/%.c $(MQTTLIB_AS_TARGET) ${CC} -g -o $@ $< -l${MQTTLIB_AS} ${FLAGS_EXES} ${SYNC_SAMPLES}: ${blddir}/samples/%: ${srcdir}/samples/%.c $(MQTTLIB_CS_TARGET) ${CC} -o $@ $< -l${MQTTLIB_CS} ${FLAGS_EXES} ${SYNC_UTILS}: ${blddir}/samples/%: ${srcdir}/samples/%.c ${srcdir}/samples/pubsub_opts.c $(MQTTLIB_CS_TARGET) ${CC} -o $@ $< -l${MQTTLIB_CS} ${FLAGS_EXES} ${srcdir}/samples/pubsub_opts.c ${ASYNC_SAMPLES}: ${blddir}/samples/%: ${srcdir}/samples/%.c $(MQTTLIB_AS_TARGET) ${CC} -o $@ $< -l${MQTTLIB_AS} ${FLAGS_EXES} ${ASYNC_UTILS}: ${blddir}/samples/%: ${srcdir}/samples/%.c ${srcdir}/samples/pubsub_opts.c $(MQTTLIB_AS_TARGET) ${CC} -o $@ $< -l${MQTTLIB_AS} ${FLAGS_EXES} ${srcdir}/samples/pubsub_opts.c $(blddir_work)/VersionInfo.h: $(srcdir)/VersionInfo.h.in -mkdir -p $(blddir_work) $(SED_COMMAND) $< > $@ ${MQTTLIB_C_TARGET}: ${SOURCE_FILES_C} ${HEADERS_C} $(blddir_work)/VersionInfo.h ${CC} ${CCFLAGS_SO} -o $@ ${SOURCE_FILES_C} ${LDFLAGS_C} -ln -s lib$(MQTTLIB_C).so.${VERSION} ${blddir}/lib$(MQTTLIB_C).so.${MAJOR_VERSION} -ln -s lib$(MQTTLIB_C).so.${MAJOR_VERSION} ${blddir}/lib$(MQTTLIB_C).so ${MQTTLIB_CS_TARGET}: ${SOURCE_FILES_CS} ${HEADERS_C} $(blddir_work)/VersionInfo.h ${CC} ${CCFLAGS_SO} -o $@ ${SOURCE_FILES_CS} -DOPENSSL ${LDFLAGS_CS} -ln -s lib$(MQTTLIB_CS).so.${VERSION} ${blddir}/lib$(MQTTLIB_CS).so.${MAJOR_VERSION} -ln -s lib$(MQTTLIB_CS).so.${MAJOR_VERSION} ${blddir}/lib$(MQTTLIB_CS).so ${MQTTLIB_A_TARGET}: ${SOURCE_FILES_A} ${HEADERS_A} $(blddir_work)/VersionInfo.h ${CC} ${CCFLAGS_SO} -o $@ ${SOURCE_FILES_A} ${LDFLAGS_A} -ln -s lib$(MQTTLIB_A).so.${VERSION} ${blddir}/lib$(MQTTLIB_A).so.${MAJOR_VERSION} -ln -s lib$(MQTTLIB_A).so.${MAJOR_VERSION} ${blddir}/lib$(MQTTLIB_A).so ${MQTTLIB_AS_TARGET}: ${SOURCE_FILES_AS} ${HEADERS_A} $(blddir_work)/VersionInfo.h ${CC} ${CCFLAGS_SO} -o $@ ${SOURCE_FILES_AS} -DOPENSSL ${LDFLAGS_AS} -ln -s lib$(MQTTLIB_AS).so.${VERSION} ${blddir}/lib$(MQTTLIB_AS).so.${MAJOR_VERSION} -ln -s lib$(MQTTLIB_AS).so.${MAJOR_VERSION} ${blddir}/lib$(MQTTLIB_AS).so ${MQTTVERSION_TARGET}: $(srcdir)/MQTTVersion.c $(srcdir)/MQTTAsync.h $(MQTTLIB_A_TARGET) ${CC} ${FLAGS_EXE} -o $@ -l${MQTTLIB_A} $(srcdir)/MQTTVersion.c -ldl strip_options: $(eval INSTALL_OPTS := -s) install-strip: build strip_options install install: build mkdir -p $(DESTDIR)$(PREFIX)${includedir} $(INSTALL_DATA) ${INSTALL_OPTS} ${MQTTLIB_C_TARGET} $(DESTDIR)${libdir} $(INSTALL_DATA) ${INSTALL_OPTS} ${MQTTLIB_CS_TARGET} $(DESTDIR)${libdir} $(INSTALL_DATA) ${INSTALL_OPTS} ${MQTTLIB_A_TARGET} $(DESTDIR)${libdir} $(INSTALL_DATA) ${INSTALL_OPTS} ${MQTTLIB_AS_TARGET} $(DESTDIR)${libdir} $(INSTALL_PROGRAM) ${INSTALL_OPTS} ${MQTTVERSION_TARGET} $(DESTDIR)${bindir} $(INSTALL_PROGRAM) ${INSTALL_OPTS} ${PAHO_C_PUB_TARGET} $(DESTDIR)${bindir} $(INSTALL_PROGRAM) ${INSTALL_OPTS} ${PAHO_C_SUB_TARGET} $(DESTDIR)${bindir} $(INSTALL_PROGRAM) ${INSTALL_OPTS} ${PAHO_CS_PUB_TARGET} $(DESTDIR)${bindir} $(INSTALL_PROGRAM) ${INSTALL_OPTS} ${PAHO_CS_SUB_TARGET} $(DESTDIR)${bindir} $(LDCONFIG) $(DESTDIR)${libdir} ln -s lib$(MQTTLIB_C).so.${MAJOR_VERSION} $(DESTDIR)${libdir}/lib$(MQTTLIB_C).so ln -s lib$(MQTTLIB_CS).so.${MAJOR_VERSION} $(DESTDIR)${libdir}/lib$(MQTTLIB_CS).so ln -s lib$(MQTTLIB_A).so.${MAJOR_VERSION} $(DESTDIR)${libdir}/lib$(MQTTLIB_A).so ln -s lib$(MQTTLIB_AS).so.${MAJOR_VERSION} $(DESTDIR)${libdir}/lib$(MQTTLIB_AS).so @if test ! -f $(DESTDIR)${libdir}/lib$(MQTTLIB_C).so.${MAJOR_VERSION}; then ln -s lib$(MQTTLIB_C).so.${VERSION} $(DESTDIR)${libdir}/lib$(MQTTLIB_C).so.${MAJOR_VERSION}; fi @if test ! -f $(DESTDIR)${libdir}/lib$(MQTTLIB_CS).so.${MAJOR_VERSION}; then ln -s lib$(MQTTLIB_CS).so.${VERSION} $(DESTDIR)${libdir}/lib$(MQTTLIB_CS).so.${MAJOR_VERSION}; fi @if test ! -f $(DESTDIR)${libdir}/lib$(MQTTLIB_A).so.${MAJOR_VERSION}; then ln -s lib$(MQTTLIB_A).so.${VERSION} $(DESTDIR)${libdir}/lib$(MQTTLIB_A).so.${MAJOR_VERSION}; fi @if test ! -f $(DESTDIR)${libdir}/lib$(MQTTLIB_AS).so.${MAJOR_VERSION}; then ln -s lib$(MQTTLIB_AS).so.${VERSION} $(DESTDIR)${libdir}/lib$(MQTTLIB_AS).so.${MAJOR_VERSION}; fi $(INSTALL_DATA) ${srcdir}/MQTTAsync.h $(DESTDIR)${includedir} $(INSTALL_DATA) ${srcdir}/MQTTClient.h $(DESTDIR)${includedir} $(INSTALL_DATA) ${srcdir}/MQTTClientPersistence.h $(DESTDIR)${includedir} $(INSTALL_DATA) ${srcdir}/MQTTProperties.h $(DESTDIR)${includedir} $(INSTALL_DATA) ${srcdir}/MQTTReasonCodes.h $(DESTDIR)${includedir} $(INSTALL_DATA) ${srcdir}/MQTTSubscribeOpts.h $(DESTDIR)${includedir} $(INSTALL_DATA) ${srcdir}/MQTTExportDeclarations.h $(DESTDIR)${includedir} - $(INSTALL_DATA) doc/man/man1/paho_c_pub.1 $(DESTDIR)${man1dir} - $(INSTALL_DATA) doc/man/man1/paho_c_sub.1 $(DESTDIR)${man1dir} - $(INSTALL_DATA) doc/man/man1/paho_cs_pub.1 $(DESTDIR)${man1dir} - $(INSTALL_DATA) doc/man/man1/paho_cs_sub.1 $(DESTDIR)${man1dir} ifneq ("$(wildcard ${blddir}/doc/MQTTClient/man/man3/MQTTClient.h.3)","") - $(INSTALL_DATA) ${blddir}/doc/MQTTClient/man/man3/MQTTClient.h.3 $(DESTDIR)${man3dir} endif ifneq ("$(wildcard ${blddir}/doc/MQTTAsync/man/man3/MQTTAsync.h.3)","") - $(INSTALL_DATA) ${blddir}/doc/MQTTAsync/man/man3/MQTTAsync.h.3 $(DESTDIR)${man3dir} endif uninstall: - rm $(DESTDIR)${libdir}/${MQTTLIB_C_NAME} - rm $(DESTDIR)${libdir}/${MQTTLIB_CS_NAME} - rm $(DESTDIR)${libdir}/${MQTTLIB_A_NAME} - rm $(DESTDIR)${libdir}/${MQTTLIB_AS_NAME} - rm $(DESTDIR)${bindir}/${MQTTVERSION_NAME} - rm $(DESTDIR)${bindir}/${PAHO_C_PUB_NAME} - rm $(DESTDIR)${bindir}/${PAHO_C_SUB_NAME} - rm $(DESTDIR)${bindir}/${PAHO_CS_PUB_NAME} - rm $(DESTDIR)${bindir}/${PAHO_CS_SUB_NAME} $(LDCONFIG) $(DESTDIR)${libdir} - rm $(DESTDIR)${libdir}/lib$(MQTTLIB_C).so - rm $(DESTDIR)${libdir}/lib$(MQTTLIB_CS).so - rm $(DESTDIR)${libdir}/lib$(MQTTLIB_A).so - rm $(DESTDIR)${libdir}/lib$(MQTTLIB_AS).so - rm $(DESTDIR)${libdir}/lib$(MQTTLIB_C).so.${MAJOR_VERSION} - rm $(DESTDIR)${libdir}/lib$(MQTTLIB_CS).so.${MAJOR_VERSION} - rm $(DESTDIR)${libdir}/lib$(MQTTLIB_A).so.${MAJOR_VERSION} - rm $(DESTDIR)${libdir}/lib$(MQTTLIB_AS).so.${MAJOR_VERSION} - rm $(DESTDIR)${includedir}/MQTTAsync.h - rm $(DESTDIR)${includedir}/MQTTClient.h - rm $(DESTDIR)${includedir}/MQTTClientPersistence.h - rm $(DESTDIR)${includedir}/MQTTProperties.h - rm $(DESTDIR)${includedir}/MQTTReasonCodes.h - rm $(DESTDIR)${includedir}/MQTTSubscribeOpts.h - rm $(DESTDIR)${includedir}/MQTTExportDeclarations.h - rm $(DESTDIR)${man1dir}/paho_c_pub.1 - rm $(DESTDIR)${man1dir}/paho_c_sub.1 - rm $(DESTDIR)${man1dir}/paho_cs_pub.1 - rm $(DESTDIR)${man1dir}/paho_cs_sub.1 ifneq ("$(wildcard $(DESTDIR)${man3dir}/MQTTClient.h.3)","") - rm $(DESTDIR)${man3dir}/MQTTClient.h.3 endif ifneq ("$(wildcard $(DESTDIR)${man3dir}/MQTTAsync.h.3)","") - rm $(DESTDIR)${man3dir}/MQTTAsync.h.3 endif REGEX_DOXYGEN := \ 's;@PROJECT_SOURCE_DIR@/src/\?;;' \ 's;@PROJECT_SOURCE_DIR@;..;' \ 's;@CMAKE_CURRENT_BINARY_DIR@;../build/output;' SED_DOXYGEN := $(foreach sed_exp,$(REGEX_DOXYGEN),-e $(sed_exp)) define process_doxygen cd ${srcdir}; sed $(SED_DOXYGEN) ../doc/${1}.in > ../$(docdir_work)/${1} cd ${srcdir}; $(DOXYGEN_COMMAND) ../$(docdir_work)/${1} endef html: -mkdir -p $(docdir_work) -mkdir -p ${docdir} $(call process_doxygen,DoxyfileV3ClientAPI) $(call process_doxygen,DoxyfileV3AsyncAPI) $(call process_doxygen,DoxyfileV3ClientInternal) paho.mqtt.c-1.3.14/NOTICE000066400000000000000000000040221473722542500146510ustar00rootroot00000000000000# Notices for Eclipse Paho This content is produced and maintained by the Eclipse Paho project. * Project home: https://projects.eclipse.org/projects/iot.paho ## Trademarks Pahoâ„¢ is a trademark of the Eclipse Foundation. ## Copyright All content is the property of the respective authors or their employers. For more information regarding authorship of content, please consult the listed source code repository logs. ## Declared Project Licenses This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which is available at https://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License v1.0 which is available at https://www.eclipse.org/org/documents/edl-v10.php. SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause ## Source Code The project maintains the following source code repositories: * https://github.com/eclipse/paho-website * https://github.com/eclipse/paho.golang * https://github.com/eclipse/paho.mqtt-sn.embedded-c * https://github.com/eclipse/paho.mqtt-spy * https://github.com/eclipse/paho.mqtt.android * https://github.com/eclipse/paho.mqtt.c * https://github.com/eclipse/paho.mqtt.cpp * https://github.com/eclipse/paho.mqtt.d * https://github.com/eclipse/paho.mqtt.embedded-c * https://github.com/eclipse/paho.mqtt.golang * https://github.com/eclipse/paho.mqtt.java * https://github.com/eclipse/paho.mqtt.javascript * https://github.com/eclipse/paho.mqtt.m2mqtt * https://github.com/eclipse/paho.mqtt.python * https://github.com/eclipse/paho.mqtt.ruby * https://github.com/eclipse/paho.mqtt.rust * https://github.com/eclipse/paho.mqtt.testing ## Cryptography Content may contain encryption software. The country in which you are currently may have restrictions on the import, possession, and use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check the country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. paho.mqtt.c-1.3.14/PULL_REQUEST_TEMPLATE.md000066400000000000000000000011101473722542500175410ustar00rootroot00000000000000 Thank you for your interest in this project managed by the Eclipse Foundation. The guidelines for contributions can be found in the CONTRIBUTING.md file. At a minimum, you must sign the Eclipse ECA, and sign off each commit. To complete and submit a ECA, log into the Eclipse projects forge You will need to create an account with the Eclipse Foundation if you have not already done so. Be sure to use the same email address when you register for the account that you intend to use when you commit to Git. Go to https://accounts.eclipse.org/user/eca to sign the Eclipse ECA. paho.mqtt.c-1.3.14/README.md000066400000000000000000000415321473722542500152330ustar00rootroot00000000000000[![Build Status](https://travis-ci.org/eclipse/paho.mqtt.c.svg?branch=master)](https://travis-ci.org/eclipse/paho.mqtt.c) [![Total Alerts](https://img.shields.io/lgtm/alerts/g/eclipse/paho.mqtt.c.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/eclipse/paho.mqtt.c/alerts/) [![Coverity Scan Build Status](https://scan.coverity.com/projects/2339/badge.svg)](https://scan.coverity.com/projects/paho-c) # Eclipse Paho C Client Library for the MQTT Protocol This repository contains the source code for the [Eclipse Paho](http://eclipse.org/paho) MQTT C client library. This code builds libraries which enable applications to connect to an [MQTT](http://mqtt.org) broker to publish messages, and to subscribe to topics and receive published messages. Synchronous and various asynchronous programming models are supported. ## Information About MQTT * [MQTT website](http://mqtt.org) * [The MQTT 3.1.1 standard](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html) * [The MQTT 5.0 standard](https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html) * [HiveMQ introduction to MQTT](https://www.hivemq.com/mqtt/) * [OASIS Introduction to MQTT presentation](https://www.oasis-open.org/committees/download.php/49205/MQTT-OASIS-Webinar.pdf) ## Libraries The Paho C client comprises four variant libraries, shared or static: * paho-mqtt3a - asynchronous (MQTTAsync) * paho-mqtt3as - asynchronous with SSL/TLS (MQTTAsync) * paho-mqtt3c - "classic" / synchronous (MQTTClient) * paho-mqtt3cs - "classic" / synchronous with SSL/TLS (MQTTClient) [Which Paho C API to use, with some history, for context](https://modelbasedtesting.co.uk/2013/10/13/which-paho-mqtt-c-api-to-use-and-some-history/) ## Usage and API Detailed API documentation [is available online](https://eclipse-paho.github.io/paho.mqtt.c/MQTTClient/html/). It is also available by building the Doxygen docs in the ``doc`` directory. Samples are available in the Doxygen docs and also in `src/samples` for reference. These are: - *paho_c_pub.c* and *paho_c_sub.c:* command line utilities to publish and subscribe, -h will give help - *paho_cs_pub.c* and *paho_cs_sub.c:* command line utilities using MQTTClient to publish and subscribe - *MQTTClient_publish.c, MQTTClient_subscribe.c* and *MQTTClient_publish_async.c:* MQTTClient simple code examples - *MQTTAsync_publish.c* and *MQTTAsync_subscribe.c:* MQTTAsync simple code examples Some potentially useful blog posts: - [Paho client MQTT 5.0 support and command line utilities](https://modelbasedtesting.co.uk/2018/08/08/paho-c-client-mqtt-5-0-and-command-line-utilities/) - [MQTT, QoS and persistence](https://modelbasedtesting.co.uk/2013/11/24/mqtt-qos-and-persistence/) - [A story of MQTT 5.0](https://modelbasedtesting.co.uk/2018/04/09/a-story-of-mqtt-5-0/) [Various MQTT and MQTT-SN talks I've given.](https://modelbasedtesting.co.uk/talks-ive-given/) ### Supported Network Protocols The library supports connecting to an MQTT server using TCP, SSL/TLS, Unix-domain sockets, and websockets (secure and insecure). This is chosen by the client using the URI supplied in the connect options. It can be specified as: "mqtt://:" - TCP, unsecure "tcp://:" (same) "mqtts://:" - SSL/TLS "ssl://:" (same) "unix:///path/to/socket - UNIX-domain socket (*nix systems only) "ws://:[/path]" - Websockets, unsecure "wss://:[/path]" - Websockets, secure The "mqtt://" and "tcp://" schemas are identical. They indicate an insecure connection over TCP. The "mqtt://" variation is new for the library, but becoming more common across different MQTT libraries. Similarly, the "mqtts://" and "ssl://" schemas are identical. They specify a secure connection over SSL/TLS sockets. The use any of the secure connect options requires that you compile the library with the `PAHO_WITH_SSL=TRUE` CMake option to include OpenSSL. In addition, you _must_ specify `ssl_options` when you connect to the broker - i.e. you must add an instance of `ssl_options` to the `connect_options` when calling `connect()`. The use of Unix-domain sockets requires the build option of `PAHO_WITH_UNIX_SOCKETS=TRUE` is required. This is only available on *nix-style systems like Linux and macOS. It is not vailable on Windows. ## Runtime tracing A number of environment variables control runtime tracing of the C library. Tracing is switched on using `MQTT_C_CLIENT_TRACE` (a value of ON traces to stdout, any other value should specify a file to trace to). The verbosity of the output is controlled using the `MQTT_C_CLIENT_TRACE_LEVEL` environment variable - valid values are ERROR, PROTOCOL, MINIMUM, MEDIUM and MAXIMUM (from least to most verbose). The variable `MQTT_C_CLIENT_TRACE_MAX_LINES` limits the number of lines of trace that are output. ``` export MQTT_C_CLIENT_TRACE=ON export MQTT_C_CLIENT_TRACE_LEVEL=PROTOCOL ``` ## Reporting bugs Please open issues in the Github project: https://github.com/eclipse-paho/paho.mqtt.c/issues. ## More information Discussion of the Paho clients takes place on the [Eclipse paho-dev mailing list](https://dev.eclipse.org/mailman/listinfo/paho-dev). ## Follow Eclipse Paho on Twitter: [@eclipsepaho](https://twitter.com/eclipsepaho) General questions about the MQTT protocol are discussed in the [MQTT Google Group](https://groups.google.com/forum/?hl=en-US&fromgroups#!forum/mqtt). There is more information available via the [MQTT community site](http://mqtt.org). ## Building with CMake The build process currently supports a number of Linux "flavors" including ARM and s390, OS X, AIX and Solaris as well as the Windows operating system. The build process requires the following tools: * [CMake](http://cmake.org) * [GNU Make](https://www.gnu.org/software/make/) or [Ninja](https://martine.github.io/ninja/) * A conforming C compiler, such as [gcc](https://gcc.gnu.org/), [Clang](https://clang.llvm.org/), etc On Debian based systems this would mean that the following packages have to be installed: ``` $ apt-get install build-essential gcc make cmake cmake-gui cmake-curses-gui ``` Also, in order to build a debian package from the source code, the following packages have to be installed ``` $ apt-get install fakeroot devscripts dh-make lsb-release ``` Ninja can be downloaded from its github project page in the "releases" section. Optionally it is possible to build binaries with SSL/TLS support. This requires the OpenSSL libraries and includes to be available. E. g. on Debian: ``` $ apt-get install libssl-dev ``` The documentation requires doxygen and optionally graphviz: ``` $ apt-get install doxygen graphviz ``` ### Building your application with CMake If the Paho C library was built with CMake and is already installed on the system, it is relatively easy to set up a CMake build for your application. (If it's not already built and installed read the next section). The library can be built with several options which create variations of the library for asynchronous or synchronous use; encryption (SSL/TLS) support or not; and whether the library is shared or static. CMake exports all of the libraries that were built as targets, and the user can chose which is best suited for an application. The package is named: **eclipse-paho-mqtt-c** The namespace for all the targets is also: **eclipse-paho-mqtt-c** The target names are the same as the library names. The static libraries append *-static* to the target name even for platforms that use the same base name for shared and static libraries. So: Target|Description ------|----------- paho-mqtt3a | asynchronous, no encryption paho-mqtt3as | asynchronous with SSL/TLS support paho-mqtt3c | synchronous, no encryption paho-mqtt3cs | synchronous with SSL/TLS support paho-mqtt3a-static | asynchronous, no encryption, static linkage paho-mqtt3as-static | asynchronous with SSL/TLS support, static linkage paho-mqtt3c-static | synchronous, no encryption, static linkage paho-mqtt3cs-static | synchronous with SSL/TLS support, static linkage Remember, though, that not all of these targets may be available. It depends on how the library was built. A sample *CMakeLists.txt* for an application that uses the asynchronous library with encryption support *(paho-mqtt3as)* might look like this: ``` cmake_minimum_required(VERSION 3.5) project(MyMQTTApp VERSION 1.0.0 LANGUAGES C) find_package(eclipse-paho-mqtt-c REQUIRED) add_executable(MyMQTTApp MyMQTTApp.c) target_link_libraries(MQTTVersion eclipse-paho-mqtt-c::paho-mqtt3as) ``` If the library was installed to a non-traditional location, you may need to tell CMake where to find it using `CMAKE_PREFIX_PATH`. For example, if you installed it in */opt/mqtt/paho.mqtt.c* ``` $ cmake -DCMAKE_PREFIX_PATH=/opt/mqtt/paho.mqtt.c .. ``` ### Building the Paho C library with CMake Before compiling, determine the value of some variables in order to configure features, library locations, and other options: Variable | Default Value | Description ------------ | ------------- | ------------- PAHO_BUILD_SHARED | TRUE | Build a shared version of the libraries PAHO_BUILD_STATIC | FALSE | Build a static version of the libraries PAHO_HIGH_PERFORMANCE | FALSE | When set to true, the debugging aids internal tracing and heap tracking are not included. PAHO_WITH_SSL | FALSE | Flag that defines whether to build ssl-enabled binaries too. OPENSSL_ROOT_DIR | "" (system default) | Directory containing your OpenSSL installation (i.e. `/usr/local` when headers are in `/usr/local/include` and libraries are in `/usr/local/lib`) PAHO_WITH_LIBRESSL | FALSE | Flag that defines whether to build ssl-enabled binaries with LibreSSL instead of OpenSSL. LIBRESSL_ROOT_DIR | "" (system default) | Directory containing your LibreSSL installation (i.e. `/usr/local` when headers are in `/usr/local/include` and libraries are in `/usr/local/lib`) PAHO_WITH_UNIX_SOCKETS | FALSE | (*nix systems only) Flag to enable support for UNIX-domain sockets PAHO_BUILD_DOCUMENTATION | FALSE | Create and install the HTML based API documentation (requires Doxygen) PAHO_BUILD_SAMPLES | FALSE | Build sample programs PAHO_ENABLE_TESTING | TRUE | Build test and run MQTT_TEST_BROKER | tcp://localhost:1883 | MQTT connection URL for a broker to use during test execution MQTT_TEST_PROXY | tcp://localhost:1883 | Hostname of the test proxy to use MQTT_SSL_HOSTNAME | localhost | Hostname of a test SSL MQTT broker to use PAHO_BUILD_DEB_PACKAGE | FALSE | Build debian package Using these variables CMake can be used to generate your Ninja or Make files. Using CMake, building out-of-source is the default. Therefore it is recommended to invoke all build commands inside your chosen build directory but outside of the source tree. An example build session targeting the build platform could look like this: ``` $ mkdir /tmp/build.paho ; cd /tmp/build.paho $ cmake -DPAHO_WITH_SSL=TRUE -DPAHO_BUILD_DOCUMENTATION=TRUE \ -DPAHO_BUILD_SAMPLES=TRUE ~/paho.mqtt.c ``` Invoking cmake and specifying build options can also be performed using cmake-gui or ccmake (see https://cmake.org/runningcmake/). For example: ``` $ ccmake ~/paho.mqtt.c ``` To compile/link the binaries, to install, or to generate packages, use these commands: ``` $ cmake --build . $ cmake --build . --target install $ cmake --build . --target package ``` To build, install, or generate packages, you can also use the generated builder like _ninja_ or _make_ directly after invoking the initial CMake configuration step, such as `ninja package` or `make -j package`. ### Debug builds Debug builds can be performed by defining the value of the `CMAKE_BUILD_TYPE` option to `Debug`. For example: ``` $ cmake -DCMAKE_BUILD_TYPE=Debug ~/paho.mqtt.c ``` ### Running the tests Test code is available in the `test` directory. The tests can be built and executed with the CMake build system. The test execution requires a MQTT broker running. By default, the build system uses `localhost`, however it is possible to configure the build to use an external broker. These parameters are documented in the Build Requirements section above. After ensuring a MQTT broker is available, it is possible to execute the tests by starting the proxy and running `ctest` as described below: ``` $ python ../test/mqttsas.py & $ ctest -VV ``` ### Cross compilation Cross compilation using CMake is performed by using so called "toolchain files" (see: https://cmake.org/cmake/help/latest/manual/cmake-toolchains.7.html). The path to the toolchain file can be specified by using CMake's `-DCMAKE_TOOLCHAIN_FILE` option. In case no toolchain file is specified, the build is performed for the native build platform. For your convenience toolchain files for the following platforms can be found in the `cmake` directory of Eclipse Paho: * Linux x86 * Linux ARM11 (a.k.a. the Raspberry Pi) * Windows x86_64 * Windows x86 The provided toolchain files assume that required compilers/linkers are to be found in the environment, i. e. the PATH-Variable of your user or system. If you prefer, you can also specify the absolute location of your compilers in the toolchain files. Example invocation for the Raspberry Pi: ``` $ cmake -GNinja -DPAHO_WITH_SSL=TRUE -DPAHO_BUILD_SAMPLES=TRUE \ -DPAHO_BUILD_DOCUMENTATION=TRUE \ -DOPENSSL_LIB_SEARCH_PATH=/tmp/libssl-dev/usr/lib/arm-linux-gnueabihf \ -DOPENSSL_INC_SEARCH_PATH="/tmp/libssl-dev/usr/include/openssl;/tmp/libssl-dev/usr/include/arm-linux-gnueabihf" \ -DCMAKE_TOOLCHAIN_FILE=~/paho.mqtt.c/cmake/toolchain.linux-arm11.cmake \ ~/paho.mqtt.c ``` Compilers for the Raspberry Pi and other ARM targets can be obtained from ARM (https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/downloads) This example assumes that OpenSSL-libraries and includes have been installed in the `/tmp/libssl-dev` directory. Example invocation for Windows 64 bit: ``` $ cmake -DPAHO_BUILD_SAMPLES=TRUE \ -DCMAKE_TOOLCHAIN_FILE=~/paho.mqtt.c/cmake/toolchain.win64.cmake \ ~/paho.mqtt.c ``` In this case the libraries and executable are not linked against OpenSSL Libraries. Cross compilers for the Windows platform can be installed on Debian like systems like this: ``` $ apt-get install gcc-mingw-w64-x86-64 gcc-mingw-w64-i686 ``` ## Build instructions for GNU Make Ensure the OpenSSL development package is installed. Then from the client library base directory run: ``` $ make $ sudo make install ``` This will build and install the libraries. To uninstall: ``` $ sudo make uninstall ``` To build the documentation requires doxygen and optionally graphviz. ``` $ make html ``` The provided GNU Makefile is intended to perform all build steps in the ```build``` directory within the source-tree of Eclipse Paho. Generated binares, libraries, and the documentation can be found in the ```build/output``` directory after completion. Options that are passed to the compiler/linker can be specified by typical Unix build variables: Variable | Description ------------ | ------------- CC | Path to the C compiler CFLAGS | Flags passed to compiler calls LDFLAGS | Flags passed to linker calls ## Building paho-mqtt - Using vcpkg You can download and install paho-mqtt using the [vcpkg](https://github.com/Microsoft/vcpkg) dependency manager: git clone https://github.com/Microsoft/vcpkg.git cd vcpkg ./bootstrap-vcpkg.sh ./vcpkg integrate install ./vcpkg install paho-mqtt The paho-mqtt port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository. ## Fully static builds with musl libc (By Frank Pagliughi) [musl libc](https://musl.libc.org/) is is an implementation of the C standard library built on top of the Linux system call API, including interfaces defined in the base language standard, POSIX, and widely agreed-upon extensions. Users of the Rust library, which wraps this one, had been complaining that they could not compile using the musl build tools. Musl is a small std C lib that can be statically linked. With the latest Paho C library (and a very minor tweak to the build), we're now able to build Rust apps using musl and Paho C that are fully static; no runtime dependencies on the platform; not even on the standard C lib. $ ./async_publish Publishing a message on the 'test' topic $ ldd async_publish not a dynamic executable So, for example, if maintaining a suite of apps for some newer and older embedded Linux boards, the same executables could be deployed without worry about the C ABI on the particular boards. Certainly C apps using the Paho library could do this also. ## Microsoft Windows ### Calling convention As is normal for C programs on Windows, the calling convention is __cdecl. See the Microsoft documentation here: https://docs.microsoft.com/en-us/cpp/cpp/cdecl?view=vs-2019 If you call this library from another language, you may need to take this into account. paho.mqtt.c-1.3.14/SECURITY.md000066400000000000000000000012241473722542500155370ustar00rootroot00000000000000# Security Policy This project follows the [Eclipse Vulnerability Reporting Policy](https://www.eclipse.org/security/policy.php). Vulnerabilities are tracked by the Eclipse security team, in cooperation with the project lead. Fixing vulnerabilities is taken care of by the project committers, with assistance and guidance of the security team. ## Supported Versions Eclipse Paho provides security updates for the most recent version only. ## Reporting a Vulnerability We recommend that in case of suspected vulnerabilities you do not create a GitHub issue, but instead contact the Eclipse Security Team directly sending an email to security@eclipse.org. paho.mqtt.c-1.3.14/about.html000066400000000000000000000030741473722542500157530ustar00rootroot00000000000000 About

About This Content

April 6, 2020

License

The Eclipse Foundation makes available all content in this plug-in ("Content"). Unless otherwise indicated below, the Content is provided to you under the terms and conditions of the Eclipse Public License Version 2.0 ("EPL") and Eclipse Distribution License Version 1.0 ("EDL"). A copy of the EPL is available at https://www.eclipse.org/legal/epl-2.0/ and a copy of the EDL is available at http://www.eclipse.org/org/documents/edl-v10.php. For purposes of the EPL, "Program" will mean the Content.

If you did not receive this Content directly from the Eclipse Foundation, the Content is being redistributed by another party ("Redistributor") and different terms and conditions may apply to your use of any object code in the Content. Check the Redistributor's license that was provided with the Content. If no such license exists, contact the Redistributor. Unless otherwise indicated below, the terms and conditions of the EPL still apply to any source code in the Content and such source code may be obtained at http://www.eclipse.org.

paho.mqtt.c-1.3.14/android/000077500000000000000000000000001473722542500153675ustar00rootroot00000000000000paho.mqtt.c-1.3.14/android/Android.mk000066400000000000000000000130171473722542500173020ustar00rootroot00000000000000# Example: Android Native Library makefile for paho.mqtt.c # contributed by Bin Li LOCAL_PATH := $(call my-dir) libpaho-mqtt3_lib_path := ../src libpaho-mqtt3_c_includes := $(LOCAL_PATH)/$(libpaho-mqtt3_lib_path) \ external/hdc/android-ifaddrs \ external/openssl/include \ external/zlib # build sample util define build_sample_util __sample_module:= $1 __sample_lib:= $2 include $(CLEAR_VARS) LOCAL_C_INCLUDES := $(libpaho-mqtt3_c_includes) LOCAL_SHARED_LIBRARIES := $$(__sample_lib) LOCAL_MODULE := $$(__sample_module) LOCAL_SRC_FILES := $(libpaho-mqtt3_lib_path)/samples/$$(__sample_module).c include $(BUILD_EXECUTABLE) endef libpaho-mqtt3_local_src_c_files_common := \ $(libpaho-mqtt3_lib_path)/MQTTProtocolClient.c \ $(libpaho-mqtt3_lib_path)/Tree.c \ $(libpaho-mqtt3_lib_path)/Heap.c \ $(libpaho-mqtt3_lib_path)/MQTTPacket.c \ $(libpaho-mqtt3_lib_path)/Clients.c \ $(libpaho-mqtt3_lib_path)/Thread.c \ $(libpaho-mqtt3_lib_path)/utf-8.c \ $(libpaho-mqtt3_lib_path)/StackTrace.c \ $(libpaho-mqtt3_lib_path)/MQTTProtocolOut.c \ $(libpaho-mqtt3_lib_path)/Socket.c \ $(libpaho-mqtt3_lib_path)/Log.c \ $(libpaho-mqtt3_lib_path)/Messages.c \ $(libpaho-mqtt3_lib_path)/LinkedList.c \ $(libpaho-mqtt3_lib_path)/MQTTPersistence.c \ $(libpaho-mqtt3_lib_path)/MQTTPacketOut.c \ $(libpaho-mqtt3_lib_path)/SocketBuffer.c \ $(libpaho-mqtt3_lib_path)/MQTTPersistenceDefault.c \ libpaho-mqtt3_local_src_c_files_c := \ $(libpaho-mqtt3_lib_path)/MQTTClient.c \ libpaho-mqtt3_local_src_c_files_cs := \ $(libpaho-mqtt3_lib_path)/MQTTClient.c \ $(libpaho-mqtt3_lib_path)/SSLSocket.c \ libpaho-mqtt3_local_src_c_files_a := \ $(libpaho-mqtt3_lib_path)/MQTTAsync.c \ libpaho-mqtt3_local_src_c_files_as := \ $(libpaho-mqtt3_lib_path)/MQTTAsync.c \ $(libpaho-mqtt3_lib_path)/SSLSocket.c \ # update the header file which normally generated by cmake $(shell (cp -f $(LOCAL_PATH)/$(libpaho-mqtt3_lib_path)/VersionInfo.h.in $(LOCAL_PATH)/$(libpaho-mqtt3_lib_path)/VersionInfo.h)) $(shell (sed -i "s/@CLIENT_VERSION@/1.2.0/g" $(LOCAL_PATH)/$(libpaho-mqtt3_lib_path)/VersionInfo.h)) $(shell ( sed -i "s/@BUILD_TIMESTAMP@/$(shell date)/g" $(LOCAL_PATH)/$(libpaho-mqtt3_lib_path)/VersionInfo.h)) # building static libraries include $(CLEAR_VARS) LOCAL_MODULE := libpaho-mqtt3c LOCAL_EXPORT_C_INCLUDE_DIRS := $(LOCAL_PATH)/$(libpaho-mqtt3_lib_path) LOCAL_C_INCLUDES:= $(libpaho-mqtt3_c_includes) LOCAL_SRC_FILES := $(libpaho-mqtt3_local_src_c_files_common) $(libpaho-mqtt3_local_src_c_files_c) include $(BUILD_STATIC_LIBRARY) include $(CLEAR_VARS) LOCAL_MODULE := libpaho-mqtt3cs LOCAL_EXPORT_C_INCLUDE_DIRS := $(LOCAL_PATH)/$(libpaho-mqtt3_lib_path) LOCAL_C_INCLUDES:= $(libpaho-mqtt3_c_includes) LOCAL_CFLAGS += -DOPENSSL LOCAL_SRC_FILES := $(libpaho-mqtt3_local_src_c_files_common) $(libpaho-mqtt3_local_src_c_files_cs) include $(BUILD_STATIC_LIBRARY) include $(CLEAR_VARS) LOCAL_MODULE := libpaho-mqtt3a LOCAL_EXPORT_C_INCLUDE_DIRS := $(LOCAL_PATH)/${libpaho-mqtt3_lib_path} LOCAL_C_INCLUDES:= $(libpaho-mqtt3_c_includes) LOCAL_SRC_FILES := $(libpaho-mqtt3_local_src_c_files_common) $(libpaho-mqtt3_local_src_c_files_a) include $(BUILD_STATIC_LIBRARY) include $(CLEAR_VARS) LOCAL_MODULE := libpaho-mqtt3as LOCAL_EXPORT_C_INCLUDE_DIRS := $(LOCAL_PATH)/${libpaho-mqtt3_lib_path} LOCAL_CFLAGS += -DOPENSSL LOCAL_C_INCLUDES:= $(libpaho-mqtt3_c_includes) LOCAL_SRC_FILES := $(libpaho-mqtt3_local_src_c_files_common) $(libpaho-mqtt3_local_src_c_files_as) include $(BUILD_STATIC_LIBRARY) # building shared libraries include $(CLEAR_VARS) LOCAL_MODULE := libpaho-mqtt3c LOCAL_SHARED_LIBRARIES := libdl LOCAL_EXPORT_C_INCLUDE_DIRS := $(LOCAL_PATH)/$(libpaho-mqtt3_lib_path) LOCAL_C_INCLUDES:= $(libpaho-mqtt3_c_includes) LOCAL_SRC_FILES := $(libpaho-mqtt3_local_src_c_files_common) $(libpaho-mqtt3_local_src_c_files_c) include $(BUILD_SHARED_LIBRARY) include $(CLEAR_VARS) LOCAL_MODULE := libpaho-mqtt3cs LOCAL_SHARED_LIBRARIES := libcrypto libssl libdl LOCAL_EXPORT_C_INCLUDE_DIRS := $(LOCAL_PATH)/$(libpaho-mqtt3_lib_path) LOCAL_C_INCLUDES:= $(libpaho-mqtt3_c_includes) LOCAL_CFLAGS += -DOPENSSL LOCAL_SRC_FILES := $(libpaho-mqtt3_local_src_c_files_common) $(libpaho-mqtt3_local_src_c_files_cs) include $(BUILD_SHARED_LIBRARY) include $(CLEAR_VARS) LOCAL_MODULE := libpaho-mqtt3a LOCAL_SHARED_LIBRARIES := libdl LOCAL_EXPORT_C_INCLUDE_DIRS := $(LOCAL_PATH)/${libpaho-mqtt3_lib_path} LOCAL_C_INCLUDES:= $(libpaho-mqtt3_c_includes) LOCAL_SRC_FILES := $(libpaho-mqtt3_local_src_c_files_common) $(libpaho-mqtt3_local_src_c_files_a) include $(BUILD_SHARED_LIBRARY) include $(CLEAR_VARS) LOCAL_MODULE := libpaho-mqtt3as LOCAL_SHARED_LIBRARIES := libcrypto libssl libdl LOCAL_EXPORT_C_INCLUDE_DIRS := $(LOCAL_PATH)/${libpaho-mqtt3_lib_path} LOCAL_CFLAGS += -DOPENSSL LOCAL_C_INCLUDES:= $(libpaho-mqtt3_c_includes) LOCAL_SRC_FILES := $(libpaho-mqtt3_local_src_c_files_common) $(libpaho-mqtt3_local_src_c_files_as) include $(BUILD_SHARED_LIBRARY) # building samples $(eval $(call build_sample_util, MQTTAsync_subscribe, libpaho-mqtt3a ) ) $(eval $(call build_sample_util, MQTTAsync_publish, libpaho-mqtt3a ) ) $(eval $(call build_sample_util, MQTTClient_publish, libpaho-mqtt3c ) ) $(eval $(call build_sample_util, MQTTClient_publish_async, libpaho-mqtt3c ) ) $(eval $(call build_sample_util, MQTTClient_subscribe, libpaho-mqtt3c ) ) $(eval $(call build_sample_util, paho_c_pub, libpaho-mqtt3a ) ) $(eval $(call build_sample_util, paho_c_sub, libpaho-mqtt3a ) ) $(eval $(call build_sample_util, paho_cs_pub, libpaho-mqtt3c ) ) $(eval $(call build_sample_util, paho_cs_sub, libpaho-mqtt3c ) ) paho.mqtt.c-1.3.14/appveyor.yml000066400000000000000000000071571473722542500163510ustar00rootroot00000000000000version: 1.3.{build} environment: matrix: - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2013 PAHO_WINDOWS_BUILD_BIT: x64 OPENSSL_ROOT_DIR: "C:/OpenSSL-v111-Win64" PAHO_BUILD_STATIC: FALSE PAHO_BUILD_SHARED: TRUE PAHO_HIGH_PERFORMANCE: FALSE PYTHON_VERSION: Python36 - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015 PAHO_WINDOWS_BUILD_BIT: x64 OPENSSL_ROOT_DIR: "C:/OpenSSL-Win64" PAHO_BUILD_STATIC: TRUE PAHO_BUILD_SHARED: FALSE PAHO_HIGH_PERFORMANCE: TRUE PYTHON_VERSION: Python36 - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019 PAHO_WINDOWS_BUILD_BIT: x86 OPENSSL_ROOT_DIR: "C:/OpenSSL-Win32" PAHO_BUILD_STATIC: FALSE PAHO_BUILD_SHARED: TRUE PAHO_HIGH_PERFORMANCE: TRUE PYTHON_VERSION: Python37 configuration: Debug install: - cmd: ver - cmd: openssl version - cmd: C:\%PYTHON_VERSION%\python --version - cmd: netsh advfirewall firewall add rule name="Python 3" dir=in action=allow program="C:\%PYTHON_VERSION%\python.exe" enable=yes - cmd: netsh advfirewall firewall add rule name="Open Port 1883" dir=in action=allow protocol=TCP localport=1883 - cmd: netsh advfirewall set allprofiles state off - ps: Start-Process C:\$Env:PYTHON_VERSION\python -ArgumentList 'test\mqttsas.py' - cmd: git clone https://github.com/eclipse/paho.mqtt.testing.git - cmd: cd paho.mqtt.testing\interoperability - ps: Start-Process C:\$Env:PYTHON_VERSION\python -ArgumentList 'startbroker.py -c localhost_testing.conf' - cmd: cd ..\.. build_script: - cmd: >- mkdir build.paho cd build.paho echo %APPVEYOR_BUILD_WORKER_IMAGE% if "%APPVEYOR_BUILD_WORKER_IMAGE%" == "Visual Studio 2019" call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsall.bat" %PAHO_WINDOWS_BUILD_BIT% if "%APPVEYOR_BUILD_WORKER_IMAGE%" == "Visual Studio 2015" call "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" %PAHO_WINDOWS_BUILD_BIT% if "%APPVEYOR_BUILD_WORKER_IMAGE%" == "Visual Studio 2013" call "C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\vcvarsall.bat" %PAHO_WINDOWS_BUILD_BIT% cmake -G "NMake Makefiles" -DPAHO_WITH_SSL=TRUE -DOPENSSL_ROOT_DIR=%OPENSSL_ROOT_DIR% -DPAHO_BUILD_DOCUMENTATION=FALSE -DPAHO_BUILD_SAMPLES=TRUE -DCMAKE_BUILD_TYPE=Release -DCMAKE_VERBOSE_MAKEFILE=TRUE -DPAHO_BUILD_STATIC=%PAHO_BUILD_STATIC% -DPAHO_BUILD_SHARED=%PAHO_BUILD_SHARED% -DPAHO_HIGH_PERFORMANCE=%PAHO_HIGH_PERFORMANCE% .. nmake ctest -T test -VV cd .. after_build: - cmd: >- set ZIPNAME=eclipse-paho-mqtt-c-windows.zip 7z a %ZIPNAME% %APPVEYOR_BUILD_FOLDER%\*.html 7z a %ZIPNAME% %APPVEYOR_BUILD_FOLDER%\*.md 7z a %ZIPNAME% %APPVEYOR_BUILD_FOLDER%\*-v10 7z a %ZIPNAME% build.paho\src\*.dll 7z a %ZIPNAME% build.paho\src\*.lib 7z rn %ZIPNAME% build.paho\src lib 7z a %ZIPNAME% build.paho\src\samples\*.exe 7z rn %ZIPNAME% build.paho\src\samples bin if "%PAHO_BUILD_SHARED%" == "TRUE" 7z a %ZIPNAME% "%APPVEYOR_BUILD_FOLDER%\build.paho\src\MQTTVersion.exe" 7z rn %ZIPNAME% MQTTVersion.exe bin\MQTTVersion.exe 7z a %ZIPNAME% src\MQTTClient.h src\MQTTAsync.h src\MQTTClientPersistence.h src\MQTTProperties.h src\MQTTReasonCodes.h src\MQTTSubscribeOpts.h src\MQTTExportDeclarations.h 7z rn %ZIPNAME% src include 7z a %ZIPNAME% src\samples\*.c 7z rn %ZIPNAME% src\samples samples artifacts: - path: eclipse-paho-mqtt-c-windows.zip name: paho-mqtt-c test: assemblies: build/Testing/*/Test.xml paho.mqtt.c-1.3.14/build.xml000066400000000000000000000246411473722542500155770ustar00rootroot00000000000000 paho.mqtt.c-1.3.14/cbuild.bat000066400000000000000000000012541473722542500157030ustar00rootroot00000000000000REM start broker and proxy REM Start-Process C:\Python36\python -ArgumentList 'test\mqttsas.py' REM Start-Process C:\Python36\python -ArgumentList 'startbroker.py -c localhost_testing.conf' setlocal set APPVEYOR_BUILD_FOLDER=%cd% rmdir /s /q build.paho mkdir build.paho cd build.paho REM call "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" x64 call "j:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat" cmake -G "NMake Makefiles" -DPAHO_WITH_SSL=TRUE -DPAHO_BUILD_DOCUMENTATION=FALSE -DPAHO_BUILD_SAMPLES=TRUE -DCMAKE_BUILD_TYPE=Release -DCMAKE_VERBOSE_MAKEFILE=TRUE .. nmake ctest -T test -VV cd .. endlocal paho.mqtt.c-1.3.14/cmake-build.sh000077500000000000000000000012111473722542500164560ustar00rootroot00000000000000#!/bin/bash set -e rm -rf build.paho mkdir build.paho cd build.paho echo "travis build dir $TRAVIS_BUILD_DIR pwd $PWD with OpenSSL root $OPENSSL_ROOT_DIR" cmake -DPAHO_BUILD_STATIC=$PAHO_BUILD_STATIC -DPAHO_BUILD_SHARED=$PAHO_BUILD_SHARED -DCMAKE_BUILD_TYPE=Debug -DPAHO_WITH_SSL=TRUE -DOPENSSL_ROOT_DIR=$OPENSSL_ROOT_DIR -DPAHO_BUILD_DOCUMENTATION=FALSE -DPAHO_BUILD_SAMPLES=TRUE -DPAHO_HIGH_PERFORMANCE=$PAHO_HIGH_PERFORMANCE -DPAHO_USE_SELECT=$PAHO_USE_SELECT .. cmake --build . python3 ../test/mqttsas.py & ctest -VV --timeout 600 killall python3 || true sleep 3 # allow broker time to terminate and report #killall mosquitto cpack --verbose paho.mqtt.c-1.3.14/cmake/000077500000000000000000000000001473722542500150275ustar00rootroot00000000000000paho.mqtt.c-1.3.14/cmake/CPackDebConfig.cmake.in000066400000000000000000000063161473722542500211660ustar00rootroot00000000000000IF (CPACK_GENERATOR MATCHES "DEB") FIND_PROGRAM(DPKG_PROGRAM dpkg DOC "dpkg program of Debian-based systems") IF (DPKG_PROGRAM) EXECUTE_PROCESS( COMMAND ${DPKG_PROGRAM} --print-architecture OUTPUT_VARIABLE CPACK_DEBIAN_PACKAGE_ARCHITECTURE OUTPUT_STRIP_TRAILING_WHITESPACE ) ELSE (DPKG_PROGRAM) MESSAGE(FATAL_ERROR "Could not find an architecture for the package") ENDIF (DPKG_PROGRAM) EXECUTE_PROCESS( COMMAND lsb_release -si OUTPUT_VARIABLE CPACK_DEBIAN_DIST_NAME RESULT_VARIABLE DIST_NAME_STATUS OUTPUT_STRIP_TRAILING_WHITESPACE ) IF (DIST_NAME_STATUS) MESSAGE(FATAL_ERROR "Could not find a GNU/Linux distribution name") ENDIF (DIST_NAME_STATUS) IF (CPACK_DEBIAN_DIST_NAME STREQUAL "") MESSAGE(FATAL_ERROR "Could not find a GNU/Linux distribution name") ENDIF () EXECUTE_PROCESS( COMMAND lsb_release -sc OUTPUT_VARIABLE CPACK_DEBIAN_DIST_CODE RESULT_VARIABLE DIST_CODE_STATUS OUTPUT_STRIP_TRAILING_WHITESPACE ) IF (DIST_NAME_STATUS) MESSAGE(FATAL_ERROR "Could not find a GNU/Linux distribution codename") ENDIF (DIST_NAME_STATUS) IF (CPACK_DEBIAN_DIST_CODE STREQUAL "") MESSAGE(FATAL_ERROR "Could not find a GNU/Linux distribution codename") ENDIF () SET(CPACK_PACKAGE_VERSION_MAJOR @PAHO_VERSION_MAJOR@) SET(CPACK_PACKAGE_VERSION_MINOR @PAHO_VERSION_MINOR@) SET(CPACK_PACKAGE_VERSION_PATCH @PAHO_VERSION_PATCH@) SET(PACKAGE_VERSION "${CPACK_PACKAGE_VERSION_MAJOR}.${CPACK_PACKAGE_VERSION_MINOR}.${CPACK_PACKAGE_VERSION_PATCH}") IF (PACKAGE_VERSION STREQUAL "") MESSAGE(FATAL_ERROR "Could not find a version number for the package") ENDIF () SET(PAHO_WITH_SSL @PAHO_WITH_SSL@) MESSAGE("Package version: ${PACKAGE_VERSION}") MESSAGE("Package built for: ${CPACK_DEBIAN_DIST_NAME} ${CPACK_DEBIAN_DIST_CODE}") IF(PAHO_WITH_SSL) MESSAGE("Package built with ssl-enabled binaries too") ENDIF() # Additional lines to a paragraph should start with " "; paragraphs should # be separated with a " ." line SET(CPACK_PACKAGE_NAME "libpaho-mqtt") SET(CPACK_PACKAGE_CONTACT "Eclipse") SET(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Eclipse Paho MQTT C client") SET(CPACK_DEBIAN_PACKAGE_NAME ${CPACK_PACKAGE_NAME}) SET(CPACK_DEBIAN_PACKAGE_MAINTAINER "Genis Riera Perez ") SET(CPACK_DEBIAN_PACKAGE_DESCRIPTION "Eclipse Paho MQTT C client library") SET(CPACK_DEBIAN_PACKAGE_SHLIBDEPS ON) SET(CPACK_DEBIAN_PACKAGE_VERSION ${PACKAGE_VERSION}) SET(CPACK_DEBIAN_PACKAGE_SECTION "net") SET(CPACK_DEBIAN_PACKAGE_CONFLICTS ${CPACK_PACKAGE_NAME}) SET(CPACK_PACKAGE_FILE_NAME "${CPACK_DEBIAN_PACKAGE_NAME}_${CPACK_DEBIAN_PACKAGE_VERSION}_${CPACK_DEBIAN_PACKAGE_ARCHITECTURE}") UNSET(PACKAGE_VERSION CACHE) UNSET(CPACK_DEBIAN_PACKAGE_VERSION CACHE) # # From CMakeDebHelper # See http://www.cmake.org/Wiki/CMake:CPackPackageGenerators#Overall_usage_.28common_to_all_generators.29 # # When the DEB-generator runs, we want him to run our install-script #set( CPACK_INSTALL_SCRIPT ${CPACK_DEBIAN_INSTALL_SCRIPT} ) ENDIF() paho.mqtt.c-1.3.14/cmake/modules/000077500000000000000000000000001473722542500164775ustar00rootroot00000000000000paho.mqtt.c-1.3.14/cmake/modules/FindLibreSSL.cmake000066400000000000000000000143741473722542500217320ustar00rootroot00000000000000#[=======================================================================[ Copyright (c) 2019 John Norrbin Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. FindLibreSSL ------------ Find the LibreSSL encryption library. Optional Components ^^^^^^^^^^^^^^^^^^^ This module supports two optional components: SSL and TLS. Both components have associated imported targets, as described below. Imported Targets ^^^^^^^^^^^^^^^^ This module defines the following imported targets: LibreSSL::Crypto The LibreSSL crypto library, if found. LibreSSL::SSL The LibreSSL ssl library, if found. Requires and includes LibreSSL::Crypto automatically. LibreSSL::TLS The LibreSSL tls library, if found. Requires and includes LibreSSL::SSL and LibreSSL::Crypto automatically. Result Variables ^^^^^^^^^^^^^^^^ This module will set the following variables in your project: LIBRESSL_FOUND System has the LibreSSL library. If no components are requested it only requires the crypto library. LIBRESSL_INCLUDE_DIR The LibreSSL include directory. LIBRESSL_CRYPTO_LIBRARY The LibreSSL crypto library. LIBRESSL_SSL_LIBRARY The LibreSSL SSL library. LIBRESSL_TLS_LIBRARY The LibreSSL TLS library. LIBRESSL_LIBRARIES All LibreSSL libraries. LIBRESSL_VERSION This is set to $major.$minor.$revision (e.g. 2.6.8). Hints ^^^^^ Set LIBRESSL_ROOT_DIR to the root directory of an LibreSSL installation. ]=======================================================================] INCLUDE(FindPackageHandleStandardArgs) # Set Hints set(_LIBRESSL_ROOT_HINTS ${LIBRESSL_ROOT_DIR} ENV LIBRESSL_ROOT_DIR ) # Set Paths if (WIN32) file(TO_CMAKE_PATH "$ENV{PROGRAMFILES}" _programfiles) set(_LIBRESSL_ROOT_PATHS "${_programfiles}/LibreSSL" ) unset(_programfiles) else() set(_LIBRESSL_ROOT_PATHS "/usr/local/" ) endif() # Combine set(_LIBRESSL_ROOT_HINTS_AND_PATHS HINTS ${_LIBRESSL_ROOT_HINTS} PATHS ${_LIBRESSL_ROOT_PATHS} ) # Find Include Path find_path(LIBRESSL_INCLUDE_DIR NAMES tls.h ${_LIBRESSL_ROOT_HINTS_AND_PATHS} PATH_SUFFIXES include ) # Find Crypto Library find_library(LIBRESSL_CRYPTO_LIBRARY NAMES libcrypto crypto NAMES_PER_DIR ${_LIBRESSL_ROOT_HINTS_AND_PATHS} PATH_SUFFIXES lib ) # Find SSL Library find_library(LIBRESSL_SSL_LIBRARY NAMES libssl ssl NAMES_PER_DIR ${_LIBRESSL_ROOT_HINTS_AND_PATHS} PATH_SUFFIXES lib ) # Find TLS Library find_library(LIBRESSL_TLS_LIBRARY NAMES libtls tls NAMES_PER_DIR ${_LIBRESSL_ROOT_HINTS_AND_PATHS} PATH_SUFFIXES lib ) # Set Libraries set(LIBRESSL_LIBRARIES ${LIBRESSL_CRYPTO_LIBRARY} ${LIBRESSL_SSL_LIBRARY} ${LIBRESSL_TLS_LIBRARY}) # Mark Variables As Advanced mark_as_advanced(LIBRESSL_INCLUDE_DIR LIBRESSL_LIBRARIES LIBRESSL_CRYPTO_LIBRARY LIBRESSL_SSL_LIBRARY LIBRESSL_TLS_LIBRARY) # Find Version File if(LIBRESSL_INCLUDE_DIR AND EXISTS "${LIBRESSL_INCLUDE_DIR}/openssl/opensslv.h") # Get Version From File file(STRINGS "${LIBRESSL_INCLUDE_DIR}/openssl/opensslv.h" OPENSSLV.H REGEX "#define LIBRESSL_VERSION_TEXT[ ]+\".*\"") # Match Version String string(REGEX REPLACE ".*\".*([0-9]+)\\.([0-9]+)\\.([0-9]+)\"" "\\1;\\2;\\3" LIBRESSL_VERSION_LIST "${OPENSSLV.H}") # Split Parts list(GET LIBRESSL_VERSION_LIST 0 LIBRESSL_VERSION_MAJOR) list(GET LIBRESSL_VERSION_LIST 1 LIBRESSL_VERSION_MINOR) list(GET LIBRESSL_VERSION_LIST 2 LIBRESSL_VERSION_REVISION) # Set Version String set(LIBRESSL_VERSION "${LIBRESSL_VERSION_MAJOR}.${LIBRESSL_VERSION_MINOR}.${LIBRESSL_VERSION_REVISION}") endif() # Set Find Package Arguments find_package_handle_standard_args(LibreSSL REQUIRED_VARS LIBRESSL_CRYPTO_LIBRARY LIBRESSL_INCLUDE_DIR VERSION_VAR LIBRESSL_VERSION HANDLE_COMPONENTS FAIL_MESSAGE "Could NOT find LibreSSL, try setting the path to LibreSSL using the LIBRESSL_ROOT_DIR environment variable" ) # LibreSSL Found if(LIBRESSL_FOUND) # Set LibreSSL::Crypto if(NOT TARGET LibreSSL::Crypto AND EXISTS "${LIBRESSL_CRYPTO_LIBRARY}") # Add Library add_library(LibreSSL::Crypto UNKNOWN IMPORTED) # Set Properties set_target_properties( LibreSSL::Crypto PROPERTIES INTERFACE_INCLUDE_DIRECTORIES "${LIBRESSL_INCLUDE_DIR}" IMPORTED_LINK_INTERFACE_LANGUAGES "C" IMPORTED_LOCATION "${LIBRESSL_CRYPTO_LIBRARY}" ) endif() # LibreSSL::Crypto # Set LibreSSL::SSL if(NOT TARGET LibreSSL::SSL AND EXISTS "${LIBRESSL_SSL_LIBRARY}") # Add Library add_library(LibreSSL::SSL UNKNOWN IMPORTED) # Set Properties set_target_properties( LibreSSL::SSL PROPERTIES INTERFACE_INCLUDE_DIRECTORIES "${LIBRESSL_INCLUDE_DIR}" IMPORTED_LINK_INTERFACE_LANGUAGES "C" IMPORTED_LOCATION "${LIBRESSL_SSL_LIBRARY}" INTERFACE_LINK_LIBRARIES LibreSSL::Crypto ) endif() # LibreSSL::SSL # Set LibreSSL::TLS if(NOT TARGET LibreSSL::TLS AND EXISTS "${LIBRESSL_TLS_LIBRARY}") add_library(LibreSSL::TLS UNKNOWN IMPORTED) set_target_properties( LibreSSL::TLS PROPERTIES INTERFACE_INCLUDE_DIRECTORIES "${LIBRESSL_INCLUDE_DIR}" IMPORTED_LINK_INTERFACE_LANGUAGES "C" IMPORTED_LOCATION "${LIBRESSL_TLS_LIBRARY}" INTERFACE_LINK_LIBRARIES LibreSSL::SSL ) endif() # LibreSSL::TLS endif(LIBRESSL_FOUND)paho.mqtt.c-1.3.14/cmake/toolchain.linux-arm11.cmake000066400000000000000000000003751473722542500220730ustar00rootroot00000000000000# path to compiler and utilities # specify the cross compiler SET(CMAKE_C_COMPILER arm-linux-gnueabihf-gcc) # Name of the target platform SET(CMAKE_SYSTEM_NAME Linux) SET(CMAKE_SYSTEM_PROCESSOR arm) # Version of the system SET(CMAKE_SYSTEM_VERSION 1) paho.mqtt.c-1.3.14/cmake/toolchain.win32.cmake000066400000000000000000000011311473722542500207460ustar00rootroot00000000000000# Name of the target platform SET(CMAKE_SYSTEM_NAME Windows) # Version of the system SET(CMAKE_SYSTEM_VERSION 1) # specify the cross compiler SET(CMAKE_C_COMPILER i686-w64-mingw32-gcc) SET(CMAKE_CXX_COMPILER i686-w64-mingw32-g++) SET(CMAKE_RC_COMPILER_ENV_VAR "RC") SET(CMAKE_RC_COMPILER "") SET(CMAKE_SHARED_LINKER_FLAGS "-fdata-sections -ffunction-sections -Wl,--enable-stdcall-fixup -static-libgcc -static -lpthread" CACHE STRING "" FORCE) SET(CMAKE_EXE_LINKER_FLAGS "-fdata-sections -ffunction-sections -Wl,--enable-stdcall-fixup -static-libgcc -static -lpthread" CACHE STRING "" FORCE) paho.mqtt.c-1.3.14/cmake/toolchain.win64.cmake000066400000000000000000000011351473722542500207570ustar00rootroot00000000000000# Name of the target platform SET(CMAKE_SYSTEM_NAME Windows) # Version of the system SET(CMAKE_SYSTEM_VERSION 1) # specify the cross compiler SET(CMAKE_C_COMPILER x86_64-w64-mingw32-gcc) SET(CMAKE_CXX_COMPILER x86_64-w64-mingw32-g++) SET(CMAKE_RC_COMPILER_ENV_VAR "RC") SET(CMAKE_RC_COMPILER "") SET(CMAKE_SHARED_LINKER_FLAGS "-fdata-sections -ffunction-sections -Wl,--enable-stdcall-fixup -static-libgcc -static -lpthread" CACHE STRING "" FORCE) SET(CMAKE_EXE_LINKER_FLAGS "-fdata-sections -ffunction-sections -Wl,--enable-stdcall-fixup -static-libgcc -static -lpthread" CACHE STRING "" FORCE) paho.mqtt.c-1.3.14/deploy_rsa.enc000066400000000000000000000062601473722542500166030ustar00rootroot00000000000000}+I¥2™ôËo;îñE¢ÁG®uY‰MAK!‹Ëê]Ä]@£Þ ¥mV$´ÞN+Üø1Z†)ÖŽku’!,4ÑqçvšØÖùÿ˧¼§AÙz7Ódbn€ümB¹ÇÄ .ïD…Î&ãò‡V¹[–sé®Lxú9í,âVSoÚ¦x9 ½³m dû³í ˜×ÐéuVÑ¡ˆ(`×Á!l Ìs(‹>jÖÂ-·ykw褕rr ½ë.•…|8}9̯/ä9ð«dµõçK¢#=;"JnEÓ Ððïdke¡)œ¼é-Q¿k_ûÖ'étÈÃ溾L~¶ÕÙ-‹–'»Rd‘þž†6«³Y0‡ë}Ž±Ì¿¦2dOÑܹðb ZVó…óQ­1Ð ]ö²›@ÐB&EÚe€_£aÀª @l¬tfgO¨§×KÝv~uÃ_óFfíŽX»Lì)*™a…KP+Èp¸*l͘׫ž¹,ºÒÔª’üõ$哽ÇñûÞLáÀ²îÐT¯^9TÇÆ‘Àäæ cíqÍ6á4]Ju¥óƒÙ–²‰5VТ8tqvú }ãgÖÙýG\µÔV›ÍàÍyo^*‚Va™:¦o€þÃÒF0uDêp‡k«'£ÈªLY´¢}abÞN4ÙÚà²é }ù ¾yeCžL… ‘îsóüè˜ÖRFL†¥½lKO¯dV[ây¤ô¼é¯ÓÞ¦ö§¤÷€ïèþjú‡mÈùšu¸´³šë¸}´ÄÑprçÒ¤µ[ò?–\ãaì-Ï·l@ññQª%žc—”.ÕôÌ¢{ô…ŠZ´ZUß×—´&°ë±Å课ן\KÉ(š)I-9ëyŽ?Ý}£Ü^s_Õ>.¶AÆdþ}ž{6V£ ºßJªâð®#"±Á8Ô@#ã`›¼Š øÑ#¬øÒ¦#mLem%q˜)Iag42•PÐ*Æþ?§ÅVL{é)¬TMÉå"è[FÔÒiϵdD\ú甘r³-Gè P*µ0äNŠhû›¡A’ÙçÙ·ýÿÅäu‚÷ÅEekñÊb;î«ö”–P¶è+Îæ´¤†-ÖÿIš å)÷É6ŽqWq¢`Ø¢TšÕÇ@u¦õ|ÄOÕ²À0éfUo}·Ž}õn08Ÿc­¥˜‘’ØãÖ™ò·|iiçxmÇ”eEíBh 7ûÒÖ€œ ÷|6-úN¾Fl<ä [íòNÇ\ã/Žù)k¦Kã”.yÏþëX 1Fº áÓb-½V|/1ù—ií?uù§ƒ (ú¡•Y¬#ú[Ä…ƒo“ö±$¬zý.ÞˆêpêÝ«=©…‰Ðžòo,Ì¡8YΔÏä& è?a†#,5Г•ñç hË‘¸_wÕ><²FSÿ•óuU m!¯Öod¨åLx·±HÓ !\ÆßUóƒã6MÞ è%ðêH ®ÚÁíˆøÚ«{j¤2ÜC –QÙvxMf[Ë&©YÆñ¹uZ_ò¢qoí]Ò²ý7F(r;”¼î ÿ ±¢.Ì.+ßOÜsWÅ"˜{ß9žNAL€> áí˜>µh¦ãÏ]í.°*qÔ[°È|äÏÕfÑÁçN’Ž8Õ9rúÂQÄá‰aËX§õ”Û}Kr1s¸*ìäàÖ+)[\ÐØ©žÌøý~ù¢ Zål·eTI½D&é±y—Ú¢ÀÉY—‡?Îòôé³rˆ)H¶ Çå ;6n¬3:³\⮉¡ãÐj£(¶›¢ìüuøϤ”@&Ó<êtRÃôÌñµù…B±í6?å~ýÔ é‚Ù?ãÀžú w­ü"9%qeÿ(5Ç’³Uo/?›[ÇÚÍ»¡6[)…U×/¸‹ŽO?ÿD»1ú÷çÇËFÁÖvé)€î›ñ+‘uìPϪµæ~ÀdŸÒ’š :Å Ãs­Ä|“oº€jùü„†,CÉ+Ô¶éî‰[è`þ©Ô/y:†«°ÜÕŸ²4÷N6×vnòvè5Öôl:³ú uÈŽÐëÔ}’+4äåbñý2¶7xÿ)}9´ôSgõþúVd úËìÙÜ"ðy6'ž# ä4s§Öó(l¯cûÁ·‹ —¸€H—€OØë–v¸®ÕùU|ƒoëŠ|„úc€eANäŠT ¯„v{QSBÈäL™ EmwÌ,ÀèbÈ`Vú-¤†7À¼™ü(«ó¥ÁÈPÏâ܇Sí\´Â}""æ>*{Û±>£‚‰Ú5‚ÏdWEøi%j­€ .üíe欱eÉÉ«ðÈΟÏÇ ä÷K¤±h:eè€Réº?«áºC AlIvl9^|=ÙÁån·:ÇBÎ M®î䘎;àô™¢&9[¦› `|2Vd“éT¯x/ ­»¥€ë´¹¨., Ð{ùÕ4ɶqZ06_ÿ¿ªâb ”ÏÊJ’NŠOŸÀñËDÁ ·]¯ð“@ÿï²ÎdûÇ™íiú¿[p°t+š= è÷Ø]•j,üDÃNWVæ1¤>^@óÛ„ÂÝõÁ3¼*|<ç“z³ì 9PÒTÿŒ‹„Ä<«–™K¡é¼×!ê­Mà#ôš{B¹/—Õ”©Á"OÆb0†ƒB7í¯À8æ¾K·A,&®:£Ü„Ф4êgbÞ3˜¯Â{û‹Žkûí‹ækàžá¸h®„¼‰-ý{yˆüú\l´ 7;ºÞ¥¦ÊU–™ž5â_ïïqkEÀ|rª¬¸›rè1Úh ,—› RVŸÎ\$pãG¡>0|ÊaèDä;¨~Û»Ç_²!ÝÚ;Gþ)8òóÙA{u9yBÚTP™ÕÒx6qT {Wð‚Äâ4“xƒ×ÜñÛÇ*µc½½ái±ïÂ)¦¹â,q-hn0ëŠgÎIÏ÷&~ Ó:,j…ÚÐ&|žÔÒ¦ÕO±Ìfz5…ä¼WÕR€7­Á¼jBóÃYPÜÒhgHPÞ^¦Í¡)¼.´p%Bc²SƒDZ·¡\»8ê'”ãñeúN(ò߉lu°²dì‹ãªZ͵ìÅ$ÏžœÄ{ÊÎfÍLõ]Tì¨9H«9Dâ^ˆYæÉÚQP°a» oPObyö#2¼·Pœ¥ÖÝÈèÌ.]ÊÔ´ÅÈ%5ï<}†…êwǼޖeL‚*k.Umƒ©Ÿ©Ï?¹Ñϱ½—e„(ÌÉ„ZºBI㘲Œ´”W×ã&†ll@€ºÒ*b×b "U(#Ž9PÊ—@BÞŒÚb±7¹<Ò¨ Aë’ÚÚê wfOæaKPgs#~1¡út9鄧©âi!HÂ[ÌÉèoè 2*þ]ýqEz-þœß'Pµ§Q•šVZd`ððê'¿Üê5uzã/Þþq[1€Ÿ/a1¥ˆ%BÙääh=©Í~äþ\æžÎÊtL•òN¥y/C›Ï§|b1»KùWpmh+¶”Nóœ&¬ aÝEJò)ê]ÖÞC 9@S^ÉXc$¬$¤þØQö»ºò2‡Úh¼ËøgvµÚl=Nb:â(ã¯]o*÷þ8æ¹Ú_öCR#v! Bšô-¡Œác‰ –m²«¯/™¶ü[ ©‚;ê³9}{¡„Øðïãš±g’¦3R2) ccÒ âÌNiL !,£Ó6`J檭é±qú$x¸€“_£\i ˜oÕÌëµýð¡trq“tð‚0m1)çu« §JIñÔªèý°§2„p8^PUoesOå8ÿL3xs.9¿¨åªÅ¥·‚Í4<ŸÞGÊ© ¹ãQª_J\GÀˆ1€?éV¿vÆ&mãƬ˜ýlp4æ*™È[,o?!±oµôÊ—Ù˜ò´‹%ïö°·øÓ*>¶#ßøÚÃÙµ?ä,5\|û.fjcqð‘‘ß[êï÷­‰üpjW²òÌŠò¥2n 3ˆpaho.mqtt.c-1.3.14/dist/000077500000000000000000000000001473722542500147125ustar00rootroot00000000000000paho.mqtt.c-1.3.14/dist/Makefile000066400000000000000000000004521473722542500163530ustar00rootroot00000000000000VERSION=1.3.0 check: rpmlint -i dist/paho-c.spec rpm-prep: mkdir -p ${HOME}/rpmbuild/SOURCES/ tar --transform="s/\./paho-c-${VERSION}/" -cf ${HOME}/rpmbuild/SOURCES/v${VERSION}.tar.gz --exclude=./build.paho --exclude=.git --exclude=*.bz ./ --gzip rpm: rpm-prep rpmbuild -ba dist/paho-c.spec paho.mqtt.c-1.3.14/dist/paho-c.spec000066400000000000000000000042151473722542500167370ustar00rootroot00000000000000Summary: MQTT C Client Name: paho-c Version: 1.3.2 Release: 3%{?dist} License: Eclipse Distribution License 1.0 and Eclipse Public License 2.0 Group: Development/Tools Source: https://github.com/eclipse/paho.mqtt.c/archive/v%{version}.tar.gz URL: https://eclipse.org/paho/clients/c/ BuildRequires: cmake BuildRequires: gcc BuildRequires: graphviz BuildRequires: doxygen BuildRequires: openssl-devel Requires: openssl %description The Paho MQTT C Client is a fully fledged MQTT client written in ANSI standard C. %package devel Summary: MQTT C Client development kit Group: Development/Libraries Requires: paho-c %description devel Development files and samples for the the Paho MQTT C Client. %package devel-docs Summary: MQTT C Client development kit documentation Group: Development/Libraries %description devel-docs Development documentation files for the the Paho MQTT C Client. %prep %autosetup -n paho-c-%{version} %build mkdir build.paho && cd build.paho %cmake -DPAHO_WITH_SSL=TRUE -DPAHO_BUILD_DOCUMENTATION=TRUE -DPAHO_BUILD_SAMPLES=TRUE .. make %{?_smp_mflags} %install cd build.paho make install DESTDIR=%{buildroot} %files %doc edl-v10 epl-v20 %{_libdir}/* %files devel %{_bindir}/* %{_includedir}/* %files devel-docs %{_datadir}/* %changelog * Thu Jul 27 2017 Otavio R. Piske - 1.2.0-4 - Enabled generation of debuginfo package * Thu Jul 27 2017 Otavio R. Piske - 1.2.0-3 - Fixed changelog issues pointed by rpmlint * Thu Jul 27 2017 Otavio R. Piske - 1.2.0-2 - Updated changelog to comply with Fedora packaging guidelines * Wed Jul 26 2017 Otavio R. Piske - 1.2.0-1 - Fixed rpmlint warnings: replaced cmake call with builtin macro - Fixed rpmlint warnings: removed buildroot reference from build section * Fri Jun 30 2017 Otavio R. Piske - 1.2.0 - Updated package to version 1.2.0 * Sat Dec 31 2016 Otavio R. Piske - 1.1.0 - Initial packaging paho.mqtt.c-1.3.14/doc/000077500000000000000000000000001473722542500145145ustar00rootroot00000000000000paho.mqtt.c-1.3.14/doc/CMakeLists.txt000066400000000000000000000032531473722542500172570ustar00rootroot00000000000000#******************************************************************************* # Copyright (c) 2015 logi.cals GmbH # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Eclipse Public License v2.0 # and Eclipse Distribution License v1.0 which accompany this distribution. # # The Eclipse Public License is available at # https://www.eclipse.org/legal/epl-2.0/ # and the Eclipse Distribution License is available at # http://www.eclipse.org/org/documents/edl-v10.php. # # Contributors: # Rainer Poisel - initial version #*******************************************************************************/ ### documentation settings find_package(Doxygen) if(NOT DOXYGEN_FOUND) message(FATAL_ERROR "Doxygen is needed to build the documentation.") endif() set(DOXYTARGETS) file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc) foreach(DOXYFILE_SRC DoxyfileV3ClientAPI;DoxyfileV3AsyncAPI;DoxyfileV3ClientInternal) set(DOXYFILE_IN ${DOXYFILE_SRC}.in) set(DOXYFILE ${CMAKE_CURRENT_BINARY_DIR}/${DOXYFILE_SRC}) configure_file(${DOXYFILE_IN} ${DOXYFILE} @ONLY) add_custom_target(${DOXYFILE_SRC}.target COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating API documentation with Doxygen" VERBATIM ) set(DOXYTARGETS ${DOXYTARGETS} ${DOXYFILE_SRC}.target) endforeach(DOXYFILE_SRC) add_custom_target(doc ALL DEPENDS ${DOXYTARGETS}) if(PAHO_ENABLE_CPACK) install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc/ DESTINATION ${CMAKE_INSTALL_DOCDIR}) else() install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc DESTINATION ${CMAKE_INSTALL_DOCDIR}) endif() paho.mqtt.c-1.3.14/doc/DoxyfileV3AsyncAPI.in000066400000000000000000003212701473722542500203750ustar00rootroot00000000000000# Doxyfile 1.8.14 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all text # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv # built into libc) for the transcoding. See # https://www.gnu.org/software/libiconv/ for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = "Paho Asynchronous MQTT C Client Library" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. PROJECT_LOGO = "@PROJECT_SOURCE_DIR@/doc/pahologo.png" # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = "@CMAKE_CURRENT_BINARY_DIR@/doc/MQTTAsync/" # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ "The $name file" \ is \ provides \ specifies \ contains \ represents \ a \ an \ the # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = NO # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@/src # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 8 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines (in the resulting output). You can put ^^ in the value part of an # alias to insert a newline as if a physical newline was in the original file. ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: # Fortran. In the later case the parser tries to guess whether the code is fixed # or free formatted code, this is the default for Fortran type files), VHDL. For # instance to make doxygen treat .inc files as Fortran files (default is PHP), # and .f files as C (default is Fortran), use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. # Minimum value: 0, maximum value: 99, default value: 0. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 0 # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option # is disabled and one has to add nested compounds explicitly via \ingroup. # The default value is: NO. GROUP_NESTED_COMPOUNDS = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # (class|struct|union) declarations. If set to NO, these declarations will be # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = YES # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = NO # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = MQTTAsync_main # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. # The default value is: NO. WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. # The default value is: NO. WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = @PROJECT_SOURCE_DIR@/src/MQTTAsync.h \ @PROJECT_SOURCE_DIR@/src/MQTTClientPersistence.h \ @PROJECT_SOURCE_DIR@/src/MQTTProperties.h \ @PROJECT_SOURCE_DIR@/src/MQTTSubscribeOpts.h \ @PROJECT_SOURCE_DIR@/src/MQTTReasonCodes.h # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: https://www.gnu.org/software/libiconv/) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. FILE_PATTERNS = # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = * # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # function all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see https://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the config file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = NO # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # https://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that # are dynamically created via Javascript. If disabled, the navigation index will # consists of multiple levels of tabs that are statically embedded in every HTML # page. Disable this option to support browsers that do not have Javascript, # like the Qt help browser. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_MENUS = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: https://developer.apple.com/tools/xcode/), introduced with # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See https://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the master .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: http://doc.qt.io/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: http://doc.qt.io/qt-4.8/qthelpproject.html#virtual-folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # http://doc.qt.io/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NONE # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # https://www.mathjax.org) which uses client side Javascript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from https://www.mathjax.org before deployment. # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /