trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mlib...@apache.org
Subject svn commit: r882316 [4/10] - /incubator/trafficserver/site/trunk/docs/sdk/
Date Thu, 19 Nov 2009 21:58:30 GMT
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKCacheRead.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheRead.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheRead.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheRead.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>INKCacheRead</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="INKCacheKeyDestroy.html" title="INKCacheKeyDestroy">
-<link rel="next" href="INKCacheReady.html" title="INKCacheReady">
-<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="INKCacheKeyDestroy.html" title="INKCacheKeyDestroy" />
+<link rel="next" href="INKCacheReady.html" title="INKCacheReady" />
+<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,42 +60,42 @@
 <p>Initiates a cache read or lookup of an object in the Traffic
         Server 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">INKAction INKCacheRead (INKCont
               <em class="replaceable"><code>contp</code></em>, INKCacheKey
               <em class="replaceable"><code>key</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">INKCont</code>
-              <code class="code"><em class="replaceable"><code>contp</code></em></code> is the
-              continuation that the cache calls back (telling it either the
-              object exists and can be read or not).</p>
+              <code class="code"><em class="replaceable"><code>contp </code></em></code> is the
+              continuation  the cache calls back (telling it whether the
+              object exists and can be read).</p>
 <p><code class="function">INKCacheKey</code>
-              <code class="code"><em class="replaceable"><code>key</code></em></code> is the cache key
+              <code class="code"><em class="replaceable"><code>key </code></em></code> is the cache key
               corresponding to the object to be read.</p>
 </dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Asks the Traffic Server cache if the object corresponding
-              to <code class="code"><em class="replaceable"><code>key</code></em></code> exists in the
+              to <code class="code"><em class="replaceable"><code>key </code></em></code> exists in the
               cache and can be read.</p>
 <p>You can do a cache lookup to determine whether or not an
               object is in the cache. To do a cache lookup, call
               <code class="function">INKCacheRead</code> on a continuation
               <code class="code"><em class="replaceable"><code>contp</code></em></code>. If the object can
-              be read, the cache calls
-              <code class="code"><em class="replaceable"><code>contp</code></em></code> back with the
+              be read, then the cache calls
+              <code class="code"><em class="replaceable"><code>contp </code></em></code> back with the
               event <code class="code">INK_EVENT_CACHE_OPEN_READ</code>. In this case, the
-              cache also passes <code class="code"><em class="replaceable"><code>contp</code></em></code>
-              a cache vconnection and
-              <code class="code"><em class="replaceable"><code>contp</code></em></code> can then initiate
+              cache also passes <code class="code"><em class="replaceable"><code>contp </code></em></code>
+              a cache vconnection; 
+              <code class="code"><em class="replaceable"><code>contp </code></em></code> can then initiate
               a read operation on that vconnection using
               <code class="function">INKVConnRead</code>.
               <code class="function">INKVConnCacheObjectSizeGet</code> can be used to
               determine the size of the object in the cache.</p>
 <p>If the object cannot be read (if, for instance, it is not
-              in the cache), the cache calls
-              <code class="code"><em class="replaceable"><code>contp</code></em></code> back with the
+              in the cache), then the cache calls
+              <code class="code"><em class="replaceable"><code>contp </code></em></code> back with the
               event <code class="code">INK_EVENT_CACHE_OPEN_READ_FAILED</code>. An error
               code is passed in the <code class="code">void *edata</code> argument of
               <code class="code"><em class="replaceable"><code>contp</code></em></code>. The error code
@@ -118,13 +118,13 @@
               <code class="function">INKActionCancel</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>It is up to the user to read the data from the cache
                 <code class="code">vc iobuffer</code> and consume it. The cache does not
-                bufferize the data. The cache will not call the user back
+                bufferize the data and will not call the user back
                 unless all the data from the <code class="code">cache iobuffer</code> is
                 consumed.</p>
 <p>Reentrant calls are possible; in other words, the cache
@@ -133,15 +133,13 @@
 </td></tr>
 </table></div>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>An <code class="function">INKAction</code> object if
               successful.</p>
 <p><code class="code">INK_ERROR_PTR</code> if an argument is incorrect or
               if the API failed.</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/INKCacheReady.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheReady.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheReady.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheReady.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>INKCacheReady</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="INKCacheRead.html" title="INKCacheRead">
