trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mlib...@apache.org
Subject svn commit: r882316 [2/10] - /incubator/trafficserver/site/trunk/docs/sdk/
Date Thu, 19 Nov 2009 21:58:30 GMT
Modified: incubator/trafficserver/site/trunk/docs/sdk/HTTPTransactionFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTPTransactionFunctions.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTPTransactionFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTPTransactionFunctions.html Thu Nov 19 21:58:27 2009
@@ -1,64 +1,64 @@
 <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>HTTP Transaction Functions</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="HTTPFunctions.html" title="HTTP Functions">
-<link rel="prev" href="HTTPSessionFunctions.html" title="Session Functions">
-<link rel="next" href="InitiateConnectionFunctions.html" title="Initiate Connection">
-<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="HTTPTransactionFunctions.html#INKHttpTxnCacheLookupStatusGet" title="INKHttpTxnCacheLookupStatusGet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnCachedReqGet" title="INKHttpTxnCachedReqGet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnCachedRespGet" title="INKHttpTxnCachedRespGet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnClientIncomingPortGet" title="INKHttpTxnClientIncomingPortGet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnClientIPGet" title="INKHttpTxnClientIPGet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnClientRemotePortGet" title="INKHttpTxnClientRemotePortGet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnClientReqGet" title="INKHttpTxnClientReqGet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnClientRespGet" title="INKHttpTxnClientRespGet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnErrorBodySet" title="INKHttpTxnErrorBodySet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnHookAdd" title="INKHttpTxnHookAdd">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnNextHopIPGet" title="INKHttpTxnNextHopIPGet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnParentProxyGet" title="INKHttpTxnParentProxyGet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnParentProxySet" title="INKHttpTxnParentProxySet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnReenable" title="INKHttpTxnReenable">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnServerIPGet" title="INKHttpTxnServerIPGet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnServerReqGet" title="INKHttpTxnServerReqGet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnServerRespGet" title="INKHttpTxnServerRespGet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnSsnGet" title="INKHttpTxnSsnGet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnTransformedRespCache" title="INKHttpTxnTransformedRespCache">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnTransformRespGet" title="INKHttpTxnTransformRespGet">
-<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnUntransformedRespCache" title="INKHttpTxnUntransformedRespCache">
+<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="HTTPFunctions.html" title="HTTP Functions" />
+<link rel="prev" href="HTTPSessionFunctions.html" title="Session Functions" />
+<link rel="next" href="InitiateConnectionFunctions.html" title="Initiate Connection" />
+<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="HTTPTransactionFunctions.html#INKHttpTxnCacheLookupStatusGet" title="INKHttpTxnCacheLookupStatusGet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnCachedReqGet" title="INKHttpTxnCachedReqGet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnCachedRespGet" title="INKHttpTxnCachedRespGet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnClientIncomingPortGet" title="INKHttpTxnClientIncomingPortGet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnClientIPGet" title="INKHttpTxnClientIPGet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnClientRemotePortGet" title="INKHttpTxnClientRemotePortGet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnClientReqGet" title="INKHttpTxnClientReqGet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnClientRespGet" title="INKHttpTxnClientRespGet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnErrorBodySet" title="INKHttpTxnErrorBodySet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnHookAdd" title="INKHttpTxnHookAdd" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnNextHopIPGet" title="INKHttpTxnNextHopIPGet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnParentProxyGet" title="INKHttpTxnParentProxyGet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnParentProxySet" title="INKHttpTxnParentProxySet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnReenable" title="INKHttpTxnReenable" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnServerIPGet" title="INKHttpTxnServerIPGet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnServerReqGet" title="INKHttpTxnServerReqGet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnServerRespGet" title="INKHttpTxnServerRespGet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnSsnGet" title="INKHttpTxnSsnGet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnTransformedRespCache" title="INKHttpTxnTransformedRespCache" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnTransformRespGet" title="INKHttpTxnTransformRespGet" />
+<link rel="subsection" href="HTTPTransactionFunctions.html#INKHttpTxnUntransformedRespCache" title="INKHttpTxnUntransformedRespCache" />
 <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>
@@ -66,7 +66,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">
@@ -82,52 +82,56 @@
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKHttpTxnCacheLookupStatusGet"></a>INKHttpTxnCacheLookupStatusGet</h4></div></div></div>
 <p>Stores the current cache lookup status for the ongoing
-          transaction. Also stores the number of cache lookup operations
+          transaction; also stores the number of cache lookup operations
           already performed.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
