trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mlib...@apache.org
Subject svn commit: r833611 - in /incubator/trafficserver/site/trunk/docs/sdk: AccessPluginFiles.html AccessingTransactionProc.html ActionsGuide.html ActivateContinuations.html AddingHooks.html
Date Sat, 07 Nov 2009 00:08:18 GMT
Author: mlibbey
Date: Sat Nov  7 00:08:17 2009
New Revision: 833611

URL: http://svn.apache.org/viewvc?rev=833611&view=rev
Log:
DianeS doc changes + self-closing tags

Modified:
    incubator/trafficserver/site/trunk/docs/sdk/AccessPluginFiles.html
    incubator/trafficserver/site/trunk/docs/sdk/AccessingTransactionProc.html
    incubator/trafficserver/site/trunk/docs/sdk/ActionsGuide.html
    incubator/trafficserver/site/trunk/docs/sdk/ActivateContinuations.html
    incubator/trafficserver/site/trunk/docs/sdk/AddingHooks.html

Modified: incubator/trafficserver/site/trunk/docs/sdk/AccessPluginFiles.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/AccessPluginFiles.html?rev=833611&r1=833610&r2=833611&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/AccessPluginFiles.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/AccessPluginFiles.html Sat Nov  7 00:08:17 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>Accessing Installed Plugin Files</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="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="prev" href="ReadTESettingStats.html" title="Reading Traffic Server Settings and Statistics">
-<link rel="next" href="LicensingPlugin.html" title="Licensing Your 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="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="prev" href="ReadTESettingStats.html" title="Reading Traffic Server Settings and Statistics" />
+<link rel="next" href="LicensingPlugin.html" title="Licensing Your 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">
@@ -61,19 +61,21 @@
       such as configuration files. When you upgrade Traffic Server, you might
       need to make sure your plugin is always able to find its associated
       files. The mechanism for preserving relative file locations with
-      upgrades is the following:</p>
+      upgrades is as follows:</p>
 <div class="itemizedlist"><ul type="disc">
-<li><p>Make sure all plugins are contained in their own directories
-          within the plugin directory.</p></li>
+<li>
+  <p>Make sure that all plugins are contained in their own directories
+      within the <code>plugin</code> directory.</p></li>
 <li><p>The plugin directory path is specified in the Traffic Server
           <code class="filename">records.config</code> file variable
-          <code class="varname">proxy.config.plugin.plugin_dir</code>. This path is
+          <code class="varname"><i>proxy.config.plugin.plugin_dir</i></code>. This path is
           relative to the Traffic Server install directory. The default value
-          is <code class="filename">config/plugin</code>.</p></li>
-<li><p>Make sure all plugins are listed in the
+      is <code class="filename">config/plugin</code>.</p></li>
+<li>
+  <p>Make sure that all plugins are listed in the
           <code class="filename">plugin.db</code> file. For each plugin, this file
           contains the plugin name, object file, license key, file name(s),
-          and directory relative to the plugin directory.</p></li>
+      and directory relative to the <code>plugin</code> directory.</p></li>
 <li><p>When Traffic Server is upgraded, the Traffic Server
           installation program looks at the <code class="filename">plugin.db</code>
           file to see which plugins to copy over to the new Traffic Server
@@ -87,7 +89,7 @@
 License=[license key]
 Dir=[name of any directories to be copied over] </pre>
 <div class="itemizedlist"><ul type="disc">
-<li><p>Entries in plugin.db are case-sensitive.</p></li>
+<li><p>Entries in <code>plugin.db</code> are case-sensitive.</p></li>
 <li>
 <p>Do not include white spaces in your entries. For example, the
           following line is incorrect:</p>
@@ -96,8 +98,8 @@
 <pre class="programlisting">Object=plugin.so</pre>
 </li>
 </ul></div>
-<p>For example, suppose that you have a blacklist plugin in the
-      plugin directory. Its object file is <code class="filename">Blacklist.so</code>
+<p>For example: suppose  you have a blacklist plugin in the
+      <code>plugin</code> directory. Its object file is <code class="filename">Blacklist.so</code>
       and it has some user interface files (images and HTML files) in the
       <code class="filename">Blacklist/ui</code> directory. To make sure that the
       blacklist plugin is upgraded properly, <code class="filename">plugin.db</code>
