Many updates for corresponding Connective C++ changes, updated dependencies

Author: cliffg-softwarelibre

.github/workflows/build_cmake.yml

@@ -0,0 +1,31 @@
+# Build, run unit tests
+name: CMake build and run unit test matrix
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+env:
+  BUILD_TYPE: Release
+jobs:
+  build_matrix:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-15]
+          # os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+      - name: create-build-dir
+        run: mkdir build
+      - name: configure-cmake
+        run: cd build && cmake -D CHOPS_NET_IP_BUILD_TESTS:BOOL=ON -D CHOPS_NET_IP_BUILD_EXAMPLES:BOOL=ON ..
+      - name: build
+        run: cd build && cmake --build . --config $BUILD_TYPE
+      - name: run-unit-test
+        run: cd build && ctest -C $BUILD_TYPE

.github/workflows/build_run_unit_test_cmake.yml

@@ -0,0 +1,28 @@
+# Build, run unit tests
+name: Generate documentation
+
+on:
+  push:
+    branches:
+      - main
+jobs:
+  build_matrix:
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+      - name: run-doxygen
+        uses: mattnotmitt/doxygen-action@v1.12.0
+        with:
+          working-directory: doc
+      - name: deploy-pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doc/doc_output/html

.github/workflows/gen_docs.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2019-2024 by Cliff Green
+# Copyright (c) 2019-2025 by Cliff Green
 #
 # https://github.com/connectivecpp/chops-net-ip
 #
@@ -27,8 +27,11 @@ add_library ( chops::chops_net_ip ALIAS chops_net_ip )
 
 # thread support specified in Asio download
 
+# dependencies needed for main library
+
 include ( cmake/download_cpm.cmake )
