trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From andrew...@apache.org
Subject svn commit: r831152 [12/37] - in /incubator/trafficserver/site/trunk/docs: ./ admin/ admin/images/ sdk/ sdk/css/ sdk/images/ sdk/images/docbook/ sdk/js/
Date Thu, 29 Oct 2009 23:23:36 GMT
Added: incubator/trafficserver/site/trunk/docs/sdk/DebuggingFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/DebuggingFunctions.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/DebuggingFunctions.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/DebuggingFunctions.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,124 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Debugging Functions</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="prev" href="INKTrafficServerVersionGet.html" title="INKTrafficServerVersionGet">
+<link rel="next" href="INKIsDebugTagSet.html" title="INKIsDebugTagSet">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="subsection" href="DebuggingFunctions.html#INKDebug" title="INKDebug">
+<link rel="subsection" href="INKIsDebugTagSet.html" title="INKIsDebugTagSet">
+<link rel="subsection" href="INKError.html" title="INKError">
+<link rel="subsection" href="INKAssert.html" title="INKAssert">
+<link rel="subsection" href="INKReleaseAssert.html" title="INKReleaseAssert">
+<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>
+</head>
+<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>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKTrafficServerVersionGet.html">Prev</a> — INKTrafficServerVersionGet</div>
+<div class="navnext">INKIsDebugTagSet — <a accesskey="n" href="INKIsDebugTagSet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="DebuggingFunctions"></a>Debugging Functions</h2></div></div></div>
+<p>The debugging functions are:</p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKDebug"></a>INKDebug</h3></div></div></div>
+<p>Issues debug statements.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">void INKDebug (const char
+              <em class="replaceable"><code>*tag</code></em>, const char
+              <em class="replaceable"><code>*format_str</code></em>, ...)</code></p></dd>
+<dt><span class="term">Arguments</span></dt>
+<dd>
+<p><em class="parameter"><code>tag</code></em> is the Traffic Server parameter
+              that enables Traffic Server to print out
+              <em class="parameter"><code>format_str</code></em>.</p>
+<p><code class="code">... </code>is a variable for
+              <em class="parameter"><code>format_str</code></em>.</p>
+</dd>
+<dt><span class="term">Description</span></dt>
+<dd>
+<p><code class="code">INKDebug</code> prints out the statement
+              <code class="code">format_str</code> if debugging is enabled. There are two
+              ways to enable debugging:</p>
+<div class="itemizedlist"><ul type="disc">
+<li>
+<p>On UNIX systems, run Traffic Server with the
+                  <code class="option">-Ttag</code> option. For example, if the tag
+                  is</p>
+<pre class="programlisting">my-plugin: traffic_server -Tmy-plugin</pre>
+<p>In this case, the debug output goes to
+                  <code class="filename">traffic.out</code>.</p>
+</li>
+<li>
+<p>On either UNIX or Windows NT systems, set the
+                  following variables in <code class="filename">records.config</code>
+                  (in the Traffic Server config directory):</p>
+<pre class="programlisting">proxy.config.diags.debug.enabled INT 1
+proxy.config.diags.debug.tags STRING debug-tag-name</pre>
+<p>In this case, debug output goes to
+                  <code class="filename">traffic.out</code> on UNIX systems, and to
+                  diags.log on Windows NT systems.</p>
+</li>
+</ul></div>
+</dd>
+<dt><span class="term">Example</span></dt>
+<dd>
+<p><code class="code">INKDebug ("my-plugin", “Starting my-plugin at %d\n”,
+              the_time);</code></p>
+<p>The statement “Starting my-plugin at
+              <em class="replaceable"><code>&lt;time&gt;</code></em>” appears whenever you
+              run Traffic Server with the my-plugin tag:</p>
+<pre class="programlisting">traffic_server -Tmy-plugin</pre>
+</dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.5</p></dd>
+</dl></div>
+</div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/DebuggingFunctions.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/Dep_IOBufferInterface.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/Dep_IOBufferInterface.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/Dep_IOBufferInterface.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/Dep_IOBufferInterface.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,160 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>IO Buffer Interface</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="OtherDeprecatedFunctions.html" title="Other Deprecated Functions">
+<link rel="prev" href="OtherDeprecatedFunctions.html" title="Other Deprecated Functions">
+<link rel="next" href="Dep_MutexFunctions.html" title="Mutex Function">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="subsection" href="Dep_IOBufferInterface.html#INKIOBufferAppend" title="INKIOBufferAppend">
+<link rel="subsection" href="Dep_IOBufferInterface.html#INKIOBufferBlockCreate" title="INKIOBufferBlockCreate">
+<link rel="subsection" href="Dep_IOBufferInterface.html#INKIOBufferDataCreate" title="INKIOBufferDataCreate">
+<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>
+</head>
+<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>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="OtherDeprecatedFunctions.html">Prev</a> — Other Deprecated Functions</div>
+<div class="navnext">Mutex Function — <a accesskey="n" href="Dep_MutexFunctions.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="Dep_IOBufferInterface"></a>IO Buffer Interface</h3></div></div></div>
+<p></p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="INKIOBufferAppend"></a>INKIOBufferAppend</h4></div></div></div>
+<p>Appends to an IO buffer.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p>INKReturnCode INKIOBufferAppend (INKIOBuffer bufp,
+                INKIOBufferBlock blockp)</p></dd>
+<dt><span class="term">Description</span></dt>
+<dd><p>Appends a block to the IO buffer bufp. The data in the
+                appended block is made available for reading.</p></dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p>INK_SUCCESS if the block was successfully appended to
+                the specified IO buffer.</p>
+<p>INK_ERROR if an error occurred.</p>
+</dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="INKIOBufferBlockCreate"></a>INKIOBufferBlockCreate</h4></div></div></div>
+<p>Creates an IO buffer block.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">INKIOBufferBlock INKIOBufferBlockCreate
+                (INKIOBufferData <em class="replaceable"><code>datap</code></em>, int
+                <em class="replaceable"><code>size</code></em>, int
+                <em class="replaceable"><code>offset</code></em>)</code></p></dd>
+<dt><span class="term">Description</span></dt>
+<dd><p>Creates a new IO buffer block and initializes it with
+                the IO buffer data
+                <code class="code"><em class="replaceable"><code>datap</code></em></code>. The
+                <code class="code"><em class="replaceable"><code>size</code></em></code> parameter is the
+                amount of data that is initially available for reading in this
+                new buffer block. The
+                <code class="code"><em class="replaceable"><code>offset</code></em></code> parameter is
+                the offset into <code class="code"><em class="replaceable"><code>datap</code></em></code>
+                at which will be used as the start for the block. The two
+                common uses for <code class="function">INKIOBufferBlockCreate</code>
+                are to create an empty block by specifying size as 0 and to
+                create a full block by specifying size as the total size of
+                <code class="code">datap</code>. The newly created block should be added
+                almost immediately to an IO buffer by a call to
+                <code class="function">INKIOBufferAppend</code> since there is no
+                function for destroying a buffer block other than relying on
+                it automatically being destroyed by an IO buffer.</p></dd>
+<dt><span class="term">Returns</span></dt>
+<dd><p>The newly created IO buffer block.</p></dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="INKIOBufferDataCreate"></a>INKIOBufferDataCreate</h4></div></div></div>
+<p>Creates IO buffer data.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">INKIOBufferData INKIOBufferDataCreate (void*
+                <em class="replaceable"><code>data</code></em>, int
+                <em class="replaceable"><code>size</code></em>, INKIOBufferDataFlags
+                <em class="replaceable"><code>flags</code></em>)</code></p></dd>
+<dt><span class="term">Description</span></dt>
+<dd>
+<p>Creates a new IO buffer data and initialize it with
+                <code class="code"><em class="replaceable"><code>data</code></em></code>,
+                <code class="code"><em class="replaceable"><code>size</code></em></code>. The
+                <code class="code"><em class="replaceable"><code>flags</code></em></code> parameter
+                specifies how to interpret data.</p>
+<p><code class="code">INK_DATA_ALLOCATE</code></p>
+<p>The data pointer is <code class="code">NULL</code> and the data
+                associated with the <code class="function">INKIOBufferData</code>
+                should be allocated.
+                <code class="function">INKIOBufferDataCreate</code> rounds size to a
+                power of 2 less than or equal to 32K.</p>
+<p><code class="code">INK_DATA_MALLOCED</code></p>
+<p>The data pointer was allocated by
+                <code class="function">INKmalloc</code> and will be freed when the last
+                reference to the new <code class="function">INKIOBufferData</code> is
+                released by a call to <code class="function">INKfree</code>.</p>
+<p><code class="code">INK_DATA_CONSTANT</code></p>
+<p>The data pointer is data that should not be freed when
+                the last reference to the new
+                <code class="function">INKIOBufferData</code> is released.</p>
+</dd>
+<dt><span class="term">Returns</span></dt>
+<dd><p>A handle to the newly created IO buffer.</p></dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/Dep_IOBufferInterface.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/Dep_MutexFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/Dep_MutexFunctions.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/Dep_MutexFunctions.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/Dep_MutexFunctions.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,108 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Mutex Function</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="OtherDeprecatedFunctions.html" title="Other Deprecated Functions">
+<link rel="prev" href="Dep_IOBufferInterface.html" title="IO Buffer Interface">
+<link rel="next" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="subsection" href="Dep_MutexFunctions.html#InkMutexTryLock" title="InkMutexTryLock">
+<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>
+</head>
+<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>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="Dep_IOBufferInterface.html">Prev</a> — IO Buffer Interface</div>
+<div class="navnext">Appendix C. Troubleshooting Tips — <a accesskey="n" href="App_Troubleshooting.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="Dep_MutexFunctions"></a>Mutex Function</h3></div></div></div>
+<p></p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="InkMutexTryLock"></a>InkMutexTryLock</h4></div></div></div>
+<p>Tries to lock an <code class="code">INKMutex</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">INKReturnCode InkMutexTryLock (INKMutex
+                <em class="replaceable"><code>mutex</code></em>, int
+                *<em class="replaceable"><code>is_mutex_lock</code></em>)</code></p></dd>
+<dt><span class="term">Description</span></dt>
+<dd>
+<p>Tries to lock the <code class="code">INKMutex</code> mutex.</p>
+<p>In general, use <code class="code">InkMutexTryLock</code> to obtain a
+                mutex. See the example below.</p>
+<p>This API has been deprecated by
+                <code class="code">INKMutexLockTry</code>.</p>
+</dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p>If the mutex was successfully locked, 1 will be
+                returned.</p>
+<p>If mutex is already locked then 0 will be
+                returned.</p>
+</dd>
+<dt><span class="term">Example</span></dt>
+<dd><pre class="programlisting">int handler (INKCont contp, INKEvent event, void *edata)
+{
+   //this continuation tries to grab a mutex
+   int lock = InkMutexTryLock (mutex);
+   if (!lock)
+   {
+   /* Schedule a retry; RETRY_TIME should be 10 ms or longer. */
+      INKContSchedule (contp, RETRY_TIME); 
+      return INK_EVENT_IMMEDIATE;
+   }
+
+   // Now the mutex is grabbed
+   do_some_job ...
+   INKMutexUnlock (mutexp);
+}</pre></dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0a</p></dd>
+</dl></div>
+</div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/Dep_MutexFunctions.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/DeprecatedMarshBufFuncs.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/DeprecatedMarshBufFuncs.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/DeprecatedMarshBufFuncs.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/DeprecatedMarshBufFuncs.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,117 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Deprecated Functions</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="GuideTSHTTPHdrSyst.html" title="Guide to Traffic Server HTTP Header System">
+<link rel="prev" href="RlsMarshalBufHandles.html" title="Release Marshal Buffer Handles">
+<link rel="next" href="MarshalBuffers.html" title="Marshal Buffers">
+<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>
+</head>
+<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>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="RlsMarshalBufHandles.html">Prev</a> — Release Marshal Buffer Handles</div>
+<div class="navnext">Marshal Buffers — <a accesskey="n" href="MarshalBuffers.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="DeprecatedMarshBufFuncs"></a>Deprecated Functions<a class="indexterm" name="id381488"></a></h3></div></div></div>
+<p>Several marshal buffer functions and MIME field functions are
+        deprecated in this release. The following marshal buffer functions are
+        deprecated. Do not use them:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><code class="function">INKMBufferCompress</code></p></li>
+<li><p><code class="function">INKMBufferDataGet</code></p></li>
+<li><p><code class="function">INKMBufferDataSet</code></p></li>
+<li><p><code class="function">INKMBufferLengthGet</code></p></li>
+<li><p><code class="function">INKMBufferRef</code></p></li>
+<li><p><code class="function">INKMBufferUnref</code></p></li>
+</ul></div>
+<p>The following MIME field functions are deprecated. If you need
+        to support these functions in existing code, documentation is provided
+        in <a href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">Appendix B, <i>Deprecated Functions</i></a>.</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><code class="function">INKMimeFieldCreate</code></p></li>
+<li><p><code class="function">INKMimeFieldDestroy</code></p></li>
+<li><p><code class="function">INKMimeFieldCopy</code></p></li>
+<li><p><code class="function">INKMimeFieldCopyValues</code></p></li>
+<li><p><code class="function">INKMimeFieldNext</code></p></li>
+<li><p><code class="function">INKMimeFieldLengthGet</code></p></li>
+<li><p><code class="function">INKMimeFieldNameGet</code></p></li>
+<li><p><code class="function">INKMimeFieldNameSet</code></p></li>
+<li><p><code class="function">INKMimeFieldValuesClear</code></p></li>
+<li><p><code class="function">INKMimeFieldValuesCount</code></p></li>
+<li><p><code class="function">INKMimeFieldValueGet</code></p></li>
+<li><p><code class="function">INKMimeFieldValueGetInt</code></p></li>
+<li><p><code class="function">INKMimeFieldValueGetUint</code></p></li>
+<li><p><code class="function">INKMimeFieldValueGetDate</code></p></li>
+<li><p><code class="function">INKMimeFieldValueSet</code></p></li>
+<li><p><code class="function">INKMimeFieldValueSetInt</code></p></li>
+<li><p><code class="function">INKMimeFieldValueSetUint</code></p></li>
+<li><p><code class="function">INKMimeFieldValueSetDate</code></p></li>
+<li><p><code class="function">INKMimeFieldValueAppend</code></p></li>
+<li><p><code class="function">INKMimeFieldValueInsert</code></p></li>
+<li><p><code class="function">INKMimeFieldValueInsertInt</code></p></li>
+<li><p><code class="function">INKMimeFieldValueInsertUint</code></p></li>
+<li><p><code class="function">INKMimeFieldValueInsertDate</code></p></li>
+<li><p><code class="function">INKMimeFieldValueDelete</code></p></li>
+<li><p><code class="function">INKMimeHdrFieldValueGet</code></p></li>
+<li><p><code class="function">INKMimeHdrFieldValueGetDate</code></p></li>
+<li><p><code class="function">INKMimeHdrFieldValueGetInt</code></p></li>
+<li><p><code class="function">INKMimeHdrFieldValueGetUint</code></p></li>
+<li><p><code class="function">INKMimeHdrFieldValueInsert</code></p></li>
+<li><p><code class="function">INKMimeHdrFieldValueInsertDate</code></p></li>
+<li><p><code class="function">INKMimeHdrFieldValueInsertInt</code></p></li>
+<li><p><code class="function">INKMimeHdrFieldValueInsertUint</code></p></li>
+<li><p><code class="function">INKMimeHdrFieldValueSet</code></p></li>
+<li><p><code class="function">INKMimeHdrFieldValueSetDate</code></p></li>
+<li><p><code class="function">INKMimeHdrFieldValueSetInt</code></p></li>
+<li><p><code class="function">INKMimeHdrFieldValueSetUint</code></p></li>
+<li><p><code class="function">INKMimeHdrFieldDelete</code></p></li>
+<li><p><code class="function">INKMimeHdrFieldInsert</code></p></li>
+<li><p><code class="function">INKMimeHdrFieldRetrieve</code></p></li>
+</ul></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/DeprecatedMarshBufFuncs.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/DoACacheRemove.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/DoACacheRemove.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/DoACacheRemove.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/DoACacheRemove.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,72 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>How to Do a Cache Remove</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="CacheAPI.html" title="Guide to the Cache API">
+<link rel="prev" href="DoACacheWrite.html" title="How to Do a Cache Write">
+<link rel="next" href="Errors_Cache.html" title="Errors">
+<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>
+</head>
+<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>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="DoACacheWrite.html">Prev</a> — How to Do a Cache Write</div>
+<div class="navnext">Errors — <a accesskey="n" href="Errors_Cache.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="DoACacheRemove"></a>How to Do a Cache Remove</h3></div></div></div>
+<p>Use <code class="function">INKCacheRemove</code> to remove items from the
+        cache. The possible callback events include:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><code class="code">INK_EVENT_CACHE_REMOVE</code> - item was removed.
+            There is not data payload for this event.</p></li>
+<li><p><code class="code">INK_EVENT_CACHE_REMOVE_FAILED</code> - indicating that
+            the cache was unabled to remove the item idetified by the cache
+            key. Data indicates the reason why the removed failed
+            (<code class="function">INKCacheError</code>).</p></li>
+</ul></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/DoACacheRemove.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/DoACacheWrite.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/DoACacheWrite.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/DoACacheWrite.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/DoACacheWrite.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,76 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>How to Do a Cache Write</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="CacheAPI.html" title="Guide to the Cache API">
+<link rel="prev" href="CacheAPI.html" title="Guide to the Cache API">
+<link rel="next" href="DoACacheRemove.html" title="How to Do a Cache Remove">
+<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>
+</head>
+<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>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="CacheAPI.html">Prev</a> — Guide to the Cache API</div>
+<div class="navnext">How to Do a Cache Remove — <a accesskey="n" href="DoACacheRemove.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="DoACacheWrite"></a>How to Do a Cache Write</h3></div></div></div>
+<p>Use <code class="function">INKCacheWrite</code> to write to a cache. See
+        the sample Protocol plugin. The possible callback events
+        include:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><code class="code">INK_EVENT_CACHE_WRITE_READ</code> - indicating that
+            the lookup was successful, the data passed back along with this
+            event is a cache vconnection that may be used to initiate a write
+            to the cache.</p></li>
+<li><p><code class="code">INK_EVENT_CACHE_OPEN_WRITE_FAILED</code> - The event
+            is returned if another continuation is currently writing to this
+            location in the cache. Data payload for this event indicates the
+            possible reason for the write failing
+            (<code class="function">INKCacheError</code>).</p></li>
+</ul></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/DoACacheWrite.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/DuplicateMIMEFlds.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/DuplicateMIMEFlds.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/DuplicateMIMEFlds.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/DuplicateMIMEFlds.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,73 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Duplicate MIME Fields Are Not Coalesced</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="GuideTSHTTPHdrSyst.html" title="Guide to Traffic Server HTTP Header System">
+<link rel="prev" href="GuideTSHTTPHdrSyst.html" title="Guide to Traffic Server HTTP Header System">
+<link rel="next" href="MIMEFldsBelongAssocMIMEHdr.html" title="MIME Fields Always Belong to an Associated MIME
+        Header">
+<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>
+</head>
+<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>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="GuideTSHTTPHdrSyst.html">Prev</a> — Guide to Traffic Server HTTP Header System</div>
+<div class="navnext">MIME Fields Always Belong to an Associated MIME
+        Header — <a accesskey="n" href="MIMEFldsBelongAssocMIMEHdr.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="DuplicateMIMEFlds"></a>Duplicate MIME Fields Are Not Coalesced<a class="indexterm" name="id381001"></a></h3></div></div></div>
+<p>MIME headers may contain more than one MIME field with the same
+        name. Pre-4.0 versions of Traffic Server joined multiple fields with
+        the same name into one field with composite values. This behavior
+        comes at a performance cost, and causes interoperability problems with
+        some older clients and servers. Traffic Server 4.0 and newer ceases
+        coalescing duplicate fields.</p>
+<p>Correctly behaving plugins should check for the presence of
+        duplicate fields, and iterate over the duplicate fields, by using
+        <code class="function">INKMimeHdrFieldNextDup</code> (see <a href="MimeHeadersFunctions.html#INKMimeHdrFieldNextDup" title="INKMimeHdrFieldNextDup">“INKMimeHdrFieldNextDup”</a>).</p>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/DuplicateMIMEFlds.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/Errors_Cache.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/Errors_Cache.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/Errors_Cache.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/Errors_Cache.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,72 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Errors</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="CacheAPI.html" title="Guide to the Cache API">
+<link rel="prev" href="DoACacheRemove.html" title="How to Do a Cache Remove">
+<link rel="next" href="CacheAPI_Example.html" title="Example">
+<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>
+</head>
+<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>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="DoACacheRemove.html">Prev</a> — How to Do a Cache Remove</div>
+<div class="navnext">Example — <a accesskey="n" href="CacheAPI_Example.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="Errors_Cache"></a>Errors</h3></div></div></div>
+<p>Errors as to why various cache operations failed are indicated
+        by <code class="function">INKCacheError</code> (enumeration) as follows:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><code class="code">INK_CACHE_ERROR_NO_DOC</code> - key does not match a
+            cached resource.</p></li>
+<li><p><code class="code">INK_CACHE_ERROR_DOC_BUSY</code> - e.g, another
+            continuation could be writing to that cache location.</p></li>
+<li><p><code class="code">INK_CACHE_ERROR_NOT_READY</code> - the cache is not
+            ready.</p></li>
+</ul></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/Errors_Cache.html
------------------------------------------------------------------------------
    svn:keywords = Id



Mime
View raw message