@@ -107,7 +109,7 @@
 License=ABCD0123456789
 Dir=Blacklist/ui</pre>
 <p>In this example, if all of the necessary files and directories are
-      in the Blacklist directory, you could simply specify
+      in the Blacklist directory, then you could simply specify
       <code class="code">Dir=Blacklist</code>.</p>
 <p>This means that the Blacklist image and HTML files are always
       located in:</p>

Modified: incubator/trafficserver/site/trunk/docs/sdk/AccessingTransactionProc.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/AccessingTransactionProc.html?rev=833611&r1=833610&r2=833611&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/AccessingTransactionProc.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/AccessingTransactionProc.html Sat Nov  7 00:08:17 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>Accessing the Transaction Being Processed</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="BlacklistPlugin.html" title="The Blacklist Plugin">
-<link rel="prev" href="SettingUpUIUpdateCallbacks.html" title="Setting Up UI Update Callbacks">
-<link rel="next" href="SettingUpTransacHook.html" title="Setting Up a Transaction 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="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="BlacklistPlugin.html" title="The Blacklist Plugin" />
+<link rel="prev" href="SettingUpUIUpdateCallbacks.html" title="Setting Up UI Update Callbacks" />
+<link rel="next" href="SettingUpTransacHook.html" title="Setting Up a Transaction 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" />
 <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,18 +58,18 @@
 <div class="titlepage"><div><div><h3 class="title">
 <a name="AccessingTransactionProc"></a>Accessing the Transaction Being Processed<a class="indexterm" name="id373366"></a></h3></div></div></div>
 <p>A continuation’s handler function is of type
-        <code class="function">INKEventFunc</code><a class="indexterm" name="id373381"></a>, and the prototype is as follows:<a class="indexterm" name="id373390"></a></p>
+        <code class="function">INKEventFunc</code><a class="indexterm" name="id373381"></a>; the prototype is as follows:<a class="indexterm" name="id373390"></a></p>
 <pre class="programlisting">static int function_name (INKCont contp, INKEvent event, void *edata)</pre>
 <p>In general, the return value of the handler function is not
         used. The continuation argument is the continuation being called back,
         the event is the event being sent to the continuation, and the data
-        pointed to by void *edata depends on the type of event. The data types
+        pointed to by <code>void *edata</code> depends on the type of event. The data types
         for each event type are listed in <a href="WritingHandlerFunctions.html" title="Writing Handler Functions">“Writing Handler Functions”</a>.</p>
 <p>The key here is that if the event is an HTTP transaction event,
         then the data passed to the continuation’s handler is of type
         <code class="code">INKHttpTxn<a class="indexterm" name="id373419"></a></code> (a data type that represents HTTP transactions).
         Your plugin can then do things with the transaction. Here’s how it
-        looks in the Blacklist plugin’s handler’s code:</p>
+        looks in the code for the Blacklist plugin’s handler:</p>
 <pre class="programlisting">static int
 blacklist_plugin (INKCont contp, INKEvent event, void *edata)
 {
@@ -89,8 +89,8 @@
      }
      return 0;
 }</pre>
-<p>When, for example, the origin server DNS lookup event is sent,
-        blacklist_plugin can call handle_dns and pass txnp as an
+<p>For example: when the origin server DNS lookup event is sent,
+        <code>blacklist_plugin</code> can call <code>handle_dns </code>and pass <code>txnp</code> as an
         argument.</p>
 </div>
 </body>

Modified: incubator/trafficserver/site/trunk/docs/sdk/ActionsGuide.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/ActionsGuide.html?rev=833611&r1=833610&r2=833611&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/ActionsGuide.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/ActionsGuide.html Sat Nov  7 00:08:17 2009
@@ -1,45 +1,45 @@
 <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>Chapter 14. Actions Guide</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="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="next" href="HostsLookupAPI.html" title="Hosts Lookup API">
