You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by bu...@apache.org on 2011/03/09 02:54:42 UTC
svn commit: r786717 [2/2] - in
/websites/staging/trafficserver/trunk/content/docs/trunk:
admin/configuring-traffic-server/ admin/security-options/ sdk/
sdk/actions-guide/ sdk/adding-statistics/ sdk/cache-plugin/
sdk/continuations/ sdk/getting-started/ ...
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/http-transformation-plugin/sample-null-transformation-plugin.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/http-transformation-plugin/sample-null-transformation-plugin.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/http-transformation-plugin/sample-null-transformation-plugin.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="append-transform-plugin.en.html">Next</a></span>
+
+ <span class="nav"><a href="index.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../http-transformation-plugin">Prev</a> - HTTP Transformation Plugins</p>
-<p>The Append-Transform Plugin - <a href="append-transform-plugin">Next</a></p>
-<h2 id="SampleNullTransformPlugin">The Sample Null Transform Plugin</h2>
+ <h2 id="SampleNullTransformPlugin">The Sample Null Transform Plugin</h2>
<p>This section provides a step-by-step description of what the null transform
plugin does, along with sections of code that apply. For context, you can find
each code snippet in the complete source code. Some of the error checking details
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/index.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,19 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="index.en.html">Top</a></span>
+
+ <span class="nav"><a href="preface/how-to-use-this-book.en.html">Next</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p>Preface - <a href="preface">Next</a></p>
-<h1 id="apache_traffic_server+_software_developers_kit">Apache Traffic Server⢠Software Developers Kit</h1>
-<h2 id="programmers_guide">Programmers Guide</h2>
+ <h2 id="programmers_guide">Programmers Guide</h2>
<p><em>In progress</em></p>
<p><strong>Abstract</strong></p>
<p>The <em>Traffic Server Software Developers Kit</em> shows you how to create plugins
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/errors.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/errors.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/errors.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="example.en.html">Next</a></span>
+
+ <span class="nav"><a href="how-to-do-a-cache-remove.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="how-to-do-a-cache-remove">Prev</a> - How to Do a Cache Remove</p>
-<p>Example - <a href="example">Next</a></p>
-<h3 id="Errors">Errors</h3>
+ <h3 id="Errors">Errors</h3>
<p>Errors pertaining to the failure of various cache operations are indicated
by <code>TSCacheError</code> (enumeration). They are as follows:</p>
<ul>
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/example.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/example.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/example.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,19 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="errors.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="errors">Prev</a> - Errors</p>
-<p>Chapter 16. Plugin Management - <a href="../../plugin-management">Next</a></p>
-<h3 id="Example">Example</h3>
+ <h3 id="Example">Example</h3>
<p>In the example below, suppose there is a cache hit and the cache returns a
vconnection that enables you to read the document from cache. To do this, you
need to prepare a buffer (<code>cache_bufp</code>) to hold the document; meanwhile, use
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/how-to-do-a-cache-remove.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/how-to-do-a-cache-remove.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/how-to-do-a-cache-remove.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="errors.en.html">Next</a></span>
+
+ <span class="nav"><a href="how-to-do-a-cache-write.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="how-to-do-a-cache-write">Prev</a> - How to Do a Cache Write</p>
-<p>Errors - <a href="errors">Next</a></p>
-<h3 id="HowDoaCacheRemove">How to Do a Cache Remove</h3>
+ <h3 id="HowDoaCacheRemove">How to Do a Cache Remove</h3>
<p>Use <code>TSCacheRemove</code> to remove items from the cache. Possible callback events
include:</p>
<ul>
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/how-to-do-a-cache-write.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/how-to-do-a-cache-write.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/how-to-do-a-cache-write.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="how-to-do-a-cache-remove.en.html">Next</a></span>
+
+ <span class="nav"><a href="index.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../guide-to-cache-api">Prev</a> - Guide to the Cache API</p>
-<p>How to Do a Cache Remove - <a href="how-to-do-a-cache-remove">Next</a></p>
-<h3 id="HowDoaCacheWrite">How to Do a Cache Write</h3>
+ <h3 id="HowDoaCacheWrite">How to Do a Cache Write</h3>
<p>Use <code>TSCacheWrite</code> to write to a cache (see the <a href="../../new-protocol-plugins#AboutSampleProtocol">sample Protocol plugin</a>).
Possible callback events include:</p>
<ul>
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/index.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,19 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="how-to-do-a-cache-write.en.html">Next</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../io-buffers">Prev</a> - IO Buffers</p>
-<p>How to Do a Cache Write - <a href="how-to-do-a-cache-write">Next</a></p>
-<h2 id="GuideCacheAPI">Guide to the Cache API</h2>
+ <h2 id="GuideCacheAPI">Guide to the Cache API</h2>
<p>The cache API enables plugins to read, write, and remove objects in the Traffic
Server cache. All cache APIs are keyed by an object called an <code>TSCacheKey</code>;
cache keys are created via <code>TSCacheKeyCreate</code>; keys are destroyed via <code>TSCacheKeyDestroy</code>.
Added: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/order.txt
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/order.txt (added)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/guide-to-cache-api/order.txt Wed Mar 9 01:54:40 2011
@@ -0,0 +1,5 @@
+index
+how-to-do-a-cache-write
+how-to-do-a-cache-remove
+errors
+example
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/index.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,19 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="net-vconnections.en.html">Next</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../actions-guide/hosts-lookup-api">Prev</a> - Hosts Lookup API</p>
-<p>Net Vconnections - <a href="net-vconnections">Next</a></p>
-<h2 id="IOGuide">IO Guide</h2>
+ <h2 id="IOGuide">IO Guide</h2>
<p>This chapter contains the following sections:</p>
<ul>
<li><a href="#Vconnections">Vconnections</a></li>
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/io-buffers.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/io-buffers.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/io-buffers.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="guide-to-cache-api/errors.en.html">Next</a></span>
+
+ <span class="nav"><a href="vios.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="vios">Prev</a> - VIOs</p>
-<p>Guide to the Cache API - <a href="guide-to-cache-api">Next</a></p>
-<h2 id="IOBuffers">IO Buffers</h2>
+ <h2 id="IOBuffers">IO Buffers</h2>
<p>The IO buffer data structure is the building block of the vconnection abstraction.
An <strong>IO buffer</strong> (<code>TSIOBuffer</code>) is composed of a list of buffer blocks that
point to buffer data. Both the buffer block (<code>TSIOBufferBlock</code>) and buffer
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/net-vconnections.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/net-vconnections.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/net-vconnections.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="transformations.en.html">Next</a></span>
+
+ <span class="nav"><a href="index.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../io-guide">Prev</a> - IO Guide</p>
-<p>Transformations - <a href="transformations">Next</a></p>
-<h2 id="NetVconnections">Net Vconnections</h2>
+ <h2 id="NetVconnections">Net Vconnections</h2>
<p>A <strong>network</strong> <strong>vconnection</strong> (or<strong> netvconnection</strong>) is a wrapper around a
TCP socket that enables the socket to work within the Traffic Server vconnection
framework. See <a href="IOGuide.html#Vconnections">vconnections</a> for more information
Added: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/order.txt
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/order.txt (added)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/order.txt Wed Mar 9 01:54:40 2011
@@ -0,0 +1,6 @@
+index
+net-vconnections
+transformations
+vios
+io-buffers
+guide-to-cache-api
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/transformations.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/transformations.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/transformations.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="vios.en.html">Next</a></span>
+
+ <span class="nav"><a href="net-vconnections.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="net-vconnections">Prev</a> - Net Vconnections</p>
-<p>VIOs - <a href="vios">Next</a></p>
-<h2 id="Transformations">Transformations</h2>
+ <h2 id="Transformations">Transformations</h2>
<h3 id="VconnectionImplementorsView">The Vconnection Implementor's View</h3>
<p>A VConnection implementor writes only transformations. All other VConnections
(net VConnections and cache VConnections) are implemented in iocore. As mentioned
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/vios.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/vios.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/io-guide/vios.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="io-buffers.en.html">Next</a></span>
+
+ <span class="nav"><a href="transformations.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="transformations">Prev</a> - Transformations</p>
-<p>IO Buffers - <a href="io-buffers">Next</a></p>
-<h2 id="VIOs">VIOs</h2>
+ <h2 id="VIOs">VIOs</h2>
<p>A <strong>VIO</strong>, or <strong>virtual IO</strong>, is a description of an IO operation that's currently
in progress. The VIO data structure is used by vconnection users to determine
how much progress has been made on a particular IO operation and to re-enable
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/misc-interface-guide/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/misc-interface-guide/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/misc-interface-guide/index.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,19 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="tsfopen-family.en.html">Next</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="HTTPAlternateSelection.html">Prev</a> - HTTP Alternate Selection</p>
-<p>The TSfopen Family - <a href="TSfopenFamily.html">Next</a></p>
-<h2 id="MiscellaneousInterfaceGuide">Miscellaneous Interface Guide</h2>
+ <h2 id="MiscellaneousInterfaceGuide">Miscellaneous Interface Guide</h2>
<p>Most of the functions in the Traffic Server API provide an interface to specific
code modules within Traffic Server. The miscellaneous functions described in
this chapter provide some useful general capabilities. They are categorized
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/misc-interface-guide/memory-allocation.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/misc-interface-guide/memory-allocation.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/misc-interface-guide/memory-allocation.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="thread-functions.en.html">Next</a></span>
+
+ <span class="nav"><a href="tsfopen-family.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="tsfopen-family">Prev</a> - The TSfopen Family</p>
-<p>Thread Functions - <a href="thread-functions">Next</a></p>
-<h2 id="MemoryAllocation">Memory Allocation</h2>
+ <h2 id="MemoryAllocation">Memory Allocation</h2>
<p>Traffic Server provides five routines for allocating and freeing memory. These
routines correspond to similar routines in the C library. For example, <code>TSrealloc</code>
behaves like the C library routine <code>realloc</code>.</p>
Added: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/misc-interface-guide/order.txt
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/misc-interface-guide/order.txt (added)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/misc-interface-guide/order.txt Wed Mar 9 01:54:40 2011
@@ -0,0 +1,4 @@
+index
+tsfopen-family
+memory-allocation
+thread-functions
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/misc-interface-guide/thread-functions.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/misc-interface-guide/thread-functions.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/misc-interface-guide/thread-functions.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,19 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="memory-allocation.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="memory-allocation">Prev</a> - Memory Allocation</p>
-<p>Chapter 10. HTTP Headers - <a href="../http-headers">Next</a></p>
-<h2 id="ThreadFunctions">Thread Functions</h2>
+ <h2 id="ThreadFunctions">Thread Functions</h2>
<p>The Traffic Server API thread functions enable you to create, destroy, and
identify threads within Traffic Server. Multithreading enables a single program
to have more than one stream of execution and to process more than one transaction
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/misc-interface-guide/tsfopen-family.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/misc-interface-guide/tsfopen-family.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/misc-interface-guide/tsfopen-family.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="memory-allocation.en.html">Next</a></span>
+
+ <span class="nav"><a href="index.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../misc-interface-guide">Prev</a> - iscellaneous Interface Guide</p>
-<p>Memory Allocation - <a href="memory-allocation">Next</a></p>
-<h2 id="TSfopenFamily">The TSfopen Family</h2>
+ <h2 id="TSfopenFamily">The TSfopen Family</h2>
<p>The <code>fopen</code> family of functions in C is normally used for reading configuration
files, since <code>fgets</code> is an easy way to parse files on a line-by-line basis.
The <code>TSfopen</code> family of functions aims at solving the same problem of buffered
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/mutex-guide/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/mutex-guide/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/mutex-guide/index.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="../continuations/how-to-activate-continuations.en.html">Next</a></span>
+
+ <span class="nav"><a href="../http-headers/http-headers.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../http-headers/mime-headers">Prev</a> - MIME Headers</p>
-<p>Continuations - <a href="continuations">Next</a></p>
-<h2 id="MutexGuide">Mutex Guide</h2>
+ <h2 id="MutexGuide">Mutex Guide</h2>
<p>Mutexes are used to lock shared data. This chapter explains how to use the
mutex interface.</p>
<div class="toc">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/new-protocol-plugins/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/new-protocol-plugins/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/new-protocol-plugins/index.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="../cache-plugin/cache-events.en.html">Next</a></span>
+
+ <span class="nav"><a href="../http-transformation-plugin/append-transform-plugin.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../http-transformation-plugin/sample-buffered-null-transformation-plugin">Prev</a> - The Sample Buffered Null Transform Plugin</p>
-<p>Cache Plugin - <a href="../cache-plugin">Next</a></p>
-<h2 id="NewProtocolPlugins">New Protocol Plugins</h2>
+ <h2 id="NewProtocolPlugins">New Protocol Plugins</h2>
<div class="toc">
<ul>
<li><a href="#NewProtocolPlugins">New Protocol Plugins</a><ul>
@@ -53,7 +61,7 @@ a sample Protocol plugin that supports a
<p>The sample protocol enables a client to ask a server for a file. Clients send
requests to a specific Traffic Server port (specified in <code>plugin.config</code>);
each request has the following structure:</p>
-<div class="codehilite"><pre><span class="n">server_name</span> <span class="n">file_name</span><span class="o">\</span><span class="n">n</span><span class="o">\</span><span class="n">n</span>
+<div class="codehilite"><pre><span class="n">server_name</span> <span class="n">file_name</span>
</pre></div>
Added: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/order.txt
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/order.txt (added)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/order.txt Wed Mar 9 01:54:40 2011
@@ -0,0 +1,21 @@
+index
+preface
+getting-started
+how-to-create-trafficserver-plugins
+remap-plugin
+header-based-plugin-examples
+http-transformation-plugin
+new-protocol-plugins
+cache-plugin
+http-hooks-and-transactions
+misc-interface-guide
+http-headers
+mutex-guide
+continuations
+plugin-configurations
+actions-guide
+io-guide
+plugin-management
+adding-statistics
+sample-source-code
+troubleshooting-tips
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/plugin-configurations/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/plugin-configurations/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/plugin-configurations/index.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="../actions-guide/hosts-lookup-api.en.html">Next</a></span>
+
+ <span class="nav"><a href="../continuations/how-to-activate-continuations.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../continuations/writing-handler-functions">Prev</a> - Writing Handler Functions</p>
-<p>Actions Guide - <a href="../actions-guide">Next</a></p>
-<h2 id="PluginConfigurations">Plugin Configurations</h2>
+ <h2 id="PluginConfigurations">Plugin Configurations</h2>
<p>This chapter contains the following section:</p>
<ul>
<li><a href="#PluginConfigurations">Plugin Configurations</a></li>
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/plugin-management/guide-to-the-logging-api.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/plugin-management/guide-to-the-logging-api.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/plugin-management/guide-to-the-logging-api.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,19 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="reading-trafficserver-settings-and-statistics.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="reading-trafficserver-settings-and-statistics">Prev</a> - Reading Traffic Server Settings and Statistics</p>
-<p>Adding Statistics - <a href="../adding-statistics">Next</a></p>
-<h2 id="GuideLoggingAPI">Guide to the Logging API</h2>
+ <h2 id="GuideLoggingAPI">Guide to the Logging API</h2>
<p>The logging API enables your plugin to log entries in a custom text log file
that you create with the call <code>TSTextLogObjectCreate</code>. This log file is part
of Traffic Server's logging system; by default, it is stored in the logging
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/plugin-management/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/plugin-management/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/plugin-management/index.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,19 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="reading-trafficserver-settings-and-statistics.en.html">Next</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../io-guide/guide-to-cache-api/example">Prev</a> - Example</p>
-<p>Reading Traffic Server Settings and Statistics - <a href="reading-trafficserver-settings-and-statistics">Next</a></p>
-<h2 id="PluginManagement">Plugin Management</h2>
+ <h2 id="PluginManagement">Plugin Management</h2>
<p>This chapter covers the following topics:</p>
<ul>
<li>
Added: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/plugin-management/order.txt
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/plugin-management/order.txt (added)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/plugin-management/order.txt Wed Mar 9 01:54:40 2011
@@ -0,0 +1,3 @@
+index
+reading-trafficserver-settings-and-statistics
+guide-to-the-logging-api
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/plugin-management/reading-trafficserver-settings-and-statistics.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/plugin-management/reading-trafficserver-settings-and-statistics.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/plugin-management/reading-trafficserver-settings-and-statistics.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="guide-to-the-logging-api.en.html">Next</a></span>
+
+ <span class="nav"><a href="index.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="PluginManagement.html">Prev</a> - Plugin Management</p>
-<p>Guide to the Logging API - <a href="guide-to-the-logging-api">Next</a></p>
-<h2 id="ReadingTSSettingsStatistics">Reading Traffic Server Settings and Statistics</h2>
+ <h2 id="ReadingTSSettingsStatistics">Reading Traffic Server Settings and Statistics</h2>
<p>Your plugin might need to know information about Traffic Server's current configuration
and performance. The functions described in this section read this information
from the Traffic Server <code>records.config</code> file. Configuration settings are stored
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/preface/how-to-use-this-book.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/preface/how-to-use-this-book.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/preface/how-to-use-this-book.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="typographical-conventions.en.html">Next</a></span>
+
+ <span class="nav"><a href="index.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../preface">Prev</a> - Preface</p>
-<p>Typographical Conventions - <a href="typographical-conventions">Next</a></p>
-<h2 id="how_to_use_this_book">How to Use This Book</h2>
+ <h2 id="HowUseBook">How to Use This Book</h2>
<p>This book has the following basic components:</p>
<ul>
<li>
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/preface/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/preface/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/preface/index.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,19 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="how-to-use-this-book.en.html">Next</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="..">Prev</a> - Traffic Server Software Developers Kit</p>
-<p>How to Use This Book - <a href="how-to-use-this-book">Next</a></p>
-<h2 id="preface">Preface</h2>
+ <h2 id="Preface">Preface</h2>
<p><strong>Table of Contents</strong></p>
<p><a href="how-to-use-this-book">How to Use This Book</a>
<a href="typographical-conventions">Typographical Conventions</a></p>
Added: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/preface/order.txt
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/preface/order.txt (added)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/preface/order.txt Wed Mar 9 01:54:40 2011
@@ -0,0 +1,3 @@
+index
+how-to-use-this-book
+typographical-conventions
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/preface/typographical-conventions.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/preface/typographical-conventions.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/preface/typographical-conventions.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,19 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="how-to-use-this-book.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="how-to-use-this-book">Prev</a> - How to Use This Book</p>
-<p>Getting Started - <a href="../getting-started">Next</a></p>
-<h2 id="typographical_conventions">Typographical Conventions</h2>
+ <h2 id="TypographicalConventions">Typographical Conventions</h2>
<p>This document uses the following typographic conventions:</p>
<dl>
<dt>_italics _ or <strong> bold</strong></dt>
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/remap-plugin/example-query-remap.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/remap-plugin/example-query-remap.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/remap-plugin/example-query-remap.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,19 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="index.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../remap-plugin">Prev</a> - Remap Plugin: Getting Started</p>
-<p>Header-Based Plugin Examples <a href="../header-based-plugin-examples">Next</a></p>
-<h2 id="ExampleQueryRemapPlugin">Example: Query Remap Plugin</h2>
+ <h2 id="ExampleQueryRemapPlugin">Example: Query Remap Plugin</h2>
<p>The sample remap plugin, <code>query_remap.c</code>, maps client requests to a number
of servers based on a hash of the request's URL query parameter. This can be
useful for spreading load for a given type of request among backend servers,
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/remap-plugin/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/remap-plugin/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/remap-plugin/index.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,19 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="example-query-remap.en.html">Next</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../how-to-create-trafficserver-plugins/roadmap-for-creating-plugins">Prev</a> - Roadmap for Creating Plugins</p>
-<p>Example: Query Remap Plugin - <a href="example-query-remap">Next</a></p>
-<h2 id="RemapPlugin">Remap Plugin</h2>
+ <h2 id="RemapPlugin">Remap Plugin</h2>
<div class="toc">
<ul>
<li><a href="#RemapPlugin">Remap Plugin</a><ul>
Added: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/remap-plugin/order.txt
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/remap-plugin/order.txt (added)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/remap-plugin/order.txt Wed Mar 9 01:54:40 2011
@@ -0,0 +1,2 @@
+index
+example-query-remap
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/sample-source-code/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/sample-source-code/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/sample-source-code/index.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="../troubleshooting-tips/debugging-memory-leaks.en.html">Next</a></span>
+
+ <span class="nav"><a href="../adding-statistics/coupled-statistics.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../adding-statistics">Prev</a> - Adding Statistics</p>
-<p>Troubleshooting Tips - <a href="../troubleshooting-tips">Next</a></p>
-<h2 id="SampleSourceCode">Sample Source Code</h2>
+ <h2 id="SampleSourceCode">Sample Source Code</h2>
<p>This appendix provides several source code examples. In the online formats
of this book, function calls are linked to their references in the previous
chapters. The following sample plugins are provided:</p>
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/debugging-memory-leaks.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/debugging-memory-leaks.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/debugging-memory-leaks.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,19 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="using-a-debugger.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="using-a-debugger">Prev</a> - Using a Debugger</p>
-<h2 id="DebuggingMemoryLeaks">Debugging Memory Leaks</h2>
-<p>Memory leaks in a plugin can be detected using e.g. an MRTG graph related to
+ <p>Memory leaks in a plugin can be detected using e.g. an MRTG graph related to
memory - you can use memory dump information.
Enable <code>mem dump</code> in <code>records.config</code> as follows:</p>
<div class="codehilite"><pre> CONFIG proxy.config.dump_mem_info_frequency INT <value>
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/index.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,19 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="unable-to-load-plugins.en.html">Next</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../sample-source-code">Prev</a> - Sample Source Code</p>
-<p>Unable to Load Plugins - <a href="unable-to-load-plugins">Next</a></p>
-<h2 id="TroubleshootingTips">Troubleshooting Tips</h2>
+ <h2 id="TroubleshootingTips">Troubleshooting Tips</h2>
<p>This appendix lists the following troubleshooting tips.</p>
<ul>
<li>
Added: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/order.txt
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/order.txt (added)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/order.txt Wed Mar 9 01:54:40 2011
@@ -0,0 +1,5 @@
+index
+unable-to-load-plugins
+unable-to-debug-tags
+using-a-debugger
+debugging-memory-leaks
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/unable-to-debug-tags.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/unable-to-debug-tags.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/unable-to-debug-tags.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="using-a-debugger.en.html">Next</a></span>
+
+ <span class="nav"><a href="unable-to-load-plugins.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="unable-to-load-plugins">Prev</a> - Unable to Load Plugins</p>
-<p>Using a Debugger - <a href="using-a-debugger">Next</a></p>
-<h2 id="UsingDebugTags">Using Debug Tags</h2>
+ <h2 id="UsingDebugTags">Using Debug Tags</h2>
<p>Use the API <code>void TSDebug (const char *tag, const char *format_str, ...)</code>
to add traces in your plugin. In this API:</p>
<ul>
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/unable-to-load-plugins.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/unable-to-load-plugins.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/unable-to-load-plugins.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="unable-to-debug-tags.en.html">Next</a></span>
+
+ <span class="nav"><a href="index.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="../troubleshooting-tips">Prev</a> - Troubleshooting Tips</p>
-<p>Using Debug Tags - <a href="unable-to-debug-tags">Next</a></p>
-<h2 id="UnableLoadPlugins">Unable to Load Plugins</h2>
+ <h2 id="UnableLoadPlugins">Unable to Load Plugins</h2>
<p>To load plugins, follow the steps below.</p>
<ol>
<li>
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/using-a-debugger.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/using-a-debugger.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/troubleshooting-tips/using-a-debugger.en.html Wed Mar 9 01:54:40 2011
@@ -23,13 +23,21 @@
</tr></table>
</div><!-- header -->
+ <div class="nav">
+
+ <span class="nav"><a href="../index.en.html">Top</a></span>
+
+ <span class="nav"><a href="debugging-memory-leaks.en.html">Next</a></span>
+
+ <span class="nav"><a href="unable-to-debug-tags.en.html">Back</a></span>
+
+ </div>
+
<div class="main">
<div id="content">
- <p><a href="unable-to-debug-tags">Prev</a> - Using Debug Tags</p>
-<p>Debugging Memory Leaks - <a href="debugging-memory-leaks">Next</a></p>
-<h2 id="UsingaDebugger">Using a Debugger</h2>
+ <h2 id="UsingaDebugger">Using a Debugger</h2>
<p>A debugger can set breakpoints in a plugin. Use a Traffic Server debug build
and compile the plugin with the <code>-g</code> option. A debugger can also be used to
analyze a core dump. To generate core, set the size limit of the core files