-<dd><p><code class="code">INKReturnCode INKHttpTxnCacheLookupStatusGet
-                (INKHttpTxn <em class="replaceable"><code>txnp</code></em>, int
-                *<em class="replaceable"><code>lookup_status</code></em>)</code></p></dd>
-<dt><span class="term">Arguments</span></dt>
-<dd>
-<p>INKHttpTxn txnp is the ongoing transaction.</p>
-<p>int *lookup_status is set to the lookup status.</p>
-</dd>
-<dt><span class="term">Description</span></dt>
-<dd>
-<p>Obtains the status of the current cache lookup for the
-                ongoing transaction
-                <code class="code"><em class="replaceable"><code>txnp</code></em></code> in the
-                <code class="code"><em class="replaceable"><code>lookup_status</code></em></code>
-                variable.</p>
-<p>This function should only be called from
-                <code class="code">INK_HTTP_CACHE_LOOKUP_COMPLETE_HOOK</code>.</p>
-<p>The possible status values returned in
-                <code class="code"><em class="replaceable"><code>lookup_status</code></em></code>
-                are:</p>
-<p><code class="code">INK_CACHE_LOOKUP_MISS</code> - Document was not in
-                the cache. It will be fetched from the OS.</p>
-<p><code class="code">INK_CACHE_LOOKUP_HIT_STALE</code> - Document was
-                present in the cache but stale. A fresher version will be
-                fetched from the OS (IMS request).</p>
-<p><code class="code">INK_CACHE_LOOKUP_HIT_FRESH</code> - Document was
-                present in the cache and is fresh. Document will be served
-                from the cache.</p>
-<p><code class="code">INK_CACHE_LOOKUP_SKIPPED</code> - Traffic Server
-                didn't perform a cache lookup as the request was not cacheable
-                (url looks dynamic or request marked as noncacheable).</p>
-</dd>
-<dt><span class="term">Returns</span></dt>
-<dd>
-<p><code class="code">INK_SUCCESS</code> if the API is called
-                successfully.</p>
-<p><code class="code">INK_ERROR</code> if an error occurs while calling
-                the API or if an argument is invalid.</p>
-</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 5.2</p></dd>
-</dl></div>
+  <dt><span class="term"><b>Prototype</b></span></dt>
+  <dd><p><code class="code">INKReturnCode INKHttpTxnCacheLookupStatusGet
+    (INKHttpTxn <em class="replaceable"><code>txnp</code></em>, int
+    *<em class="replaceable"><code>lookup_status</code></em>)</code></p></dd>
+  <dt><span class="term"><b>Arguments</b></span></dt>
+  <dd>
+  <p><code>INKHttpTxn <i>txnp </i></code> is the ongoing transaction.</p>
+  <p><code>int <i>*lookup_status </i></code> is set to the lookup status.</p>
+  </dd>
+  <dt><span class="term"><b>Description</b></span></dt>
+  <dd>
+  <p>Obtains the status of the current cache lookup for the
+    ongoing transaction
+    <code class="code"><em class="replaceable"><code>txnp </code></em></code> in the
+    <code class="code"><em class="replaceable"><code>lookup_status </code></em></code>
+    variable.</p>
+  <p>This function should only be called from
+    <code class="code">INK_HTTP_CACHE_LOOKUP_COMPLETE_HOOK</code>.</p>
+  <p>The possible status values returned in
+    <code class="code"><em class="replaceable"><code>lookup_status </code></em></code>
+    are:
+  <ul>
+    <li><code class="code">INK_CACHE_LOOKUP_MISS</code> - Document was not in
+      the cache; it will be fetched from the OS.</li>
+    <li><code class="code">INK_CACHE_LOOKUP_HIT_STALE</code> - Document was
+      present in the cache but stale. A fresher version will be
+      fetched from the OS (IMS request).</li>
+    <li><code class="code">INK_CACHE_LOOKUP_HIT_FRESH</code> - Document was
+      present in the cache and is fresh. Document will be served
+      from the cache.</li>
+    <li><code class="code">INK_CACHE_LOOKUP_SKIPPED</code> - Traffic Server
+      didn't perform a cache lookup as the request was not cacheable
+      (this can happen when the URL looks dynamic or the request is marked as noncacheable).</li>
+  </ul>
+  </dd>
+</dl>
+  </p>
+  <dl>
+  <dt><span class="term"><b>Returns</b></span></dt>
+  <dd>
+    <p><code class="code">INK_SUCCESS</code> if the API is called
+      successfully.</p>
+    <p><code class="code">INK_ERROR</code> if an error occurs while calling
+      the API or if an argument is invalid.</p>
+  </dd>
+  </dl>
+</div>
 </div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
@@ -135,50 +139,52 @@
 <p>Gets the cached request header for a specified HTTP
           transaction.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">INKReturnCode INKHttpTxnCachedReqGet (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>, INKMBuffer
                 *<em class="replaceable"><code>bufp</code></em>, INKMLoc
                 *<em class="replaceable"><code>hdr_loc</code></em>) </code></p></dd>
-<dt><span class="term">Arguments</span></dt>
+<dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
 <p><code class="code">INKHttpTxn</code>
-                <code class="code"><em class="replaceable"><code>txnp</code></em></code> is the ongoing
+                <code class="code"><em class="replaceable"><code>txnp </code></em></code> is the ongoing
                 transaction.</p>
 <p><code class="code">int *</code><code class="code">lookup_status</code> is set to
                 the lookup status.</p>
 </dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Obtains the status of the current cache lookup for the
                 ongoing transaction
-                <code class="code"><em class="replaceable"><code>txnp</code></em></code> in the
-                <code class="code">lookup_status</code> variable.</p>
+                <code class="code"><em class="replaceable"><code>txnp </code></em></code> in the
+                <code class="code"><i>lookup_status </i></code> variable.</p>
 <p>This function should only be called from
                 <code class="code">INK_HTTP_CACHE_LOOKUP_COMPLETE_HOOK</code>.</p>
 <p>The possible status values returned in
                 <code class="code">lookup_status</code> are:</p>
-<p><code class="code">INK_CACHE_LOOKUP_MISS</code> - Document was not in
-                the cache. It will be fetched from the OS.</p>
-<p><code class="code">INK_CACHE_LOOKUP_HIT_STALE</code> - Document was
+                <ul>
+                <li>
+<code class="code">INK_CACHE_LOOKUP_MISS</code> - Document was not in
+                the cache; it will be fetched from the OS.</li>
+<li><code class="code">INK_CACHE_LOOKUP_HIT_STALE</code> - Document was
                 present in the cache but stale. A fresher version will be