-<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="ActionsGuide.html#Actions" title="Actions">
-<link rel="section" href="HostsLookupAPI.html" title="Hosts Lookup API">
+<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="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="next" href="HostsLookupAPI.html" title="Hosts Lookup API" />
+<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="ActionsGuide.html#Actions" title="Actions" />
+<link rel="section" href="HostsLookupAPI.html" title="Hosts Lookup API" />
 <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>
@@ -47,7 +47,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">
@@ -74,39 +74,39 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="Actions"></a>Actions</h2></div></div></div>
-<p>An action is a handle to an operation initiated by a plugin which
-      has not yet completed. For example, when a plugin connects to a remote
-      server it uses the call <code class="function">INKNetConnect</code> which takes
+<p>An action is a handle to an operation initiated by a plugin that
+      has not yet completed. For example: when a plugin connects to a remote
+      server, it uses the call <code class="function">INKNetConnect</code> which takes
       an <code class="function">INKCont</code> as an argument to call back when the
       connection is established. <code class="function">INKNetConnect</code> might not
       call the continuation back immediately and will return an
-      <code class="function">INKAction</code> structure which the caller can use to
+      <code class="function">INKAction</code> structure that the caller can use to
       cancel the operation. Cancelling the operation does not necessarily mean
-      that the operation will not occur, but that the continuation passed in
+      that the operation will not occur; it means that the continuation passed in
       to the operation will not be called back. In the above example, the
       connection might still occur if the action is cancelled, but the
       continuation that initiated the connection would not be called back when
       that occurred.</p>
-<p>It is possible that the connection, in the preceding example, will
+<p>In the preceding example, it is possible that the connection will
       complete and callback the continuation before
-      <code class="function">INKNetConnect</code> returns. If this occurs
-      <code class="function">INKNetConnect</code> will return a special action which
-      will cause <code class="function">INKActionDone</code> to return 1. Basically
-      this is specifying that the operation has already completed. There is no
+      <code class="function">INKNetConnect</code> returns. If this occurs, then 
+      <code class="function">INKNetConnect</code>  returns a special action that
+       causes <code class="function">INKActionDone</code> to return 1. Basically,
+      this specifies that the operation has already completed; there is no
       point in trying to cancel the operation. Note that an action will never
       change from non-completed to completed. When the operation actually
-      succeeds and the continuation is called back it is up to the
-      continuation to zero out its action pointer to indicate to itself that
+      succeeds and the continuation is called back,  the
+      continuation must zero out its action pointer to indicate to itself that
       the operation succeeded.</p>
 <p>The asynchronous nature of all operations in Traffic Server
       necessitates actions. You should notice from the above discussion that
       once a call to a function like <code class="function">INKNetConnect</code> is
       made by a continuation and that function returns a valid action
-      (<code class="function">INKActionDone</code> returns 0) then it is not safe for
+      (<code class="function">INKActionDone</code> returns 0),  it is not safe for
       the continuation to do anything else except return from its handler
       function. It is not safe to modify or examine the continuation’s data
       since the continuation may have already been destroyed.</p>
-<p>Here is an example of a typical usage of an action:</p>
+<p>Below is an example of typical usage for an action:</p>
 <pre class="programlisting">#include “InkAPI.h”
 static int
 handler (INKCont contp, INKEvent event, void *edata)
@@ -145,23 +145,22 @@
        the system is started up. */
     INKContSchedule (contp, 0);
 }</pre>
-<p>The preceding example shows a simple plugin which creates a
+<p>The  example above shows a simple plugin that creates a
       continuation and schedules it to be called immediately. When the
-      plugin’s handler function is called the first time the event will be
+      plugin’s handler function is called the first time, the event will be
       <code class="code">INK_EVENT_IMMEDIATE</code>. The plugin then tries to open a net
-      connection to port 9999 on localhost (127.0.0.1). I’ve left the IP
-      description in dot notation to make it clearer what is going on. Please
-      note that the above won’t actually compile until the IP address is
+      connection to port 9999 on <code>localhost</code> (127.0.0.1). The IP
+      description was left cider notation to make it clearer what is going on; also note that the above won’t actually compile until the IP address is
       modified. The action returned from <code class="function">INKNetConnect</code> is
