From 9a15d416c138c7adff7b5e5abd9d1d57de44fe91 Mon Sep 17 00:00:00 2001 From: Walt Karas Date: Thu, 26 Oct 2023 22:38:42 +0000 Subject: [PATCH] Deprecate the C++ API. --- .../introduction/header-file-structure.en.rst | 4 ++++ doc/release-notes/whats-new.en.rst | 5 +++++ include/tscpp/api/Async.h | 2 ++ include/tscpp/api/AsyncHttpFetch.h | 2 ++ include/tscpp/api/AsyncTimer.h | 2 ++ include/tscpp/api/CaseInsensitiveStringComparator.h | 2 ++ include/tscpp/api/ClientRequest.h | 2 ++ include/tscpp/api/Continuation.h | 2 ++ include/tscpp/api/GlobalPlugin.h | 2 ++ include/tscpp/api/GzipDeflateTransformation.h | 2 ++ include/tscpp/api/GzipInflateTransformation.h | 2 ++ include/tscpp/api/Headers.h | 2 ++ include/tscpp/api/HttpMethod.h | 3 +++ include/tscpp/api/HttpStatus.h | 2 ++ include/tscpp/api/HttpVersion.h | 2 ++ include/tscpp/api/InterceptPlugin.h | 2 ++ include/tscpp/api/Logger.h | 2 ++ include/tscpp/api/Plugin.h | 2 ++ include/tscpp/api/PluginInit.h | 2 ++ include/tscpp/api/RemapPlugin.h | 2 ++ include/tscpp/api/Request.h | 2 ++ include/tscpp/api/Response.h | 2 ++ include/tscpp/api/Stat.h | 2 ++ include/tscpp/api/Transaction.h | 2 ++ include/tscpp/api/TransactionPlugin.h | 2 ++ include/tscpp/api/TransformationPlugin.h | 2 ++ include/tscpp/api/Url.h | 2 ++ include/tscpp/api/utils.h | 2 ++ 28 files changed, 62 insertions(+) diff --git a/doc/developer-guide/introduction/header-file-structure.en.rst b/doc/developer-guide/introduction/header-file-structure.en.rst index 2dd22b795cd..b40299eec67 100644 --- a/doc/developer-guide/introduction/header-file-structure.en.rst +++ b/doc/developer-guide/introduction/header-file-structure.en.rst @@ -28,6 +28,10 @@ The header files are located in the ``include/`` directory. There are several su The C++ Plugin API. These call functions in the ``libtscppapi.so`` library to directly interact with the running |TS| instance. +.. note:: + + The C++ Plugin API is deprecated in ATS 10. It will be removed in ATS 11. + "tscpp/util" C++ utilities. These are standalone headers (although they may depend on other headers in the same directory). These provide functionality that is used inside the |TS| core logic but has been diff --git a/doc/release-notes/whats-new.en.rst b/doc/release-notes/whats-new.en.rst index 600b99c4344..688e4016bfa 100644 --- a/doc/release-notes/whats-new.en.rst +++ b/doc/release-notes/whats-new.en.rst @@ -54,3 +54,8 @@ Plugins are now required to be compiled as C++ code, rather than straight C. The API is tested with C++17, so code compatible with this version is preferred. ``TSDebug`` and related functions are removed. Debug tracing should now be done using cpp:func:`Dbg` and related functions, as in |TS| core code. + +C++ Plugin API Deprecated +^^^^^^^^^^^^^^^^^^^^^^^^^ + +It is deprecated in this release. It will be deleted in ATS 11. diff --git a/include/tscpp/api/Async.h b/include/tscpp/api/Async.h index 37bdd292666..b1d5fffa3e4 100644 --- a/include/tscpp/api/Async.h +++ b/include/tscpp/api/Async.h @@ -21,6 +21,8 @@ * @brief Provides constructs to perform async operations. */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/AsyncHttpFetch.h b/include/tscpp/api/AsyncHttpFetch.h index 4c805cc1e17..0c2fc5255e6 100644 --- a/include/tscpp/api/AsyncHttpFetch.h +++ b/include/tscpp/api/AsyncHttpFetch.h @@ -20,6 +20,8 @@ * @file AsyncHttpFetch.h */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/AsyncTimer.h b/include/tscpp/api/AsyncTimer.h index 3e7658a976d..9b511c28f46 100644 --- a/include/tscpp/api/AsyncTimer.h +++ b/include/tscpp/api/AsyncTimer.h @@ -20,6 +20,8 @@ * @file AsyncTimer.h */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/CaseInsensitiveStringComparator.h b/include/tscpp/api/CaseInsensitiveStringComparator.h index 4d57eb8902d..0d6811650c1 100644 --- a/include/tscpp/api/CaseInsensitiveStringComparator.h +++ b/include/tscpp/api/CaseInsensitiveStringComparator.h @@ -20,6 +20,8 @@ * @brief A case insensitive comparator that can be used with STL containers. */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/ClientRequest.h b/include/tscpp/api/ClientRequest.h index 79a37b0165b..3ec2fb74b84 100644 --- a/include/tscpp/api/ClientRequest.h +++ b/include/tscpp/api/ClientRequest.h @@ -20,6 +20,8 @@ * @file ClientRequest.h */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include "tscpp/api/Request.h" diff --git a/include/tscpp/api/Continuation.h b/include/tscpp/api/Continuation.h index 64480ff6f46..fd09eabc829 100644 --- a/include/tscpp/api/Continuation.h +++ b/include/tscpp/api/Continuation.h @@ -21,6 +21,8 @@ * @brief Wrapper class for TS API type TSCont. */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/GlobalPlugin.h b/include/tscpp/api/GlobalPlugin.h index 1d76ed5d8ff..a1885691306 100644 --- a/include/tscpp/api/GlobalPlugin.h +++ b/include/tscpp/api/GlobalPlugin.h @@ -21,6 +21,8 @@ * @brief Contains the interface used in creating Global plugins. */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include "tscpp/api/Plugin.h" diff --git a/include/tscpp/api/GzipDeflateTransformation.h b/include/tscpp/api/GzipDeflateTransformation.h index 10cfb621283..f947722921e 100644 --- a/include/tscpp/api/GzipDeflateTransformation.h +++ b/include/tscpp/api/GzipDeflateTransformation.h @@ -21,6 +21,8 @@ * @brief Gzip Deflate Transformation can be used to compress content. */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/GzipInflateTransformation.h b/include/tscpp/api/GzipInflateTransformation.h index 358fdc7b658..c09aae3337f 100644 --- a/include/tscpp/api/GzipInflateTransformation.h +++ b/include/tscpp/api/GzipInflateTransformation.h @@ -21,6 +21,8 @@ * @brief Gzip Inflate Transformation can be used to decompress gzipped content. */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/Headers.h b/include/tscpp/api/Headers.h index 33a920e80a2..4797ad2bca8 100644 --- a/include/tscpp/api/Headers.h +++ b/include/tscpp/api/Headers.h @@ -20,6 +20,8 @@ * @file Headers.h */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include "tscpp/api/noncopyable.h" diff --git a/include/tscpp/api/HttpMethod.h b/include/tscpp/api/HttpMethod.h index ce672a6c647..59a6fb7857f 100644 --- a/include/tscpp/api/HttpMethod.h +++ b/include/tscpp/api/HttpMethod.h @@ -20,6 +20,9 @@ * @file HttpMethod.h * @brief Contains an enumeration and printable strings for Http Methods. */ + +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/HttpStatus.h b/include/tscpp/api/HttpStatus.h index 89f6dd8f945..0338a6d93ae 100644 --- a/include/tscpp/api/HttpStatus.h +++ b/include/tscpp/api/HttpStatus.h @@ -21,6 +21,8 @@ * @brief Contains an enumeration and printable strings for Http Status codes. */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/HttpVersion.h b/include/tscpp/api/HttpVersion.h index 00a39a3cdb2..de5c18ddc74 100644 --- a/include/tscpp/api/HttpVersion.h +++ b/include/tscpp/api/HttpVersion.h @@ -21,6 +21,8 @@ * @brief Contains an enumeration and printable strings for Http Versions. */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/InterceptPlugin.h b/include/tscpp/api/InterceptPlugin.h index d7d6597b4e5..c1d69b9b123 100644 --- a/include/tscpp/api/InterceptPlugin.h +++ b/include/tscpp/api/InterceptPlugin.h @@ -20,6 +20,8 @@ * @file InterceptPlugin.h */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/Logger.h b/include/tscpp/api/Logger.h index 643bd31b4cd..7e1e59d46a0 100644 --- a/include/tscpp/api/Logger.h +++ b/include/tscpp/api/Logger.h @@ -26,6 +26,8 @@ * */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/Plugin.h b/include/tscpp/api/Plugin.h index f37b8050e17..4662aebdba9 100644 --- a/include/tscpp/api/Plugin.h +++ b/include/tscpp/api/Plugin.h @@ -23,6 +23,8 @@ * through extending GlobalPlugin, TransactionPlugin, or TransformationPlugin. */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include "tscpp/api/Request.h" diff --git a/include/tscpp/api/PluginInit.h b/include/tscpp/api/PluginInit.h index acd8bea2986..e306b272fd1 100644 --- a/include/tscpp/api/PluginInit.h +++ b/include/tscpp/api/PluginInit.h @@ -20,6 +20,8 @@ * @brief Provides hooks that plugins have to implement. ATS will invoke these when loading the plugin .so files. */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include #include "tscpp/api/utils.h" diff --git a/include/tscpp/api/RemapPlugin.h b/include/tscpp/api/RemapPlugin.h index e69cbb6ee42..d7de3a69bea 100644 --- a/include/tscpp/api/RemapPlugin.h +++ b/include/tscpp/api/RemapPlugin.h @@ -20,6 +20,8 @@ * @file RemapPlugin.h */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include "tscpp/api/Transaction.h" diff --git a/include/tscpp/api/Request.h b/include/tscpp/api/Request.h index 515ec32f348..f378de6e302 100644 --- a/include/tscpp/api/Request.h +++ b/include/tscpp/api/Request.h @@ -19,6 +19,8 @@ * @file Request.h */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include "tscpp/api/Headers.h" diff --git a/include/tscpp/api/Response.h b/include/tscpp/api/Response.h index f96890b37ab..f5d7d1ccec7 100644 --- a/include/tscpp/api/Response.h +++ b/include/tscpp/api/Response.h @@ -19,6 +19,8 @@ * @file Response.h */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include "tscpp/api/Headers.h" diff --git a/include/tscpp/api/Stat.h b/include/tscpp/api/Stat.h index ba87c6d0d3f..62b03797bec 100644 --- a/include/tscpp/api/Stat.h +++ b/include/tscpp/api/Stat.h @@ -19,6 +19,8 @@ * @file Stat.h */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include "ts/apidefs.h" diff --git a/include/tscpp/api/Transaction.h b/include/tscpp/api/Transaction.h index 874c315b853..dd7c756db88 100644 --- a/include/tscpp/api/Transaction.h +++ b/include/tscpp/api/Transaction.h @@ -19,6 +19,8 @@ * @file Transaction.h */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/TransactionPlugin.h b/include/tscpp/api/TransactionPlugin.h index bed12ca9f72..23c63623a9c 100644 --- a/include/tscpp/api/TransactionPlugin.h +++ b/include/tscpp/api/TransactionPlugin.h @@ -20,6 +20,8 @@ * @brief Contains the interface used in creating Transaction plugins. */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/TransformationPlugin.h b/include/tscpp/api/TransformationPlugin.h index c77e33c2f45..456de4d1261 100644 --- a/include/tscpp/api/TransformationPlugin.h +++ b/include/tscpp/api/TransformationPlugin.h @@ -20,6 +20,8 @@ * @file TransformationPlugin.h */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/Url.h b/include/tscpp/api/Url.h index 38a45104d92..d2e877b612e 100644 --- a/include/tscpp/api/Url.h +++ b/include/tscpp/api/Url.h @@ -19,6 +19,8 @@ * @file Url.h */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include diff --git a/include/tscpp/api/utils.h b/include/tscpp/api/utils.h index c6d521568d2..fa3a8db91ef 100644 --- a/include/tscpp/api/utils.h +++ b/include/tscpp/api/utils.h @@ -22,6 +22,8 @@ * */ +// The C++ Plugin API is deprecated in ATS 10, and will be removed in ATS 11. + #pragma once #include