introduce TSStrategy type for plugins

Brian Olsen · Brian Olsen · commit 6663eb1a413f · 2025-11-17T13:32:11.000Z
diff --git a/doc/developer-guide/api/functions/TSHttpTxnNextHopStrategyFind.en.rst b/doc/developer-guide/api/functions/TSHttpTxnNextHopStrategyFind.en.rst
@@ -28,7 +28,7 @@ Synopsis
 
     #include <ts/ts.h>
 
-.. function:: void const* TSHttpTxnNextHopStrategyFind(TSHttpTxn txnp, const char *name)
+.. function:: TSStrategy TSHttpTxnNextHopStrategyFind(TSHttpTxn txnp, const char *name)
 
 Description
 ===========
diff --git a/doc/developer-guide/api/functions/TSHttpTxnNextHopStrategyGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnNextHopStrategyGet.en.rst
@@ -28,7 +28,7 @@ Synopsis
 
     #include <ts/ts.h>
 
-.. function:: void const* TSHttpTxnNextHopStrategyGet(TSHttpTxn txnp)
+.. function:: TSStrategy TSHttpTxnNextHopStrategyGet(TSHttpTxn txnp)
 
 Description
 ===========
diff --git a/doc/developer-guide/api/functions/TSHttpTxnNextHopStrategySet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnNextHopStrategySet.en.rst
@@ -28,7 +28,7 @@ Synopsis
 
     #include <ts/ts.h>
 
-.. function:: void TSHttpTxnNextHopStrategySet(TSHttpTxn txnp, void const* strategy)
+.. function:: void TSHttpTxnNextHopStrategySet(TSHttpTxn txnp, TSStrategy strategy)
 
 Description
 ===========
diff --git a/doc/developer-guide/api/functions/TSNextHopStrategyNameGet.en.rst b/doc/developer-guide/api/functions/TSNextHopStrategyNameGet.en.rst
@@ -28,7 +28,7 @@ Synopsis
 
     #include <ts/ts.h>
 
-.. function:: char const* TSNextHopStrategyNameGet(void const* strategy)
+.. function:: char const* TSNextHopStrategyNameGet(TSStrategy strategy)
 
 Description
 ===========
diff --git a/doc/developer-guide/api/functions/TSRemapNextHopStrategyFind.en.rst b/doc/developer-guide/api/functions/TSRemapNextHopStrategyFind.en.rst
@@ -28,7 +28,7 @@ Synopsis
 
     #include <ts/ts.h>
 
-.. function:: void const* TSRemapNextHopStrategyFind(const char *name)
+.. function:: TSStrategy TSRemapNextHopStrategyFind(const char *name)
 
 Description
 ===========
diff --git a/doc/developer-guide/api/functions/TSRemapNextHopStrategyGet.en.rst b/doc/developer-guide/api/functions/TSRemapNextHopStrategyGet.en.rst
@@ -28,7 +28,7 @@ Synopsis
 
     #include <ts/ts.h>
 
-.. function:: void const* TSRemapNextHopStrategyGet()
+.. function:: TSStrategy TSRemapNextHopStrategyGet()
 
 Description
 ===========
diff --git a/doc/developer-guide/api/functions/TSRemapNextHopStrategySet.en.rst b/doc/developer-guide/api/functions/TSRemapNextHopStrategySet.en.rst
@@ -28,7 +28,7 @@ Synopsis
 
     #include <ts/ts.h>
 
-.. function:: void TSRemapNextHopStrategySet(void const* strategy)
+.. function:: void TSRemapNextHopStrategySet(TSStrategy strategy)
 
 Description
 ===========
diff --git a/include/ts/apidefs.h.in b/include/ts/apidefs.h.in
@@ -1080,6 +1080,7 @@ using TSHostLookupResult = struct tsapi_hostlookupresult *;
 using TSAIOCallback      = struct tsapi_aiocallback *;
 using TSAcceptor         = struct tsapi_net_accept *;
 using TSRemapPluginInfo  = struct tsapi_remap_plugin_info *;