-<link rel="next" href="INKCacheWrite.html" title="INKCacheWrite">
-<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="INKCacheRead.html" title="INKCacheRead" />
+<link rel="next" href="INKCacheWrite.html" title="INKCacheWrite" />
+<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,34 +60,33 @@
 <p>Determines if the Traffic Server cache is initialized and ready
         to accept requests for the specified data type.</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 INKCacheReady (int
               *<em class="replaceable"><code>is_ready</code></em>)</code></p></dd>
-<dt><span class="term">Arguments</span></dt>
-<dd><p><code class="code">int *<em class="replaceable"><code>is_ready</code></em></code> is
-              the argument set to non-zero if cache ready and 0 if cache not
+<dt><span class="term"><b>Arguments</b></span></dt>
+<dd>
+  <p>The <code class="code">int *<em class="replaceable"><code>is_ready </code></em></code>  
+               argument is set to a non-zero value if the cache is ready. It is set to 0 if the cache is not
               ready.</p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Asks the Traffic Server cache if it is initialized and
-              ready to accept requests. If the cache is not initialized, any
-              attempt to read, write or remove document will fail.</p>
+              ready to accept requests. If the cache is not initialized, then any
+              attempts to read, write, or remove documents will fail.</p>
 <p>When a plugin starts (its
               <code class="function">INKPluginInit</code> function is called), there is
               no guarantee that the cache is already initialized. This API is
-              useful if a plugin needs to access to the cache from the
+              useful if a plugin needs to access  the cache from the
               <code class="function">INKPluginInit</code> function. If the cache is not
-              ready, the plugin should retry later.</p>
+              ready, then the plugin should retry later.</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 API is called
+<p><code class="code">INK_SUCCESS</code> if the API is called
               successfully.</p>
-<p><code class="code">INK_ERROR</code> if cache ready could not be set or
-              is invalid.</p>
+<p><code class="code">INK_ERROR</code> if this function  could not be set or
+              if it 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/INKCacheRemove.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheRemove.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheRemove.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheRemove.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>INKCacheRemove</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="INKCacheWrite.html" title="INKCacheWrite">
-<link rel="next" href="INKCacheKeyPinnedSet.html" title="INKCacheKeyPinnedSet">
-<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="INKCacheWrite.html" title="INKCacheWrite" />
+<link rel="next" href="INKCacheKeyPinnedSet.html" title="INKCacheKeyPinnedSet" />
+<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,64 +59,64 @@
 <a name="INKCacheRemove"></a>INKCacheRemove</h3></div></div></div>
 <p>Removes an object from the Traffic Server 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">INKAction INKCacheRemove (INKCont
               <em class="replaceable"><code>contp</code></em>, INKCacheKey
               <em class="replaceable"><code>key</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">INKCont</code>
-              <code class="code"><em class="replaceable"><code>contp</code></em></code> is the
-              continuation that the cache calls back reporting the success or
+              <code class="code"><em class="replaceable"><code>contp </code></em></code> is the
+              continuation  the cache calls back when reporting the success or
               failure of the remove.</p>
 <p><code class="function">INKCacheKey</code>
-              <code class="code"><em class="replaceable"><code>key</code></em></code> is the cache key
-              corresponding to the object to be removed.</p>
+              <code class="code"><em class="replaceable"><code>key </code></em></code> is the cache key
+              that corresponds to the object tol be removed.</p>
 </dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Removes the object corresponding to
-              <code class="code"><em class="replaceable"><code>key</code></em></code> from the
+              <code class="code"><em class="replaceable"><code>key </code></em></code> from the
               cache.</p>
-<p>If the object was removed successfully, the cache calls
-              <code class="code"><em class="replaceable"><code>contp</code></em></code> back with the
+<p>If the object was removed successfully, then the cache calls
+              <code class="code"><em class="replaceable"><code>contp </code></em></code> back with the
               event <code class="code">INK_EVENT_CACHE_REMOVE</code>.</p>
 <p>If the object was not found in the cache, the cache calls
-              <code class="code"><em class="replaceable"><code>contp</code></em></code> back with the
+              <code class="code"><em class="replaceable"><code>contp </code></em></code> back with the
               event <code class="code">INK_EVENT_CACHE_REMOVE_FAILED</code>. An error code
               is passed in the <code class="code">void *edata</code> argument of
               <code class="code"><em class="replaceable"><code>contp</code></em></code>. The error code
               can be:</p>
 <div class="itemizedlist"><ul type="disc">