-                fetched from the OS (IMS request).</p>
-<p><code class="code">INK_CACHE_LOOKUP_HIT_FRESH</code> - Document was
+                fetched from the OS (IMS request).</li>
+<li><code class="code">INK_CACHE_LOOKUP_HIT_FRESH</code> - Document was
                 present in the cache and is fresh. Document will be served
-                from the cache.</p>
-<p><code class="code">INK_CACHE_LOOKUP_SKIPPED</code> - Traffic Server
-                didn't perform a cache lookup as the request was not cacheable
-                (url looks dynamic or request marked as noncacheable).</p>
+                from the cache.</li>
+<li><code class="code">INK_CACHE_LOOKUP_SKIPPED</code> - Traffic Server
+                didn't perform a cache lookup because the request was not cacheable
+                (this can happen when the URL looks dynamic or the request is marked as noncacheable).</li>
+</p>
+                </ul>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the API is called
                 successfully.</p>
 <p><code class="code">INK_ERROR</code> if an error occurs while calling
                 the API or if an argument is invalid.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 5.2</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
@@ -187,38 +193,35 @@
 <p>Gets the cached response header for a specified HTTP
           transaction.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">int INKHttpTxnCachedRespGet (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>, INKMBuffer
                 *<em class="replaceable"><code>bufp</code></em>, INKMLoc
                 *<em class="replaceable"><code>hdr_loc</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Retrieves the cached response header from the HTTP
-                transaction <code class="code"><em class="replaceable"><code>txnp</code></em></code> and
-                stores the cached response header in bufp, at location
-                <code class="code"><em class="replaceable"><code>hdr_loc</code></em></code>.</p>
+                transaction <code class="code"><em class="replaceable"><code>txnp </code></em></code> and
+                stores the cached response header in <code>bufp</code>, at location <code class="code"><em class="replaceable"><code>hdr_loc</code></em></code>.</p>
 <p>Call after <code class="code">SEND_RESPONSE_HDR_HOOK</code>.</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>Do not modify any cached response headers returned by
-                  <code class="function">INKHttpTxnCachedRespGet</code>. The underlying
+                  <code class="function">INKHttpTxnCachedRespGet</code>; the underlying
                   data structure is read-only. Release the returned
-                  <code class="code"><em class="replaceable"><code>hdr_loc</code></em></code> with a call
+                  <code class="code"><em class="replaceable"><code>hdr_loc </code></em></code> with a call
                   to <code class="function">INKHandleMLocRelease</code>.</p></td></tr>
 </table></div>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>If the cached response header does not exist, then
                 <code class="function">INKHttpTxnCachedRespGet</code> returns 0.</p>
-<p>Otherwise returns 1.</p>
+<p>Otherwise, returns 1.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
@@ -227,24 +230,22 @@
 <p>Gets the port on which the incoming request is
           received.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">int INKHttpTxnClientIncomingPortGet (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Returns the port on which the HTTP transaction
-                <code class="code"><em class="replaceable"><code>txnp</code></em></code> was received.
-                This is not the destination port in the URL. It is the proxy
+                <code class="code"><em class="replaceable"><code>txnp </code></em></code> was received.
+                This is not the destination port in the UR; it is the proxy
                 port to which the client browser is pointed.</p>
 <p>Call after <code class="code">TXN_START_HOOK</code>.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>The port number in host byte order.</p>
 <p>Returns -1 if an error occurred.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.5</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
@@ -253,10 +254,10 @@
 <p>Gets the client IP address for a specified HTTP
           transaction.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">unsigned int INKHttpTxnClientIPGet (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Returns the IP address of the client for the HTTP
                 transaction
@@ -265,13 +266,11 @@
                 IP address in network byte order.</p>
 <p>Call after <code class="code">TXN_START_HOOK</code>.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>The client IP address.</p>
 <p>Returns 0 if an error occurred.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
@@ -280,31 +279,31 @@
 <p>Gets the remote host’s port number for a specified HTTP
           transaction.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">INKReturnCode
                 INKHttpTxnClientRemotePortGet(INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>, int
                 *<em class="replaceable"><code>port</code></em>)</code></p></dd>
-<dt><span class="term">Arguments</span></dt>
+<dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
 <p><code class="code">INKHttpTxn</code>
-                <code class="code"><code class="code"><em class="replaceable"><code>txnp</code></em></code></code> is
+                <code class="code"><code class="code"><em class="replaceable"><code>txnp </code></em></code></code> is
                 an HTTP transaction.</p>
 <p><code class="code">int
-                *</code><code class="code"><em class="replaceable"><code>port</code></em></code> is set to
+                *</code><code class="code"><em class="replaceable"><code>port </code></em></code> is set to
                 the client’s remote port value (port number used by the client
                 when creating a socket connection with the proxy for the
                 transaction <code class="code"><em class="replaceable"><code>txnp</code></em></code>) in
                 network byte order.</p>
 </dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Obtains the port number of the remote host for the
                 specified HTTP transaction. The port number is returned in
                 network byte order.</p>
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
 <tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png"></td>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
 <th align="left">Note</th>
 </tr>
 <tr><td align="left" valign="top"><p>This is an exception to the rule that port numbers are
@@ -314,15 +313,13 @@
                 be retrieved using
                 <code class="function">INKHttpTxnClientIncomingPortGet</code>.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the API is called
                 successfully.</p>
 <p><code class="code">INK_ERROR</code> if an error occurs while calling
                 the API or if an argument is invalid.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 5.2</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
