You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by di...@apache.org on 2009/12/15 21:36:41 UTC
svn commit: r890975 [9/10] - /incubator/trafficserver/site/trunk/docs/sdk/
Modified: incubator/trafficserver/site/trunk/docs/sdk/URLs.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/URLs.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/URLs.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/URLs.html Tue Dec 15 20:36:40 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>URLs</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="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="prev" href="HTTPHeaders2.html" title="HTTP Headers">
-<link rel="next" href="MIMEHeaders.html" title="MIME 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="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="prev" href="HTTPHeaders2.html" title="HTTP Headers" />
+<link rel="next" href="MIMEHeaders.html" title="MIME 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">
@@ -59,7 +59,7 @@
<a name="URLs"></a>URLs</h2></div></div></div>
<p>API URL functions provide access to URL data stored in marshal
buffers. The URL functions can create, copy, retrieve or delete entire
- URLs, and retrieve or modify parts of URLs, such as their port or scheme
+ URLs; they can also etrieve or modify parts of URLs, such as port or scheme
information.</p>
<p>The general form of an Internet URL is:</p>
<pre class="programlisting">scheme://user:password@host:port/stuff</pre>
@@ -69,17 +69,16 @@
<p>FTP URLs have the form:</p>
<pre class="programlisting">ftp://user:password@host:port/path;type=val</pre>
<p>The URL port and FTP type are stored as integers. All remaining
- parts of the URL (the scheme, user, etc.) are stored as strings.</p>
-<p>URL functions are named according to the portion of the URL on
+ parts of the URL (scheme, user, etc.) are stored as strings. Traffic Server URL functions are named according to the portion of the URL on
which they operate. For instance, the function that retrieves the host
portion of a URL is named <code class="function">INKUrlHostGet</code>.</p>
-<p>To facilitate fast comparisons and to reduce storage size, Traffic
+<p>To facilitate fast comparisons and reduce storage size, Traffic
Server defines several preallocated scheme names.</p>
<div class="informaltable"><table border="1">
<colgroup>
-<col>
-<col>
-<col>
+<col />
+<col />
+<col />
</colgroup>
<tbody>
<tr>
@@ -91,74 +90,72 @@
Lengths</strong></span></td>
</tr>
<tr>
-<td>INK_URL_SCHEME_FILE</td>
+<td><code>INK_URL_SCHEME_FILE</code></td>
<td>âfileâ</td>
-<td>INK_URL_LEN_FILE</td>
+<td><code>INK_URL_LEN_FILE</code></td>
</tr>
<tr>
-<td>INK_URL_SCHEME_FTP</td>
+<td><code>INK_URL_SCHEME_FTP</code></td>
<td>âftpâ</td>
-<td>INK_URL_LEN_FTP</td>
+<td><code>INK_URL_LEN_FTP</code></td>
</tr>
<tr>
-<td>INK_URL_SCHEME_GOPHER</td>
+<td><code>INK_URL_SCHEME_GOPHER</code></td>
<td>âgopherâ</td>
-<td>INK_URL_LEN_GOPHER</td>
+<td><code>INK_URL_LEN_GOPHER</code></td>
</tr>
<tr>
-<td>INK_URL_SCHEME_HTTP</td>
+<td><code>INK_URL_SCHEME_HTTP</code></td>
<td>âhttpâ</td>
-<td>INK_URL_LEN_HTTP</td>
+<td><code>INK_URL_LEN_HTTP</code></td>
</tr>
<tr>
-<td>INK_URL_SCHEME_HTTPS</td>
+<td><code>INK_URL_SCHEME_HTTPS</code></td>
<td>âhttpsâ</td>
-<td>INK_URL_LEN_HTTPS</td>
+<td><code>INK_URL_LEN_HTTPS</code></td>
</tr>
<tr>
-<td>INK_URL_SCHEME_MAILTO</td>
+<td><code>INK_URL_SCHEME_MAILTO</code></td>
<td>âmailtoâ</td>
-<td>INK_URL_LEN_MAILTO</td>
+<td><code>INK_URL_LEN_MAILTO</code></td>
</tr>
<tr>
-<td>INK_URL_SCHEME_NEWS</td>
+<td><code>INK_URL_SCHEME_NEWS</code></td>
<td>ânewsâ</td>
-<td>INK_URL_LEN_NEWS</td>
+<td><code>INK_URL_LEN_NEWS</code></td>
</tr>
<tr>
-<td>INK_URL_SCHEME_NNTP</td>
+<td><code>INK_URL_SCHEME_NNTP</code></td>
<td>ânntpâ</td>
-<td>INK_URL_LEN_NNTP</td>
+<td><code>INK_URL_LEN_NNTP</code></td>
</tr>
<tr>
-<td>INK_URL_SCHEME_PROSPERO</td>
+<td><code>INK_URL_SCHEME_PROSPERO</code></td>
<td>âprosperoâ</td>
-<td>INK_URL_LEN_PROSPERO</td>
+<td><code>INK_URL_LEN_PROSPERO</code></td>
</tr>
<tr>
-<td>INK_URL_SCHEME_TELNET</td>
+<td><code>INK_URL_SCHEME_TELNET</code></td>
<td>âtelnetâ</td>
-<td>INK_URL_LEN_TELNET</td>
+<td><code>INK_URL_LEN_TELNET</code></td>
</tr>
<tr>
-<td>INK_URL_SCHEME_WAIS</td>
+<td><code>INK_URL_SCHEME_WAIS</code></td>
<td>âwaisâ</td>
-<td>INK_URL_LEN_WAIS</td>
+<td><code>INK_URL_LEN_WAIS</code></td>
</tr>
</tbody>
</table></div>
-<p>The scheme names above are defined in InkAPI.h as const char*
- strings. When Traffic Server sets the scheme portion of the URL (or any
- portion for that matter), it makes a quick check to see if the new value
- is one of the known values. If it is, instead of storing the known value
- in the marshal buffer, it stores a pointer into a global table. The
+<p>The scheme names above are defined in <code>InkAPI.h</code> as <code>const</code> <code>char*</code> strings. When Traffic Server sets the scheme portion of the URL (or any
+ portion for that matter), it quickly checks to see if the new value
+ is one of the known values. If it is, then it stores a pointer into a global table (instead of storing the known value
+ in the marshal buffer). The
scheme values listed above are also pointers into this table. This
allows simple pointer comparison of the value returned from
- INKUrlSchemeGet with one of the values listed above. Inktomi recommends
- that you use the Traffic Server-defined values when referring to one of
- the known schemes, as doing so removes the possibility of a spelling
- error.</p>
-<p>The URL functions are:</p>
+ <code>INKUrlSchemeGet</code> with one of the values listed above. You should
+ use the Traffic Server-defined values when referring to one of
+ the known schemes, since it prevents possible spelling errors.</p>
+<p>The URL functions are listed below:</p>
<div class="itemizedlist"><ul type="disc">
<li><p><code class="function">INKUrlClone</code></p></li>
<li><p><code class="function">INKUrlCopy</code></p></li>
Modified: incubator/trafficserver/site/trunk/docs/sdk/Updatingplugin.configFile.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/Updatingplugin.configFile.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/Updatingplugin.configFile.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/Updatingplugin.configFile.html Tue Dec 15 20:36:40 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>Update the plugin.config File</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="ASimplePlugin.html" title="A Simple Plugin">
-<link rel="prev" href="ASimplePlugin.html" title="A Simple Plugin">
-<link rel="next" href="SpecifyingPluginLocation.html" title="Specify the Pluginâs Location">
-<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="ASimplePlugin.html" title="A Simple Plugin" />
+<link rel="prev" href="ASimplePlugin.html" title="A Simple Plugin" />
+<link rel="next" href="SpecifyingPluginLocation.html" title="Specify the Pluginâs Location" />
+<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">
@@ -65,8 +65,8 @@
hello-world.so</pre>
<p><a name="MultiplePlugins"></a>Traffic Server can accommodate multiple
plugins. If several plugin functions are triggered by the same event,
- then Traffic Server invokes each pluginâs function in the order they
- were defined in the <code class="filename">plugin.config</code> file.<a class="indexterm" name="id307332"></a></p>
+ then Traffic Server invokes each pluginâs function in the order each was
+ defined in the <code class="filename">plugin.config</code> file.<a class="indexterm" name="id307332"></a></p>
</div>
</body>
</html>
Modified: incubator/trafficserver/site/trunk/docs/sdk/VIOs_IO.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/VIOs_IO.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/VIOs_IO.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/VIOs_IO.html Tue Dec 15 20:36:40 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>VIOs</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="Transformations_IO.html" title="Transformations">
-<link rel="next" href="IOBuffers_IO.html" title="IO 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">
+<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="Transformations_IO.html" title="Transformations" />
+<link rel="next" href="IOBuffers_IO.html" title="IO 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>
@@ -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,16 +57,16 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="VIOs_IO"></a>VIOs</h2></div></div></div>
-<p>A VIO or virtual IO is a description of an in progress IO
- operation. The VIO data structure is used by vconnection users to
+<p>A <b>VIO</b>, or virtual IO, is a description of an IO
+ operation that's in progress. The VIO data structure is used by vconnection users to
determine how much progress has been made on a particular IO operation
- and to re-enable an IO operation when it stalls due to buffer space.
+ and to re-enable an IO operation when it stalls due to buffer space issues.
VIOs are used by vconnection implementors to determine the buffer for an
- IO operation, to determine how much work to do on the IO operation and
- to determine which continuation to call back when progress on the IO
+ IO operation, how much work to do on the IO operation, and
+ which continuation to call back when progress on the IO
operation is made.</p>
<p>The <code class="function">INKVIO</code> data structure itself is opaque,
- but it might have been defined as follows:</p>
+ but it could be defined as follows:</p>
<pre class="programlisting">typedef struct {
INKCont continuation;
INKVConn vconnection;
Modified: incubator/trafficserver/site/trunk/docs/sdk/ViewStatsUsingTrafLine.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/ViewStatsUsingTrafLine.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/ViewStatsUsingTrafLine.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/ViewStatsUsingTrafLine.html Tue Dec 15 20:36:40 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>Viewing Statistics Using Traffic Line</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="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="prev" href="CoupledStatistics.html" title="Coupled Statistics">
-<link rel="next" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<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="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="prev" href="CoupledStatistics.html" title="Coupled Statistics" />
+<link rel="next" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<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,9 +57,10 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="ViewStatsUsingTrafLine"></a>Viewing Statistics Using Traffic Line<a class="indexterm" name="id391657"></a><a class="indexterm" name="id391665"></a></h2></div></div></div>
-<p>To view your pluginâs statistics, follow these steps:</p>
+<p>To view statistics for your plugin, follow the steps below:</p>
<div class="orderedlist"><ol type="1">
-<li><p>Make sure you know the name of your statistic (the name used
+<li>
+ <p>Make sure you know the name of your statistic (i.e., the name used
in the <code class="code">INKStatCoupledGlobalAdd</code>,
<code class="code">INKStatCreate</code>, or
<code class="code">INKStatCoupledGlobalCategoryCreate</code> call).</p></li>
Modified: incubator/trafficserver/site/trunk/docs/sdk/WorkWHTTPHeaderFunc.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/WorkWHTTPHeaderFunc.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/WorkWHTTPHeaderFunc.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/WorkWHTTPHeaderFunc.html Tue Dec 15 20:36:40 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>Working with HTTP Header 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="BlacklistPlugin.html" title="The Blacklist Plugin">
-<link rel="prev" href="SettingUpTransacHook.html" title="Setting Up a Transaction Hook">
-<link rel="next" href="BasicAuthorizatonPlugin.html" title="The Basic Authorization Plugin">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="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="BlacklistPlugin.html" title="The Blacklist Plugin" />
+<link rel="prev" href="SettingUpTransacHook.html" title="Setting Up a Transaction Hook" />
+<link rel="next" href="BasicAuthorizatonPlugin.html" title="The Basic Authorization Plugin" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
<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,8 +58,7 @@
<div class="titlepage"><div><div><h3 class="title">
<a name="WorkWHTTPHeaderFunc"></a>Working with HTTP Header Functions</h3></div></div></div>
<p>The Blacklist plugin examines the host header in every client
- transaction. This is done in the handle_dns routine, using
- <code class="code">INKHttpTxnClientIPGet</code>, <code class="code">INKHttpHdrUrlGet</code>, and
+ transaction. This is done in the <code>handle_dns</code> routine, using <code class="code">INKHttpTxnClientIPGet</code>, <code class="code">INKHttpHdrUrlGet</code>, and
<code class="code">INKUrlHostGet</code>.</p>
<pre class="programlisting">INKUrlHostGet.
static void
@@ -91,11 +90,10 @@
INKHandleMLocRelease (bufp, INK_NULL_MLOC, hdr_loc);
goto done;
}</pre>
-<p>To access the host header, the plugin first has to get the
- client request, then retrieve the URL portion, and then obtain the
- host header. See <a href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">Chapter 10, <i>HTTP Headers</i></a> for more information
- about these calls.</p>
-<p>See <a href="RlsMarshalBufHandles.html" title="Release Marshal Buffer Handles">âRelease Marshal Buffer Handlesâ</a> for guidelines on
+<p>To access the host header, the plugin must first get the
+ client request, retrieve the URL portion, and then obtain the
+ host header. See <a href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">HTTP Headers</a> for more information
+ about these calls. See <a href="RlsMarshalBufHandles.html" title="Release Marshal Buffer Handles">Release Marshal Buffer Handles</a> for guidelines on
using <code class="code">INKHandleMLocRelease</code> and
<code class="code">INKHandleStringRelease</code>.</p>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/WorkWithHTTPHeaders.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/WorkWithHTTPHeaders.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/WorkWithHTTPHeaders.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/WorkWithHTTPHeaders.html Tue Dec 15 20:36:40 2009
@@ -1,44 +1,44 @@
<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>Working With HTTP Headers</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="BasicAuthorizatonPlugin.html" title="The Basic Authorization Plugin">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="BasicAuthorizatonPlugin.html" title="The Basic Authorization Plugin" />
<link rel="prev" href="ImplementHandler_GetTransHandle.html" title="Implementing the Handler and Getting a Handle to the
- Transaction">
-<link rel="next" href="SetTransactionHook.html" title="Setting a Transaction Hook">
-<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">
+ Transaction" />
+<link rel="next" href="SetTransactionHook.html" title="Setting a Transaction Hook" />
+<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>
@@ -46,7 +46,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">
@@ -61,11 +61,9 @@
<a name="WorkWithHTTPHeaders"></a>Working With HTTP Headers</h3></div></div></div>
<p>The plugin checks all client request headers for the
Proxy-Authorization MIME field, which should contain the user name and
- password.</p>
-<p>The pluginâs continuation handler, <code class="code">auth-plugin</code>,
+ password. The pluginâs continuation handler, <code class="code">auth-plugin</code>,
calls <code class="code">handle_dns</code> to check the
- <code class="code">Proxy-Authorization</code> field.</p>
-<p>The handle_dns routine uses <code class="code">INKHttpTxnClientReqGet</code>
+ <code class="code">Proxy-Authorization</code> field. The <code>handle_dns</code> routine uses <code class="code">INKHttpTxnClientReqGet</code>
and <code class="code">INKMimeHdrFieldFind</code> to obtain the
<code class="code">Proxy-Authorization</code> field:</p>
<pre class="programlisting">{
@@ -82,7 +80,7 @@
field_loc = INKMimeHdrFieldFind (bufp, hdr_loc,
INK_MIME_FIELD_PROXY_AUTHORIZATION);</pre>
-<p>If the <code class="code">Proxy-Authorization</code> field is present, the
+<p>If the <code class="code">Proxy-Authorization</code> field is present, then the
plugin checks that the authentication type is âBasicâ, and the user
name and password are present and valid:</p>
<pre class="programlisting">val = INKMimeHdrFieldValueStringGet (bufp, hdr_loc, field_loc, 0, &authval_length);
Modified: incubator/trafficserver/site/trunk/docs/sdk/WritingHandlerFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/WritingHandlerFunctions.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/WritingHandlerFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/WritingHandlerFunctions.html Tue Dec 15 20:36:40 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>Writing Handler 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="Continuations.html" title="Chapter 12. Continuations">
-<link rel="prev" href="ActivateContinuations.html" title="How to Activate Continuations">
-<link rel="next" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<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="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="prev" href="ActivateContinuations.html" title="How to Activate Continuations" />
+<link rel="next" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<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,15 +57,15 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="WritingHandlerFunctions"></a>Writing Handler Functions</h2></div></div></div>
-<p>The handler function is the meat of the continuation. It is
- supposed to examine the event and event data and do something
+<p>The handler function is the key component of a continuation. It is
+ supposed to examine the event and event data, and then do something
appropriate. The probable action might be to schedule another event for
- the continuation to received, or to open up a connection to a server or
- to destroy itself.</p>
+ the continuation to received, to open up a connection to a server, or
+ simply to destroy itself.</p>
<p>The continuationâs handler function is a function of type
<code class="function">INKEventFunc</code>. Its arguments are a continuation, an
event, and a pointer to some data (this data is passed to the
- continuation by the caller; do not confuse this data with the
+ continuation by the caller - do not confuse this data with the
continuationâs own data, associated by
<code class="function">INKContDataSet</code>). When the continuation is called
back, the continuation and an event are passed to the handler function.
@@ -91,237 +91,237 @@
}</pre>
<div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Caution">
<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/docbook/caution.png"></td>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/docbook/caution.png" /></td>
<th align="left">Caution</th>
</tr>
<tr><td align="left" valign="top"><p>You might notice that a continuation cannot determine if more
- events are âin flightâ towards it. Do not use
+ events are âin flightâ toward it. Do not use
<code class="function">INKContDestroy</code> to delete a continuation before
- making sure that all incoming events, such as those sent because of
+ you make sure that all incoming events, such as those sent because of
<code class="function">INKHttpTxnHookAdd</code>, have been handled.</p></td></tr>
</table></div>
<p>The following table lists events and the corresponding type of
- void * data passed to handler functions:</p>
+ <code>void * </code>data passed to handler functions:</p>
<div class="informaltable"><table border="1">
<colgroup>
-<col>
-<col>
-<col>
+<col />
+<col />
+<col />
</colgroup>
<tbody>
<tr>
<td align="center"><span class="bold"><strong>Event</strong></span></td>
-<td align="center"><span class="bold"><strong>Hook or API function
- that sends the event</strong></span></td>
-<td align="center"><span class="bold"><strong>void * data
- type</strong></span></td>
+<td align="center"><span class="bold"><strong>Hook or API Function
+ That Sends the Event</strong></span></td>
+<td align="center"><span class="bold"><strong><code>void *</code> Data
+ Type</strong></span></td>
</tr>
<tr>
-<td>INK_EVENT_HTTP_READ_REQUEST_HDR</td>
-<td>INK_HTTP_READ_REQUEST_HDR_HOOK</td>
-<td>INKHttpTxn</td>
+<td><code>INK_EVENT_HTTP_READ_REQUEST_HDR</code></td>
+<td><code>INK_HTTP_READ_REQUEST_HDR_HOOK</code></td>
+<td><code>INKHttpTxn</code></td>
</tr>
<tr>
-<td>INK_EVENT_HTTP_OS_DNS</td>
-<td>INK_HTTP_OS_DNS_HOOK</td>
-<td>INKHttpTxn</td>
+<td><code>INK_EVENT_HTTP_OS_DNS</code></td>
+<td><code>INK_HTTP_OS_DNS_HOOK</code></td>
+<td><code>INKHttpTxn</code></td>
</tr>
<tr>
-<td>INK_EVENT_HTTP_SEND_REQUEST_HDR</td>
-<td>INK_HTTP_SEND_REQUEST_HDR_HOOK</td>
-<td>INKHttpTxn</td>
+<td><code>INK_EVENT_HTTP_SEND_REQUEST_HDR</code></td>
+<td><code>INK_HTTP_SEND_REQUEST_HDR_HOOK</code></td>
+<td><code>INKHttpTxn</code></td>
</tr>
<tr>
-<td>INK_EVENT_HTTP_READ_CACHE_HDR</td>
-<td>INK_HTTP_READ_CACHE_HDR_HOOK</td>
-<td>INKHttpTxn</td>
+<td><code>INK_EVENT_HTTP_READ_CACHE_HDR</code></td>
+<td><code>INK_HTTP_READ_CACHE_HDR_HOOK</code></td>
+<td><code>INKHttpTxn</code></td>
</tr>
<tr>
-<td>INK_EVENT_HTTP_READ_RESPONSE_HDR</td>
-<td>INK_HTTP_READ_RESPONSE_HDR_HOOK</td>
-<td>INKHttpTxn</td>
+<td><code>INK_EVENT_HTTP_READ_RESPONSE_HDR</code></td>
+<td><code>INK_HTTP_READ_RESPONSE_HDR_HOOK</code></td>
+<td><code>INKHttpTxn</code></td>
</tr>
<tr>
-<td>INK_EVENT_HTTP_SEND_RESPONSE_HDR</td>
-<td>INK_HTTP_SEND_RESPONSE_HDR_HOOK</td>
-<td>INKHttpTxn</td>
+<td><code>INK_EVENT_HTTP_SEND_RESPONSE_HDR</code></td>
+<td><code>INK_HTTP_SEND_RESPONSE_HDR_HOOK</code></td>
+<td><code>INKHttpTxn</code></td>
</tr>
<tr>
-<td>INK_EVENT_HTTP_SELECT_ALT</td>
-<td>INK_HTTP_SELECT_ALT_HOOK</td>
-<td>INKHttpTxn</td>
+<td><code>INK_EVENT_HTTP_SELECT_ALT</code></td>
+<td><code>INK_HTTP_SELECT_ALT_HOOK</code></td>
+<td><code>INKHttpTxn</code></td>
</tr>
<tr>
-<td>INK_EVENT_HTTP_TXN_START</td>
-<td>INK_HTTP_TXN_START_HOOK</td>
-<td>INKHttpTxn</td>
+<td><code>INK_EVENT_HTTP_TXN_START</code></td>
+<td><code>INK_HTTP_TXN_START_HOOK</code></td>
+<td><code>INKHttpTxn</code></td>
</tr>
<tr>
-<td>INK_EVENT_HTTP_TXN_CLOSE</td>
-<td>INK_HTTP_TXN_CLOSE_HOOK</td>
-<td>INKHttpTxn</td>
+<td><code>INK_EVENT_HTTP_TXN_CLOSE</code></td>
+<td><code>INK_HTTP_TXN_CLOSE_HOOK</code></td>
+<td><code>INKHttpTxn</code></td>
</tr>
<tr>
-<td>INK_EVENT_HTTP_SSN_START</td>
-<td>INK_HTTP_SSN_START_HOOK</td>
-<td>INKHttpSsn</td>
+<td><code>INK_EVENT_HTTP_SSN_START</code></td>
+<td><code>INK_HTTP_SSN_START_HOOK</code></td>
+<td><code>INKHttpSsn</code></td>
</tr>
<tr>
-<td>INK_EVENT_HTTP_SSN_CLOSE</td>
-<td>INK_HTTP_SSN_CLOSE_HOOK</td>
-<td>INKHttpSsn</td>
+<td><code>INK_EVENT_HTTP_SSN_CLOSE</code></td>
+<td><code>INK_HTTP_SSN_CLOSE_HOOK</code></td>
+<td><code>INKHttpSsn</code></td>
</tr>
<tr>
-<td>Â </td>
-<td>Â </td>
-<td>Â </td>
+<td><code>Â </code></td>
+<td><code>Â </code></td>
+<td><code>Â </code></td>
</tr>
<tr>
-<td>INK_EVENT_NONE</td>
-<td>Â </td>
-<td>Â </td>
+<td><code>INK_EVENT_NONE</code></td>
+<td><code>Â </code></td>
+<td><code>Â </code></td>
</tr>
<tr>
-<td>INK_EVENT_CACHE_LOOKUP_COMPLETE</td>
-<td>INK_HTTP_CACHE_LOOKUP_COMPLETE_HOOK</td>
-<td>INKHttpTxn</td>
+<td><code>INK_EVENT_CACHE_LOOKUP_COMPLETE</code></td>
+<td><code>INK_HTTP_CACHE_LOOKUP_COMPLETE_HOOK</code></td>
+<td><code>INKHttpTxn</code></td>
</tr>
<tr>
-<td>INK_EVENT_IMMEDIATE</td>
-<td>INKVConnClose, INKVIOReenable, INKContSchedule</td>
-<td>Â </td>
+<td><code>INK_EVENT_IMMEDIATE</code></td>
+<td><code>INKVConnClose, INKVIOReenable, INKContSchedule</code></td>
+<td><code>Â </code></td>
</tr>
<tr>
-<td>INK_EVENT_IMMEDIATE</td>
-<td>INK_HTTP_REQUEST_TRANSFORM_HOOK</td>
-<td>Â </td>
+<td><code>INK_EVENT_IMMEDIATE</code></td>
+<td><code>INK_HTTP_REQUEST_TRANSFORM_HOOK</code></td>
+<td><code>Â </code></td>
</tr>
<tr>
-<td>INK_EVENT_IMMEDIATE</td>
-<td>INK_HTTP_RESPONSE_TRANSFORM_HOOK</td>
-<td>Â </td>
+<td><code>INK_EVENT_IMMEDIATE</code></td>
+<td><code>INK_HTTP_RESPONSE_TRANSFORM_HOOK</code></td>
+<td><code>Â </code></td>
</tr>
<tr>
-<td>INK_EVENT_CACHE_OPEN_READ</td>
-<td>INKCacheRead</td>
+<td><code>INK_EVENT_CACHE_OPEN_READ</code></td>
+<td><code>INKCacheRead</code></td>
<td>Cache VC</td>
</tr>
<tr>
-<td>INK_EVENT_CACHE_OPEN_READ_FAILED</td>
-<td>INKCacheRead</td>
-<td>Error code, see INK_CACHE_ERROR_XXX</td>
+<td><code>INK_EVENT_CACHE_OPEN_READ_FAILED</code></td>
+<td><code>INKCacheRead</code></td>
+<td>Error code, see <code>INK_CACHE_ERROR_XXX</code></td>
</tr>
<tr>
-<td>INK_EVENT_CACHE_OPEN_WRITE</td>
-<td>INKCacheWrite</td>
+<td><code>INK_EVENT_CACHE_OPEN_WRITE</code></td>
+<td><code>INKCacheWrite</code></td>
<td>Cache VC</td>
</tr>
<tr>
-<td>INK_EVENT_CACHE_OPEN_WRITE_FAILED</td>
-<td>INKCacheWrite</td>
-<td>Error code, see INK_CACHE_ERROR_XXX</td>
+<td><code>INK_EVENT_CACHE_OPEN_WRITE_FAILED</code></td>
+<td><code>INKCacheWrite</code></td>
+<td>Error code, see <code>INK_CACHE_ERROR_XXX</code></td>
</tr>
<tr>
-<td>INK_EVENT_CACHE_REMOVE</td>
-<td>INKCacheRemove</td>
+<td><code>INK_EVENT_CACHE_REMOVE</code></td>
+<td><code>INKCacheRemove</code></td>
<td>Nothing</td>
</tr>
<tr>
-<td>INK_EVENT_CACHE_REMOVE_FAILED</td>
-<td>INKCacheRemove</td>
-<td>Error code, see INK_CACHE_ERROR_XXX</td>
+<td><code>INK_EVENT_CACHE_REMOVE_FAILED</code></td>
+<td><code>INKCacheRemove</code></td>
+<td>Error code, see <code>INK_CACHE_ERROR_XXX</code></td>
</tr>
<tr>
-<td>INK_EVENT_NET_ACCEPT</td>
-<td>INKNetAccept, INKHttpTxnServerIntercept,
- INKHttpTxnIntercept</td>
+<td><code>INK_EVENT_NET_ACCEPT</code></td>
+<td><code>INKNetAccept, INKHttpTxnServerIntercept,
+ INKHttpTxnIntercept</code></td>
<td>Net VConnection</td>
</tr>
<tr>
-<td>INK_EVENT_NET_ACCEPT_FAILED</td>
-<td>INKNetAccept, INKHttpTxnServerIntercept,
- INKHttpTxnIntercept</td>
+<td><code>INK_EVENT_NET_ACCEPT_FAILED</code></td>
+<td><code>INKNetAccept, INKHttpTxnServerIntercept,
+ INKHttpTxnIntercept</code></td>
<td>Nothing</td>
</tr>
<tr>
-<td>INK_EVENT_HOST_LOOKUP</td>
-<td>INKHostLookup</td>
+<td><code>INK_EVENT_HOST_LOOKUP</code></td>
+<td><code>INKHostLookup</code></td>
<td>Null pointer - error Non null pointer -
- INKHostLookupResult</td>
+ <code>INKHostLookupResult</code></td>
</tr>
<tr>
-<td>INK_EVENT_TIMEOUT</td>
-<td>INKContSchedule</td>
-<td>Â </td>
+<td><code>INK_EVENT_TIMEOUT</code></td>
+<td><code>INKContSchedule</code></td>
+<td><code>Â </code></td>
</tr>
<tr>
-<td>INK_EVENT_ERROR</td>
-<td>Â </td>
-<td>Â </td>
+<td><code>INK_EVENT_ERROR</code></td>
+<td><code>Â </code></td>
+<td><code>Â </code></td>
</tr>
<tr>
-<td>Â </td>
-<td>Â </td>
-<td>Â </td>
+<td><code>Â </code></td>
+<td><code>Â </code></td>
+<td><code>Â </code></td>
</tr>
<tr>
-<td>INK_EVENT_VCONN_READ_READY</td>
-<td>INKVConnRead</td>
-<td>INKVConn</td>
+<td><code>INK_EVENT_VCONN_READ_READY</code></td>
+<td><code>INKVConnRead</code></td>
+<td><code>INKVConn</code></td>
</tr>
<tr>
-<td>INK_EVENT_VCONN_WRITE_READY</td>
-<td>INKVConnWrite</td>
-<td>INKVConn</td>
+<td><code>INK_EVENT_VCONN_WRITE_READY</code></td>
+<td><code>INKVConnWrite</code></td>
+<td><code>INKVConn</code></td>
</tr>
<tr>
-<td>INK_EVENT_VCONN_READ_COMPLETE</td>
-<td>INKVConnRead</td>
-<td>INKVConn</td>
+<td><code>INK_EVENT_VCONN_READ_COMPLETE</code></td>
+<td><code>INKVConnRead</code></td>
+<td><code>INKVConn</code></td>
</tr>
<tr>
-<td>INK_EVENT_VCONN_WRITE_COMPLETE</td>
-<td>INKVConnWrite</td>
-<td>INKVConn</td>
+<td><code>INK_EVENT_VCONN_WRITE_COMPLETE</code></td>
+<td><code>INKVConnWrite</code></td>
+<td><code>INKVConn</code></td>
</tr>
<tr>
-<td>INK_EVENT_VCONN_EOS</td>
-<td>INKVConnRead</td>
-<td>INKVConn</td>
+<td><code>INK_EVENT_VCONN_EOS</code></td>
+<td><code>INKVConnRead</code></td>
+<td><code>INKVConn</code></td>
</tr>
<tr>
-<td>INK_EVENT_NET_CONNECT</td>
-<td>INKNetConnect</td>
-<td>INKVConn</td>
+<td><code>INK_EVENT_NET_CONNECT</code></td>
+<td><code>INKNetConnect</code></td>
+<td><code>INKVConn</code></td>
</tr>
<tr>
-<td>INK_EVENT_NET_CONNECT_FAILED</td>
-<td>INKNetConnect</td>
-<td>INKVConn</td>
+<td><code>INK_EVENT_NET_CONNECT_FAILED</code></td>
+<td><code>INKNetConnect</code></td>
+<td><code>INKVConn</code></td>
</tr>
<tr>
-<td>Â </td>
-<td>Â </td>
-<td>Â </td>
+<td><code>Â </code></td>
+<td><code>Â </code></td>
+<td><code>Â </code></td>
</tr>
<tr>
-<td>INK_EVENT_HTTP_CONTINUE</td>
-<td>Â </td>
-<td>Â </td>
+<td><code>INK_EVENT_HTTP_CONTINUE</code></td>
+<td><code>Â </code></td>
+<td><code>Â </code></td>
</tr>
<tr>
-<td>INK_EVENT_HTTP_ERROR</td>
-<td>Â </td>
-<td>Â </td>
+<td><code>INK_EVENT_HTTP_ERROR</code></td>
+<td><code>Â </code></td>
+<td><code>Â </code></td>
</tr>
<tr>
-<td>INK_EVENT_MGMT_UPDATE</td>
-<td>INKMgmtUpdateRegister</td>
-<td>NULL</td>
+<td><code>INK_EVENT_MGMT_UPDATE</code></td>
+<td><code>INKMgmtUpdateRegister</code></td>
+<td><code>NULL</code></td>
</tr>
</tbody>
</table></div>
-<p>The continuation functions are:</p>
+<p>The continuation functions are listed below:</p>
<div class="itemizedlist"><ul type="disc">
<li><p><code class="function">INKContCall</code></p></li>
<li><p><code class="function">INKContCreate</code></p></li>