trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mlib...@apache.org
Subject svn commit: r882316 [3/10] - /incubator/trafficserver/site/trunk/docs/sdk/
Date Thu, 19 Nov 2009 21:58:30 GMT
Modified: incubator/trafficserver/site/trunk/docs/sdk/HTTPTransformationPlugins.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTPTransformationPlugins.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTPTransformationPlugins.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTPTransformationPlugins.html Thu Nov 19 21:58:27 2009
@@ -1,47 +1,47 @@
 <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 5. HTTP Transformation Plugins</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="SetTransactionHook.html" title="Setting a Transaction Hook">
-<link rel="next" href="SampleNullTransformPlugin.html" title="The Sample Null Transform Plugin">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
-<link rel="section" href="HTTPTransformationPlugins.html#WritingContentTransformPlugins" title="Writing Content Transform Plugins">
-<link rel="section" href="SampleNullTransformPlugin.html" title="The Sample Null Transform Plugin">
-<link rel="section" href="AppendTransformPlugin.html" title="The Append-Transform Plugin">
-<link rel="section" href="SampleBufferedNullTransformPlugin.html" title="The Sample Buffered Null Transform Plugin">
+<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="SetTransactionHook.html" title="Setting a Transaction Hook" />
+<link rel="next" href="SampleNullTransformPlugin.html" title="The Sample Null Transform Plugin" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
+<link rel="section" href="HTTPTransformationPlugins.html#WritingContentTransformPlugins" title="Writing Content Transform Plugins" />
+<link rel="section" href="SampleNullTransformPlugin.html" title="The Sample Null Transform Plugin" />
+<link rel="section" href="AppendTransformPlugin.html" title="The Append-Transform Plugin" />
+<link rel="section" href="SampleBufferedNullTransformPlugin.html" title="The Sample Buffered Null Transform Plugin" />
 <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>
@@ -49,7 +49,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">
@@ -76,80 +76,78 @@
 </dl>
 </div>
 <p>Transform plugins examine or transform HTTP message body content.
-    For example, transform plugins can</p>
+    For example, transform plugins can:</p>
 <div class="itemizedlist"><ul type="disc">
 <li><p>Append text to HTML documents</p></li>
 <li><p>Compress images</p></li>
-<li><p>Do virus checking (on client POST data or server response
-        data)</p></li>
+<li><p>Do virus checking (on client <code>POST</code> data or server response
+      data)</p></li>
 <li><p>Do content-based filtering (filter out HTML documents that
         contain certain terms or expressions)</p></li>
 </ul></div>
-<p>In this chapter you can learn how to write transform plugins. The
+<p>This chapter explains   how to write transform plugins. The
     following examples are discussed in detail:</p>
 <div class="itemizedlist"><ul type="disc">
-<li><p><a href="SampleNullTransformPlugin.html" title="The Sample Null Transform Plugin">“The Sample Null Transform Plugin”</a></p></li>
-<li><p><a href="AppendTransformPlugin.html" title="The Append-Transform Plugin">“The Append-Transform Plugin”</a></p></li>
-<li><p><a href="SampleBufferedNullTransformPlugin.html" title="The Sample Buffered Null Transform Plugin">“The Sample Buffered Null Transform Plugin”</a></p></li>
+<li><p><a href="SampleNullTransformPlugin.html" title="The Sample Null Transform Plugin">The Sample Null Transform Plugin</a></p></li>
+<li><p><a href="AppendTransformPlugin.html" title="The Append-Transform Plugin">The Append-Transform Plugin</a></p></li>
+<li><p><a href="SampleBufferedNullTransformPlugin.html" title="The Sample Buffered Null Transform Plugin">The Sample Buffered Null Transform Plugin</a></p></li>
 </ul></div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="WritingContentTransformPlugins"></a>Writing Content Transform Plugins<a class="indexterm" name="id374305"></a></h2></div></div></div>
 <p>Content transformation plugins transform HTTP response content
       (such as images or HTML documents), and HTTP request content such as
-      client POST data. Because the data stream to be transformed is of
+      client <code>POST</code> data. Because the data stream to be transformed is of
       variable length, these plugins must use a mechanism that passes data