@@ -331,10 +328,10 @@
 <p>Gets the client request header for a specified HTTP
           transaction.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">int INKHttpTxnClientReqGet (INKHttpTxn txnp,
                 INKMBuffer *bufp, INKMLoc *hdr_loc) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Retrieves the client request header from the HTTP
                 transaction <code class="code"><em class="replaceable"><code>txnp</code></em></code>.
@@ -344,19 +341,18 @@
                 <code class="code"><em class="replaceable"><code>hdr_loc</code></em></code>.</p>
 <p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
 <p>Release the returned
-                <code class="code"><em class="replaceable"><code>hdr_loc</code></em></code> with a call to
+                <code class="code"><em class="replaceable"><code>hdr_loc </code></em></code> with a call to
                 <code class="function">INKHandleMLocRelease</code>.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>If the client request header does not exist or in case
                 of an error, then <code class="function">INKHttpTxnClientReqGet</code>
                 returns 0.</p>
-<p>Otherwise returns 1.</p>
+<p>Otherwise, returns 1.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
-</dl></div>
+</dl>
+</div>
 </div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
@@ -364,12 +360,12 @@
 <p>Gets the client response header for a specified HTTP
           transaction.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">int INKHttpTxnClientRespGet (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>, INKMBuffer
                 *<em class="replaceable"><code>bufp</code></em>, INKMLoc
                 *<em class="replaceable"><code>hdr_loc</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Retrieves the client response header from the HTTP
                 transaction <code class="code"><em class="replaceable"><code>txnp</code></em></code>.
@@ -379,18 +375,15 @@
                 <code class="code"><em class="replaceable"><code>hdr_loc</code></em></code>.</p>
 <p>Call after <code class="code">SEND_RESPONSE_HOOK</code>.</p>
 <p>Release the returned
-                <code class="code"><em class="replaceable"><code>hdr_loc</code></em></code> with a call to
+                <code class="code"><em class="replaceable"><code>hdr_loc </code></em></code> with a call to
                 <code class="function">INKHandleMLocRelease</code>.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p>If the client response header does not exist or in the
-                case of an error, then
+<p>If the client response header does not exist or if there is an error, then
                 <code class="function">INKHttpTxnClientRespGet</code> returns 0.</p>
-<p>Otherwise returns 1.</p>
+<p>Otherwise, returns 1.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
@@ -399,73 +392,71 @@
 <p>Sets the format and content of the error body (or response
           data) that Traffic Server sends to clients.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">INKReturnCode INKHttpTxnErrorBodySet (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>, char
                 *<em class="replaceable"><code>buf</code></em>, int
                 <em class="replaceable"><code>buflength</code></em>, char
                 *<em class="replaceable"><code>mimetype</code></em>)</code></p></dd>
-<dt><span class="term">Arguments</span></dt>
+<dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
-<p><code class="code"><em class="replaceable"><code>txnp</code></em></code> is the HTTP
+<p><code class="code"><em class="replaceable"><code>txnp </code></em></code> is the HTTP
                 transaction to act upon.</p>
-<p><code class="code"><em class="replaceable"><code>buf</code></em></code> contains the
+<p><code class="code"><em class="replaceable"><code>buf </code></em></code> contains the
                 error (or response) body. The error body can be text, an HTML
                 document, image, or another format. Before you call
-                <code class="function">INKHttpTxnErrorBodySet</code>, be sure to
-                allocate <code class="code"><em class="replaceable"><code>buf</code></em></code> using
+                <code class="function">INKHttpTxnErrorBodySet,</code> be sure to
+                allocate <code class="code"><em class="replaceable"><code>buf </code></em></code> using
                 <code class="function">INKmalloc</code>.</p>
-<p><code class="code"><em class="replaceable"><code>buflength</code></em></code> is the
+<p><code class="code"><em class="replaceable"><code>buflength </code></em></code> is the
                 length of the error body.</p>
-<p><code class="code"><em class="replaceable"><code>mimetype</code></em></code>
+<p><code class="code"><em class="replaceable"><code>mimetype </code></em></code>
                 contains the format of the error body. If you want to set the
-                <code class="code"><em class="replaceable"><code>mimetype</code></em></code> to a value
-                other than <code class="code">NULL</code>, you must allocate
-                <code class="code"><em class="replaceable"><code>mimetype</code></em></code> using
+                <code class="code"><em class="replaceable"><code>mimetype </code></em></code> to a value
+                other than <code class="code">NULL</code>, then you must allocate
+                <code class="code"><em class="replaceable"><code>mimetype </code></em></code> using
                 <code class="function">INKmalloc</code> before you call
                 <code class="function">INKHttpTxnErrorBodySet</code>.</p>
 </dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>Sets the format of the error body that Traffic Server
+<p>Sets the format of the error body  Traffic Server
                 sends back when sending an error or response to a client. The
                 error body data is stored in the buffer
                 <code class="code"><em class="replaceable"><code>buf</code></em></code>. If the error body
