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. void
  6. TSPluginInit(int argc, const char *argv[])
  7. {
  8.   (void)argc; // unused
  9.   (void)argv; // unused
  11.   // Get the version:
  12.   const char *ts_version = TSTrafficServerVersionGet();
  13.   if (!ts_version) {
  14.     TSError("[version] Can't get Traffic Server verion.\n");
  15.     return;
  16.   }
  18.   // Split it in major, minor, patch:
  19.   int major_ts_version = 0;
  20.   int minor_ts_version = 0;
  21.   int patch_ts_version = 0;
  23.   if (sscanf(ts_version, "%d.%d.%d", &major_ts_version, &minor_ts_version, &patch_ts_version) != 3) {
  24.     TSError("[version] Can't extract verions.\n");
  25.     return;
  26.   }
  28.   TSPluginRegistrationInfo info;
  29.   info.plugin_name   = "version-plugin";
  30.   info.vendor_name   = "MyCompany";
  31.   info.support_email = "ts-api-support@MyCompany.com";
  33. // partial compilation
  34. #if (TS_VERSION_NUMBER < 3000000)
  35.   if (TSPluginRegister(TS_SDK_VERSION_2_0, &info) != TS_SUCCESS) {
  36. #elif (TS_VERSION_NUMBER < 6000000)
  37.   if (TSPluginRegister(TS_SDK_VERSION_3_0, &info) != TS_SUCCESS) {
  38. #else
  39.   if (TSPluginRegister(&info) != TS_SUCCESS) {
  40. #endif
  41.     TSError("[version] Plugin registration failed. \n");
  42.   }
  44.   TSDebug("debug-version-plugin", "Running in Apache Traffic Server: v%d.%d.%d", major_ts_version, minor_ts_version,
  45.           patch_ts_version);
  46. }