-      from buffer to buffer and checks to see if the end of the data stream is
-      reached.</p>
-<p>This mechanism is provided by virtual connections (vconnections)
+      from buffer to buffer <i>and</i> checks to see if the end of the data stream is
+      reached. This mechanism is provided by virtual connections (vconnections)
       and virtual IO descriptors (VIOs).</p>
-<p>A <span class="emphasis"><em>vconnection</em></span> is an abstraction for a data
+<p>A <span class="emphasis"><b>vconnection</b></span> is an abstraction for a data
       pipe that allows its users to perform asynchronous reads and writes
       without knowing the underlying implementation. A transformation is a
       specific type of vconnection. A
-      <span class="emphasis"><em>transformation</em></span><a class="indexterm" name="id374327"></a> connects an input data source and an output data sink;
+      <span class="emphasis"><b>transformation</b></span><a class="indexterm" name="id374327"></a> connects an input data source and an output data sink;
       this feature enables it to view and modify all the data passing through
       it.</p>
 <p>Transformations can be chained together, one after the other, so
       that multiple transformations can be performed on the same content. The
       vconnection type, <code class="code">INKVConn</code>, is actually a subclass of
-      INKCont, which means that vconnections (and transformations) are
+      <code>INKCont</code>, which means that vconnections (and transformations) are
       continuations. Vconnections and transformations can thus exchange
-      events, informing one another (for example) that data is available for
+      events, informing one another that data is available for
       reading or writing, or that the end of a data stream is reached.</p>
-<p>A VIO<a class="indexterm" name="id374345"></a> is a description of an in-progress IO operation. Every
-      vconnection has an associated input VIO and an associated output VIO.
+<p>A <b>VIO</b><a class="indexterm" name="id374345"></a> is a description of an IO operation that is in progress. Every
+      vconnection has an associated <i>input VIO</i> and an associated <i>output VIO</i>.
       When vconnections are transferring data to one another, one
       vconnection’s input VIO is another vconnection’s output VIO. A
-      vconnection’s input VIO is also called its write VIO<a class="indexterm" name="id374354"></a> because the input VIO refers to a write operation
+      vconnection’s input VIO is also called its <b>write VIO</b><a class="indexterm" name="id374354"></a> because the input VIO refers to a write operation
       performed on the vconnection itself. Similarly, the outpt VIO is also
-      called the read VIO<a class="indexterm" name="id374362"></a>. For transformations, which are designed to pass data in
+      called the <b>read VIO</b><a class="indexterm" name="id374362"></a>. For transformations, which are designed to pass data in
       one direction, you can picture the relationship between the
       transformation vconnection and its VIOs as follows:</p>
 <div class="figure">
 <a name="Fig_TransformationAndVIOs"></a><p class="title"><b>Figure 5.1. A Transformation and its VIOs</b></p>
-<div class="mediaobject"><img src="images/vconnection.jpg" alt="A Transformation and its VIOs"></div>
+<div class="mediaobject"><img src="images/vconnection.jpg" alt="A Transformation and its VIOs" /></div>
 </div>
 <p>Because the Traffic Server API places transformations directly in
       the response or request data stream, the transformation vconnection is
       responsible only for reading the data from the input buffer,
-      transforming it, and writing it to the output buffer. The upstream
+      transforming it, and then writing it to the output buffer. The upstream
       vconnection writes the incoming data to the transformation’s input
-      buffer. In <a href="HTTPTransformationPlugins.html#Fig_TransformationAndVIOs" title="Figure 5.1. A Transformation and its VIOs">Figure 5.1, “A Transformation and its VIOs”</a>, the input VIO
+      buffer. In the figure above, <a href="HTTPTransformationPlugins.html#Fig_TransformationAndVIOs" title="Figure 5.1. A Transformation and its VIOs">“A Transformation and its VIOs”</a>, the input VIO
       describes the progress of the upstream vconnection’s write operation on
-      the transformation, and the output VIO describes the progress of the
+      the transformation, while the output VIO describes the progress of the
       transformation’s write operation on the output (downstream) vconnection.