-                is just plain text, setting mimetype to <code class="code">NULL</code>
-                works fine. If the error body is HTML then
-                <code class="code"><em class="replaceable"><code>mimetype</code></em></code> should be
-                "<code class="code">text/html</code>". If the error body is a JPEG image
-                then <code class="code"><em class="replaceable"><code>mimetype</code></em></code> should
-                be “image/jpeg".</p>
+                is just plain text, then setting mimetype to <code class="code">NULL</code>
+                works fine. If the error body is HTML, then
+                <code class="code"><em class="replaceable"><code>mimetype </code></em></code> should be
+                "<code class="code">text/html</code>". If the error body is a JPEG image,
+                then <code class="code"><em class="replaceable"><code>mimetype </code></em></code> should
+                be “<code>image/jpeg</code>".</p>
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
 <tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png"></td>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
 <th align="left">Note</th>
 </tr>
 <tr><td align="left" valign="top"><p>Traffic Server automatically calls
-                  <code class="function">INKfree</code> to free buf when
-                  <code class="code"><em class="replaceable"><code>buf</code></em></code> is no longer
+                  <code class="function">INKfree</code> to free   
+                  <code class="code"><em class="replaceable"><code>buf  </code></em></code> when it is no longer
                   needed; make sure that the buffer
-                  <code class="code"><em class="replaceable"><code>buf</code></em></code> is allocated by
+                  <code class="code"><em class="replaceable"><code>buf </code></em></code> is allocated by
                   a call to <code class="function">INKmalloc</code>. Similarly, if you
-                  want to set <code class="code"><em class="replaceable"><code>mimetype</code></em></code>
-                  to something other than <code class="code">NULL</code>, make sure that
+                  want to set <code class="code"><em class="replaceable"><code>mimetype </code></em></code>
+                  to something other than <code class="code">NULL</code>, then make sure that
                   you allocate
-                  <code class="code"><em class="replaceable"><code>mimetype</code></em></code> with a call
+                  <code class="code"><em class="replaceable"><code>mimetype </code></em></code> with a call
                   to <code class="function">INKmalloc</code>. Traffic Server
                   automatically calls <code class="function">INKfree</code> to free
                   <code class="code"><em class="replaceable"><code>mimetype</code></em></code>.</p></td></tr>
 </table></div>
 <p>Call after <code class="code">SEND_RESPONSE_HDR_HOOK</code>.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the operation completes
                 successfully.</p>
 <p><code class="code">INK_ERROR</code> if an error occurs.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
@@ -474,31 +465,29 @@
 <p>Adds a continuation to the list of HTTP transaction hooks for
           a specified HTTP transaction.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">INKReturnCode INKHttpTxnHookAdd (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>, INKHttpHookID
                 <em class="replaceable"><code>id</code></em>, INKCont
                 <em class="replaceable"><code>contp</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>Adds <code class="code"><em class="replaceable"><code>contp</code></em></code> to
+<p>Adds <code class="code"><em class="replaceable"><code>contp </code></em></code> to
                 the end of the list of HTTP transaction hooks specified by
                 <code class="code"><em class="replaceable"><code>id</code></em></code>. Since
-                <code class="code"><em class="replaceable"><code>contp</code></em></code> is added to a
+                <code class="code"><em class="replaceable"><code>contp </code></em></code> is added to a
                 transaction, it is not possible to call
                 <code class="function">INKHttpTxnHookAdd</code> from the plugin
-                initialization routine but only when the plugin has a handle
+                initialization routine unless the plugin has a handle
                 to an HTTP transaction.</p>
 <p>Call after <code class="code">HTTP_TXN_START_HOOK</code>.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the operation completes
                 successfully.</p>
 <p><code class="code">INK_ERROR</code> if an error occurs.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
@@ -507,10 +496,10 @@
 <p>Gets the IP address of the next server from which Traffic
           Server tries to retrieve requested HTTP content.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">unsigned int INKHttpTxnNextHopIPGet (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Returns the IP address of the next server from which
                 Traffic Server attempts to retrieve the requested document, in
@@ -519,15 +508,13 @@
                 address.</p>
 <p>Call after <code class="code">SEND_REQUEST_HDR_HOOK</code>.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>Returns the IP address of the next server from which
                 Traffic Server attempts to retrieve the request, in network
                 byte order.</p>
 <p>Returns 0 if an error occurred.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
@@ -536,40 +523,38 @@
 <p>Gets the parent proxy name and port, if parent proxying is
           enabled.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">INKReturnCode INKHttpTxnParentProxyGet (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>, char
                 **<em class="replaceable"><code>hostname</code></em>, int
                 *<em class="replaceable"><code>port</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Retrieves the value set previously by
                 <code class="function">INKHttpParentProxySet</code>. Does not return
-                values set in <code class="filename">records.config</code> parameter
-                <em class="parameter"><code>proxy.config.http.parent_proxies</code></em> or in
-                <code class="filename">parent.config</code> file.</p>
+                values set in
+                <code class="filename">parent.config</code> file or in <code class="filename">records.config</code> for the 
+                <code><i>proxy.config.http.parent_proxies </i></code>parameter.</p>
 <p>This function can be called from within any
                 <code class="code">txn</code> hook.</p>
-<p>The <code class="code">hostname</code> string returned must not be
+<p>The <code class="code"><i>hostname </i></code> string returned must not be
                 deallocated.</p>
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
 <tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png"></td>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
 <th align="left">Note</th>
 </tr>
-<tr><td align="left" valign="top"><p>If parent proxying is not enabled,
+<tr><td align="left" valign="top"><p>If parent proxying is not enabled, then
                   <code class="function">INKHttpTxnParentProxyGet</code> returns
-                  <code class="code">NULL</code> in hostname and -1 in port.</p></td></tr>
+                  <code class="code">NULL</code> for <code><i>hostname </i></code> and <code>-1</code> for <code><i>port</i></code>.</p></td></tr>
 </table></div>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the operation completes
                 successfully.</p>
 <p><code class="code">INK_ERROR</code> if an error occurs.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