+using TSStrategy         = struct tsapi_strategy *;
 
 using TSFetchSM = struct tsapi_fetchsm *;
 
diff --git a/include/ts/ts.h b/include/ts/ts.h
@@ -1590,7 +1590,7 @@ char *TSHttpTxnErrorBodyGet(TSHttpTxn txnp, size_t *buflength, char **mimetype);
     @param name of the strategy to look up.
 
  */
-void const *TSHttpTxnNextHopStrategyFind(TSHttpTxn txnp, const char *name);
+TSStrategy TSHttpTxnNextHopStrategyFind(TSHttpTxn txnp, const char *name);
 
 /**
     Sets the Transaction's Next Hop Parent Strategy.
@@ -1602,7 +1602,7 @@ void const *TSHttpTxnNextHopStrategyFind(TSHttpTxn txnp, const char *name);
     @param pointer to the given strategy.
 
  */
-void TSHttpTxnNextHopStrategySet(TSHttpTxn txnp, void const *strategy);
+void TSHttpTxnNextHopStrategySet(TSHttpTxn txnp, TSStrategy strategy);
 
 /**
     Retrieves a pointer to the current next hop selection strategy.
@@ -1613,7 +1613,7 @@ void TSHttpTxnNextHopStrategySet(TSHttpTxn txnp, void const *strategy);
     @param txnp HTTP transaction whose next hop strategy to get.
 
  */
-void const *TSHttpTxnNextHopStrategyGet(TSHttpTxn txnp);
+TSStrategy TSHttpTxnNextHopStrategyGet(TSHttpTxn txnp);
 
 /**
     Returns either null pointer or null terminated pointer to name.
@@ -1626,7 +1626,7 @@ void const *TSHttpTxnNextHopStrategyGet(TSHttpTxn txnp);
     @param pointer to the NextHopStrategy.
 
  */
-char const *TSNextHopStrategyNameGet(void const *strategy);
+char const *TSNextHopStrategyNameGet(TSStrategy strategy);
 
 /**
     Retrieves a pointer to the named strategy in the strategy table.
@@ -1639,7 +1639,7 @@ char const *TSNextHopStrategyNameGet(void const *strategy);
     @param name of the strategy to look up.
 
  */
-void const *TSRemapNextHopStrategyFind(const char *name);
+TSStrategy TSRemapNextHopStrategyFind(const char *name);
 
 /**
     Retrieves a pointer to remap rule strategy pointer.
@@ -1649,7 +1649,7 @@ void const *TSRemapNextHopStrategyFind(const char *name);
     Returns nullptr if no strategy assigned.
 
  */
-void const *TSRemapNextHopStrategyGet();
+TSStrategy TSRemapNextHopStrategyGet();
 
 /**
     Sets the remap rule's next hop strategy.
@@ -1661,7 +1661,7 @@ void const *TSRemapNextHopStrategyGet();
     @param handle to the strategy to set.
 
  */
