You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by ml...@apache.org on 2009/12/01 23:45:49 UTC
svn commit: r885984 [2/3] - /incubator/trafficserver/site/trunk/docs/sdk/
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKVIOVConnGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKVIOVConnGet.html?rev=885984&r1=885983&r2=885984&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKVIOVConnGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKVIOVConnGet.html Tue Dec 1 22:45:47 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>INKVIOVConnGet</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="VIOFunctions.html" title="VIO Functions">
-<link rel="prev" href="VIOFunctions.html" title="VIO Functions">
-<link rel="next" href="INKVIOContGet.html" title="INKVIOContGet">
-<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="VIOFunctions.html" title="VIO Functions" />
+<link rel="prev" href="VIOFunctions.html" title="VIO Functions" />
+<link rel="next" href="INKVIOContGet.html" title="INKVIOContGet" />
+<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,21 +59,19 @@
<a name="INKVIOVConnGet"></a>INKVIOVConnGet</h3></div></div></div>
<p>Gets a VIO connection.</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">INKVConn INKVIOVConnGet (INKVIO
<em class="replaceable"><code>viop</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd><p>Gets the vconnection associated with the IO operation
described by <code class="code"><em class="replaceable"><code>viop</code></em></code>. This
is the vconnection passed to <code class="function">INKVConnRead</code>
or <code class="function">INKVConnWrite</code>.</p></dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>The vconnection for the specified IO operation.</p>
<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
</body>
Modified: incubator/trafficserver/site/trunk/docs/sdk/IOBuffers_IO.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/IOBuffers_IO.html?rev=885984&r1=885983&r2=885984&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/IOBuffers_IO.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/IOBuffers_IO.html Tue Dec 1 22:45:47 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>IO Buffers</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="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="prev" href="VIOs_IO.html" title="VIOs">
-<link rel="next" href="CacheAPI.html" title="Guide to the Cache API">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="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="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="prev" href="VIOs_IO.html" title="VIOs" />
+<link rel="next" href="CacheAPI.html" title="Guide to the Cache API" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
document.write("<style> div.toc {display: none} </style>");
</script>
@@ -45,7 +45,7 @@
<body>
<div class="doctitle">
<a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
<div class="navprev">
@@ -58,36 +58,34 @@
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="IOBuffers_IO"></a>IO Buffers</h2></div></div></div>
<p>The IO buffer data structure is the building block of the
- vconnection abstraction. An IO buffer (<code class="function">INKIOBuffer</code>)
- is composed of a list of buffer blocks which in turn point to buffer
+ vconnection abstraction. An <b>IO buffer</b> (<code class="function">INKIOBuffer</code>)
+ is composed of a list of buffer blocks that point to buffer
data. Both the buffer block (<code class="function">INKIOBufferBlock</code>) and
buffer data (<code class="function">INKIOBufferData</code>) data structures are
- reference counted so that they can reside in multiple buffers at the
+ reference-counted so that they can reside in multiple buffers at the
same time. This makes it extremely efficient to copy data from one IO
- buffer to another using <code class="function">INKIOBufferCopy</code> since
- Traffic Server only needs to copy pointers and adjust reference counts
- appropriately and not actually copy any data.</p>
+ buffer to another via <code class="function">INKIOBufferCopy</code>, since
+ Traffic Server must only copy pointers and adjust reference counts
+ appropriately and doesn't actually copy any data.</p>
<p>The IO buffer abstraction provides for a single writer and
multiple readers. In order for the readers to have no knowledge of each
other, they manipulate IO buffers through the
<code class="function">INKIOBufferReader</code> data structure. Since only a
single writer is allowed, there is no corresponding
<code class="function">INKIOBufferWriter</code> data structure. The writer simply
- modifies the IO buffer directly.</p>
-<p>Refer to the sample code in the description of <a href="INKIOBufferBlockReadStart.html" title="INKIOBufferBlockReadStart">âINKIOBufferBlockReadStartâ</a> for a sample that illustrates how
- to use IOBuffers.</p>
-<p>The IO buffer functions are:</p>
+ modifies the IO buffer directly. To see an example that illustrates how
+ to use IOBuffers, refer to the sample code in the description of <a href="INKIOBufferBlockReadStart.html" title="INKIOBufferBlockReadStart">INKIOBufferBlockReadStart</a>.</p>
+<p>Additional information about IO buffer functions:</p>
<div class="itemizedlist"><ul type="disc">
-<li><p>The <code class="function">INKIOBufferReader</code> data structure
- keeps track of how much data in the <code class="function">INKIOBuffer</code>
- has been read. It has an offset number of bytes which is the current
- start point of a particular buffer reader. (For every read operation
- on an INKIOBuffer, you must allocate an
- <code class="function">INKIOBufferReader</code>).</p></li>
-<li><p>Note that the bytes that already have been read may or may not
- be freed within the <code class="code">INKIOBuffer</code>. You have to call
- <code class="function">INKIOBufferConsume</code> to consume bytes that have
- been read.</p></li>
+<li>
+ <p>The <code class="function">INKIOBufferReader</code> data structure
+ tracks how much data in <code class="function">INKIOBuffer</code>
+ has been read. It has an offset number of bytes that is the current
+ start point of a particular buffer reader (for every read operation
+ on an <code><b>INKIOBuffer</b></code>, you must allocate an <code class="function">INKIOBufferReader</code>).</p></li>
+<li>Bytes that have already been read may not
+ necessarily be freed within the <code class="code">INKIOBuffer</code>. To consume bytes that have been read, you must call
+ <code class="function">INKIOBufferConsume</code>.</li>
</ul></div>
</div>
</body>
Modified: incubator/trafficserver/site/trunk/docs/sdk/IOGuide.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/IOGuide.html?rev=885984&r1=885983&r2=885984&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/IOGuide.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/IOGuide.html Tue Dec 1 22:45:47 2009
@@ -1,49 +1,49 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Chapter 15. IO Guide</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="prev" href="HostsLookupAPI.html" title="Hosts Lookup API">
-<link rel="next" href="NetVconnections.html" title="Net Vconnections">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
-<link rel="section" href="IOGuide.html#Vconnections" title="Vconnections">
-<link rel="section" href="NetVconnections.html" title="Net Vconnections">
-<link rel="section" href="Transformations_IO.html" title="Transformations">
-<link rel="section" href="VIOs_IO.html" title="VIOs">
-<link rel="section" href="IOBuffers_IO.html" title="IO Buffers">
-<link rel="section" href="CacheAPI.html" title="Guide to the Cache API">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="prev" href="HostsLookupAPI.html" title="Hosts Lookup API" />
+<link rel="next" href="NetVconnections.html" title="Net Vconnections" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
+<link rel="section" href="IOGuide.html#Vconnections" title="Vconnections" />
+<link rel="section" href="NetVconnections.html" title="Net Vconnections" />
+<link rel="section" href="Transformations_IO.html" title="Transformations" />
+<link rel="section" href="VIOs_IO.html" title="VIOs" />
+<link rel="section" href="IOBuffers_IO.html" title="IO Buffers" />
+<link rel="section" href="CacheAPI.html" title="Guide to the Cache API" />
<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
document.write("<style> div.toc {display: none} </style>");
</script>
@@ -51,7 +51,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">
@@ -86,14 +86,14 @@
</dl></dd>
</dl>
</div>
-<p>This chapter contains:</p>
+<p>This chapter contains the following sections:</p>
<div class="itemizedlist"><ul type="disc">
-<li><p><a href="IOGuide.html#Vconnections" title="Vconnections">âVconnectionsâ</a></p></li>
-<li><p><a href="NetVconnections.html" title="Net Vconnections">âNet Vconnectionsâ</a></p></li>
-<li><p><a href="Transformations_IO.html" title="Transformations">âTransformationsâ</a></p></li>
-<li><p><a href="HTTPTransformationPlugins.html#VIOs" title="VIOs">âVIOsâ</a></p></li>
-<li><p><a href="HTTPTransformationPlugins.html#IOBuffers" title="IO Buffers">âIO Buffersâ</a></p></li>
-<li><p><a href="CacheAPI.html" title="Guide to the Cache API">âGuide to the Cache APIâ</a></p></li>
+<li><p><a href="IOGuide.html#Vconnections" title="Vconnections">Vconnections</a></p></li>
+<li><p><a href="NetVconnections.html" title="Net Vconnections">Net Vconnections</a></p></li>
+<li><p><a href="Transformations_IO.html" title="Transformations">Transformations</a></p></li>
+<li><p><a href="HTTPTransformationPlugins.html#VIOs" title="VIOs">VIOs</a></p></li>
+<li><p><a href="HTTPTransformationPlugins.html#IOBuffers" title="IO Buffers">IO Buffers</a></p></li>
+<li><p><a href="CacheAPI.html" title="Guide to the Cache API">Guide to the Cache API</a></p></li>
</ul></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -103,82 +103,81 @@
<div class="titlepage"><div><div><h3 class="title">
<a name="VconnectionUsersView"></a>The vconnection userâs view</h3></div></div></div>
<p>To use a vconnection, a user first needs to get a handle to one.
- This is usually accomplished by having it handed to the user or the
- user issuing a call which creates a vconnection such as
- <code class="function">INKNetConnect</code>. In the case of transform plugins,
- plugin creates a transformation vconnection using
- <code class="function">INKTransformCreate</code>, and accesses the output
+ This is usually accomplished by having it handed to the user or by the
+ user issuing a call that creates a vconnection (such as
+ <code class="function">INKNetConnect)</code>. In the case of transform plugins,
+ the plugin creates a transformation vconnection using
+ <code class="function">INKTransformCreate</code> and then accesses the output
vconnection using
<code class="function">INKTransformOutputVConnGet</code>.</p>
-<p>Once the user has a handle to a vconnection he can then issue a
+<p>Once the user has a handle to a vconnection, she can then issue a
read or write call. Itâs important to note that not all vconnections
- support both reading and writing. As of yet, there has not been a need
- to query a vconnection ask to whether it can perform a read or write
+ support both reading and writing - as of yet, there has not been a need
+ to query a vconnection as to whether it can perform a read or write
operation. That ability is obvious from context.</p>
-<p>To issue a read or write operation a user calls
+<p>To issue a read or write operation, a user calls
<code class="function">INKVConnRead</code> or
<code class="function">INKVConnWrite</code>. These two operations both return
- VIO (INKVIO). The VIO describes the operation being performed and how
- much progress has been made.</p>
-<p>Transform plugins initiate output to the downstream vconnection
+ VIO (<code>INKVIO</code>). The VIO describes the operation being performed and how
+ much progress has been made. Transform plugins initiate output to the downstream vconnection
by calling <code class="function">INKVConnWrite</code>.</p>
<p>A vconnection read or write operation is different from a normal
- Unix read(2) or write(2) operation in that the operation can specify
+ UNIX read(2) or write(2) operation. Specifically, the vconnection operation can specify
more data to be read or written than exists in the buffer handed to
- the operation. For example, it is typical to issue a read for
+ the operation. For example, it's typical to issue a read for
<code class="code">INT_MAX</code> <a class="indexterm" name="id387878"></a>(4 billion) bytes from a network vconnection in order to
- read all the data from the network connection until we reach the end
- of stream. Contrast this to the usual Unix fashion of issuing repeated
- calls to read(2) until one of them finally returns 0 indicating the
- end of stream was reached. (Yes, the underlying implementation of
- vconnections on Unix still issues those calls to read(2), but the
+ read all the data from the network connection until the end
+ of stream is reached. This contrasts with the usual UNIX fashion of issuing repeated
+ calls to read(2), until one of the calls finally returns 0 to indicate the
+ end of stream was reached (indeed, the underlying implementation of
+ vconnections on UNIX still does issue those calls to read(2), but the
interface does not expose that detail).</p>
<p>A given vconnection can have at most one read operation and one
write operation being performed on it. This is restricted both by
- design and common sense. If two write operations were to be performed
- on a single vconnection the user would not be able to specify which
- one should occur first and the output would occur in an intermingled
+ design and common sense: if two write operations were to be performed
+ on a single vconnection, then the user would not be able to specify which
+ should occur first and the output would occur in an intermingled
fashion. Note that both a read operation and a write operation can
- happen on a single vconnection at the same time. The restriction is on
+ happen on a single vconnection at the same time; the restriction is on
more than one operation of a given type.</p>
-<p>One issue that should be obvious is that the buffer passed to
+<p>One obvious issue is that the buffer passed to
<code class="function">INKVConnRead</code> and
- <code class="function">INKVConnWrite</code> wonât be large enough. There is no
+ <code class="function">INKVConnWrite</code> wonât be large enough - there is no
reasonable way to make a buffer that can hold <code class="code">INT_MAX</code> (4
billion) bytes. The secret is that vconnections engage in a protocol
- whereby they signal their user (the continuation passed to
+ whereby they signal to the user (the continuation passed to
<code class="function">INKVConnRead</code> and
- <code class="function">INKVConnWrite</code>) that they have emptied out the
- buffers passed to them and are ready for more data. When this occurs
+ <code class="function">INKVConnWrite</code>) that they have emptied the
+ buffers passed to them and are ready for more data. When this occurs,
it is up to the user to add more data to the buffers (or wait for more
data to be added) and then wake up the vconnection by calling
<code class="function">INKVIOReenable</code> on the VIO describing the
operation. <code class="function">INKVIOReenable</code> specifies that the
buffer for the operation has been modified and that the vconnection
should reexamine it to see if it can make further progress.</p>
-<p>The null transform plugin gives an example of how this is done.
- First, here is the prototype of
+<p>The null transform plugin provides an example of how this is done.
+ Below is a prototype for
<code class="function">INKVConnWrite</code>:</p>
<pre class="programlisting">INKVIO INKVConnWrite (INKVConn connp, INKCont contp, INKIOBufferReader readerp, int nbytes)</pre>
-<p>Where the <code class="varname">connp</code> is the vconnection that the
- user is writing to, and <code class="varname">contp</code> is the âuserâ â it is
- the continuation that connp calls back when it has emptied out its
+<p>The <code class="varname">connp</code> is the vconnection the
+ user is writing to and <code class="varname">contp</code> is the âuserâ â i.e.,
+ the continuation that <code>connp</code> calls back when it has emptied its
buffer and is ready for more data.</p>
<p>The call made in the null transform plugin is:</p>
<pre class="programlisting">INKVConnWrite (output_conn, contp, data->output_reader, INKVIONBytesGet (input_vio));</pre>
-<p>In this example, <code class="code">contp</code> is the transformation
- vconnection, which is writing to the output vconnection. The number of
- bytes to be written is obtained from the <code class="code">input_vio</code> by
+<p>In the example above, <code class="code">contp</code> is the transformation
+ vconnection that is writing to the output vconnection. The number of
+ bytes to be written is obtained from <code class="code">input_vio</code> by
<code class="function">INKVIONBytesGet</code>.</p>
<p>When a vconnection calls back its user to indicate that it wants
- more data or when some other condition has occurred, it issues a call
- to <code class="function">INKContCall</code> and passes one of the following
- values as the event parameter and the <code class="code">INKVIO</code> describing
- the operation as the data parameter.</p>
+ more data (or when some other condition has occurred), it issues a call
+ to <code class="function">INKContCall</code>. It passes the <code class="code">INKVIO</code> describing
+ the operation as the data parameter, and one of the
+ values below as the event parameter.</p>
<div class="informaltable"><table border="1">
<colgroup>
-<col>
-<col>
+<col />
+<col />
</colgroup>
<tbody>
<tr>
@@ -187,44 +186,44 @@
<td align="center"><span class="bold"><strong>Description</strong></span></td>
</tr>
<tr>
-<td>INK_EVENT_ERROR</td>
-<td>Indicates that an error has occurred on the
+<td><code>INK_EVENT_ERROR</code></td>
+<td>Indicates an error has occurred on the
vconnection. This will happen for network IO if the underlying
- read(2) or write(2) call return an error.</td>
+ read(2) or write(2) call returns an error.</td>
</tr>
<tr>
-<td>INK_EVENT_VCONN_READ_READY</td>
+<td><code>INK_EVENT_VCONN_READ_READY</code></td>
<td>The vconnection has placed data in the buffer passed to
an <code class="function">INKVConnRead</code> operation and it would
- like to do more IO but the buffer is now full. When the user
- consumes the data from the buffer it should re-enable the VIO
- to indicate to the vconnection that the buffer has been
+ like to do more IO, but the buffer is now full. When the user
+ consumes the data from the buffer, this should re-enable the VIO
+ so it indicates to the vconnection that the buffer has been
modified.</td>
</tr>
<tr>
-<td>INK_EVENT_VCONN_WRITE_READY</td>
+<td><code>INK_EVENT_VCONN_WRITE_READY</code></td>
<td>The vconnection has removed data from the buffer passed
to an <code class="function">INKVConnWrite</code> operation and it
- would like to do more IO but the buffer does not have enough
- data in it. When the user places more data in the buffer he
- should re-enable the VIO to indicate to the vconnection that
+ would like to do more IO, but the buffer does not have enough
+ data in it. When placing more data in the buffer, the user
+ should re-enable the VIO so it indicates to the vconnection that
the buffer has been modified.</td>
</tr>
<tr>
-<td>INK_EVENT_VCONN_READ_COMPLETE</td>
+<td><code>INK_EVENT_VCONN_READ_COMPLETE</code></td>
<td>The vconnection has read all the bytes specified by an
<code class="function">INKVConnRead</code> operation. The vconnection
can now be used to initiate a new IO operation.</td>
</tr>
<tr>
-<td>INK_EVENT_VCONN_WRITE_COMPLETE</td>
+<td><code>INK_EVENT_VCONN_WRITE_COMPLETE</code></td>
<td>The vconnection has written all the bytes specified by
an <code class="function">INKVConnWrite</code> operation. The
vconnection can now be used to initiate a new IO
operation.</td>
</tr>
<tr>
-<td>INK_EVENT_VCONN_EOS</td>
+<td><code>INK_EVENT_VCONN_EOS</code></td>
<td>An attempt was made to read past the end of the stream
of bytes during the handling of an
<code class="function">INKVConnRead</code> operation. This event occurs
@@ -233,36 +232,33 @@
specifies should be read from the vconnection in a call to
<code class="function">INKVConnRead</code>. A common case where this
occurs is when the user specifies that <code class="code">INT_MAX</code>
- bytes are to be read from network connection.</td>
+ bytes are to be read from a network connection.</td>
</tr>
</tbody>
</table></div>
-<p>The null transform pluginâs transformation, for example,
+<p>For example: the null transform pluginâs transformation
receives <code class="code">INK_EVENT_VCONN_WRITE_READY</code> and
<code class="code">INK_EVENT_VCONN_WRITE_COMPLETE</code> events from the downstream
vconnection as a result of the call to
<code class="function">INKVConnWrite</code>.</p>
-<p>When the user is finished using a vconnection he needs to call
+<p>After using a vconnection, the user must call
<code class="function">INKVConnClose</code> or
- <code class="function">INKVConnAbort</code>. Both calls indicate that the
- vconnection can destroy itself but <code class="function">INKVConnAbort</code>
+ <code class="function">INKVConnAbort</code>. While both calls indicate that the
+ vconnection can destroy itself, <code class="function">INKVConnAbort</code>
should be used when the connection is being closed abnormally. After a
call to <code class="function">INKVConnClose</code> or
- <code class="function">INKVConnAbort</code> the user will not be called back by
+ <code class="function">INKVConnAbort</code>, the user will not be called back by
the vconnection again.</p>
<p>Sometimes itâs desirable to simply close down the write portion
of a connection while keeping the read portion open. This can be
- accomplished using the <code class="function">INKVConnShutdown</code> function
- which will shutdown either the read or write portion of a vconnection.
- Shutdown means that the vconnection will no longer call back the user
- with events for the portion of the connection shutdown. For example,
- if the user shuts down the write portion of a connection he will no
- longer get <code class="code">INK_EVENT_VCONN_WRITE_READY</code> or
- <code class="code">INK_EVENT_VCONN_WRITE_COMPLETE</code> events.</p>
-<p>In the null transform plugin, the write operation is shut down
- with a call to <code class="function">INKVConnShutdown</code>.</p>
-<p>For a description of how vconnections are used in transformation
- plugins, see<a href="HTTPTransformationPlugins.html#WritingContentTransformPlugins" title="Writing Content Transform Plugins">âWriting Content Transform Pluginsâ</a>.</p>
+ accomplished via the <code class="function">INKVConnShutdown</code> function,
+ which shuts down either the read or write portion of a vconnection.
+ <i>Shutdown</i> means that the vconnection will no longer call back the user
+ with events for the portion of the connection that was shut down. For example:
+ if the user shuts down the write portion of a connection, then the <code class="code">INK_EVENT_VCONN_WRITE_READY</code> or
+ <code class="code">INK_EVENT_VCONN_WRITE_COMPLETE</code> events will not be produced. In the null transform plugin, the write operation is shut down
+ with a call to <code class="function">INKVConnShutdown</code>. To learn how vconnections are used in transformation
+ plugins, see <a href="HTTPTransformationPlugins.html#WritingContentTransformPlugins" title="Writing Content Transform Plugins">Writing Content Transform Plugins</a>.</p>
<p>The vconnection functions are:</p>
<div class="itemizedlist"><ul type="disc">
<li><p><code class="function">INKVConnAbort</code></p></li>
Modified: incubator/trafficserver/site/trunk/docs/sdk/InterceptingHTTPTransactionFuncs.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/InterceptingHTTPTransactionFuncs.html?rev=885984&r1=885983&r2=885984&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/InterceptingHTTPTransactionFuncs.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/InterceptingHTTPTransactionFuncs.html Tue Dec 1 22:45:47 2009
@@ -1,47 +1,47 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Intercepting HTTP Transaction Functions</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="prev" href="InitiateConnectionFunctions.html" title="Initiate Connection">
-<link rel="next" href="INKHttpTxnServerIntercept.html" title="INKHttpTxnServerIntercept">
-<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="InterceptingHTTPTransactionFuncs.html#INKHttpTxnIntercept" title="INKHttpTxnIntercept">
-<link rel="subsection" href="INKHttpTxnServerIntercept.html" title="INKHttpTxnServerIntercept">
-<link rel="subsection" href="AlternateSelectionFunctions.html" title="Alternate Selection Functions">
-<link rel="subsection" href="ch18s09s04.html" title="Handle Release Functions">
+<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="InitiateConnectionFunctions.html" title="Initiate Connection" />
+<link rel="next" href="INKHttpTxnServerIntercept.html" title="INKHttpTxnServerIntercept" />
+<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="InterceptingHTTPTransactionFuncs.html#INKHttpTxnIntercept" title="INKHttpTxnIntercept" />
+<link rel="subsection" href="INKHttpTxnServerIntercept.html" title="INKHttpTxnServerIntercept" />
+<link rel="subsection" href="AlternateSelectionFunctions.html" title="Alternate Selection Functions" />
+<link rel="subsection" href="ch18s09s04.html" title="Handle Release Functions" />
<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
document.write("<style> div.toc {display: none} </style>");
</script>
@@ -49,7 +49,7 @@
<body>
<div class="doctitle">
<a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
<div class="navprev">
@@ -64,61 +64,60 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="INKHttpTxnIntercept"></a>INKHttpTxnIntercept</h3></div></div></div>
-<p>Allows a plugin to intercept an HTTP clientâs request and to
- serve the content in place of the origin server.</p>
+<p>Enables a plugin to intercept an HTTP clientâs request and
+ serve content in place of the origin server.</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 INKHttpTxnIntercept (INKCont
<em class="replaceable"><code>contp</code></em>, INKHttpTxn
<em class="replaceable"><code>txnp</code></em>) </code></p></dd>
-<dt><span class="term">Arguments</span></dt>
+<dt><span class="term"><b>Arguments</b></span></dt>
<dd>
<p><code class="code">INKCont
- </code><code class="code"><em class="replaceable"><code>contp</code></em></code> is the
- continuation that is called to accept the connection.</p>
+ </code><code class="code"><em class="replaceable"><code>contp </code></em></code> is the
+ continuation called to accept the connection.</p>
<p><code class="code">INKHttpTxn
- </code><code class="code"><em class="replaceable"><code>txnp</code></em></code> is the
- current HTTP txn the plugin wants to intercept.</p>
+ </code><code class="code"><em class="replaceable"><code>txnp </code></em></code> is the
+ current HTTP transaction the plugin wants to intercept.</p>
</dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Allows a plugin to intercept an HTTP client's request and
- to serve the content in place of the origin server. The request
- is intercepted right after being read by Traffic Server. The
- origin server is not contacted.</p>
-<p>This API should be used in the
+ serve content in place of the origin server. The request
+ is intercepted immediately after it is read by Traffic Server; the
+ origin server is not contacted. This API should be used in the
<code class="code">INK_HTTP_READ_REQUEST_HDR_HOOK</code> hook.</p>
-<p>Once <code class="function">INKHttpTxnIntercept</code> has been
+<p>Once <code class="function">INKHttpTxnIntercept</code> is
called, the handler of the continuation
- <code class="code"><em class="replaceable"><code>contp</code></em></code> receives an event
+ <code class="code"><em class="replaceable"><code>contp </code></em></code> receives an event
<code class="code">INK_EVENT_NET_ACCEPT</code>. Note that the continuation
- passed should not have a <code class="code">NULL</code> mutex or an error is
- returned.</p>
-<p>The void *<code class="code"><em class="replaceable"><code>data</code></em></code>
+ passed should not have a <code class="code">NULL</code> mutex; if it does, then an error is
+ returned. The <code>void </code><code class="code"><em class="replaceable"><code>*data </code></em></code>
passed to the handler of the continuation
- <code class="code"><em class="replaceable"><code>contp</code></em></code> is a data of type
- NetVConnection representing the connection.</p>
-<p>Once VConnection is established, user can use regular
+ <code class="code"><em class="replaceable"><code>contp </code></em></code> is a data of type
+ NetVConnection that represents the connection. Once a vconnection is established, the user can use regular
VConnection operations (<code class="function">INKVConnRead</code>,
<code class="function">INKVConnWrite</code>, etc...).</p>
-<p>A typical scenario when using INKHttpTxnIntercept
- is:</p>
+<p>A typical scenario for using <code>INKHttpTxnIntercept</code> is as follows:</p>
<div class="itemizedlist"><ul type="disc">
<li><p>Call <code class="function">INKHttpTxnIntercept</code> from
hook <code class="code">INK_HTTP_READ_REQUEST_HDR_HOOK</code>.</p></li>
-<li><p>Get called back on the continuation's handler passed
- as argument to
+<li>
+ <p>Get called back on the continuation's handler that's passed
+ as an argument to
<code class="function">INKHttpTxnIntercept</code>.</p></li>
-<li><p>Get the VC from argument void
- *<code class="code"><em class="replaceable"><code>data</code></em></code> .</p></li>
-<li><p>Use <code class="function">INKVConnRead</code> to get the HTTP
- request. Note that you will not receive an event
- <code class="code">INK_VCONN_READ_COMPLETE</code>, only
- <code class="code">INK_VCONN_READ_READY</code>, as the number of
- characters to read is unknown. You should rely on
+<li>
+ <p>Get the vconnection from the argument <code>void
+ *</code><code class="code"><em class="replaceable"><code>data</code></em></code> .</p></li>
+<li>
+ <p>Use <code class="function">INKVConnRead</code> to get the HTTP
+ request. Note that you will not receive the event
+ <code class="code">INK_VCONN_READ_COMPLETE</code> - you will only receive the
+ <code class="code">INK_VCONN_READ_READY</code> event because the number of
+ characters to be read is unknown. You should rely on
<code class="function">INKTHttpParser</code> to parse the request and
- return a status <code class="code">INK_PARSE_DONE</code> when request is
- fully received (escape sequence â<code class="code">\r\n\r\n</code>â
+ then return a status <code class="code">INK_PARSE_DONE</code> when request is
+ fully received (escape sequence <code class="code">\r\n\r\n</code>
read).</p></li>
<li><p>Use <code class="function">INKHttpParser</code> to parse the
request.</p></li>
@@ -127,16 +126,16 @@
</ul></div>
<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>The request and response do not go through the Traffic
- Server HTTP state machine. So the request and response are not
+<tr><td align="left" valign="top"><p>Because the request and response do not go through the Traffic
+ Server HTTP state machine, neither is
cached by Traffic Server. The request is logged in
- squid.log.</p></td></tr>
+ <code>squid.log</code>.</p></td></tr>
</table></div>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if the API is called
successfully.</p>
@@ -145,8 +144,6 @@
returned if the continuation passed has a <code class="code">NULL</code>
mutex.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 5.2</p></dd>
</dl></div>
</div>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/InterceptingHTTPTx.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/InterceptingHTTPTx.html?rev=885984&r1=885983&r2=885984&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/InterceptingHTTPTx.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/InterceptingHTTPTx.html Tue Dec 1 22:45:47 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>Intercepting HTTP Transactions</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="prev" href="HTTP_Transactions.html" title="HTTP Transactions">
-<link rel="next" href="InitiateHTTPConnection.html" title="Initiate HTTP Connection">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="prev" href="HTTP_Transactions.html" title="HTTP Transactions" />
+<link rel="next" href="InitiateHTTPConnection.html" title="Initiate HTTP Connection" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
document.write("<style> div.toc {display: none} </style>");
</script>
@@ -45,7 +45,7 @@
<body>
<div class="doctitle">
<a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
<div class="navprev">
@@ -57,14 +57,13 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="InterceptingHTTPTx"></a>Intercepting HTTP Transactions</h2></div></div></div>
-<p>The intercepting HTTP transaction functions provide plugins the
- ability to intercept transactions either after the request is received
- or on contact with the origin server. The plugin acts as the origin
- server using the <code class="code">INKVConn</code> interface. Allows both for
- reading POST bodies in plugins as well as using alternative transports
+<p>The intercepting HTTP transaction functions enable plugins to intercept transactions either after the request is received
+ or upon contact with the origin server. The plugin then acts as the origin
+ server using the <code class="code">INKVConn</code> interface. The intercepting HTTP transaction function allow for
+ reading <code>POST</code> bodies in plugins as well as using alternative transports
to the origin server.The intercepting HTTP transaction functions
are:</p>
-<div class="itemizedlist"><ul type="disc"><li><p><a href="InterceptingHTTPTransactionFuncs.html#INKHttpTxnIntercept" title="INKHttpTxnIntercept">âINKHttpTxnInterceptâ</a></p></li></ul></div>
+<div class="itemizedlist"><ul type="disc"><li><p><a href="InterceptingHTTPTransactionFuncs.html#INKHttpTxnIntercept" title="INKHttpTxnIntercept">INKHttpTxnIntercept</a></p></li></ul></div>
</div>
</body>
</html>
Modified: incubator/trafficserver/site/trunk/docs/sdk/Interface_ThreadFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/Interface_ThreadFunctions.html?rev=885984&r1=885983&r2=885984&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/Interface_ThreadFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/Interface_ThreadFunctions.html Tue Dec 1 22:45:47 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>Thread 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="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="prev" href="MemoryAllocation.html" title="Memory Allocation">
-<link rel="next" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<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="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="prev" href="MemoryAllocation.html" title="Memory Allocation" />
+<link rel="next" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<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">
@@ -62,13 +62,13 @@
enables a single program to have more than one stream of execution and
to process more than one transaction at a time.</p>
<p>Threads serialize their access to shared resources and data using
- the <code class="function">INKMutex</code> type, described in <a href="MutexGuide.html#Mutexes" title="Mutexes">âMutexesâ</a>.</p>
+ the <code class="function">INKMutex</code> type, as described in <a href="MutexGuide.html#Mutexes" title="Mutexes">Mutexes</a>.</p>
<p>The thread functions are:</p>
<div class="itemizedlist"><ul type="disc">
-<li><p><a href="ThreadFunctions.html#INKThreadCreate" title="INKThreadCreate">âINKThreadCreateâ</a></p></li>
-<li><p><a href="INKThreadDestroy.html" title="INKThreadDestroy">âINKThreadDestroyâ</a></p></li>
-<li><p><a href="INKThreadInit.html" title="INKThreadInit">âINKThreadInitâ</a></p></li>
-<li><p><a href="INKThreadSelf.html" title="INKThreadSelf">âINKThreadSelfâ</a></p></li>
+<li><p><a href="ThreadFunctions.html#INKThreadCreate" title="INKThreadCreate">INKThreadCreate</a></p></li>
+<li><p><a href="INKThreadDestroy.html" title="INKThreadDestroy">INKThreadDestroy</a></p></li>
+<li><p><a href="INKThreadInit.html" title="INKThreadInit">INKThreadInit</a></p></li>
+<li><p><a href="INKThreadSelf.html" title="INKThreadSelf">INKThreadSelf</a></p></li>
</ul></div>
</div>
</body>