-      The nbytes value in the VIO is the total number of bytes to be written.
-      The ndone value is the current progress, the number of bytes
-      written.</p>
-<p>When writing a transformation plugin, you need to understand both
-      implementing and using vconnections. The implementor’s side refers to
+      The <b>nbytes</b> value in the VIO is the total number of bytes to be written.
+      The <b>ndone</b> value is the current progress, or the number of bytes
+      that have been written at a specific point in time.</p>
+<p>When writing a transformation plugin, you must understand  
+      implementation as well as the use of vconnections. The <i>implementor’s side </i>refers to
       how to implement a vconnection that others can use. At minimum, a
       transform plugin creates a transformation that sits in the data stream
       and must be able to handle the events that the upstream and downstream
-      vconnections send it. The user’s side refers to how to use a vconnection
-      to read or write data. Transformations output (write) data, at the very
-      least.</p>
+      vconnections send to it. The <i>user’s side </i>refers to how to use a vconnection
+      to read or write data. At the very least, transformations output (write) data.</p>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="Transformations"></a>Transformations</h3></div></div></div>
@@ -158,16 +156,16 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="VIOs"></a>VIOs</h3></div></div></div>
-<p>A VIO or virtual IO is a description of an in progress IO
+<p>A <b>VIO</b> or virtual IO is a description of an in progress IO
         operation. The VIO data structure is used by vconnection users to
-        determine how much progress has been made on a particular IO operation
-        and to re-enable an IO operation when it stalls due to buffer space.
-        VIOs are used by vconnection implementors to determine the buffer for
-        an IO operation, to determine how much work to do on the IO operation
-        and to determine which continuation to call back when progress on the
+        determine how much progress has been made on a particular IO operation,
+        and to reenable an IO operation when it stalls due to buffer space.
+        Vconnection implementors use VIOs to determine the buffer for
+        an IO operation,  how much work to do on the IO operation,
+        and  which continuation to call back when progress on the
         IO operation is made.</p>
 <p>The <code class="code">INKVIO<a class="indexterm" name="id374498"></a></code> data structure itself is opaque, but it might
