doc/developer-guide/plugins/getting-started/plugin-registration-and-version-checking.en.rst

.. Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
   distributed with this work for additional information
   regarding copyright ownership.  The ASF licenses this file
   to you under the Apache License, Version 2.0 (the
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing,
   software distributed under the License is distributed on an
   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   KIND, either express or implied.  See the License for the
   specific language governing permissions and limitations
   under the License.

.. include:: ../../../common.defs

.. _developer-plugins-getting-started-registration:

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:

-  :c:func:`TSPluginRegister`
-  :c:func:`TSTrafficServerVersionGet`

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

.. literalinclude:: ../../../../example/plugins/c-api/version/version.c
  :language: c
  :lines: 23-