-<li><p><code class="code">INK_CACHE_ERROR_NOT_READY</code>: Trying to
-                  access to the cache while it's not yet initialized.</p></li>
-<li><p><code class="code">INK_CACHE_ERROR_NO_DOC</code>: Doc doesn't exist
+<li>
+  <p><code class="code">INK_CACHE_ERROR_NOT_READY</code>: tried to
+                  access  the cache before it was initialized.</p></li>
+<li>
+  <p><code class="code">INK_CACHE_ERROR_NO_DOC</code>: doc doesn't exist
                   in cache</p></li>
 <li><p>any other value: unknown remove failure</p></li>
 </ul></div>
 <p>In both of these callbacks, the user does not have to do
-              anything. The user does not get any vconnection from the cache,
+              anything. The user does not get a vconnection from the cache,
               since no data needs to be transferred. When the cache calls the
               user back with <code class="code">INK_EVENT_CACHE_REMOVE</code>, the remove
               has already been committed.</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>Reentrant calls are possible, i.e. the cache can call
-                back the user (contp) in the same call.</p></td></tr>
+                back the user (<code>contp</code>) in the same call.</p></td></tr>
 </table></div>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>An <code class="function">INKAction</code> object if
               successful.</p>
 <p><code class="code">INK_ERROR_PTR</code> if an argument is incorrect or
               if the API fails.</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/INKCacheWrite.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheWrite.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheWrite.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheWrite.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>INKCacheWrite</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="INKCacheReady.html" title="INKCacheReady">
-<link rel="next" href="INKCacheRemove.html" title="INKCacheRemove">
-<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="INKCacheReady.html" title="INKCacheReady" />
+<link rel="next" href="INKCacheRemove.html" title="INKCacheRemove" />
+<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,36 +59,36 @@
 <a name="INKCacheWrite"></a>INKCacheWrite</h3></div></div></div>
 <p>Initiates writing an object to the Traffic Server 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">INKAction INKCacheWrite (INKCont
               <em class="replaceable"><code>contp</code></em>, INKCacheKey
               <em class="replaceable"><code>key</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">INKCont</code>
-              <code class="code"><em class="replaceable"><code>contp</code></em></code> is the
-              continuation that the cache calls back (telling it whether the
-              write operation can proceed or not).</p>
+              <code class="code"><em class="replaceable"><code>contp </code></em></code> is the
+              continuation  the cache calls back (telling it whether the
+              write operation can proceed).</p>
 <p><code class="function">INKCacheKey</code>
-              <code class="code"><em class="replaceable"><code>key</code></em></code> is the cache key
-              corresponding to the object to be cached.</p>
+              <code class="code"><em class="replaceable"><code>key </code></em></code> is the cache key
+              that corresponds to the object to be cached.</p>
 </dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Asks the Traffic Server cache if
-              <code class="code"><em class="replaceable"><code>contp</code></em></code> can start writing
+              <code class="code"><em class="replaceable"><code>contp </code></em></code> can start writing
               the object (corresponding to key) to the cache.</p>
-<p>If the object can be written, the cache calls
-              <code class="code"><em class="replaceable"><code>contp</code></em></code> back with the
+<p>If the object can be written, then the cache calls
+              <code class="code"><em class="replaceable"><code>contp </code></em></code> back with the
               event <code class="code">INK_EVENT_CACHE_OPEN_WRITE</code>. In this case, the
-              cache also passes <code class="code"><em class="replaceable"><code>contp</code></em></code>
-              a cache vconnection in the <code class="code">void *edata</code> argument and
-              <code class="code"><em class="replaceable"><code>contp</code></em></code> can then initiate
+              cache also passes <code class="code"><em class="replaceable"><code>contp </code></em></code>
+              a cache vconnection in the <code class="code">void *edata</code> argument; 
+              <code class="code"><em class="replaceable"><code>contp </code></em></code> can then initiate
               a write operation on that vconnection using
               <code class="function">INKVConnWrite</code>. The object is not committed
-              to the cache until the vconnection is closed.</p>
-<p>If the object cannot be written, the cache calls
-              <code class="code"><em class="replaceable"><code>contp</code></em></code> back with the
+              to  cache until the vconnection is closed.</p>
+<p>If the object cannot be written, then the cache calls
+              <code class="code"><em class="replaceable"><code>contp </code></em></code> back with the
               event <code class="code">INK_EVENT_CACHE_OPEN_WRITE_FAILED</code>. This can
               happen, for example, if there is another object with the same
               key being written to the cache. An error code is passed in the