@@ -577,92 +562,91 @@
 <a name="INKHttpTxnParentProxySet"></a>INKHttpTxnParentProxySet</h4></div></div></div>
 <p>Sets the parent proxy name and port.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">INKReturnCode INKHttpTxnParentProxySet (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>, char
                 *<em class="replaceable"><code>hostname</code></em>, int
                 <em class="replaceable"><code>port</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>This can be used to overwrite the value set in
-                <code class="filename">records.config</code> parameter
-                <em class="parameter"><code>proxy.config.http.parent_proxies</code></em> or in
+                <code class="filename">records.config</code> for the parameter
+                <code><i>proxy.config.http.parent_proxies, </i></code> or in the
                 <code class="filename">parent.config</code> file.</p>
 <p>Call before or within
                 <code class="code">CACHE_LOOKUP_COMPLETE</code>.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the operation completes
                 successfully.</p>
 <p><code class="code">INK_ERROR</code> if an error occurs.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKHttpTxnReenable"></a>INKHttpTxnReenable</h4></div></div></div>
-<p>Tells a transaction whether or not the processing of a
+<p>Tells a transaction if the processing of a
           particular hook has completed.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">INKReturnCode INKHttpTxnReenable (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>, INKEvent
                 <em class="replaceable"><code>event</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
-<dd>
-<p>Notifies the HTTP transaction txnp that the plugin is
-                done processing the current hook. If
-                <code class="code">INK_EVENT_HTTP_CONTINUE</code> is specified for
-                <code class="code"><em class="replaceable"><code>event</code></em></code>, then the plugin
-                wants the transaction to continue. If
-                <code class="code">INK_EVENT_HTTP_ERROR</code> is specified for
-                <code class="code"><em class="replaceable"><code>event</code></em></code>, then the plugin
-                wants the transaction to be terminated and for an error to be
-                sent back to the client if no response has already been
-                sent.</p>
-<p>You must always re-enable the HTTP transaction after the
-                processing of each transaction event. However, never re-enable
-                twice. Re-enabling twice is a serious error.</p>
-<p>When event is set to <code class="code">INK_EVENT_HTTP_ERROR</code>,
-                Traffic Server performs different processing depending on the
-                type of hook involved.</p>
-<p><code class="code">INK_HTTP_TXN_START_HOOK</code>: The transaction is
-                stopped right away, the connection to the client is closed,
-                and no response is sent back to the origin server.</p>
-<p><code class="code">INK_HTTP_READ_REQUEST_HDR_HOOK</code>: Traffic
-                Server does not send any request to the origin server, it
-                directly sends a 500 to the client.</p>
-<p><code class="code">INK_HTTP_SEND_REQUEST_HDR_HOOK</code>: Traffic
-                Server opens a connection to the origin server, sends an empty
-                request to the origin server, and sends back 500 to the
-                client. Then the connection to the origin server is
-                closed.</p>
-<p><code class="code">INK_HTTP_READ_RESPONSE_HDR_HOOK</code>,
-                <code class="code">INK_HTTP_SEND_RESPONSE_HOOK</code>,
-                <code class="code">INK_HTTP_OS_DNS_HOOK</code>,
-                <code class="code">INK_HTTP_READ_CACHE_HDR_HOOK</code>, and
-                <code class="code">INK_HTTP_CACHE_LOOKUP_COMPLETE_HOOK</code>: Traffic
-                Server receives all the headers of the response from the
-                origin server, then closes the connection to the origin server
-                and sends a 500 to the client. TS does not receive the
-                response body.</p>
-<p><code class="code">INK_HTTP_TXN_CLOSE_HOOK</code>: The client
-                receives whatever answer was sent by the origin server because
-                with this hook, the response has already been sent to the
-                client.</p>
-</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p><code class="code">INK_SUCCESS</code> if the operation completes
-                successfully.</p>
-<p><code class="code">INK_ERROR</code> if an error occurs.</p>
-</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
-</dl></div>
+  <p>Notifies the HTTP transaction <code><i>txnp </i></code> that the plugin is
+    finished processing the current hook. If <code class="code">INK_EVENT_HTTP_CONTINUE</code> is specified for
+    <code class="code"><em class="replaceable"><code>event</code></em></code>, then the plugin
+    wants the transaction to continue. If
+    <code class="code">INK_EVENT_HTTP_ERROR</code> is specified for
+    <code class="code"><em class="replaceable"><code>event</code></em></code>, then the plugin
+    wants the transaction to be terminated; an error is then 
+    sent back to the client if no response has already been
+    sent.</p>
+  <p>You must always reenable the HTTP transaction after 
+      each transaction event is processed. However, you should never reenable
+    twice - this is a serious error.</p>
+  <p>When event is set to <code class="code">INK_EVENT_HTTP_ERROR</code>,
+    Traffic Server performs different processing depending on the
+    type of hook involved.</p>
+  <ul>
+    <li><code class="code">INK_HTTP_TXN_START_HOOK</code>: The transaction is
+      stopped right away, then the client connection  is closed
+      and no response is sent back to the origin server.</li>
+    <li><code class="code">INK_HTTP_READ_REQUEST_HDR_HOOK</code>: Traffic
+      Server does not send a request to the origin server; it
+      directly sends a 500 to the client.</li>
+    <li><code class="code">INK_HTTP_SEND_REQUEST_HDR_HOOK</code>: Traffic
+      Server opens a connection to the origin server, sends an empty
+      request to it, and sends a <code>500</code> status message back to the
+      client. The connection to the origin server is
+      then closed.</li>
+    <li><code class="code">INK_HTTP_READ_RESPONSE_HDR_HOOK</code>,
+      <code class="code">INK_HTTP_SEND_RESPONSE_HOOK</code>,
+      <code class="code">INK_HTTP_OS_DNS_HOOK</code>,
+      <code class="code">INK_HTTP_READ_CACHE_HDR_HOOK</code>, and
+      <code class="code">INK_HTTP_CACHE_LOOKUP_COMPLETE_HOOK</code>: Traffic
+      Server receives all  headers in the origin server's response,  closes the connection to the origin server,
+      and sends a <code>500</code> status message back to the client. Traffic Server does not receive the
+      response body.</li>
+    <li><code class="code">INK_HTTP_TXN_CLOSE_HOOK</code>: The client
+      receives whatever answer was sent by the origin server because
+      with this hook, the response has already been sent to the
+      client.</li>
+  </ul>
+</dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+</dl>
+  <dl>
+  <dd>
+    <p><code class="code">INK_SUCCESS</code> if the operation completes
+      successfully.</p>
+    <p><code class="code">INK_ERROR</code> if an error occurs.</p>
+  </dd>
+  </dl>
+</div>
 </div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