-      examined by the plugin. If the operation has not completed the plugin
-      stores the action in its continuation. Otherwise the plugin knows it has
+      examined by the plugin. If the operation has not completed, then the plugin
+      stores the action in its continuation. Otherwise, the plugin knows it has
       already been called back and there is no reason to store the action
       pointer.</p>
 <p>A final question might be why would a plugin want to cancel an
-      action. In the above example a valid reason would be to place a time
-      limit on how long it takes to open a connection. The plugin could
+      action. In the above example, a valid reason could be to place a 
+      limit on the length of time  it takes to open a connection. The plugin could
       schedule itself to get called back in 30 seconds and then initiate the
-      net connection. If the time-out expires first then the plugin would
+      net connection. If the time-out expires first, then the plugin would
       cancel the action. The following sample code implements this:</p>
 <pre class="programlisting">#include “InkAPI.h”
 static int

Modified: incubator/trafficserver/site/trunk/docs/sdk/ActivateContinuations.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/ActivateContinuations.html?rev=833611&r1=833610&r2=833611&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/ActivateContinuations.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/ActivateContinuations.html Sat Nov  7 00:08:17 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>How to Activate Continuations</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="Continuations.html" title="Chapter 12. Continuations">
-<link rel="prev" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="next" href="WritingHandlerFunctions.html" title="Writing Handler 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="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="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="prev" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="next" href="WritingHandlerFunctions.html" title="Writing Handler 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" />
 <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,9 +57,9 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="ActivateContinuations"></a>How to Activate Continuations</h2></div></div></div>
-<p>Continuations are activated when they receive an event or by
-      <code class="function">INKContSchedule</code>, which schedules a continuation to
-      receive an event. They might receive an event because:</p>
+<p>Continuations are activated   by
+      <code class="function">INKContSchedule</code> (which schedules a continuation to
+      receive an event) or when they receive an event. Continuations might receive an event because:</p>
 <div class="itemizedlist"><ul type="disc">
 <li><p>Your plugin calls <code class="function">INKContCall</code></p></li>
 <li><p>The Traffic Server HTTP state machine sends an event

Modified: incubator/trafficserver/site/trunk/docs/sdk/AddingHooks.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/AddingHooks.html?rev=833611&r1=833610&r2=833611&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/AddingHooks.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/AddingHooks.html Sat Nov  7 00:08:17 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>Adding Hooks</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="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="prev" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="next" href="HTTPSessions.html" title="HTTP Sessions">
-<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="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="prev" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="next" href="HTTPSessions.html" title="HTTP Sessions" />
+<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,10 +57,10 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="AddingHooks"></a>Adding Hooks</h2></div></div></div>
-<p>There are several ways of adding hooks to your plugin.</p>
+<p>There are several ways to add hooks to your plugin.</p>
 <div class="itemizedlist"><ul type="disc">
 <li>
-<p>global HTTP hooks<a class="indexterm" name="id378262"></a></p>
+<p><b>Global HTTP hooks</b><a class="indexterm" name="id378262"></a></p>
 <p>HTTP transaction hooks are set on a global basis using the
           function <code class="code">INKHttpHookAdd</code>. This means that the
           continuation specified as the parameter to
@@ -69,42 +69,42 @@
           <code class="code">INKPluginInit</code>.</p>
 </li>
 <li>
-<p>transaction hooks</p>
+<p><b>Transaction hooks</b></p>
 <p>Transaction hooks can be used to call plugins back for a
           specific HTTP transaction. You cannot add transaction hooks in
           <code class="code">INKPluginInit</code>; you first need a handle to a
           transaction. See <a href="AccessingTransactionProc.html" title="Accessing the Transaction Being Processed">“Accessing the Transaction Being Processed”</a>.</p>
 </li>
 <li>
-<p>transformation hooks</p>
+<p><b>Transformation hooks</b></p>
 <p>Transformation hooks are a special case of transaction hooks.
           See <a href="INKVConnCacheObjectSizeGet.html" title="INKVConnCacheObjectSizeGet">“INKVConnCacheObjectSizeGet”</a> for more