-CPMAddPackage ( "gh:connectivecpp/shared_buffer@v1.0.0"
+CPMAddPackage ( "gh:connectivecpp/shared-buffer@1.0.3" )
+CPMAddPackage ( "gh:martinmoene/expected-lite@0.8.0" )
 
 include ( cmake/download_asio_cpm.cmake )
 

CMakeLists.txt

@@ -6,6 +6,13 @@ Chops Net IP is not like any other high-level, general purpose C++ socket librar
 
 Chops Net IP is layered on top of the Asio asynchronous networking library, taking advantage of the portability and functionality that Asio provides. However, it simplifies network programming compared to coding against the Asio API, while providing easy scalability through the asynchronous facilities.
 
+Chops Net IP:
+
+1. Asio gotchas
+2. Simplifies many use cases
+3. API between TCP and UDP is similar, allowing shared code
+4. Provides callback points 
+
 #### Unit Test and Documentation Generation Workflow Status
 
 ![GH Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/connectivecpp/chops-net-ip/build_run_unit_test_cmake.yml?branch=main&label=GH%20Actions%20build,%20unit%20tests%20on%20main)
@@ -18,42 +25,42 @@ Chops Net IP is layered on top of the Asio asynchronous networking library, taki
 
 ## Overview
 
-`periodic_timer` is an asynchronous periodic timer that wraps and simplifies Asio timers when periodic callbacks are needed. The periodicity can be based on either a simple duration or on timepoints based on a duration.
-
-Timepoint calculations are performed by this class template so that timepoint durations don't "drift". In other words, if the processing during a callback takes 15 milliseconds, the next callback invocation is adjusted accordingly.
-
-Asynchronous timers from Asio are relatively easy to use. However, there are no timers that are periodic. This class simplifies the usage, using application supplied function object callbacks. When the timer is started, the application specifies whether each callback is invoked based on a duration (e.g. one second after the last callback), or on timepoints (e.g. a callback will be invoked each second according to the clock).
+(fill in)
 
 ## Generated Documentation
 
-The generated Doxygen documentation for `periodic_timer` is [here](https://connectivecpp.github.io/chops-net-ip/).
+The generated Doxygen documentation for `chops_net_ip` is [here](https://connectivecpp.github.io/chops-net-ip/).
 
 ## Dependencies
 
-The `periodic_timer` header file has the stand-alone Asio library for a dependency. Specific version (or branch) specs for the Asio dependency is in `cmake/download_asio_cpm.cmake`.
+The stand-alone Asio library is a dependency for Chops Net IP. Specific version (or branch) specs for the Asio dependency is in `cmake/download_asio_cpm.cmake`.
+
+The `shared_buffer` library from Connective C++ is a dependency, providing reference counted `std::byte` buffers.
+
+`expected_lite` from Martin Moene is a dependency, providing `std::expected` functionality for C++ 20 code baselines. If Chops Net IP transitions to a C++ 23 baseline, `expected_lite` will be replaced with `std::expected`.
 
 ## C++ Standard
 
-`periodic_timer` is built under C++ 20, but (currently) does not use any specific C++ 20 features. In the future `concepts` / `requires` will be added.
+`chops_net_ip` is built under C++ 20, using features such as `std::span`. In the future `concepts` / `requires` will be added.
 
 ## Supported Compilers
 
 Continuous integration workflows build and unit test on g++ (through Ubuntu), MSVC (through Windows), and clang (through macOS).
 
 ## Unit Test Dependencies
 
-The unit test code uses [Catch2](https://github.com/catchorg/Catch2). If the `PERIODIC_TIMER_BUILD_TESTS` flag is provided to Cmake (see commands below) the Cmake configure / generate will download the Catch2 library as appropriate using the [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake) dependency manager. If Catch2 (v3 or greater) is already installed using a different package manager (such as Conan or vcpkg), the `CPM_USE_LOCAL_PACKAGES` variable can be set which results in `find_package` being attempted. Note that v3 (or later) of Catch2 is required.
+The unit test code uses [Catch2](https://github.com/catchorg/Catch2). If the `CHOPS_NET_IP_BUILD_TESTS` flag is provided to Cmake (see commands below) the Cmake configure / generate will download the Catch2 library as appropriate using the [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake) dependency manager. If Catch2 (v3 or greater) is already installed using a different package manager (such as Conan or vcpkg), the `CPM_USE_LOCAL_PACKAGES` variable can be set which results in `find_package` being attempted. Note that v3 (or later) of Catch2 is required.
 
 Specific version (or branch) specs for the Catch2 dependency is in the [test/CMakeLists.txt](test/CMakeLists.txt) file, look for the `CPMAddPackage` command.
 
 ## Build and Run Unit Tests
 
-To build and run the unit test program:
+To build and run the unit test programs:
 
-First clone the `periodic-timer` repository, then create a build directory in parallel to the `periodic-timer` directory (this is called "out of source" builds, which is recommended), then `cd` (change directory) into the build directory. The CMake commands:
+First clone the `chops-net-ip` repository, then create a build directory in parallel to the `chops-net-ip` directory (this is called "out of source" builds, which is recommended), then `cd` (change directory) into the build directory. The CMake commands:
 
 ```
-cmake -D PERIODIC_TIMER_BUILD_TESTS:BOOL=ON ../periodic-timer
+cmake -D CHOPS_NET_IP_BUILD_TESTS:BOOL=ON ../chops_net_ip
 
 cmake --build .
 
@@ -63,8 +70,8 @@ ctest
 For additional test output, run the unit test individually, for example:
 
 ```
-test/periodic_timer_test -s
+test/net_ip/basic_io_output_test -s
 ```
 
-The example can be built by adding `-D PERIODIC_TIMER_BUILD_EXAMPLES:BOOL=ON` to the CMake configure / generate step.
+The examples can be built by adding `-D CHOPS_NET_IP_BUILD_EXAMPLES:BOOL=ON` to the CMake configure / generate step.
 

README.md

@@ -10,8 +10,7 @@ set ( CMAKE_THREAD_PREFER_PTHREAD TRUE )
 set ( THREADS_PREFER_PTHREAD_FLAG TRUE )
 find_package ( Threads REQUIRED )
 
-include ( cmake/download_cpm.cmake )
-CPMAddPackage ( "gh:chriskohlhoff/asio#asio-1-32-0@1.32.0" )
+CPMAddPackage ( "gh:chriskohlhoff/asio#asio-1-34-0@1.34.0" )
 
 # ASIO doesn't use CMake, we have to configure it manually. Extra notes for using on Windows:
 #

cmake/add_target_dependencies.cmake

@@ -4,7 +4,7 @@
 
 file(
   DOWNLOAD
-  https://github.com/cpm-cmake/CPM.cmake/releases/download/v0.39.0/CPM.cmake
+  https://github.com/cpm-cmake/CPM.cmake/releases/download/v0.40.0/CPM.cmake
   ${CMAKE_CURRENT_BINARY_DIR}/cmake/CPM.cmake
 )
 include(${CMAKE_CURRENT_BINARY_DIR}/cmake/CPM.cmake)

cmake/download_asio_cpm.cmake

@@ -0,0 +1,14 @@
+# Copyright (c) 2024-2025 by Cliff Green
+#
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
+
+# add example executable
+foreach ( example_app_name IN LISTS example_app_names )
+  message ( "Creating example executable: ${example_app_name}" )
+  add_executable ( ${example_app_name} ${example_app_name}.cpp )
+  target_compile_features ( ${example_app_name} PRIVATE cxx_std_20 )
+  target_link_libraries ( ${example_app_name} PRIVATE 
+      Threads::Threads chops_net_ip asio shared_buffer expected-lite Catch2::Catch2WithMain )
+endforeach()
+