@@ -670,10 +654,10 @@
 <p>Gets the origin server IP address for a specified HTTP
           transaction.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">unsigned int INKHttpTxnServerIPGet (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Returns the IP address of the origin server specified by
                 the client request in network byte order.
@@ -682,14 +666,12 @@
                 transaction.</p>
 <p>Call after <code class="code">INK_HTTP_OS_DNS_HOOK</code>.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>Returns the origin server IP address in network byte
                 order.</p>
 <p>Returns 0 if an error occurred.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
@@ -698,12 +680,12 @@
 <p>Gets the server request header from a specified HTTP
           transaction.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">int INKHttpTxnServerReqGet (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>, INKMBuffer
                 *<em class="replaceable"><code>bufp</code></em>, INKMLoc
                 *<em class="replaceable"><code>hdr_loc</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Retrieves the server request header from the HTTP
                 transaction <code class="code"><em class="replaceable"><code>txnp</code></em></code>.
@@ -713,18 +695,16 @@
                 <code class="code"><em class="replaceable"><code>hdr_loc</code></em></code>.</p>
 <p>Call after <code class="code">SEND_REQUEST_HDR_HOOK</code>.</p>
 <p>Release the returned
-                <code class="code"><em class="replaceable"><code>hdr_loc</code></em></code> with a call to
+                <code class="code"><em class="replaceable"><code>hdr_loc </code></em></code> with a call to
                 <code class="function">INKHandleMLocRelease</code>.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>If the server request header does not exist or in the
                 case of an error, then
                 <code class="function">INKHttpTxnServerReqGet</code> returns 0.</p>
-<p>Otherwise returns 1.</p>
+<p>Otherwise, returns 1.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
@@ -733,12 +713,12 @@
 <p>Gets the server response header from a specified HTTP
           transaction.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">int INKHttpTxnServerRespGet (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>, INKMBuffer
                 *<em class="replaceable"><code>bufp</code></em>, INKMLoc
                 *<em class="replaceable"><code>hdr_loc</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Retrieves the server response header from the HTTP
                 transaction <code class="code"><em class="replaceable"><code>txnp</code></em></code>.
@@ -748,93 +728,86 @@
                 <code class="code"><em class="replaceable"><code>hdr_loc</code></em></code>.</p>
 <p>Call after <code class="code">READ_RESPONSE_HDR_HOOK</code>.</p>
 <p>Release the returned
-                <code class="code"><em class="replaceable"><code>hdr_loc</code></em></code> with a call to
+                <code class="code"><em class="replaceable"><code>hdr_loc </code></em></code> with a call to
                 <code class="function">INKHandleMLocRelease</code>.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p>If the server response header does not exist or in the
-                case of an error, then
+<p>If the server response header does not exist or if there
+                is an error, then
                 <code class="function">INKHttpTxnServerRespGet</code> returns 0.</p>
-<p>Otherwise returns 1.</p>
+<p>Otherwise, returns 1.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKHttpTxnSsnGet"></a>INKHttpTxnSsnGet</h4></div></div></div>
-<p>Returns the session handle associated to a specified HTTP
+<p>Returns the session handle associated with a specific HTTP
           transaction.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">INKHttpSsn INKHttpTxnSsnGet (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Retrieves the <code class="function">INKHttpSsn</code> handle
                 associated with the HTTP transaction
                 <code class="code"><em class="replaceable"><code>txnp</code></em></code>.</p>
 <p>Call after <code class="code">TXN_START_HOOK</code>.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>The session handle associated with the specified HTTP
                 transaction.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKHttpTxnTransformedRespCache"></a>INKHttpTxnTransformedRespCache</h4></div></div></div>