@@ -96,9 +96,11 @@
               <code class="code"><em class="replaceable"><code>contp</code></em></code>. The error code
               can be:</p>
 <div class="itemizedlist"><ul type="disc">
-<li><p><code class="code">INK_CACHE_ERROR_NOT_READY</code>: Trying to
-                  access to the cache while it's not yet initialized.</p></li>
-<li><p><code class="code">INK_CACHE_ERROR_DOC_BUSY</code>: Trying to write
+<li>
+  <p><code class="code">INK_CACHE_ERROR_NOT_READY</code>: trying to
+                  access to the cache before it's initialized.</p></li>
+<li>
+  <p><code class="code">INK_CACHE_ERROR_DOC_BUSY</code>: trying to write
                   a document while another continuation is writing or reading
                   it.</p></li>
 <li><p>Any other value: unknown write failure.</p></li>
@@ -113,11 +115,11 @@
               vconnection for any data transfer. When all data has been
               transferred, the user must do a
               <code class="function">INKVConnClose</code>. In case of any errors, the
-              user must do an <code class="function">INKVConnAbort</code>(contp,
-              0).</p>
+              user must do an <code class="function">INKVConnAbort(contp,
+              0).</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">
@@ -127,23 +129,21 @@
                 call.</p>
 <p><code class="function">INKCacheWrite</code> does not overwrite
                 content already stored in the cache under the same cache key.
-                If you try to do so, the cache returns
+                If you try to do so, then the cache returns
                 <code class="code">INK_EVENT_CACHE_OPEN_WRITE_FAILED</code>. To overwrite
                 content, first call <code class="function">INKCacheRemove</code> to
-                remove the content, then call
+                remove the content and then call
                 <code class="function">INKCacheWrite</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>An <code class="function">INKAction</code> object if
               successful.</p>
 <p><code class="code">INK_ERROR_PTR</code> if an argument is incorrect or
               the API fails.</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/INKConfigGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKConfigGet.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKConfigGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKConfigGet.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>INKConfigGet</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="PluginConfigurationFunctions.html" title="Plugin Configuration Functions">
-<link rel="prev" href="PluginConfigurationFunctions.html" title="Plugin Configuration Functions">
-<link rel="next" href="INKConfigRelease.html" title="INKConfigRelease">
-<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="PluginConfigurationFunctions.html" title="Plugin Configuration Functions" />
+<link rel="prev" href="PluginConfigurationFunctions.html" title="Plugin Configuration Functions" />
+<link rel="next" href="INKConfigRelease.html" title="INKConfigRelease" />
+<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,10 +59,10 @@
 <a name="INKConfigGet"></a>INKConfigGet</h3></div></div></div>
 <p>Returns a pointer to the Traffic Server configuration.</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">INKConfig INKConfigGet (unsigned int
               <em class="replaceable"><code>id</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 current configuration pointer associated
               with the configuration identifier
@@ -76,15 +76,13 @@
               pointer.</p>
 <p>Before you call <code class="function">INKConfigGet</code>, you
               must set the identifier
-              <code class="code"><em class="replaceable"><code>id</code></em></code> to some plugin
-              configuration data using <code class="function">INKConfigSet</code>. See
-              the code snippet in the previous section.</p>
+              <code class="code"><em class="replaceable"><code>id </code></em></code> to some plugin
+              configuration data using <code class="function">INKConfigSet</code> (see
+              code snippet in the previous section).</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd><p>A pointer to the current Traffic Server
               configuration.</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/INKConfigRelease.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKConfigRelease.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKConfigRelease.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKConfigRelease.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>INKConfigRelease</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="PluginConfigurationFunctions.html" title="Plugin Configuration Functions">
