Plugin Registration and Version Checking

If you need you make a plugin that will load against multiple versions of Traffic Server, you can check the API version at both compilation time and run time.

Use the following interfaces:

The plugin registers the plugin and ensures it’s running with a compatible version of Traffic Server.

  2. #include <stdio.h>
  3. #include <ts/ts.h>
  5. #define PLUGIN_NAME "version"
  7. void
  8. TSPluginInit(int argc, const char *argv[])
  9. {
  10.   (void)argc; // unused
  11.   (void)argv; // unused
  13.   // Get the version:
  14.   const char *ts_version = TSTrafficServerVersionGet();
  15.   if (!ts_version) {
  16.     TSError("[%s] Can't get Traffic Server version.", PLUGIN_NAME);
  17.     return;
  18.   }
  20.   // Split it in major, minor, patch:
  21.   int major_ts_version = 0;
  22.   int minor_ts_version = 0;
  23.   int patch_ts_version = 0;
  25.   if (sscanf(ts_version, "%d.%d.%d", &major_ts_version, &minor_ts_version, &patch_ts_version) != 3) {
  26.     TSError("[%s] Can't extract versions.", PLUGIN_NAME);
  27.     return;
  28.   }
  30.   TSPluginRegistrationInfo info;
  31.   info.plugin_name   = PLUGIN_NAME;
  32.   info.vendor_name   = "Apache Software Foundation";
  33.   info.support_email = "dev@trafficserver.apache.org";
  35. // partial compilation
  36. #if (TS_VERSION_NUMBER < 3000000)
  37.   if (TSPluginRegister(TS_SDK_VERSION_2_0, &info) != TS_SUCCESS) {
  38. #elif (TS_VERSION_NUMBER < 6000000)
  39.   if (TSPluginRegister(TS_SDK_VERSION_3_0, &info) != TS_SUCCESS) {
  40. #else
  41.   if (TSPluginRegister(&info) != TS_SUCCESS) {
  42. #endif
  43.     TSError("[%s] Plugin registration failed.", PLUGIN_NAME);
  44.   }
  46.   TSDebug(PLUGIN_NAME, "Running in Apache Traffic Server: v%d.%d.%d", major_ts_version, minor_ts_version, patch_ts_version);
  47. }