-<p>Indicates whether or not Traffic Server writes transformed
+<p>Indicates whether Traffic Server writes transformed
           documents to the cache.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">INKReturnCode INKHttpTxnTransformedRespCache
                 (INKHttpTxn <em class="replaceable"><code>txnp</code></em>, int
                 <em class="replaceable"><code>on</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Specifies whether the transformed document should be
-                written to the cache or not. If a transformation is occurring
+                written to the cache. If a transformation is occurring, then
                 the default is for the transformed copy to be written to the
                 cache. The default maintains a rule that only a single version
-                of a document will be written to the cache for a single
-                transaction. It is valid for that rule to be broken by
-                specifying that both the transformed and the un-transformed
+                of a document is written to the cache for a single
+                transaction. It is valid for that rule to be broken if you 
+                specify that both the transformed and  untransformed
                 documents be written to the cache. Calls need to be made prior
                 to the actual transformation, (i.e. at the time of creating
                 the transformation) rather than in the transformation.</p>
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
 <tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png"></td>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
 <th align="left">Note</th>
 </tr>
-<tr><td align="left" valign="top"><p>This function does not overwrite HTTP directives, like
-                  <code class="code">Cache-Control</code> or <code class="code">Expire</code>, that
-                  determine whether or not a document may be cached. If the
-                  document can be cached, this function determines whether or
-                  not to cache the transformed version. Untransformed and
+<tr><td align="left" valign="top"><p>This function does not overwrite HTTP directives (like
+                  <code class="code">Cache-Control</code> or <code class="code">Expires</code>) that
+                  determine whether document is  cached. If the
+                  document can be cached, then this function determines if the transformed version shou8ld be cached. Untransformed and
                   transformed documents are cached as HTTP alternates.</p></td></tr>
 </table></div>
 <p>Call from within or after hook
                 <code class="code">TXN_START_HOOK</code>.</p>
 <p>If called after hook <code class="code">SEND_RESPONSE_HDR</code>,
-                this function will not be taken into account by TS.</p>
+                then this function will not be taken into account by Traffic Server.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the operation completes
                 successfully.</p>
 <p><code class="code">INK_ERROR</code> if an error occurs.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
@@ -843,81 +816,75 @@
 <p>Gets the transform response header from a specified HTTP
           transaction.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">int INKHttpTxnTransformRespGet (INKHttpTxn
                 <em class="replaceable"><code>txnp</code></em>, INKMBuffer
                 *<em class="replaceable"><code>bufp</code></em>, INKMLoc
                 *<em class="replaceable"><code>offset</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Retrieves the transform response header from the HTTP
-                transaction <code class="code"><em class="replaceable"><code>txnp</code></em></code> and
+                transaction <code class="code"><em class="replaceable"><code>txnp </code></em></code> and
                 stores the transform response header in
                 <code class="code"><em class="replaceable"><code>bufp</code></em></code>, at location
                 <code class="code"><em class="replaceable"><code>offset</code></em></code>.</p>
 <p>Call from within your transformation, before transform
                 data is written to the downstream vconnection.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>If the transform response header does not exist, then
                 <code class="function">INKHttpTxnTransformRespGet</code> returns
                 0.</p>
-<p>Otherwise returns 1.</p>
+<p>Otherwise, returns 1.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKHttpTxnUntransformedRespCache"></a>INKHttpTxnUntransformedRespCache</h4></div></div></div>
-<p>Indicates whether or not Traffic Server writes un-transformed
-          documents to the cache.</p>
+<p>Indicates whether or not Traffic Server writes untransformed
+          documents to  cache.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">INKReturnCode INKHttpTxnUntransformedRespCache
                 (INKHttpTxn <em class="replaceable"><code>txnp</code></em>, int
                 <em class="replaceable"><code>on</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>Specifies whether the un-transformed document should be
-                written to the cache or not. If there is no transformation
-                occurring then the default is for the un-transformed copy to
-                be written to the cache. If a transformation is occurring the
-                default is for the un-transformed copy to not be written to
-                the cache. The defaults maintain a rule that only a single
-                version of a document will be written to the cache for a
+<p>Specifies whether the untransformed document should be
+                written to the cache. If there is no transformation
+                occurring, then the untransformed copy will
+                be written to the cache (by default). If a transformation is occurring, then the untransformed copy will not be written to
+                the cache (by default). The defaults maintain a rule that only a single
+                version of a document is  written to the cache for a
                 single transaction. It is valid for that rule to be broken by
-                specifying that both the transformed and un-transformed
+                specifying that both the transformed and untransformed
                 document be written to the cache. Calls need to be made prior
-                to the actual transformation, (i.e. at the time of creating
-                the transformation) rather than in the transformation.</p>
+                to the actual transformation (i.e. at the time of creating
+                the transformation), rather than in the transformation.</p>
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
 <tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png"></td>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
 <th align="left">Note</th>
 </tr>
-<tr><td align="left" valign="top"><p>This function does not overwrite HTTP directives, like
-                  Cache-Control or Expire, that determine whether or not a
-                  document can be cached. If the document can be cached, this
-                  function determines whether or not to cache the
-                  untransformed version. Untransformed and transformed
+<tr><td align="left" valign="top"><p>This function does not overwrite HTTP directives (ike
+                  <code>Cache-Control</code> or <code>Expires</code>) that determine if a
+                  document can be cached. If the document can be cached, then this
+                  function determines if the untransformed version should be cached. Untransformed and transformed
                   documents are cached as HTTP alternates.</p></td></tr>
 </table></div>
 <p>Call from within or after hook
                 <code class="code">TXN_START_HOOK</code>.</p>
 <p>If called after hook <code class="code">SEND_RESPONSE_HDR</code>,
-                this function will not be taken into account by TS.</p>
+                then Traffic Server will not take this function into account.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the operation completes
                 successfully.</p>
 <p><code class="code">INK_ERROR</code> if an error occurs.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 </div>



Mime
View raw message