-<link rel="prev" href="INKConfigGet.html" title="INKConfigGet">
-<link rel="next" href="INKConfigSet.html" title="INKConfigSet">
-<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="PluginConfigurationFunctions.html" title="Plugin Configuration Functions" />
+<link rel="prev" href="INKConfigGet.html" title="INKConfigGet" />
+<link rel="next" href="INKConfigSet.html" title="INKConfigSet" />
+<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,22 +59,21 @@
 <a name="INKConfigRelease"></a>INKConfigRelease</h3></div></div></div>
 <p>Releases a configuration pointer.</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 INKConfigRelease (unsigned int
               <em class="replaceable"><code>id</code></em>, INKConfig
               <em class="replaceable"><code>configp</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
-<dd><p>Releases the configuration pointer
-              <code class="code"><em class="replaceable"><code>configp</code></em></code> on the
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+  <p>Releases the configuration pointer
+              <code class="code"><em class="replaceable"><code>configp </code></em></code> on the
               configuration associated with the identifier
               <code class="code"><em class="replaceable"><code>id</code></em></code>. It is possible that
-              <code class="code"><em class="replaceable"><code>configp</code></em></code> is no longer the
-              current configuration in which case
+              <code class="code"><em class="replaceable"><code>configp </code></em></code> is no longer the
+              current configuration, in which case
               <code class="function">INKConfigRelease</code> may end up calling the
-              configuration’s destroy function. See the code snippet in the
-              previous section.</p></dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
+              configuration’s destroy function (see  code snippet in the
+              previous section).</p></dd>
 </dl></div>
 </div>
 </body>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKConfigSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKConfigSet.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKConfigSet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKConfigSet.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>INKConfigSet</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="PluginConfigurationFunctions.html" title="Plugin Configuration Functions">
-<link rel="prev" href="INKConfigRelease.html" title="INKConfigRelease">
-<link rel="next" href="ActionFunctions.html" title="Action 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="PluginConfigurationFunctions.html" title="Plugin Configuration Functions" />
+<link rel="prev" href="INKConfigRelease.html" title="INKConfigRelease" />
+<link rel="next" href="ActionFunctions.html" title="Action 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,44 +59,44 @@
 <a name="INKConfigSet"></a>INKConfigSet</h3></div></div></div>
 <p>Assigns an identifier to plugin configuration data.</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 INKConfigSet (unsigned int
               <em class="replaceable"><code>id</code></em>, void
               *<em class="replaceable"><code>data</code></em>, INKConfigDestroyFunc
               <em class="replaceable"><code>funcp</code></em>)</code></p></dd>
-<dt><span class="term">Arguments</span></dt>
+<dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
-<p>unsigned int <code class="code"><em class="replaceable"><code>id</code></em></code> is
-              the identifier that is assigned to configuration
+<p>unsigned int <code class="code"><em class="replaceable"><code>id </code></em></code> is
+              the identifier  assigned to configuration
               <code class="code"><em class="replaceable"><code>data</code></em></code>. Do not use 1 or 2
-              for <code class="code"><em class="replaceable"><code>id</code></em></code>. Traffic Server
+              for <code class="code"><em class="replaceable"><code>id </code></em></code> because Traffic Server
               internally assigns these IDs to parent and HTTP configurations.
               You can enter 0 as <code class="code"><em class="replaceable"><code>id</code></em></code>,
-              and <code class="function">INKConfigSet</code> will allocate an
+              however, and <code class="function">INKConfigSet</code> will allocate an
               identifier for you (with a value of 3 or greater). There is an
               internal upper limit of 100 on
               <code class="code"><em class="replaceable"><code>id</code></em></code>.</p>
 <p><code class="code">void
-              *</code><code class="code"><em class="replaceable"><code>data</code></em></code> points to
+              *</code><code class="code"><em class="replaceable"><code>data </code></em></code> points to
               the data that you are associating to
               <code class="code"><em class="replaceable"><code>id</code></em></code>.</p>
 <p><code class="function">INKConfigDestroyFunc</code>
-              <code class="code"><em class="replaceable"><code>funcp</code></em></code> is a pointer to a
-              destroy function that is called when Traffic Server determines
-              that there are no more references to data. The only argument of
-              <code class="code"><em class="replaceable"><code>funcp</code></em></code> is
-              <code class="code"><em class="replaceable"><code>data</code></em></code>.</p>
+              <code class="code"><em class="replaceable"><code>funcp </code></em></code> is a pointer to a
+              destroy function that's called when Traffic Server determines
+               there are no more references to data. The only argument for 
+              <code class="code"><em class="replaceable"><code>funcp </code></em></code> is 
+              <code class="code"><em class="replaceable"><code> data</code></em></code>.</p>
 </dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Sets the opaque data pointer
-              <code class="code"><em class="replaceable"><code>data</code></em></code> to be associated
+              <code class="code"><em class="replaceable"><code>data </code></em></code> to be associated
               with the configuration identifier
               <code class="code"><em class="replaceable"><code>id</code></em></code>. If
-              <code class="code"><em class="replaceable"><code>id</code></em></code> is 0 then Traffic
+              <code class="code"><em class="replaceable"><code>id </code></em></code> is 0, then Traffic
               Server allocates a new configuration identifier, and
               <code class="function">INKConfigSet</code> returns this value. If
-              <code class="code"><em class="replaceable"><code>id</code></em></code> is non-zero,
+              <code class="code"><em class="replaceable"><code>id </code></em></code> is non-zero, then 
               <code class="function">INKConfigSet</code> returns
               <code class="code"><em class="replaceable"><code>id</code></em></code>. To make sure that
               the configuration identifier stays within the recommended range
@@ -104,50 +104,46 @@
               section.</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>Never pick a configuration identifier yourself. When you
-                need a new config id, you MUST always pass 0 as
-                <code class="code"><em class="replaceable"><code>id</code></em></code> to the
-                <code class="function">INKConfigSet</code> API which will return a new
-                valid <code class="code"><em class="replaceable"><code>id</code></em></code>. It is not
-                safe to pick up a randomly selected id because there might be
-                some conflict with <code class="code"><em class="replaceable"><code>id</code></em></code>s
+                need a new config ID, you <b>must</b> always pass 0 as <code class="code"><em class="replaceable"><code>id </code></em></code> to the
+                <code class="function">INKConfigSet</code> API (which will return a new
+                valid <code class="code"><em class="replaceable"><code>id</code></em></code>). It is not
+                safe to pick up a randomly-selected <code class="code"><em class="replaceable"><code>id </code></em></code> because there might be
+                some conflict with ones
                 already in use by Traffic Server. This can cause severe memory
-                corruption as the <code class="function">INKConfig</code> mechanism is
-                also used internally by Traffic Server.</p></td></tr>
+                corruption, since the <code class="function">INKConfig</code> mechanism is
+            also used internally by Traffic Server.</p></td></tr>
 </table></div>
-<p>The <code class="code"><em class="replaceable"><code>funcp</code></em></code>
-              parameter is a pointer to a destroy function which will be
+<p>The <code class="code"><em class="replaceable"><code>funcp </code></em></code>
+              parameter is a pointer to a destroy function that is
               called with <code class="code"><em class="replaceable"><code>data</code></em></code> as its
-              only parameter when Traffic Server determines that there are no
+              only parameter when Traffic Server determines  there are no
               more references to
               <code class="code"><em class="replaceable"><code>data</code></em></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><code class="code"><em class="replaceable"><code>data</code></em></code> will not be
-                destroyed while it is the current piece of configuration data
-                since the current data always has a reference count of at
-                least 1.</p></td></tr>
+<tr><td align="left" valign="top"><p>Since  the current data always has a reference count of at least 1, <code class="code"><em class="replaceable"><code> data </code></em></code> will not be
+                destroyed while it is the current piece of configuration data.</p></td></tr>
 </table></div>
 <p>See the code snippet in the previous section for
               usage.</p>
 </dd>
-<dt><span class="term">Returns</span></dt>
-<dd><p>The unsigned int that was assigned to the data. If the
-              input <code class="code"><em class="replaceable"><code>id</code></em></code> is 0 then a new
-              configuration identifier is allocated (of value 3 or larger). If
-              the input <code class="code"><em class="replaceable"><code>id</code></em></code> is 0, the
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+  <p>The unsigned <code>int</code> that was assigned to the data. If the
+              input <code class="code"><em class="replaceable"><code>id </code></em></code> is <code>0</code>, then a new
+              configuration identifier is allocated (with value 3 or larger). If
+              the input <code class="code"><em class="replaceable"><code>id </code></em></code> is <code>0</code>, then the 
               return value is the available identifier allocated by Traffic
-              Server. If <code class="code"><em class="replaceable"><code>id</code></em></code> is
-              non-zero, the return value is
-              <code class="code"><em class="replaceable"><code>id</code></em></code>.</p></dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
+              Server. If <code class="code"><em class="replaceable"><code>id </code></em></code> is
+              non-zero, then the return value is
+      <code class="code"><em class="replaceable"><code>id</code></em></code>.</p></dd>
 </dl></div>
 </div>
 </body>



Mime
View raw message