-        have been defined as follow</p>
+        have been defined as follows:</p>
 <pre class="programlisting">typedef struct {
      INKCont continuation;
      INKVConn vconnection;
@@ -180,21 +178,18 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="IOBuffers"></a>IO Buffers</h3></div></div></div>
-<p>The IO buffer data structure is the building block of the
+<p>The <b>IO buffer</b> data structure is the building block of the
         vconnection abstraction. An IO buffer is composed of a list of buffer
-        blocks which in turn point to buffer data. Both the buffer block
-        (<code class="code">INKIOBufferBlock</code>) and buffer data
-        (<code class="code">INKIOBufferData</code>) data structures are reference counted
-        so that they can reside in multiple buffers at the same time. This
+        blocks which, in turn, point to buffer data. Both the <i>buffer block</i> (<code class="code">INKIOBufferBlock</code>) and <i>buffer data</i> (<code class="code">INKIOBufferData</code>) data structures are reference counted
+        so  they can reside in multiple buffers at the same time. This
         makes it extremely efficient to copy data from one IO buffer to
-        another using <code class="code">INKIOBufferCopy</code> since Traffic Server only
-        needs to copy pointers and adjust reference counts appropriately and
-        not actually copy any data.</p>
+        another using <code class="code">INKIOBufferCopy</code>, since Traffic Server only
+        needs to copy pointers and adjust reference counts appropriately (instead of actually copying any data).</p>
 <p>The IO buffer abstraction provides for a single writer and
         multiple readers. In order for the readers to have no knowledge of
         each other, they manipulate IO buffers through
         the<code class="code">INKIOBufferReader</code> data structure. Since only a single
-        writer is allowed, there is no corresponding
+        writer is allowed, as there is no corresponding
         <code class="code">INKIOBufferWriter</code> data structure. The writer simply
         modifies the IO buffer directly.</p>
 </div>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKActionDone.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKActionDone.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKActionDone.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKActionDone.html Thu Nov 19 21:58:27 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>INKActionDone</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="ActionFunctions.html" title="Action Functions">
-<link rel="prev" href="ActionFunctions.html" title="Action Functions">
-<link rel="next" href="HostLookupFunctions.html" title="Host Lookup 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="ActionFunctions.html" title="Action Functions" />
+<link rel="prev" href="ActionFunctions.html" title="Action Functions" />
+<link rel="next" href="HostLookupFunctions.html" title="Host Lookup 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">
@@ -59,46 +59,47 @@
 <a name="INKActionDone"></a>INKActionDone</h3></div></div></div>
 <p>Tells you if an action is 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">int INKActionDone (INKAction
               <em class="replaceable"><code>actionp</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>Is <code class="code"><em class="replaceable"><code>actionp</code></em></code> a
-              completed action. If a <code class="code">NULL</code> argument is passed to
-              <code class="function">INKActionDone</code>, Traffic Server will crash
-              and will not return <code class="code">INK_ERROR</code>. Note that it is the
-              programmer’s responsibility to ensure that a non-null value is
-              passed to INKActionDone.</p>
-<div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="images/docbook/important.png"></td>
-<th align="left">Important</th>
-</tr>
-<tr><td align="left" valign="top">
-<p>Always use <code class="function">INKActionDone</code>
-                immediately after the call that assigns the action. For
-                example:</p>
-<pre class="programlisting">actionp = INKContSchedule(contp, SOME_TIMEOUT_VALUE);
+<p><code class="code"><em class="replaceable"><code>actionp </code></em></code>  
+              is a completed action. If a <code class="code">NULL</code> argument is passed to
+              <code class="function">INKActionDone</code>, then Traffic Server  crashes
+              and does not return <code class="code">INK_ERROR</code>. </p>
+</dd>
+<dd>
+  <p><b>Note:</b> it is the
+    programmer’s responsibility to ensure that a non-null value is
+    passed to <code>INKActionDone</code>.</p>
+  <div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important">
+    <tr>
+      <td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="images/docbook/important.png" /></td>
+      <th align="left">Important</th>
+      </tr>
+    <tr><td align="left" valign="top">
+      <p>Always use <code class="function">INKActionDone</code>
+        immediately after the call that assigns the action. For
+        example:</p>
+      <pre class="programlisting">actionp = INKContSchedule(contp, SOME_TIMEOUT_VALUE);
 if (INKActionDone(actionp)){
     //event has already occurred 
    }</pre>
-</td></tr>
-</table></div>
-<p>If you call
-              <code class="function">INKActionDone</code>(<code class="code"><em class="replaceable"><code>actionp</code></em></code>)
-              some time later or some where else, it always returns false, and
-              therefore does not accurately reflect whether the action is
-              completed.</p>
+      </td></tr>
+    </table></div>
+  <p>If you call
+    <code class="function">INKActionDone</code><code>(<em class="replaceable">actionp</em>)</code>
+    some time later or some where else, then it always returns <code>false</code> and
+    therefore does not accurately reflect whether the action is
+    completed.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>0 if the action has not completed.</p>
 <p>1 if the action has completed</p>
 <p><code class="code">INK_ERROR</code> if an error has occurred.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
 </dl></div>
 </div>
 </body>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKAssert.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKAssert.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKAssert.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKAssert.html Thu Nov 19 21:58:27 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>INKAssert</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="DebuggingFunctions.html" title="Debugging Functions">
-<link rel="prev" href="INKError.html" title="INKError">
-<link rel="next" href="INKReleaseAssert.html" title="INKReleaseAssert">
-<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="DebuggingFunctions.html" title="Debugging Functions" />
+<link rel="prev" href="INKError.html" title="INKError" />
+<link rel="next" href="INKReleaseAssert.html" title="INKReleaseAssert" />
+<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,39 +57,37 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="INKAssert"></a>INKAssert</h3></div></div></div>
-<p>Allows the use of assertion in a plugin</p>
+<p>Enables the use of assertion in a plugin.</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">void
               INKAssert(<em class="replaceable"><code>expression</code></em>); </code></p></dd>
-<dt><span class="term">Arguments</span></dt>
+<dt><span class="term"><b>Arguments</b></span></dt>
 <dd><p>A boolean expression.</p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>If expression is false:</p>
-<p>In debug mode, causes the Traffic Server to print the file
-              name, line number and expression, then to abort.</p>
-<p>In optim mode, the expression is *not* removed. But the
+  <p>In debug mode, causes the Traffic Server to print the file
+              name, line number, and expression before it aborts.</p>
+<p>In optim mode, the expression is <u>not</u> removed, but the
               effect of printing an error message and aborting are. This is an
               artifact of the way the system assert is normally used and
               permits:</p>
-<pre class="programlisting">ink_assert(!setsockopt(...)); </pre>
-<p>Allows the use of assertion in a plugin.</p>
-<p>Note that when using the system “assert”, you do not have
-              to worry about the condition as the code will be 'dead code
-              eliminated' by the compiler. With <code class="code">INKAssert</code> you
+<pre class="programlisting">ink_assert(!setsockopt(...)); 
+</pre>
+<p><b>Note:</b> when using the system “assert”, you do not need
+              to worry about the condition since the code will be 'dead code
+              eliminated' by the compiler; with <code class="code">INKAssert</code>, you
               do.</p>
 </dd>
-<dt><span class="term">Example</span></dt>
+<dt><span class="term"><b>Example</b></span></dt>
 <dd><pre class="programlisting">switch (event) {
 case EVENT_IMMEDIATE:
 ....
 default:
 INKAssert (!setsockopt(...));
 break;
-}</pre></dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 5.2</p></dd>
+}</pre>
+  </dd>
 </dl></div>
 </div>
 </body>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDestroy.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDestroy.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDestroy.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDestroy.html Thu Nov 19 21:58:27 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>INKCacheKeyDestroy</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="CacheInterfaceFunctions.html" title="Cache Interface Functions">