-          information on the transformation hooks. You add a transformation
-          hook using <code class="code">INKHttpTxnHookAdd</code>, described in <a href="HTTP_Transactions.html" title="HTTP Transactions">“HTTP Transactions”</a>.</p>
+          information about transformation hooks. You add a transformation
+          hook using <code class="code">INKHttpTxnHookAdd</code>, as described in <a href="HTTP_Transactions.html" title="HTTP Transactions">“HTTP Transactions”</a>.</p>
 </li>
 <li>
-<p>session hooks</p>
+<p><b>Session hooks</b></p>
 <p>An HTTP session starts when a client opens a connection to
           Traffic Server and ends when the connection closes. A session can
-          consist of several transactions. Session hooks allow you to hook
+          consist of several transactions. Session hooks enable you to hook
           your plugin to a particular point in every transaction within a
-          specified session. See <a href="HTTPSessions.html" title="HTTP Sessions">“HTTP Sessions”</a>. Session
-          hooks are added in a manner similar to transaction hooks (you first
+          specified session (see <a href="HTTPSessions.html" title="HTTP Sessions">“HTTP Sessions”</a>). Session
+          hooks are added in a manner similar to transaction hooks (ie, you first
           need a handle to an HTTP session).</p>
 </li>
 <li>
-<p>HTTP select alternate hook</p>
-<p>Alternate selection hooks allow you to hook on to the
+<p><b>HTTP select alternate hook</b></p>
+<p>Alternate selection hooks enable you to hook on to the
           alternate selection state. These hooks must be added globally, since
           Traffic Server does not have a handle to a transaction or session
           when alternate selection is taking place. See <a href="HTTPAlternateSelection.html" title="HTTP Alternate Selection">“HTTP Alternate Selection”</a> for information on the alternate
           selection mechanism.</p>
 </li>
 </ul></div>
-<p>All of the hook addition functions (<a href="HTTPFunctions.html#INKHttpHookAdd" title="INKHttpHookAdd"><code class="code">INKHttpHookAdd</code></a>, <a href="HTTPSessionFunctions.html#INKHttpSsnHookAdd" title="INKHttpSsnHookAdd"><code class="code">INKHttpSsnHookAdd</code></a>, <a href="HTTPSessionFunctions.html#INKHttpSsnReenable" title="INKHttpSsnReenable"><code class="code">INKHttpSsnReenable</code></a>)take
-      an <code class="code">INKHttpHookID</code> identifying the hook to add on to and an
-      <code class="code">INKCont</code> which is the basic callback mechanism in Traffic
-      Server. A single INKCont can be added to any number of hooks at a given
+<p>All of the hook addition functions (<a href="HTTPFunctions.html#INKHttpHookAdd" title="INKHttpHookAdd"><code class="code">INKHttpHookAdd</code></a>, <a href="HTTPSessionFunctions.html#INKHttpSsnHookAdd" title="INKHttpSsnHookAdd"><code class="code">INKHttpSsnHookAdd</code></a>, <a href="HTTPSessionFunctions.html#INKHttpSsnReenable" title="INKHttpSsnReenable"><code class="code">INKHttpSsnReenable</code></a>) take
+       <code class="code">INKHttpHookID</code> (identifies the hook to add on to) and 
+      <code class="code">INKCont</code> (the basic callback mechanism in Traffic
+      Server). A single <code>INKCont</code> can be added to any number of hooks at a 
       time.</p>
 <p>An HTTP hook is identified by the enumerated type
       <code class="code">INKHttpHookID</code>. The values for <code class="code">INKHttpHookID</code>
@@ -112,111 +112,111 @@
 <table frame="box" id="Tbl_INKHttpHookIDValues" rules="all">
 <caption>Table 8.1. INKHttpHookID Values</caption>
 <thead><tr align="center">
-            <th rowspan="1" colspan="1"><span class="bold"><strong>Values for INKHttpHookID</strong></span></th>
+            <th width="287" colspan="1" rowspan="1"><span class="bold"><strong>Values for INKHttpHookID</strong></span></th>
 
-            <th rowspan="1" colspan="1"><span class="bold"><strong>Description</strong></span></th>
+            <th width="659" colspan="1" rowspan="1"><span class="bold"><strong>Description</strong></span></th>
           </tr></thead>
 <tbody>
 <tr>
-            <td rowspan="1" colspan="1">INK_HTTP_READ_REQUEST_HDR_HOOK</td>
+            <td rowspan="1" colspan="1"><code><i>INK_HTTP_READ_REQUEST_HDR_HOOK</i></code></td>
 
             <td rowspan="1" colspan="1">Called immediately after the request header is read from the
             client. Corresponds to the event
             <code class="code">INK_EVENT_HTTP_READ_REQUEST_HDR</code>.</td>
           </tr>
 <tr>
-            <td rowspan="1" colspan="1">INK_HTTP_OS_DNS_HOOK</td>
+            <td rowspan="1" colspan="1"><code><i>INK_HTTP_OS_DNS_HOOK</i></code></td>
 
             <td rowspan="1" colspan="1">Called immediately after the HTTP state machine has completed
             a DNS lookup of the origin server. The HTTP state machine will
-            know the origin server's IP address at this point which is useful
+            know the origin server's IP address at this point, which is useful
             for performing both authentication and blacklisting. Corresponds
             to the event <code class="code">INK_EVENT_HTTP_OS_DNS</code>.</td>
           </tr>
 <tr>
-            <td rowspan="1" colspan="1">INK_HTTP_SEND_REQUEST_HDR_HOOK</td>
+            <td rowspan="1" colspan="1"><code><i>INK_HTTP_SEND_REQUEST_HDR_HOOK</i></code></td>
 
             <td rowspan="1" colspan="1">Called immediately before the proxy's request header is sent
-            to the origin server or the parent proxy. Notice that this hook
-            will not be called if the document is being served from cache.
+            to the origin server or the parent proxy. This hook
+            is not  called if the document is being served from cache.
             This hook is usually used for modifying the proxy's request header
             before it is sent to the origin server or parent proxy.</td>
           </tr>
 <tr>
-            <td rowspan="1" colspan="1">INK_HTTP_READ_CACHE_HDR_HOOK</td>
+            <td rowspan="1" colspan="1"><code><i>INK_HTTP_READ_CACHE_HDR_HOOK</i></code></td>
 
             <td rowspan="1" colspan="1">Called immediately after the request and response header of a
-            previously cached object is read from cache. Notice that this hook
-            will only be called if the document is being served from cache.
+            previously-cached object is read from cache. This hook
+            is only called if the document is being served from cache.
             Corresponds to the event
             <code class="code">INK_EVENT_HTTP_READ_CACHE_HDR</code>.</td>
           </tr>
 <tr>
-            <td rowspan="1" colspan="1">INK_HTTP_READ_RESPONSE_HDR_HOOK</td>
+            <td rowspan="1" colspan="1"><code><i>INK_HTTP_READ_RESPONSE_HDR_HOOK</i></code></td>
 
             <td rowspan="1" colspan="1">Called immediately after the response header is read from the
             origin server or parent proxy. Corresponds to the event
             <code class="code">INK_EVENT_HTTP_READ_RESPONSE_HDR</code>.</td>
           </tr>
 <tr>
-            <td rowspan="1" colspan="1">INK_HTTP_SEND_RESPONSE_HDR_HOOK</td>
+            <td rowspan="1" colspan="1"><code><i>INK_HTTP_SEND_RESPONSE_HDR_HOOK</i></code></td>
 
             <td rowspan="1" colspan="1">Called immediately before the proxy's response header is
-            written to the client. This hook is usually used for modifying the
+            written to the client; this hook is usually used for modifying the
             response header. Corresponds to the event
             <code class="code">INK_EVENT_HTTP_SEND_RESPONSE_HDR</code>.</td>
           </tr>
 <tr>
-            <td rowspan="1" colspan="1">INK_HTTP_REQUEST_TRANSFORM_HOOK</td>
+            <td rowspan="1" colspan="1"><code><i>INK_HTTP_REQUEST_TRANSFORM_HOOK</i></code></td>
 
-            <td rowspan="1" colspan="1">See<a href="HTTPTransformationPlugins.html#Transformations" title="Transformations">“Transformations”</a> for information on the
+            <td rowspan="1" colspan="1">See<a href="HTTPTransformationPlugins.html#Transformations" title="Transformations">“Transformations”</a> for information about 
             transformation hooks.</td>
           </tr>
 <tr>
-            <td rowspan="1" colspan="1">INK_HTTP_RESPONSE_TRANSFORM_HOOK</td>
+            <td rowspan="1" colspan="1"><code><i>INK_HTTP_RESPONSE_TRANSFORM_HOOK</i></code></td>
 
-            <td rowspan="1" colspan="1">See “<a href="HTTPTransformationPlugins.html#Transformations" title="Transformations">“Transformations”</a> for information on the
+            <td rowspan="1" colspan="1">See “<a href="HTTPTransformationPlugins.html#Transformations" title="Transformations">“Transformations”</a> for information about 
             transformation hooks.</td>
           </tr>
 <tr>
-            <td rowspan="1" colspan="1">INK_HTTP_TXN_START_HOOK</td>
+            <td rowspan="1" colspan="1"><code><i>INK_HTTP_TXN_START_HOOK</i></code></td>
 
             <td rowspan="1" colspan="1">Called when an HTTP transaction is started. A transaction
             starts when either a client connects to Traffic Server and data is
-            available on the connection or a previous client connection left
-            open for keep alive has ne w data available.</td>
+            available on the connection, or a previous client connection that was left
+            open for keep alive has new data available.</td>
           </tr>
 <tr>
-            <td rowspan="1" colspan="1">INK_HTTP_TXN_CLOSE_HOOK</td>
+            <td rowspan="1" colspan="1"><code><i>INK_HTTP_TXN_CLOSE_HOOK</i></code></td>
 
             <td rowspan="1" colspan="1">Called when an HTTP transaction ends.</td>
           </tr>
 <tr>
-            <td rowspan="1" colspan="1">INK_HTTP_SELECT_ALT_HOOK</td>
+            <td rowspan="1" colspan="1"><code><i>INK_HTTP_SELECT_ALT_HOOK</i></code></td>
 
             <td rowspan="1" colspan="1">See <a href="HTTPAlternateSelection.html" title="HTTP Alternate Selection">“HTTP Alternate Selection”</a> for information
-            on the alternate selection mechanism.</td>
+            about the alternate selection mechanism.</td>
           </tr>
 <tr>
-            <td rowspan="1" colspan="1">INK_HTTP_SSN_START_HOOK</td>
+            <td rowspan="1" colspan="1"><code><i>INK_HTTP_SSN_START_HOOK</i></code></td>
 
             <td rowspan="1" colspan="1">Called when an HTTP session is started. A session starts when
             a client connects to Traffic Server. You can only add this hook as
             a global hook.</td>
           </tr>
 <tr>
-            <td rowspan="1" colspan="1">INK_HTTP_SSN_CLOSE_HOOK</td>
+            <td rowspan="1" colspan="1"><code><i>INK_HTTP_SSN_CLOSE_HOOK</i></code></td>
 
             <td rowspan="1" colspan="1">Called when an HTTP session ends. A session ends when the
             client connection is closed. You can only add this hook as a
             global hook</td>
           </tr>
 <tr>
-            <td rowspan="1" colspan="1">INK_HTTP_CACHE_LOOKUP_COMPLETE_HOOK</td>
+            <td rowspan="1" colspan="1"><code><i>INK_HTTP_CACHE_LOOKUP_COMPLETE_HOOK</i></code></td>
 
-            <td rowspan="1" colspan="1">Called once the HTTP state machine has commpleted the cache
+            <td rowspan="1" colspan="1">Called after the HTTP state machine has commpleted the cache
             lookup for the document requested in the ongoing transaction.
-            Register this hook either using either
+            Register this hook via  
             <code class="code">INKHttpTxnHookAdd</code> or <code class="code">INKHttpHookAdd</code>.
             Corresponds to the event
             <code class="code">INK_EVENT_HTTP_CACHE_LOOKUP_COMPLETE</code>.</td>



Mime
View raw message