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 [5/10] - /incubator/trafficserver/site/trunk/docs/sdk/
Modified: incubator/trafficserver/site/trunk/docs/sdk/RlsMarshalBufHandles.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/RlsMarshalBufHandles.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/RlsMarshalBufHandles.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/RlsMarshalBufHandles.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>Release Marshal Buffer Handles</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="GuideTSHTTPHdrSyst.html" title="Guide to Traffic Server HTTP Header System">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="GuideTSHTTPHdrSyst.html" title="Guide to Traffic Server HTTP Header System" />
<link rel="prev" href="MIMEFldsBelongAssocMIMEHdr.html" title="MIME Fields Always Belong to an Associated MIME
- Header">
-<link rel="next" href="DeprecatedMarshBufFuncs.html" title="Deprecated Functions">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
+ Header" />
+<link rel="next" href="DeprecatedMarshBufFuncs.html" title="Deprecated Functions" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
document.write("<style> div.toc {display: none} </style>");
</script>
@@ -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,9 +61,9 @@
<a name="RlsMarshalBufHandles"></a>Release Marshal Buffer Handles</h3></div></div></div>
<p>When you fetch a component object or create a new object, you
get back a handle to the object location. The handle is either an
- <code class="function">INKMLoc</code> for an object location, or a <code class="code">char
+ <code class="function">INKMLoc</code> for an object location or <code class="code">char
*</code> for a string location. You can manipulate the object through
- these handles, but when you are finished, you need to release the
+ these handles, but when you are finished you need to release the
handle to free up system resources.</p>
<p><a class="indexterm" name="id381185"></a>The general guideline is to release all
<code class="function">INKMLoc</code> and string handles you retrieve. The one
@@ -74,19 +74,19 @@
marshal buffer containing the data, the location of the parent object,
and the location of the object to be released. The parent location is
usually clear from the creation of the <code class="function">INKMLoc</code> or
- string; for example, if your plugin had the following calls:</p>
+ string. For example, if your plugin had the following calls:</p>
<pre class="programlisting">url_loc = INKHttpHdrUrlGet (bufp, hdr_loc);
host_string = INKUrlHostGet (bufp, url_loc, &host_length);</pre>
-<p>Your plugin would have to call:</p>
+<p>then your plugin would have to call:</p>
<pre class="programlisting">INKHandleStringRelease (bufp, url_loc, host_string);
INKHandleMLocRelease (bufp, hdr_loc, url_loc);</pre>
<p>If an <code class="function">INKMLoc</code> is obtained from a
- transaction, it does not have a parent <code class="function">INKMLoc</code>.
+ transaction, then it does not have a parent <code class="function">INKMLoc</code>.
Use the null <code class="function">INKMLoc</code> constant
<code class="code">INK_NULL_MLOC</code> as its parent. For example, if your plugin
calls:</p>
<pre class="programlisting">INKHttpTxnClientReqGet (txnp, &bufp, &hdr_loc);</pre>
-<p>You must release <code class="code">hdr_loc</code> with:</p>
+<p>then you must release <code class="code">hdr_loc</code> with:</p>
<pre class="programlisting">INKHandleMLocRelease (bufp, INK_NULL_MLOC, hdr_loc);</pre>
<p>You need to use <code class="code">INK_NULL_MLOC</code> to release any
<code class="function">INKMLoc</code> handles retrieved by the
@@ -100,13 +100,13 @@
<p>See the sample plugins for many more examples.</p>
<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip">
<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/docbook/tip.png"></td>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/docbook/tip.png" /></td>
<th align="left">Tip</th>
</tr>
-<tr><td align="left" valign="top"><p>Release handles before reenabling the HTTP transaction. In
+<tr><td align="left" valign="top"><p>You should release handles before reenabling the HTTP transaction. In
other words, call <code class="function">INKHandleMLocRelease</code> or
<code class="function">INKHandleStringRelease</code> before
- <code class="function">INKHttpTxnReenable</code>. See the sample code.</p></td></tr>
+ <code class="function">INKHttpTxnReenable</code>. </p></td></tr>
</table></div>
</div>
</body>
Modified: incubator/trafficserver/site/trunk/docs/sdk/Roadmap_CreatingPlugins.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/Roadmap_CreatingPlugins.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/Roadmap_CreatingPlugins.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/Roadmap_CreatingPlugins.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>Roadmap for Creating Plugins</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="prev" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="next" href="ch03.html" title="Chapter 3. Remap 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="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="prev" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="next" href="ch03.html" title="Chapter 3. Remap 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,74 +58,72 @@
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="Roadmap_CreatingPlugins"></a>Roadmap for Creating Plugins</h2></div></div></div>
<p>This chapter has provided an overview of Traffic Serverâs HTTP
- processing, API hooks, and the asynchronous event model. Next, it's
- essential that you understand the capabilities of Traffic Server API
+ processing, API hooks, and the asynchronous event model. Next, you must understand the capabilities of Traffic Server API
functions. These are quite broad:</p>
<div class="itemizedlist"><ul type="disc">
<li>
-<p>HTTP header manipulation functions</p>
+<p><b>HTTP header manipulation functions</b></p>
<p>Obtain information about and manipulate HTTP headers, URLs,
- MIME headers.</p>
+ & MIME headers.</p>
</li>
<li>
-<p>HTTP transaction functions</p>
+<p><b>HTTP transaction functions</b></p>
<p>Get information about and modify HTTP transactions (for
- example, get the client IP associated to the transaction; get the
+ example: get the client IP associated to the transaction; get the
server IP; get parent proxy information)</p>
</li>
<li>
-<p>IO functions</p>
+<p><b>IO functions</b></p>
<p>Manipulate vconnections (virtual connections, used for network
- and disk I/O).</p>
+ and disk I/O)</p>
</li>
<li>
-<p>Network connection functions</p>
+<p><b>Network connection functions</b></p>
<p>Open connections to remote servers.</p>
</li>
<li>
-<p>Statistics functions</p>
+<p><b>Statistics functions</b></p>
<p>Define and compute statistics for your pluginâs
activity.</p>
</li>
<li>
-<p>Plugin management functions</p>
-<p>Create a web interface for your plugin (accessible through the
- Traffic Server web interface). Control file installation. License
- your plugin.</p>
-</li>
-<li>
-<p>Traffic Server management functions</p>
-<p>Obtain values of Traffic Server configuration and statistics
- variables.</p>
+ <p><b>Traffic Server management functions</b></p>
+ <p>Obtain values for Traffic Server configuration and statistics
+ variables.</p>
</li>
</ul></div>
-<p>Here are some guidelines for creating a plugin:</p>
+<p>Below are some guidelines for creating a plugin:</p>
<div class="orderedlist"><ol type="1">
-<li><p>Decide what you want your plugin to do, based on the
- capabilities of the API and Traffic Server. The two main kinds of
- example plugins provided with SDK 5.2 are HTTP-based (includes
+<li>
+ <p>Decide what you want your plugin to do, based on the
+ capabilities of the API and Traffic Server. Two main kinds of
+ example plugins provided with this SDK are HTTP-based (includes
header-based and response transform plugins), and non-HTTP-based (a
protocol plugin). These examples are discussed in the next three
- chapters.</p></li>
-<li><p>Determine where your plugin needs to hook on to Traffic
- Serverâs HTTP processing. View the <a href="HTTPHooksAndTransactions.html#Fig_HHTTPTxStateDiag" title="Figure 8.1. HTTP Transaction State Diagram">Figure 8.1, âHTTP Transaction State Diagramâ</a>.</p></li>
-<li><p>Read <a href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">Chapter 4, <i>Header-Based Plugin Examples</i></a> to learn the
+ chapters.</p></li>
+<li>
+ <p>Determine where your plugin needs to hook on to Traffic
+ Serverâs HTTP processing (view the <a href="HTTPHooksAndTransactions.html#Fig_HHTTPTxStateDiag" title="Figure 8.1. HTTP Transaction State Diagram">HTTP Transaction State Diagram</a>).</p></li>
+<li>
+ <p>Read <a href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">Header-Based Plugin Examples</a> to learn the
basics of writing plugins: creating continuations and setting up
hooks. If you want to write a plugin that transforms data, then read
- <a href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">Chapter 5, <i>HTTP Transformation Plugins</i></a>.</p></li>
-<li><p>Figure out what parts of the Traffic Server API you need to
- use, and then read about the details of those APIs in the reference
- chapters provided in this manual.</p></li>
-<li><p>Compile and load your plugin (see <a href="GetingStarted.html#GettingStarted">Chapter 1, <i>Getting Started</i></a>).</p></li>
+ <a href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">HTTP Transformation Plugins</a>.</p></li>
+<li>
+ <p>Figure out what parts of the Traffic Server API you need to
+ use and then read about the details of those APIs in this manual's reference
+ chapters.</p></li>
+<li>
+ <p>Compile and load your plugin (see <a href="GetingStarted.html#GettingStarted">Getting Started</a>).</p></li>
<li><p>Depending on your pluginâs functionality, you might start
testing it by issuing requests by hand and checking for the desired
- behavior in Traffic Server log files. See the <span class="emphasis"><em>Traffic
- Server Administratorâs Guide</em></span> for information about
- Traffic Server logs.</p></li>
+ behavior in Traffic Server log files. See the <span class="emphasis"><em><b>Traffic
+ Server Administratorâs Guide</b></em></span> for information about
+ Traffic Server logs.</p></li>
<li><p>You can test the performance of Traffic Server running with
your plugin using SDKTest. You can also customize SDKTest to perform
functional testing on your plugin; for more information see the
- <span class="emphasis"><em>Traffic Server SDKTest Userâs Guide</em></span>.</p></li>
+ <span class="emphasis"><em><b>Traffic Server SDKTest Userâs Guide</b></em></span>.</p></li>
</ol></div>
</div>
</body>
Modified: incubator/trafficserver/site/trunk/docs/sdk/SampleBufferedNullTransformPlugin.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/SampleBufferedNullTransformPlugin.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/SampleBufferedNullTransformPlugin.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/SampleBufferedNullTransformPlugin.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>The Sample Buffered Null Transform Plugin</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="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="prev" href="AppendTransformPlugin.html" title="The Append-Transform Plugin">
-<link rel="next" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<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="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="prev" href="AppendTransformPlugin.html" title="The Append-Transform Plugin" />
+<link rel="next" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<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">
@@ -88,9 +88,9 @@
if (transformable (txnp)) {
transform_add (txnp);}</pre>
<p>The default behavior for transformations is to cache the
- transformed content. (You can tell Traffic Server to cache
+ transformed content (you also can tell Traffic Server to cache
untransformed content, if you want). Therefore, only responses
- received directly from an origin server need be transformed. Objects
+ received directly from an origin server need to be transformed. Objects
served from the cache are already transformed. To determine whether
the response is from the origin server, the routine transformable
checks the response header for the â200 OKâ server response.</p>
@@ -112,7 +112,7 @@
}</pre>
</li>
<li>
-<p>If the response is transformable, the plugin creates a
+<p>If the response is transformable, then the plugin creates a
transformation vconnection that gets called back when the response
data is ready to be transformed (as it is streaming from the origin
server).</p>
@@ -142,8 +142,8 @@
buffer to the output vconnection
(<code class="code">STATE_OUTPUT_DATA</code>).</p></li>
<li>
-<p>Get a handle to the input VIO. (See the
- <code class="function">handle_buffering</code> function.)</p>
+<p>Get a handle to the input VIO (see the
+ <code class="function">handle_buffering</code> function).</p>
<pre class="programlisting">input_vio = INKVConnWriteVIOGet (contp);</pre>
<p>This is so that the transformation can get information about
the upstream vconnectionâs write operation to the input
@@ -164,14 +164,13 @@
</li>
<li>
<p>Modify the input VIO to tell it how much data has been read
- (increase the value of ndone). See the
- <code class="function">handle_buffering</code> function for the following
+ (increase the value of <code>ndone</code>). See the <code class="function">handle_buffering</code> function for the following
code fragment:</p>
<pre class="programlisting">INKVIONDoneSet (write_vio, INKVIONDoneGet (write_vio) + towrite); }</pre>
</li>
<li>
<p>If there is more data left to read (<code class="code">if ndone <
- nbytes</code>), the <code class="function">handle_buffering</code> function
+ nbytes</code>), then the <code class="function">handle_buffering</code> function
wakes up the upstream vconnection by sending it
<code class="code">WRITE_READY</code>:</p>
<pre class="programlisting">if (INKVIONTodoGet (write_vio) > 0) {
@@ -182,30 +181,31 @@
} else {</pre>
<p>The process of passing data through the transformation is
illustrated in the following diagram. The transformation sends
- <code class="code">WRITE_READY</code> events when it needs more data, and when
- data is available the upstream vconnection reenables the
+ <code class="code">WRITE_READY</code> events when it needs more data; when
+ data is available, the upstream vconnection reenables the
transformation with an <code class="code">IMMEDIATE</code> event.</p>
<div class="figure">
<a name="Fig_STATE_BUFFER_DATAState"></a><p class="title"><b>Figure 5.4. Reading Data Into the Buffer (the STATE_BUFFER_DATA
State)</b></p>
-<div class="mediaobject"><img src="images/vconn_buffer.jpg" alt="Reading Data Into the Buffer (the STATE_BUFFER_DATA State)"></div>
+<div class="mediaobject"><img src="images/vconn_buffer.jpg" alt="Reading Data Into the Buffer (the STATE_BUFFER_DATA State)" /></div>
</div>
</li>
<li>
<p>When the data is read into the output buffer, the
<code class="function">handle_buffering</code> function sets the state of the
- transformationâs data structure to <code class="code">STATE_OUTPUT_DATA</code>.
+ transformationâs data structure to <code class="code">STATE_OUTPUT_DATA</code>
and calls the upstream vconnection back with the
<code class="code">WRITE_COMPLETE</code> event.</p>
<pre class="programlisting">data->state = STATE_OUTPUT_DATA;
INKContCall (INKVIOContGet (write_vio),
INK_EVENT_VCONN_WRITE_COMPLETE, write_vio);</pre>
</li>
-<li><p>The upstream vconnection will probably shut down the write
+<li>
+ <p>The upstream vconnection will probably shut down the write
operation when it receives the <code class="code">WRITE_COMPLETE</code> event.
The handler function of the transformation,
<code class="function">bnull_transform</code>, will receive an
- <code class="code">IMMEDIATE</code> event, and call the
+ <code class="code">IMMEDIATE</code> event and call the
<code class="function">handle_transform</code> function. This time, the state
is <code class="code">STATE_OUTPUT_DATA</code>, so
<code class="function">handle_transform</code> calls
@@ -217,7 +217,7 @@
</li>
<li>
<p>The handle_output function writes the buffer to the output
- vconnectio</p>
+ vconnection:</p>
<pre class="programlisting">data->output_vio =
INKVConnWrite (output_conn, contp, data->output_reader,
INKIOBufferReaderAvail (data->output_reader) );</pre>
@@ -225,7 +225,7 @@
vconnection:</p>
<div class="figure">
<a name="Fig_WriteBufferedDataToOutputVcon"></a><p class="title"><b>Figure 5.5. Writing the Buffered Data to the Output Vconnection</b></p>
-<div class="mediaobject"><img src="images/vconn_buf_output.jpg" alt="Writing the Buffered Data to the Output Vconnection"></div>
+<div class="mediaobject"><img src="images/vconn_buf_output.jpg" alt="Writing the Buffered Data to the Output Vconnection" /></div>
</div>
</li>
</ol></div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/SampleNullTransformPlugin.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/SampleNullTransformPlugin.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/SampleNullTransformPlugin.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/SampleNullTransformPlugin.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>The Sample Null Transform Plugin</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="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="prev" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="next" href="AppendTransformPlugin.html" title="The Append-Transform Plugin">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="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="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="prev" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="next" href="AppendTransformPlugin.html" title="The Append-Transform Plugin" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
<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,12 +58,12 @@
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="SampleNullTransformPlugin"></a>The Sample Null Transform Plugin</h2></div></div></div>
<p>This section provides a step-by-step description of what the null
- transform plugin does, along with sections of the code that apply. For
+ transform plugin does, along with sections of code that apply. For
context, you can find each code snippet in the complete source code.
- Some of the error checking details are left out; to give the description
+ Some of the error checking details are left out - to give the description
a step-by-step flow, only the highlights of the transform are
included.</p>
-<p>Here is an overview of the null transform plugin:</p>
+<p>Below is an overview of the null transform plugin:</p>
<div class="orderedlist"><ol type="1">
<li>
<p>Gets a handle to HTTP transactions.</p>
@@ -85,10 +85,10 @@
if (transformable (txnp)) {
transform_add (txnp);}</pre>
<p>The default behavior for transformations is to cache the
- transformed content. (You can tell Traffic Server to cache
+ transformed content (you can also tell Traffic Server to cache
untransformed content, if you want). Therefore, only responses
- received directly from an origin server need be transformed. Objects
- served from the cache are already transformed. To determine whether
+ received directly from an origin server need to be transformed. Objects
+ served from cache are already transformed. To determine whether
the response is from the origin server, the routine
<code class="code">transformable</code> checks the response header for the â200
OKâ server response.</p>
@@ -108,7 +108,7 @@
}</pre>
</li>
<li>
-<p>If the response is transformable, the plugin creates a
+<p>If the response is transformable, then the plugin creates a
transformation vconnection that gets called back when the response
data is ready to be transformed (as it is streaming from the origin
server).</p>
@@ -149,7 +149,7 @@
<li>
<p>Copy data from the input buffer to the output buffer. See the
<code class="code">handle_transform</code> function for the following code
- fragm</p>
+ fragment:</p>
<pre class="programlisting">INKIOBufferCopy (INKVIOBufferGet (data->output_vio),
INKVIOReaderGet (input_vio), towrite, 0);</pre>
</li>
@@ -161,13 +161,13 @@
</li>
<li>
<p>Modify the input VIO to tell it how much data has been read
- (increase the value of ndone). See the <code class="code">handle_transform</code>
+ (increase the value of <code>ndone</code>). See the <code class="code">handle_transform</code>
function for the following code fragment:</p>
<pre class="programlisting">INKVIONDoneSet (input_vio, INKVIONDoneGet (input_vio) + towrite);</pre>
</li>
<li>
<p>If there is more data left to read (<code class="code">if ndone <
- nbytes</code>), the <code class="code">handle_transform</code> function wakes up
+ nbytes</code>), then the <code class="code">handle_transform</code> function wakes up
the downstream vconnection with a reenable and wakes up the upstream
vconnection by sending it <code class="code">WRITE_READY</code>:</p>
<pre class="programlisting">if (INKVIONTodoGet (input_vio) > 0) {
@@ -180,23 +180,22 @@
} else {</pre>
<p>The process of passing data through the transformation is
illustrated in the following diagram. The downstream vconnections
- send <code class="code">WRITE_READY</code> events when they need more data, and
- when data is available the upstream vconnections reenable the
- downstream vconnections. The <code class="function">INKVIOReenable</code>
- function, in this instance, sends
+ send <code class="code">WRITE_READY</code> events when they need more data;
+ when data is available, the upstream vconnections reenable the
+ downstream vconnections. In this instance, the <code class="function">INKVIOReenable</code>
+ function sends
<code class="code">INK_EVENT_IMMEDIATE</code>.</p>
<div class="figure">
<a name="Fig_PassDataThruTransform"></a><p class="title"><b>Figure 5.2. Passing Data Through a Transformation</b></p>
-<div class="mediaobject"><img src="images/vconnection1.jpg" alt="Passing Data Through a Transformation"></div>
+<div class="mediaobject"><img src="images/vconnection1.jpg" alt="Passing Data Through a Transformation" /></div>
</div>
</li>
<li>
-<p>If the <code class="code">handle_transform</code> function finds that there
- is no more data to read, it sets nbytes to ndone on the output
- (downstream) VIO, and wakes up the output vconnection with a
+<p>If the <code class="code">handle_transform</code> function finds there
+ is no more data to read, then it sets <code>nbytes</code> to <code>ndone</code> on the output
+ (downstream) VIO and wakes up the output vconnection with a
reenable. It then triggers the end of the write operation from the
- upstream vconnection by sending the upstream vconnection a
- <code class="code">WRITE_COMPLETE</code> event.</p>
+ upstream vconnection by sending the upstream vconnection a <code class="code">WRITE_COMPLETE</code> event.</p>
<pre class="programlisting">} else {
INKVIONBytesSet (data->output_vio, INKVIONDoneGet (input_vio));
@@ -209,7 +208,7 @@
write operation.</p>
</li>
<li>
-<p>Similarly, when the downstream vconnection has consumed all of
+<p> Similarly, when the downstream vconnection has consumed all of
the data, it sends the transformation a <code class="code">WRITE_COMPLETE</code>
event. The transformation handles this event with a shut down (the
transformation shuts down the write operation to the downstream
@@ -221,7 +220,7 @@
<p>The following diagram illustrates the flow of events:</p>
<div class="figure">
<a name="Fig_EndTransformation"></a><p class="title"><b>Figure 5.3. Ending the Transformation</b></p>
-<div class="mediaobject"><img src="images/vconnection2.jpg" alt="Ending the Transformation"></div>
+<div class="mediaobject"><img src="images/vconnection2.jpg" alt="Ending the Transformation" /></div>
</div>
</li>
</ol></div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/SetTransactionHook.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/SetTransactionHook.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/SetTransactionHook.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/SetTransactionHook.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>Setting a Transaction Hook</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="prev" href="WorkWithHTTPHeaders.html" title="Working With HTTP Headers">
-<link rel="next" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<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="BasicAuthorizatonPlugin.html" title="The Basic Authorization Plugin" />
+<link rel="prev" href="WorkWithHTTPHeaders.html" title="Working With HTTP Headers" />
+<link rel="next" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<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,10 +58,10 @@
<div class="titlepage"><div><div><h3 class="title">
<a name="SetTransactionHook"></a>Setting a Transaction Hook</h3></div></div></div>
<p>If the request does not have the
- <code class="code">Proxy-Authorization</code> field set to Basic authorization, or
- a valid user name and password, the plugin sends the 407 Proxy
- authorization required status code back to the client.The client
- should then prompt the user for a user name and password, and resend
+ <code class="code">Proxy-Authorization</code> field set to Basic authorization or
+ a valid username/password, then the plugin sends the <code>407 Proxy
+ authorization</code> <code>required</code> status code back to the client. The client
+ will then prompt the user for a username and password, and then resend
the request.</p>
<p>In the <code class="code">handle_dns</code> routine, the following lines
handle the authorization error case:</p>
@@ -69,27 +69,24 @@
INKHttpTxnHookAdd (txnp, INK_HTTP_SEND_RESPONSE_HDR_HOOK, contp);
INKHttpTxnReenable (txnp, INK_EVENT_HTTP_ERROR);</pre>
<p>If <code class="code">handle_dns</code> does not find the
- <code class="code">Proxy-Authorization</code> field set to Basic authorization, or
- a valid user name and password, it adds a
+ <code class="code">Proxy-Authorization</code> field set to Basic authorization or
+ a valid username/password, then it adds a
<code class="code">SEND_RESPONSE_HDR_HOOK</code> to the transaction being
- processed; this means that Traffic Server will call the plugin back
- when sending the client response.</p>
-<p><code class="code">handle_dns</code> reenables the transaction with
+ processed. This means that Traffic Server will call the plugin back
+ when sending the client response. <code class="code">handle_dns</code> reenables the transaction with
<code class="code">INK_EVENT_HTTP_ERROR</code>, which means that the plugin wants
Traffic Server to terminate the transaction.</p>
<p>When Traffic Server terminates the transaction, it sends the
client an error message. Because of the
<code class="code">SEND_RESPONSE_HDR_HOOK</code>, Traffic Server calls the plugin
back. The <code class="code">auth-plugin</code> routine calls
- <code class="code">handle_response</code> to send the client a 407 status
- code.</p>
-<p>When the client resends the request with the <code class="code">Proxy-
+ <code class="code">handle_response</code> to send the client a <code>407</code> status
+ code. When the client resends the request with the <code class="code">Proxy-
Authorization</code> field, a new transaction begins.</p>
<p><code class="code">handle_dns</code> calls <code class="code">base64_decode</code> to
- decode the user name and password.</p>
-<p><code class="code">handle_dns</code> calls <code class="code">authorized</code> to
- validate the user name and password. In this plugin, sample NT code is
- provided for password validation. Unix programmers can supply their
+ decode the username and password; <code class="code">handle_dns</code> also calls <code class="code">authorized</code> to
+ validate the username and password. In this plugin, sample NT code is
+ provided for password validation. UNIX programmers can supply their
own validation mechanism.</p>
</div>
</body>
Modified: incubator/trafficserver/site/trunk/docs/sdk/SetUpLicensing.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/SetUpLicensing.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/SetUpLicensing.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/SetUpLicensing.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>Setting Up Licensing</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="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="prev" href="LicensingPlugin.html" title="Licensing Your Plugin">
-<link rel="next" href="GenerateLicenseKey.html" title="Generating a License Key">
-<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="SetUpLicensing.html#Licensing_Example" title="Example">
+<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="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="prev" href="LicensingPlugin.html" title="Licensing Your Plugin" />
+<link rel="next" href="GenerateLicenseKey.html" title="Generating a License Key" />
+<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="SetUpLicensing.html#Licensing_Example" title="Example" />
<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">
@@ -58,9 +58,10 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="SetUpLicensing"></a>Setting Up Licensing</h2></div></div></div>
-<p>Set up licensing in these steps:</p>
+<p>Set up licensing with the steps below:</p>
<div class="orderedlist"><ol type="1">
-<li><p>Develop your plugin, using the
+<li>
+ <p>Develop your plugin using the
<code class="function">INKPluginLicenseRequired</code> function.</p></li>
<li><p>Create an installation program for your plugin. The
installation program must update both
@@ -68,35 +69,36 @@
<code class="filename">plugin.db</code>. When your plugin customer installs
the plugin, the program should ask the customer for the license
key.</p></li>
-<li><p>Use the <code class="filename">gen_key</code> tool to generate license
- keys. You can generate different keys for different customers, and
+<li>
+ <p>Use the <code class="filename">gen_key</code> tool to generate license
+ keys. You can generate different keys for different customers and
you can set expiration dates for each key.</p></li>
-<li><p>Distribute your plugin together with license key to
- customers.</p></li>
+<li>
+ <p>Distribute your plugin, with the license key, to
+ customers.</p></li>
</ol></div>
<p>When the customer installs the plugin, the installation program
should ask for the license key. The installation program should then
- make an entry in <code class="filename">plugin.db</code> and plugin.config for
+ make an entry in <code class="filename">plugin.db</code> and <code>plugin.config</code> for
the new plugin. When the customer runs the plugin, Traffic Server checks
- the license key. If it passes, Traffic Server then calls
- <code class="function">INKPluginInit</code>.</p>
+ the license key. If it passes, then Traffic Server calls <code class="function">INKPluginInit</code>.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="Licensing_Example"></a>Example</h3></div></div></div>
<div class="itemizedlist"><ul type="disc">
-<li><p>You have a plugin filtering, implemented in object
- filtering.so</p></li>
<li>
-<p>You generate a key for your plugin filtering by
- using:</p>
-<p><span><strong class="command">gen_key filtering ABCDE 03312002</strong></span></p>
+ <p>Suppose you have a plugin filtering, implemented in the object
+ <code>filtering.so</code></p></li>
+<li>
+<p>Generate a key for your plugin filtering via:</p>
+<p><span><code>gen_key filtering ABCDE 03312002</code></span></p>
</li>
<li>
<p>The key generated by <code class="code">gen_key</code> is:</p>
<p><code class="code">ABCDE2E01E07D95</code></p>
</li>
<li>
-<p>You must update <code class="filename">plugin.db</code> and add the
+<p>Update <code class="filename">plugin.db</code> by adding the
following lines:</p>
<pre class="programlisting">[filtering]
Object=filtering.so
@@ -104,7 +106,7 @@
</li>
</ul></div>
<p>The following function is used to license your plugin:</p>
-<div class="itemizedlist"><ul type="disc"><li><p><a href="INKPluginLicenseRequired.html" title="INKPluginLicenseRequired">âINKPluginLicenseRequiredâ</a></p></li></ul></div>
+<div class="itemizedlist"><ul type="disc"><li><p><a href="INKPluginLicenseRequired.html" title="INKPluginLicenseRequired">INKPluginLicenseRequired</a></p></li></ul></div>
</div>
</div>
</body>
Modified: incubator/trafficserver/site/trunk/docs/sdk/SettingGlobalHook.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/SettingGlobalHook.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/SettingGlobalHook.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/SettingGlobalHook.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>Setting a Global Hook</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="BlacklistPlugin.html" title="The Blacklist Plugin">
-<link rel="next" href="SettingUpUIUpdateCallbacks.html" title="Setting Up UI Update Callbacks">
-<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="BlacklistPlugin.html" title="The Blacklist Plugin" />
+<link rel="next" href="SettingUpUIUpdateCallbacks.html" title="Setting Up UI Update Callbacks" />
+<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,20 +57,19 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="SettingGlobalHook"></a>Setting a Global Hook<a class="indexterm" name="id373254"></a></h3></div></div></div>
-<p>Global hooks are always added in INKPluginInit using
- <code class="function">INKHttpHookAdd</code>. The two arguments of
+<p>Global hooks are always added in <code>INKPluginInit</code> using <code class="function">INKHttpHookAdd</code>. The two arguments of
<code class="function">INKHttpHookAdd</code> are the hook ID and the
continuation to call when processing the event corresponding to the
hook. In <code class="filename">blacklist-1.c</code>, the global hook is added
as follows:</p>
<pre class="programlisting">INKHttpHookAdd (INK_HTTP_OS_DNS_HOOK, contp);</pre>
-<p>Where <code class="code">INK_HTTP_OS_DNS_HOOK</code> is the ID for the origin
- server DNS lookup hook, and <code class="code">contp</code> is the parent
+<p>Above, <code class="code">INK_HTTP_OS_DNS_HOOK</code> is the ID for the origin
+ server DNS lookup hook and <code class="code">contp</code> is the parent
continuation created earlier.</p>
<p>This means that the Blacklist plugin is called at every origin
server DNS lookup. When it is called, the handler function<code class="code">
blacklist_plugin</code> receives <code class="code">INK_EVENT_HTTP_OS_DNS</code>
- and calls <code class="code">handle_dn</code>s to see if the request is
+ and calls <code class="code">handle_dn</code><code>s</code> to see if the request is
forbidden.</p>
</div>
</body>