Programmers’ Guide

In progress

Abstract

The Traffic Server Software Developers Kit shows you how to create plugins using the Traffic Server SDK.

Introduction

This documentation is a work in progress. It was originally written for a previous, commercially-available version of Traffic Server that supported different operating systems and more functions than the current version. As a result, some of the sections may refer to functionality that no longer exists.

If you find any such issues, you may want to submit a bug or a patch. Or find out how to `find bugs <>`__, `create useful bug reports <>`__ or `patches <>`__.

Contents:

• Preface
  • How to Use This Book
  • Typographical Conventions
  • Audience
• Getting Started
  • A Simple Plugin
  • Plugin Registration and Version Checking
  • Naming Conventions
  • Understanding Traffic Server Plugins
• How to Create Traffic Server Plugins
  • Roadmap for Creating Plugins
  • The Asynchronous Event Model
• Remap Plugin
  • Example: Query Remap Plugin
  • Getting Started
• Header-Based Plugin Examples
  • The Blacklist Plugin
  • The Basic Authorization Plugin
  • Overview
• HTTP Transformation Plugins
  • The Sample Null Transform Plugin
  • The Append-Transform Plugin
  • The Sample Buffered Null Transform Plugin
  • Writing Content Transform Plugins
• New Protocol Plugins
  • About the Sample Protocol
• HTTP Hooks and Transactions
  • Adding Hooks
  • HTTP Sessions
  • HTTP Transactions
  • Intercepting HTTP Transactions
  • Initiate HTTP Connection
  • HTTP Alternate Selection
  • The Set of Hooks
  • HTTP Transaction
  • Transform hooks
  • HTTP session
  • HTTP Transaction State Diagram
• Miscellaneous Interface Guide
  • The TSfopen Family
  • Memory Allocation
  • Thread Functions
  • Debugging Functions
• HTTP Headers
  • No Null-Terminated Strings
  • Marshal Buffers
  • HTTP Headers
  • URLs
  • MIME Headers
  • About HTTP Headers
• Mutex Guide
  • Mutexes
• Continuations
  • How to Activate Continuations
  • Writing Handler Functions
  • Mutexes and Data
• Plugin Configurations
  • Plugin Configurations
• Actions Guide
  • Hosts Lookup API
  • Actions
• IO Guide
  • Net Vconnections
  • Transformations
  • VIOs
  • IO Buffers
  • Guide to the Cache API
  • Vconnections
• Plugin Management
  • Reading Traffic Server Settings and Statistics
  • Guide to the Logging API
• Adding Statistics
  • Coupled Statistics
  • Viewing Statistics Using Traffic Line
  • Uncoupled Statistics
• Sample Source Code
  • blacklist-1.c
• Troubleshooting Tips
  • Unable to Load Plugins
  • Using Debug Tags
  • Using a Debugger
  • Debugging Memory Leaks
  • Unable to Compile Plugins