You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by ml...@apache.org on 2009/11/11 00:07:52 UTC

svn commit: r834703 [3/6] - /incubator/trafficserver/site/trunk/docs/sdk/

Modified: incubator/trafficserver/site/trunk/docs/sdk/App_SampleSourceCode.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/App_SampleSourceCode.html?rev=834703&r1=834702&r2=834703&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/App_SampleSourceCode.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/App_SampleSourceCode.html Tue Nov 10 23:07:51 2009
@@ -1,44 +1,44 @@
 <html>
 <head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>Appendix A. Sample Source Code</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="prev" href="INKTextLogObjectDestroy.html" title="INKTextLogObjectDestroy">
-<link rel="next" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
-<link rel="section" href="App_SampleSourceCode.html#Sample_blacklist-1.c" title="blacklist-1.c">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="prev" href="INKTextLogObjectDestroy.html" title="INKTextLogObjectDestroy" />
+<link rel="next" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
+<link rel="section" href="App_SampleSourceCode.html#Sample_blacklist-1.c" title="blacklist-1.c" />
 <script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
     document.write("<style> div.toc {display: none} </style>"); 
   </script>
@@ -46,7 +46,7 @@
 <body>
 <div class="doctitle">
 <a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
 </div>
 <div class="navheader">
 <div class="navprev">
@@ -62,8 +62,7 @@
 <p><b>Table of Contents</b></p>
 <dl><dt><span class="section"><a href="App_SampleSourceCode.html#Sample_blacklist-1.c">blacklist-1.c</a></span></dt></dl>
 </div>
-<p>This appendix provides several source code examples. In the PDF and
-    HTML formats of this book, function calls are linked to their references
+<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>
 <div class="itemizedlist"><ul type="disc"><li><p><a href="App_SampleSourceCode.html#Sample_blacklist-1.c" title="blacklist-1.c">“blacklist-1.c”</a></p></li></ul></div>
@@ -73,8 +72,8 @@
 <p>The sample blacklisting plugin included in the Traffic Server SDK
       is <code class="filename">blacklist-1.c</code>. This plugin checks every incoming
       HTTP client request against a list of blacklisted web sites. If the
-      client requests a blacklisted site, the plugin returns an “access
-      forbidden” message to the client.</p>
+      client requests a blacklisted site, then the plugin returns an <code>Access
+      forbidden</code> message to the client.</p>
 <p>This plugin illustrates:</p>
 <div class="itemizedlist"><ul type="disc">
 <li><p>An HTTP transaction extension</p></li>