-void TSRemapNextHopStrategySet(void const *strategy);
+void TSRemapNextHopStrategySet(TSStrategy strategy);
 
 /**
     Sets the parent proxy name and port. The string hostname is copied
diff --git a/plugins/header_rewrite/conditions.cc b/plugins/header_rewrite/conditions.cc
@@ -1539,7 +1539,7 @@ ConditionNextHop::append_value(std::string &s, const Resources &res)
     s.append(std::to_string(port));
   } break;
   case NEXT_HOP_STRATEGY: {
-    void const *const strategy = TSHttpTxnNextHopStrategyGet(res.state.txnp);
+    TSStrategy const strategy = TSHttpTxnNextHopStrategyGet(res.state.txnp);
     if (nullptr != strategy) {
       char const *const name = TSNextHopStrategyNameGet(strategy);
       Dbg(pi_dbg_ctl, "Appending '%s' to evaluation value", name);
diff --git a/plugins/header_rewrite/operators.h b/plugins/header_rewrite/operators.h
@@ -677,7 +677,7 @@ class OperatorSetNextHopStrategy : public Operator
 private:
   bool        _apply = true;
   std::string _stratname;
-  void const *_strategy = nullptr;
+  TSStrategy  _strategy = nullptr;
 };
 
 ///////////////////////////////////////////////////////////////////////////////
diff --git a/plugins/lua/ts_lua_http.cc b/plugins/lua/ts_lua_http.cc
@@ -535,7 +535,7 @@ ts_lua_http_get_next_hop_strategy(lua_State *L)
 
   GET_HTTP_CONTEXT(http_ctx, L);
 
-  void const *const stratptr = TSHttpTxnNextHopStrategyGet(http_ctx->txnp);
+  TSStrategy const stratptr = TSHttpTxnNextHopStrategyGet(http_ctx->txnp);
   if (nullptr != stratptr) {
     name = TSNextHopStrategyNameGet(stratptr);
   }
@@ -569,7 +569,7 @@ ts_lua_http_set_next_hop_strategy(lua_State *L)
       Dbg(dbg_ctl, "Clearning strategy (use parent.config)");
       TSHttpTxnNextHopStrategySet(http_ctx->txnp, nullptr);
     } else {
-      void const *const stratptr = TSHttpTxnNextHopStrategyFind(http_ctx->txnp, name);
+      TSStrategy const stratptr = TSHttpTxnNextHopStrategyFind(http_ctx->txnp, name);
       if (nullptr == stratptr) {
         TSError("[ts_lua][%s] Failed get next hop strategy name '%s'", __FUNCTION__, name);
       } else {
diff --git a/plugins/regex_remap/regex_remap.cc b/plugins/regex_remap/regex_remap.cc
@@ -236,7 +236,7 @@ class RemapRegex
   {
     return _strategy_name;
   }
-  inline void const *
+  inline TSStrategy
   strategy_option() const
   {
     return _strategy;
@@ -280,7 +280,7 @@ class RemapRegex
 
   bool        _has_strategy  = false;
   std::string _strategy_name = {};
-  void const *_strategy      = nullptr;
+  TSStrategy  _strategy      = nullptr;
 
   Override *_first_override = nullptr;
   int       _sub_pos[MAX_SUBS];
diff --git a/src/api/InkAPI.cc b/src/api/InkAPI.cc
@@ -4991,17 +4991,17 @@ TSHttpTxnServerRequestBodySet(TSHttpTxn txnp, char *buf, int64_t buflength)
   s->internal_msg_buffer_fast_allocator_size = -1;
 }
 
-void const *
+TSStrategy
 TSHttpTxnNextHopStrategyGet(TSHttpTxn txnp)
 {
   sdk_assert(sdk_sanity_check_txn(txnp) == TS_SUCCESS);
 
   auto sm = reinterpret_cast<HttpSM const *>(txnp);
 
-  return static_cast<void *>(sm->t_state.next_hop_strategy);
+  return reinterpret_cast<TSStrategy>(sm->t_state.next_hop_strategy);
 }
 
-void const *
+TSStrategy
 TSHttpTxnNextHopStrategyFind(TSHttpTxn txnp, const char *name)
 {
   sdk_assert(sdk_sanity_check_txn(txnp) == TS_SUCCESS);
@@ -5014,67 +5014,65 @@ TSHttpTxnNextHopStrategyFind(TSHttpTxn txnp, const char *name)
 
   // HttpSM has a reference count handle to UrlRewrite which has a
   // pointer to NextHopStrategyFactory
-  NextHopSelectionStrategy const *const strategy = sm->m_remap->strategyFactory->strategyInstance(name);
+  NextHopSelectionStrategy *const strategy = sm->m_remap->strategyFactory->strategyInstance(name);
 
-  return static_cast<void const *>(strategy);
+  return reinterpret_cast<TSStrategy>(strategy);
 }
 
 void
-TSHttpTxnNextHopStrategySet(TSHttpTxn txnp, void const *stratptr)
+TSHttpTxnNextHopStrategySet(TSHttpTxn txnp, TSStrategy stratptr)
 {
   sdk_assert(sdk_sanity_check_txn(txnp) == TS_SUCCESS);
   // null strategy falls back to parent.config
   // sdk_assert(sdk_sanity_check_null_ptr(stratptr) == TS_SUCCESS);
 
   auto sm                       = reinterpret_cast<HttpSM *>(txnp);
-  auto strategy                 = reinterpret_cast<NextHopSelectionStrategy const *>(stratptr);
-  sm->t_state.next_hop_strategy = const_cast<NextHopSelectionStrategy *>(strategy);
+  sm->t_state.next_hop_strategy = reinterpret_cast<NextHopSelectionStrategy *>(stratptr);
 }
 
-void const *
+TSStrategy
 TSRemapNextHopStrategyFind(const char *name)
 {
   auto const um = url_mapping::instance;
   sdk_assert(sdk_sanity_check_null_ptr((void *)um) == TS_SUCCESS);
 
-  NextHopSelectionStrategy const *strategy = nullptr;
+  NextHopSelectionStrategy *strategy = nullptr;
 
   if (nullptr != um->strategyFactory) {
     // HttpSM has a reference count handle to UrlRewrite which manages
     // the NextHopStrategyFactory pointer.
     strategy = um->strategyFactory->strategyInstance(name);
   }
 
-  return static_cast<void const *>(strategy);
+  return reinterpret_cast<TSStrategy>(strategy);
 }
 
 void
-TSRemapNextHopStrategySet(void const *stratptr)
+TSRemapNextHopStrategySet(TSStrategy strategy)
 {
   auto const um = url_mapping::instance;
   sdk_assert(sdk_sanity_check_null_ptr((void *)um) == TS_SUCCESS);
   // null strategy falls back to parent.config
   // sdk_assert(sdk_sanity_check_null_ptr(stratptr) == TS_SUCCESS);
 
-  auto strategy = reinterpret_cast<NextHopSelectionStrategy const *>(stratptr);
-  um->strategy  = const_cast<NextHopSelectionStrategy *>(strategy);
+  um->strategy = reinterpret_cast<NextHopSelectionStrategy *>(strategy);
 }
 
-void const *
+TSStrategy
 TSRemapNextHopStrategyGet()
 {
   auto const um = url_mapping::instance;
   sdk_assert(sdk_sanity_check_null_ptr((void *)um) == TS_SUCCESS);
-
-  return static_cast<void *>(um->strategy);
+  return reinterpret_cast<TSStrategy>(um->strategy);
 }
 
 char const *
-TSNextHopStrategyNameGet(void const *stratptr)
+TSNextHopStrategyNameGet(TSStrategy stratptr)
 {
-  char const *name = nullptr;
+  static char const *const nullname = "null";
+  char const              *name     = nullname;
   if (nullptr != stratptr) {
-    auto strategy = reinterpret_cast<NextHopSelectionStrategy const *>(stratptr);
+    auto strategy = reinterpret_cast<NextHopSelectionStrategy *>(stratptr);
     name          = strategy->strategy_name.c_str();
   }
 
diff --git a/src/api/InkAPITest.cc b/src/api/InkAPITest.cc
@@ -3511,7 +3511,7 @@ mytest_handler(TSCont contp, TSEvent event, void *data)
 
     // Set the strategy pointer here
     // this is an invalid pointer but the contents don't matter for this test.
-    TSHttpTxnNextHopStrategySet(static_cast<TSHttpTxn>(data), (void *)0x01);
+    TSHttpTxnNextHopStrategySet(static_cast<TSHttpTxn>(data), (TSStrategy)0x01);
 
     checkHttpTxnClientReqGet(test, data);
 
