Deprecate the C++ API.

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

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.

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 <memory>

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 <string>

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 <string>

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 <string>

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"

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 <ts/ts.h>

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"

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 <string>

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 <string_view>

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"

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 <string>

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 <string>

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 <string>

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 <string>

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 <string>

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"

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 <ts/apidefs.h>
 #include "tscpp/api/utils.h"

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"

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"

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"

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"

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 <sys/socket.h>

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 <memory>

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 <string_view>

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 <string>

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 <string>