@@ -87,15 +86,9 @@
 /* blacklist-1.c:  an example program that denies client access                 
  *                 to blacklisted sites. This plugin illustrates
  *                 how to use configuration information from a 
- *                 configuration file (blacklist.txt) that can be
- *                 updated through the Traffic Manager UI.
+ *                 configuration file (blacklist.txt).
  *
- *   Copyright (c) 1999/2000 Inktomi Corporation.  All Rights Reserved. 
- *   Authorized possession and use of this software is only pursuant 
- *   to the terms of a written license agreement.
- *
- * Usage:   
- * (NT) : BlackList.dll 
+ * Usage:    
  * (Solaris) : blacklist-1.so 
  *
  *

Modified: incubator/trafficserver/site/trunk/docs/sdk/App_Troubleshooting.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/App_Troubleshooting.html?rev=834703&r1=834702&r2=834703&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/App_Troubleshooting.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/App_Troubleshooting.html Tue Nov 10 23:07:51 2009
@@ -1,48 +1,48 @@
 <html>
 <head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>Appendix C. Troubleshooting Tips</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="prev" href="Dep_MutexFunctions.html" title="Mutex Function">
-<link rel="next" href="Trouble_LoadPlugins.html" title="Unable to Load Plugins">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
-<link rel="section" href="App_Troubleshooting.html#Trouble_CompilePlugins" title="Unable to Compile Plugins">
-<link rel="section" href="Trouble_LoadPlugins.html" title="Unable to Load Plugins">
-<link rel="section" href="Trouble_DebugTags.html" title="Using Debug Tags">
-<link rel="section" href="Trouble_UsingDebugger.html" title="Using a Debugger">
-<link rel="section" href="Trouble_DebugMemLeaks.html" title="Debugging Memory Leaks">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="prev" href="Dep_MutexFunctions.html" title="Mutex Function" />
+<link rel="next" href="Trouble_LoadPlugins.html" title="Unable to Load Plugins" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
+<link rel="section" href="App_Troubleshooting.html#Trouble_CompilePlugins" title="Unable to Compile Plugins" />
+<link rel="section" href="Trouble_LoadPlugins.html" title="Unable to Load Plugins" />
+<link rel="section" href="Trouble_DebugTags.html" title="Using Debug Tags" />
+<link rel="section" href="Trouble_UsingDebugger.html" title="Using a Debugger" />
+<link rel="section" href="Trouble_DebugMemLeaks.html" title="Debugging Memory Leaks" />
 <script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
     document.write("<style> div.toc {display: none} </style>"); 
   </script>
@@ -50,7 +50,7 @@
 <body>
 <div class="doctitle">
 <a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
 </div>
 <div class="navheader">
 <div class="navprev">
@@ -69,7 +69,6 @@
 <dd><dl>
 <dt><span class="section"><a href="App_Troubleshooting.html#CompilePlugins_Unix">Unix Example</a></span></dt>
 <dt><span class="section"><a href="App_Troubleshooting.html#CompilePlugins_HPUX">HPUX Example</a></span></dt>
-<dt><span class="section"><a href="App_Troubleshooting.html#CompilePlugins_Win">Compiling For Windows NT</a></span></dt>
 </dl></dd>
 <dt><span class="section"><a href="Trouble_LoadPlugins.html">Unable to Load Plugins</a></span></dt>
 <dt><span class="section"><a href="Trouble_DebugTags.html">Using Debug Tags</a></span></dt>
@@ -90,24 +89,23 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="Trouble_CompilePlugins"></a>Unable to Compile Plugins</h2></div></div></div>
-<p>The process you use to compile a shared library will vary from
-      platform to platform, so the Traffic Server API includes makefile
-      templates you can use to create shared libraries on all the supported
+<p>The process for compiling a shared library  varies with  
+      the platform used, so the Traffic Server API includes <code>makefile</code> templates you can use to create shared libraries on all  supported
       Traffic Server platforms.</p>
 <div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="CompilePlugins_Unix"></a>Unix Example</h3></div></div></div>
-<p>Assuming the sample program is stored in the file hello-world.c,
+<div class="titlepage"><div><div>
+  <h3 class="title">
+<a name="CompilePlugins_Unix"></a>UNIX Example</h3></div></div></div>
+<p>Assuming the sample program is stored in the file <code>hello-world.c</code>,
         you could use the following commands to building a shared library on
         Solaris using the GNU C compiler.</p>
 <pre class="programlisting">gcc -g -Wall -fPIC -o hello-world.o -c hello-world.c
 gcc -g -Wall -shared -o hello-world.so hello-world.o</pre>
-<p>The first command compiles hello-world.c as Position Independent
-        Code (PIC) and the second command links the single hello-world.o
-        object file into the hello-world.so shared library.</p>
+<p>The first command compiles <code>hello-world.c </code>as Position Independent
+        Code (PIC); the second command links the single<code> hello-world.o</code> object file into the <code>hello-world.so</code> shared library.</p>
 <div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Caution">
 <tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/docbook/caution.png"></td>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/docbook/caution.png" /></td>
 <th align="left">Caution</th>
 </tr>
 <tr><td align="left" valign="top"><p>Make sure that your plugin is not statically linked with
@@ -117,48 +115,14 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="CompilePlugins_HPUX"></a>HPUX Example</h3></div></div></div>
-<p>Assuming the sample program is stored in the file hello_world.c,
+<p>Assuming the sample program is stored in the file <code>hello_world.c</code>,
         you could use the following commands to build a shared library on
         HPUX:</p>
 <pre class="programlisting">cc +z -o hello_world.o -c hello_world.c 
 ld -b -o hello_world.so hello_world.o</pre>
 </div>
 <div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="CompilePlugins_Win"></a>Compiling For Windows NT</h3></div></div></div>
-<p>Your PC must have the following software installed:</p>
-<div class="itemizedlist"><ul type="disc">
-<li><p>Windows NT 4.0 SP4</p></li>
-<li><p>Microsoft Developer Studio 6.0</p></li>
-</ul></div>
-<h4>
-<a name="id435778"></a>To compile a plugin for the Windows NT version of Traffic
-        Server:</h4>
-<div class="orderedlist"><ol type="1">
-<li><p>Open PlugIn.dsw with Microsoft Visual C++ (MSVC++). The dsw
-            file should be included in the SDK CD. Inside VC++, the sample
-            plugins are listed as separate projects.</p></li>
-<li>
-<p>For each of the projects that need to be built, you need to
-            tell VC++ where it can find the Traffic Server library:
-            traffic_server.lib. This library is in your NT Traffic Server
-            distribution.</p>
-<p>You might need to update the library lookup path. Use the
-            following procedure:</p>
-</li>
-</ol></div>
-<h4>
-<a name="id435804"></a>To update the library lookup path</h4>
-<div class="orderedlist"><ol type="1">
-<li><p>Right-mouse-click on a project.</p></li>
-<li><p>Select the <span class="guilabel">Settings...</span> option.</p></li>
-<li><p>Click the <span class="guilabel">Link</span> tab on the dialog
-            box.</p></li>
-<li><p>Select <span class="guilabel">Input</span> in the combo-box.</p></li>
-<li><p>Enter the library path in the <span class="guilabel">Additional library
-            path: text</span> field</p></li>
-<li><p>Now you can build your plugin.</p></li>
-</ol></div>
+</div></div>
 </div>
 </div>
 </div>

Modified: incubator/trafficserver/site/trunk/docs/sdk/AppendTransformPlugin.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/AppendTransformPlugin.html?rev=834703&r1=834702&r2=834703&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/AppendTransformPlugin.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/AppendTransformPlugin.html Tue Nov 10 23:07:51 2009
@@ -1,43 +1,43 @@
 <html>
 <head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>The Append-Transform Plugin</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="prev" href="SampleNullTransformPlugin.html" title="The Sample Null Transform Plugin">
-<link rel="next" href="SampleBufferedNullTransformPlugin.html" title="The Sample Buffered Null Transform Plugin">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="prev" href="SampleNullTransformPlugin.html" title="The Sample Null Transform Plugin" />
+<link rel="next" href="SampleBufferedNullTransformPlugin.html" title="The Sample Buffered Null Transform Plugin" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
 <script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
     document.write("<style> div.toc {display: none} </style>"); 
   </script>
@@ -45,7 +45,7 @@
 <body>
 <div class="doctitle">
 <a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
 </div>
 <div class="navheader">
 <div class="navprev">
@@ -58,7 +58,7 @@
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="AppendTransformPlugin"></a>The Append-Transform Plugin</h2></div></div></div>
 <p>The append-transform plugin appends text to the body of an HTTP
-      response. It obtains this text from a file. The name of the file
+      response. It obtains this text from a file; the name of the file
       containing the append text is a parameter you specify in
       <code class="filename">plugin.config</code>, as follows:</p>
 <pre class="programlisting">append-transform.so path/to/file</pre>
@@ -66,13 +66,13 @@
       <code class="filename">null-transform.c</code>. The only difference is that after
       the plugin feeds the document through the transformation, it adds text
       to the response.</p>
-<p>Here is a list of the functions in
+<p>Below is a list of the functions in
       <code class="filename">append-transform.c</code>, in the order they appear in the
-      source code, with a description of what the function does:</p>
+      source code. Below each entry is a description of what the function does:</p>
 <div class="itemizedlist"><ul type="disc">
 <li>
 <p><code class="function">my_data_alloc</code></p>
-<p>Allocates and initializes a MyData structure. The plugin
+<p>Allocates and initializes a <code>MyData</code> structure. The plugin
           defines a struct, <code class="code">MyData</code>, as follows:</p>
 <pre class="programlisting">     typedef struct {
      INKVIO output_vio;
@@ -88,48 +88,49 @@
 </li>
 <li>
 <p><code class="function">my_data_destroy</code></p>
-<p>Destroys objects of type <code class="code">MyData</code>. The
-          append_transform routine (see below) calls
-          <code class="code">my_data_destroy</code> when the transformation is complete, to
-          deallocate the transformation’s data.</p>
+<p>Destroys objects of type <code class="code">MyData</code>. To deallocate the transform's data, the
+          <code>append_transform</code> routine (see below) calls <code class="code">my_data_destroy</code> when the transformation is complete.</p>
 </li>
 <li>
 <p><code class="function">handle_transform</code></p>
 <p>This function does the actual data transformation. The
           transformation is created in <code class="code">transform_add</code> (see below).
-          handle_transform is called by append_transform.</p>
+          <code>handle_transform</code> is called by <code>append_transform</code>.</p>
 </li>
 <li>
 <p><code class="function">append_transform</code></p>
 <p>This is the handler function for the transformation
-          vconnection created in transform_add. It is the implementation of
+          vconnection created in <code>transform_add</code>. It is the implementation of
           the vconnection.</p>
 <div class="itemizedlist"><ul type="circle">
-<li><p>If the transformation vconnection has been closed,
-              append_transform calls <code class="function">my_data_destroy</code> to
-              destroy the vonnection</p></li>
-<li><p>If <code class="function">append_transform</code> receives an error
-              event, it calls back the continuation to let it know it has
-              completed the write operation</p></li>
-<li><p>If it receives a <code class="code">WRITE_COMPLETE</code> event, it
-              shuts down the write portion of its vconnection</p></li>
-<li><p>If it receives a <code class="code">WRITE_READY</code> or any other
+<li>
+  <p>If the transformation vconnection has been closed, then
+              <code>append_transform</code> calls <code class="function">my_data_destroy</code> to
+            destroy the vonnection.</p></li>
+<li>
+  <p>If <code class="function">append_transform</code> receives an error
+              event, then it calls back the continuation to let it know it has
+              completed the write operation.</p></li>
+<li>
+  <p>If it receives a <code class="code">WRITE_COMPLETE</code> event, then it
+              shuts down the write portion of its vconnection.</p></li>
+<li>
+  <p>If it receives a <code class="code">WRITE_READY</code> or any other
               event (such as
-              <code class="code">INK_HTTP_RESPONSE_TRANSFORM_HOOK</code>)<a class="indexterm" name="id304599"></a>, it calls <code class="function">handle_transform</code>
-              to attempt to transform more data</p></li>
+              <code class="code">INK_HTTP_RESPONSE_TRANSFORM_HOOK</code>)<a class="indexterm" name="id304599"></a>, then it calls <code class="function">handle_transform</code>
+              to attempt to transform more data.</p></li>
 </ul></div>
 </li>
 <li>
 <p><code class="function">transformable</code></p>
 <p>The plugin transforms only documents that have a content type
           of <code class="code">text/html</code>. This function examines the
-          <code class="code">Content-Type</code> MIME header field in the response header;
-          if the value of the MIME field is <code class="code">text/html</code>, the
-          function returns 1. Otherwise, it returns zero.</p>
+          <code class="code">Content-Type</code> MIME header field in the response header. If the value of the MIME field is <code class="code">text/html</code>, then the
+          function returns 1; otherwise, it returns zero.</p>
 </li>
 <li>
 <p><code class="function">transform_add</code></p>
-<p>Creates the transformation for the current transaction, and
+<p>Creates the transformation for the current transaction and
           sets up a transformation hook. The handler function for the
           transformation is <code class="function">append_transform</code>.</p>
 </li>
@@ -145,16 +146,17 @@
 <li><p>Calls <code class="function">transformable</code> to determine
               whether the response document content is of type
               <code class="code">text/html</code></p></li>
-<li><p>If the content is transformable, calls
+<li>
+  <p>If the content is transformable, then it calls
               <code class="function">transform_add</code> to create the
-              transformation</p></li>
+              transformation.</p></li>
 <li><p>Calls <code class="function">INKHttpTxnReenable</code> to continue
               the transaction</p></li>
 </ul></div>
 </li>
 <li>
 <p><code class="function">load</code></p>
-<p>Opens the file containing the text to be appended, and loads
+<p>Opens the file containing the text to be appended and loads
           the contents of the file into an <code class="function">INKIOBuffer</code>
           called <code class="function">append_buffer</code>.</p>
 </li>
@@ -165,14 +167,16 @@
 <li><p>Checks to make sure that the required configuration
               information (the append text filename) is entered in
               <code class="filename">plugin.config</code> correctly.</p></li>
-<li><p>If there is a filename, <code class="function">INKPluginInit</code>
+<li>
+  <p>If there is a filename, then <code class="function">INKPluginInit</code>
               calls load to load the text.</p></li>
 <li><p>Creates a continuation for the plugin. The handler for
               this continuation is
               <code class="function">transform_plugin</code>.</p></li>
-<li><p>Adds the plugin’s continuation to
+<li>
+  <p>Adds the plugin’s continuation to
               <code class="function">INK_HTTP_READ_RESPONSE_HDR_HOOK</code>. In other
-              words, sets up a callback of the plugin’s continuation when
+              words, it sets up a callback of the plugin’s continuation when
               Traffic Server reads HTTP response headers.</p></li>
 </ul></div>
 </li>

Modified: incubator/trafficserver/site/trunk/docs/sdk/BasicAuthorizatonPlugin.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/BasicAuthorizatonPlugin.html?rev=834703&r1=834702&r2=834703&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/BasicAuthorizatonPlugin.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/BasicAuthorizatonPlugin.html Tue Nov 10 23:07:51 2009
@@ -1,50 +1,50 @@
 <html>
 <head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>The Basic Authorization Plugin</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="prev" href="WorkWHTTPHeaderFunc.html" title="Working with HTTP Header Functions">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="prev" href="WorkWHTTPHeaderFunc.html" title="Working with HTTP Header Functions" />
 <link rel="next" href="ImplementHandler_GetTransHandle.html" title="Implementing the Handler and Getting a Handle to the
-        Transaction">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
+        Transaction" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
 <link rel="subsection" href="BasicAuthorizatonPlugin.html#CreatePluginParentCont_GlHk" title="Creating the Plugin's Parent Continuation and Global
-        Hook">
+        Hook" />
 <link rel="subsection" href="ImplementHandler_GetTransHandle.html" title="Implementing the Handler and Getting a Handle to the
-        Transaction">
-<link rel="subsection" href="WorkWithHTTPHeaders.html" title="Working With HTTP Headers">
-<link rel="subsection" href="SetTransactionHook.html" title="Setting a Transaction Hook">
+        Transaction" />
+<link rel="subsection" href="WorkWithHTTPHeaders.html" title="Working With HTTP Headers" />
+<link rel="subsection" href="SetTransactionHook.html" title="Setting a Transaction Hook" />
 <script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
     document.write("<style> div.toc {display: none} </style>"); 
   </script>
@@ -52,7 +52,7 @@
 <body>
 <div class="doctitle">
 <a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
 </div>
 <div class="navheader">
 <div class="navprev">
@@ -70,8 +70,8 @@
       authorization. In HTTP basic proxy authorization, client user names and
       passwords are contained in the <code class="code">Proxy-Authorization</code> header.
       The password is encoded using base64 encoding. The plugin checks all
-      incoming requests for the authorization header, user name and password.
-      If the plugin does not find all of the these, it reenables with an error
+      incoming requests for the authorization header, user name, and password.
+      If the plugin does not find all of the these, then it reenables with an error
       (effectively stopping the transaction) and adds a transaction hook to
       the send response header event.</p>
 <div class="section" lang="en">

Modified: incubator/trafficserver/site/trunk/docs/sdk/BlacklistPlugin.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/BlacklistPlugin.html?rev=834703&r1=834702&r2=834703&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/BlacklistPlugin.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/BlacklistPlugin.html Tue Nov 10 23:07:51 2009
@@ -1,49 +1,49 @@
 <html>
 <head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>The Blacklist Plugin</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="prev" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="next" href="SettingGlobalHook.html" title="Setting a Global Hook">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
-<link rel="subsection" href="BlacklistPlugin.html#CreatingParentContinuation" title="Creating the Parent Continuation">
-<link rel="subsection" href="SettingGlobalHook.html" title="Setting a Global Hook">
-<link rel="subsection" href="SettingUpUIUpdateCallbacks.html" title="Setting Up UI Update Callbacks">
-<link rel="subsection" href="AccessingTransactionProc.html" title="Accessing the Transaction Being Processed">
-<link rel="subsection" href="SettingUpTransacHook.html" title="Setting Up a Transaction Hook">
-<link rel="subsection" href="WorkWHTTPHeaderFunc.html" title="Working with HTTP Header Functions">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="prev" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="next" href="SettingGlobalHook.html" title="Setting a Global Hook" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
+<link rel="subsection" href="BlacklistPlugin.html#CreatingParentContinuation" title="Creating the Parent Continuation" />
+<link rel="subsection" href="SettingGlobalHook.html" title="Setting a Global Hook" />
+<link rel="subsection" href="SettingUpUIUpdateCallbacks.html" title="Setting Up UI Update Callbacks" />
+<link rel="subsection" href="AccessingTransactionProc.html" title="Accessing the Transaction Being Processed" />
+<link rel="subsection" href="SettingUpTransacHook.html" title="Setting Up a Transaction Hook" />
+<link rel="subsection" href="WorkWHTTPHeaderFunc.html" title="Working with HTTP Header Functions" />
 <script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
     document.write("<style> div.toc {display: none} </style>"); 
   </script>
@@ -51,7 +51,7 @@
 <body>
 <div class="doctitle">
 <a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
 </div>
 <div class="navheader">
 <div class="navprev">
@@ -67,13 +67,14 @@
       is <code class="filename">blacklist_1.c</code>. This plugin checks every incoming
       HTTP client request against a list of blacklisted web sites. If the
       client requests a blacklisted site, then the plugin returns an
-      <code class="code">Access forbidden</code> message to the client. The flow of HTTP
-      processing with the blacklist plugin is illustrated in <a href="CreatingTSPlugins.html#Fig_BlacklistPlugin" title="Figure 2.5. Blacklist Plugin">Figure 2.5, “Blacklist Plugin”</a>. Additionally, this example contains a
-      simple configuration management interface. It can read a list of
-      blacklisted sites from a file, <code class="filename">blacklist.txt</code>, that
-      can be updated by a Traffic Server administrator. When the configuration
-      file is updated, Traffic Server sends an event to the plugin which wakes
-      it up to do some work.</p>
+      <code class="code">Access forbidden</code> message to the client. </p>
+<p>The flow of HTTP
+  processing with the blacklist plugin is illustrated in <a href="CreatingTSPlugins.html#Fig_BlacklistPlugin" title="Figure 2.5. Blacklist Plugin">Figure 2.5, “Blacklist Plugin”</a>. This example also contains a
+  simple configuration management interface. It can read a list of
+  blacklisted sites from a file (<code class="filename">blacklist.txt</code>) that
+  can be updated by a Traffic Server administrator. When the configuration
+  file is updated, Traffic Server sends an event to the plugin that wakes
+  it up to do some work.</p>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="CreatingParentContinuation"></a>Creating the Parent Continuation<a class="indexterm" name="id373031"></a></h3></div></div></div>
@@ -86,9 +87,8 @@
         must create and specify their handler functions.</p>
 <p>You can specify an optional mutex lock when you create
         continuations. The mutex lock protects data shared by asynchronous
-        processes. Traffic Server has a multi-threaded design; therefore, if
-        several threads try to access the same continuation’s data, then race
-        conditions can occur.</p>
+        processes. Because Traffic Server has a multi-threaded design, race conditions can occur if
+        several threads try to access the same continuation’s data.</p>
 <p>Here is how the static parent continuation is created in
         <code class="filename">blacklist-1.c</code></p>
 <pre class="programlisting">void
@@ -100,10 +100,9 @@
 ...
 }</pre>
 <p>:</p>
-<p>The handler function for the plugin is blacklist_plugin, and the
+<p>The handler function for the plugin is <code>blacklist_plugin</code>, and the
         mutex is null. The continuation handler function’s job is to handle
-        the events that are sent to it; accordingly, the
-        <code class="filename">blacklist_plugin</code> routine consists of a switch
+        the events that are sent to it; accordingly, the <code class="filename">blacklist_plugin</code> routine consists of a switch
         statement that covers each of the events that might be sent to
         it:</p>
 <pre class="programlisting">static int
@@ -129,11 +128,11 @@
         events that might be sent to the handler by hooks or by other
         functions. In the Blacklist plugin, <code class="code">INK_EVENT_OS_DNS</code> is
         sent because of the global hook established in
-        <code class="code">INKPluginInit</code>;
+        <code class="code">INKPluginInit</code>,
         <code class="code">INK_EVENT_HTTP_SEND_RESPONSE_HDR</code> is sent because the
         plugin contains a transaction hook (see <a href="SettingUpTransacHook.html" title="Setting Up a Transaction Hook">“Setting Up a Transaction Hook”</a>), and
         <code class="code">INK_EVENT_MGMT_UPDATE</code> is sent by Traffic Manager whenever
-        there is a configuration change. See <a href="SettingUpUIUpdateCallbacks.html" title="Setting Up UI Update Callbacks">“Setting Up UI Update Callbacks”</a>. It is good practice to have a
+        there is a configuration change (see <a href="SettingUpUIUpdateCallbacks.html" title="Setting Up UI Update Callbacks">“Setting Up UI Update Callbacks”</a>). It is good practice to have a
         default case in your switch statements.</p>
 </div>
 </div>

Modified: incubator/trafficserver/site/trunk/docs/sdk/CacheAPI.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/CacheAPI.html?rev=834703&r1=834702&r2=834703&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/CacheAPI.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/CacheAPI.html Tue Nov 10 23:07:51 2009
@@ -1,48 +1,48 @@
 <html>
 <head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>Guide to the Cache API</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="prev" href="IOBuffers_IO.html" title="IO Buffers">
-<link rel="next" href="DoACacheWrite.html" title="How to Do a Cache Write">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
-<link rel="subsection" href="CacheAPI.html#DoACacheRead" title="How to Do a Cache Read">
-<link rel="subsection" href="DoACacheWrite.html" title="How to Do a Cache Write">
-<link rel="subsection" href="DoACacheRemove.html" title="How to Do a Cache Remove">
-<link rel="subsection" href="Errors_Cache.html" title="Errors">
-<link rel="subsection" href="CacheAPI_Example.html" title="Example">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="prev" href="IOBuffers_IO.html" title="IO Buffers" />
+<link rel="next" href="DoACacheWrite.html" title="How to Do a Cache Write" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
+<link rel="subsection" href="CacheAPI.html#DoACacheRead" title="How to Do a Cache Read" />
+<link rel="subsection" href="DoACacheWrite.html" title="How to Do a Cache Write" />
+<link rel="subsection" href="DoACacheRemove.html" title="How to Do a Cache Remove" />
+<link rel="subsection" href="Errors_Cache.html" title="Errors" />
+<link rel="subsection" href="CacheAPI_Example.html" title="Example" />
 <script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
     document.write("<style> div.toc {display: none} </style>"); 
   </script>
@@ -50,7 +50,7 @@
 <body>
 <div class="doctitle">
 <a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
 </div>
 <div class="navheader">
 <div class="navprev">
@@ -62,18 +62,18 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="CacheAPI"></a>Guide to the Cache API</h2></div></div></div>
-<p>The cache API lets plugins read, write, and remove objects in the
+<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 class="function">INKCacheKey</code>. Cache keys are created via
-      <code class="function">INKCacheKeyCreate</code>. Keys are destroyed via
+      <code class="function">INKCacheKey</code>; cache keys are created via
+      <code class="function">INKCacheKeyCreate</code>; keys are destroyed via
       <code class="function">INKCacheKeyDestroy</code>. Use
       <code class="function">INKCacheKeyDigestSet</code> to set the hash of the cache
       key.</p>
-<p>Note that the cache APIs differentiates between HTTP data and
+<p>Note that the cache APIs differentiate between HTTP data and
       plugin data. The cache APIs do not allow you to write HTTP docs in the
-      cache. You can only write plugin-specific data which is a specific type
-      of data which is different from the HTTP type.</p>
-<p>Example:</p>
+      cache; you can only write plugin-specific data (a specific type
+      of data that differs from the HTTP type).</p>
+<p><b>Example:</b></p>
 <pre class="programlisting">    const unsigned char *key_name = "example key name";
 
     INKCacheKey key;
@@ -83,20 +83,21 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="DoACacheRead"></a>How to Do a Cache Read</h3></div></div></div>
-<p><code class="function">INKCacheRead</code> does not really read, it is
-        used for lookups. See the sample Protocol plugin. The possible
+<p><code class="function">INKCacheRead</code> does not really read - it is
+        used for lookups (see the sample Protocol plugin). Possible
         callback events include:</p>
 <div class="itemizedlist"><ul type="disc">
-<li><p><code class="code">INK_EVENT_CACHE_OPEN_READ</code> - indicating that the
-            lookup was successful, the data passed back along with this event
-            is a cache vconnection that may be used to initiate a read on this
+<li>
+  <p><code class="code">INK_EVENT_CACHE_OPEN_READ</code> - indicates the
+            lookup was successful. The data passed back along with this event
+            is a cache vconnection that can be used to initiate a read on this
             keyed data.</p></li>
-<li><p><code class="code">INK_EVENT_CACHE_OPEN_READ_FAILED</code> - indicating
-            that the lookup was unsuccessful. Reasons for this event include:
-            another continuation could be writing to that cache location, or
-            the cache key may not refer to a cached resource. Data payload for
-            this event indicates the possible reason for the read failing
-            (<code class="function">INKCacheError</code>).</p></li>
+<li>
+  <p><code class="code">INK_EVENT_CACHE_OPEN_READ_FAILED</code> - indicates the lookup was unsuccessful. Reasons for this event could be that 
+            another continuation is writing to that cache location, or
+            the cache key doesn't refer to a cached resource. Data payload for
+            this event indicates the possible reason  the read failed
+        (<code class="function">INKCacheError</code>).</p></li>
 </ul></div>
 </div>
 </div>

Modified: incubator/trafficserver/site/trunk/docs/sdk/CacheAPI_Example.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/CacheAPI_Example.html?rev=834703&r1=834702&r2=834703&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/CacheAPI_Example.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/CacheAPI_Example.html Tue Nov 10 23:07:51 2009
@@ -1,43 +1,43 @@
 <html>
 <head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>Example</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="CacheAPI.html" title="Guide to the Cache API">
-<link rel="prev" href="Errors_Cache.html" title="Errors">
-<link rel="next" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="CacheAPI.html" title="Guide to the Cache API" />
+<link rel="prev" href="Errors_Cache.html" title="Errors" />
+<link rel="next" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
 <script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
     document.write("<style> div.toc {display: none} </style>"); 
   </script>
@@ -45,7 +45,7 @@
 <body>
 <div class="doctitle">
 <a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
 </div>
 <div class="navheader">
 <div class="navprev">
@@ -57,21 +57,21 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="CacheAPI_Example"></a>Example</h3></div></div></div>
-<p>In the example below, suppose we have a cache hit and the cache
-        returns a vconnection for us to read the document from the cache. To
-        do this, we have to prepare a buffer (<code class="varname">cache_bufp</code>)
-        to hold the document. Meanwhile, we would use
-        <code class="function">INKVConnCachedObjectSizeGet</code> to tell us the actual
-        size of the document (<code class="varname">content_length</code>). After, we
-        would issue <code class="function">INKVConnRead</code> to read the document
-        with the total data length required being
+<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 have to prepare a buffer (<code class="varname">cache_bufp</code>)
+        to hold the document. Meanwhile,   use
+        <code class="function">INKVConnCachedObjectSizeGet</code> to find out the actual
+        size of the document (<code class="varname">content_length</code>). Then, 
+         issue <code class="function">INKVConnRead</code> to read the document
+        with the total data length required as
         <code class="varname">content_length</code>. Assume the following data:</p>
 <pre class="programlisting">    INKIOBuffer       cache_bufp = INKIOBufferCreate ();
     INKIOBufferReader cache_readerp = INKIOBufferReaderAlloc (out_bufp);
     INKVConn          cache_vconnp = NULL;
     INKVIO            cache_vio = NULL;
     int               content_length = 0;</pre>
-<p>In the <code class="code">INK_CACHE_OPEN_READ</code> handler;</p>
+<p>In the <code class="code">INK_CACHE_OPEN_READ</code> handler:</p>
 <pre class="programlisting">cache_vconnp = (INKVConn) data;
     INKVConnCachedObjectSizeGet (cache_vconnp, &amp;content_length);
     cache_vio = INKVConnRead (cache_vconn, contp, cache_bufp, content_length);</pre>
@@ -93,10 +93,9 @@
 </ul></div>
 <p>APIs such as <code class="function">INKVConnRead</code>,
         <code class="function">INKVConnWrite</code>,
-        <code class="function">INKVConnClose</code>, <code class="function">INKVConnAbort</code>
-        and <code class="function">INKVConnShutdown</code> can be used on any kind of
+        <code class="function">INKVConnClose</code>, <code class="function">INKVConnAbort</code>, and <code class="function">INKVConnShutdown</code> can be used on any kind of
         VConnections.</p>
-<p>When you are done:</p>
+<p>When you are finished:</p>
 <pre class="programlisting">INKCacheKeyDestroy (key);</pre>
 </div>
 </body>