-<link rel="prev" href="INKCacheKeyHostNameSet.html" title="INKCacheKeyHostNameSet">
-<link rel="next" href="INKCacheRead.html" title="INKCacheRead">
-<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="CacheInterfaceFunctions.html" title="Cache Interface Functions" />
+<link rel="prev" href="INKCacheKeyHostNameSet.html" title="INKCacheKeyHostNameSet" />
+<link rel="next" href="INKCacheRead.html" title="INKCacheRead" />
+<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">
@@ -59,26 +59,26 @@
 <a name="INKCacheKeyDestroy"></a>INKCacheKeyDestroy</h3></div></div></div>
 <p>Destroys a cache key.</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 INKCacheKeyDestroy(INKCacheKey
               <em class="replaceable"><code>key</code></em>)</code></p></dd>
-<dt><span class="term">Arguments</span></dt>
-<dd><p><code class="function">INKCacheKey</code>
-              <code class="code"><em class="replaceable"><code>key</code></em></code> is the key to be
+<dt><span class="term"><b>Arguments</b></span></dt>
+<dd>
+<p><code class="function">INKCacheKey</code>
+              <code class="code"><em class="replaceable"><code>key </code></em></code> is the key to be
               destroyed.</p></dd>
-<dt><span class="term">Description</span></dt>
-<dd><p>Destroys a cache key (deallocate memory). You must destroy
-              cache keys when you are finished with them (after all reads and
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+  <p>Destroys a cache key (deallocates memory). You must destroy
+              cache keys when you are finished with them (i.e., after all reads and
               writes are completed).</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 cache key was successfully
               destroyed.</p>
-<p><code class="code">INK_ERROR</code> if key could not be deallocated or
+<p><code class="code">INK_ERROR</code> if the cache key could not be deallocated or
               was not valid.</p>
 </dd>
-<dt><span class="term">First Release</span></dt>
-<dd><p>Traffic Server 5.2</p></dd>
 </dl></div>
 </div>
 </body>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDigestSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDigestSet.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDigestSet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDigestSet.html Thu Nov 19 21:58:27 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>INKCacheKeyDigestSet</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="CacheInterfaceFunctions.html" title="Cache Interface Functions">
-<link rel="prev" href="CacheInterfaceFunctions.html" title="Cache Interface Functions">
-<link rel="next" href="INKCacheKeyHostNameSet.html" title="INKCacheKeyHostNameSet">
-<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="CacheInterfaceFunctions.html" title="Cache Interface Functions" />
+<link rel="prev" href="CacheInterfaceFunctions.html" title="Cache Interface Functions" />
+<link rel="next" href="INKCacheKeyHostNameSet.html" title="INKCacheKeyHostNameSet" />
+<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">
@@ -60,46 +60,44 @@
 <p>Generates and assigns a cache key to an object to be
         cached.</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 INKCacheKeyDigestSet(INKCacheKey
               <em class="replaceable"><code>key</code></em>, const unsigned char
               *<em class="replaceable"><code>input</code></em>, int
               <em class="replaceable"><code>length</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="function">INKCacheKey</code>
-              <code class="code"><em class="replaceable"><code>key</code></em></code> is the key to be
+              <code class="code"><em class="replaceable"><code>key </code></em></code> is the key to be
               associated to the cached object. Before calling
-              <code class="function">INKCacheKeyDigestSet</code> you must create the
+              <code class="function">INKCacheKeyDigestSet</code>, you must create the
               key with <code class="function">INKCacheKeyCreate</code>. Note that in
               order to generate unique keys, you must use unique input
-              strings. In other words, if the input strings are identical,
+              strings. In other words: if the input strings are identical, then 
               <code class="function">INKCacheKeyCreate</code> will generate identical
               keys.</p>
 <p><code class="code">const unsigned char
-              *</code><code class="code"><em class="replaceable"><code>input</code></em></code> is a
+              *</code><code class="code"><em class="replaceable"><code>input </code></em></code> is a
               character string that uniquely identifies the object. In most
               cases, it is the URL of the object.</p>
 <p><code class="code">int
-              </code><code class="code"><em class="replaceable"><code>length</code></em></code> is the
+              </code><code class="code"><em class="replaceable"><code>length </code></em></code> is the
               length of the string input.</p>
 </dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd><p>Generates and assigns a cache key to an object to be
               cached.</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 cache key was successfully
               generated.</p>
 <p><code class="code">INK_ERROR</code> if digest could not be set.</p>
 </dd>
-<dt><span class="term">Example</span></dt>
+<dt><span class="term"><b>Example</b></span></dt>
 <dd><pre class="programlisting">const char *digest_string = "mydigest" 
 INKCacheKey mykey; 
 INKCacheKeyCreate(&amp;mykey); 
-INKCacheKeyDigestSet(mykey,digest_string, strlen(digest_string);</pre></dd>
-<dt><span class="term">First Release</span></dt>
-<dd><p>Traffic Server 5.2</p></dd>
+INKCacheKeyDigestSet(mykey,digest_string, strlen(digest_string);</pre></dd> 
 </dl></div>
 </div>
 </body>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyHostNameSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyHostNameSet.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyHostNameSet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyHostNameSet.html Thu Nov 19 21:58:27 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>INKCacheKeyHostNameSet</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="CacheInterfaceFunctions.html" title="Cache Interface Functions">
-<link rel="prev" href="INKCacheKeyDigestSet.html" title="INKCacheKeyDigestSet">
-<link rel="next" href="INKCacheKeyDestroy.html" title="INKCacheKeyDestroy">
-<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="CacheInterfaceFunctions.html" title="Cache Interface Functions" />
+<link rel="prev" href="INKCacheKeyDigestSet.html" title="INKCacheKeyDigestSet" />
+<link rel="next" href="INKCacheKeyDestroy.html" title="INKCacheKeyDestroy" />
+<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">
@@ -60,36 +60,35 @@
 <p>Associates a host name to a cache key. Use if you want to
         support cache partitioning by host name.</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 INKCacheKeyHostNameSet(INKCacheKey
               <em class="replaceable"><code>key</code></em>, const unsigned char
               *<em class="replaceable"><code>hostname</code></em>, int
               <em class="replaceable"><code>host_len</code></em>;</code></p></dd>
-<dt><span class="term">Arguments</span></dt>
+<dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
-<p>INKCacheKey <code class="code"><em class="replaceable"><code>key</code></em></code> is
+<p><code>INKCacheKey</code> <code class="code"><em class="replaceable"><code>key </code></em></code> is
               the key to the cached object.</p>
-<p><code class="code">const unsigned char *</code><code class="code">hostname</code> is
-              the host name you are associating to the cache key.</p>
-<p><code class="code">int <em class="replaceable"><code>host_len</code></em></code> is
+<p><code class="code">const unsigned char <i>*hostname </i></code> is
+              the host name you are associating with the cache key.</p>
+<p><code class="code">int <em class="replaceable"><code>host_len </code></em></code> is
               the length of the string
               <code class="code"><em class="replaceable"><code>hostname</code></em></code>.</p>
 </dd>
-<dt><span class="term">Description</span></dt>
-<dd><p>Associates a host name to a cache key. The host name
-              setting is used in conjunction with the TS config file
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+  <p>Associates a host name to a cache key. The host name
+              setting is used in conjunction with the Traffic Server configuration files
               <code class="filename">partition.config</code> and
-              <code class="filename">hosting.config</code> that allows you to specify
+              <code class="filename">hosting.config</code> that enable you to specify
               under which cache partition the object should be stored.</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 host name was successfully
               associated with the cache key.</p>
 <p><code class="code">INK_ERROR</code> if <code class="code">hostname</code> could not
               be set or is invalid.</p>
 </dd>
-<dt><span class="term">First Release</span></dt>
-<dd><p>Traffic Server 5.2</p></dd>
 </dl></div>
 </div>
 </body>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyPinnedSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyPinnedSet.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyPinnedSet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyPinnedSet.html Thu Nov 19 21:58:27 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>INKCacheKeyPinnedSet</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="CacheInterfaceFunctions.html" title="Cache Interface Functions">
-<link rel="prev" href="INKCacheRemove.html" title="INKCacheRemove">
-<link rel="next" href="INKVConnCacheObjectSizeGet.html" title="INKVConnCacheObjectSizeGet">
-<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="CacheInterfaceFunctions.html" title="Cache Interface Functions" />
+<link rel="prev" href="INKCacheRemove.html" title="INKCacheRemove" />
+<link rel="next" href="INKVConnCacheObjectSizeGet.html" title="INKVConnCacheObjectSizeGet" />
+<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,23 +58,23 @@
 <div class="titlepage"><div><div><h3 class="title">
 <a name="INKCacheKeyPinnedSet"></a>INKCacheKeyPinnedSet</h3></div></div></div>
 <p>Pins the document corresponding to the specified key in the
-        cache so that the garbage collection process will not delete the
+        cache so that the garbage collection process does not delete the
         document from the cache for the specified number of seconds.</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 INKCacheKeyPinnedSet (INKCacheKey
               <em class="replaceable"><code>key</code></em>, time_t
               <em class="replaceable"><code>pin_in_cache</code></em>)</code></p></dd>
-<dt><span class="term">Arguments</span></dt>
+<dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
-<p>INKCacheKey <code class="code"><em class="replaceable"><code>key</code></em></code> is
+<p>INKCacheKey <code class="code"><em class="replaceable"><code>key </code></em></code> is
               the cache key for the document to be pinned.</p>
 <p><code class="code">time_t
-              <em class="replaceable"><code>pin_in_cache</code></em></code> represents the
+              <em class="replaceable"><code>pin_in_cache </code></em></code> represents the
               number of seconds the document is to be pinned in the
               cache.</p>
 </dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Pins the document corresponding to the specified
               <code class="code"><em class="replaceable"><code>key</code></em></code> in the cache for the
@@ -89,33 +89,31 @@
 <p>To delete this document before the
               <code class="code">pin_in_cache</code> interval expires, call the
               <code class="function">INKCacheRemove</code>() function with the
-              document’s cache key.</p>
+              document’s cache key. </p>
 <p><code class="methodname">InkCacheKeyPinnedSet()</code> should be
               used after a key is created and before writing the document to
               cache using I<code class="methodname">NKCacheWrite()</code>.</p>
-<p>By default, a document is not pinned in the cache and so
-              can be garbage collected at anytime.</p>
+<p>By default, a document is not pinned in the cache, so it
+              can be garbage-collected at anytime.</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>It is important that the
                 <code class="filename">records.config</code> variable
-                <code class="varname">proxy.config.cache.permit.pinning</code> be set to
-                1 in <code class="filename">records.config</code> to enable
+                <code class="varname"><i>proxy.config.cache.permit.pinning </i></code>  (in <code class="filename">records.config</code>) is set to
+                1 to enable
                 pinning.</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 specified object was
               successfully pinned in the cache.</p>
 <p><code class="code">INK_ERROR</code> if the pin could not be set or is
               invalid.</p>
 </dd>
-<dt><span class="term">First Release</span></dt>
-<dd><p>Traffic Server 5.2</p></dd>
 </dl></div>
 </div>
 </body>



Mime
View raw message