trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From andrew...@apache.org
Subject svn commit: r831152 [30/37] - in /incubator/trafficserver/site/trunk/docs: ./ admin/ admin/images/ sdk/ sdk/css/ sdk/images/ sdk/images/docbook/ sdk/js/
Date Thu, 29 Oct 2009 23:23:36 GMT
Added: incubator/trafficserver/site/trunk/docs/sdk/OtherDeprecatedFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/OtherDeprecatedFunctions.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/OtherDeprecatedFunctions.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/OtherDeprecatedFunctions.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,103 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Other Deprecated Functions</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="prev" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="next" href="Dep_IOBufferInterface.html" title="IO Buffer Interface">
+<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="OtherDeprecatedFunctions.html#Dep_StatisticFunctions" title="Statistic Functions">
+<link rel="subsection" href="Dep_IOBufferInterface.html" title="IO Buffer Interface">
+<link rel="subsection" href="Dep_MutexFunctions.html" title="Mutex Function">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="App_DeprecatedFunctions.html">Prev</a> — Appendix B. Deprecated Functions</div>
+<div class="navnext">IO Buffer Interface — <a accesskey="n" href="Dep_IOBufferInterface.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="OtherDeprecatedFunctions"></a>Other Deprecated Functions</h2></div></div></div>
+<p></p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="Dep_StatisticFunctions"></a>Statistic Functions</h3></div></div></div>
+<p></p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="INKStatFloatRead"></a>INKStatFloatRead</h4></div></div></div>
+<p>Obtains the value of a float stat.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd>
+<p><code class="code">float INKStatFloat(INKStat
+                <em class="replaceable"><code>the_stat</code></em> )</code></p>
+<p>This API has been deprecated by
+                <code class="function">INKStatFloatGet</code>.</p>
+</dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.5</p></dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="INKStatIntRead"></a>INKStatIntRead</h4></div></div></div>
+<p>Obtains the value of an integer stat.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd>
+<p><code class="code">INK64 INKStatIntRead(INKStat
+                <em class="replaceable"><code>the_stat</code></em> )</code></p>
+<p>This API has been deprecated by
+                <code class="function">INKStatIntGet</code>.</p>
+</dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.5</p></dd>
+</dl></div>
+</div>
+</div>
+</div>
+</body>
+</html>

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

Added: incubator/trafficserver/site/trunk/docs/sdk/PluginConfigurationFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/PluginConfigurationFunctions.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/PluginConfigurationFunctions.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/PluginConfigurationFunctions.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,89 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Plugin Configuration Functions</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="prev" href="INKContSchedule.html" title="INKContSchedule">
+<link rel="next" href="INKConfigGet.html" title="INKConfigGet">
+<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="PluginConfigurationFunctions.html#INKConfigDataGet" title="INKConfigDataGet">
+<link rel="subsection" href="INKConfigGet.html" title="INKConfigGet">
+<link rel="subsection" href="INKConfigRelease.html" title="INKConfigRelease">
+<link rel="subsection" href="INKConfigSet.html" title="INKConfigSet">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKContSchedule.html">Prev</a> — INKContSchedule</div>
+<div class="navnext">INKConfigGet — <a accesskey="n" href="INKConfigGet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="PluginConfigurationFunctions"></a>Plugin Configuration Functions</h2></div></div></div>
+<p></p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKConfigDataGet"></a>INKConfigDataGet</h3></div></div></div>
+<p>Gets configuration data.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">void* INKConfigDataGet (INKConfig
+              <em class="replaceable"><code>configp</code></em>)</code></p></dd>
+<dt><span class="term">Description</span></dt>
+<dd><p>Retrieves the data pointer from within the configuration
+              pointer <code class="code"><em class="replaceable"><code>configp</code></em></code>. Before
+              you use <code class="function">INKConfigDataGet</code>, you must give the
+              configuration data an identifier with
+              <code class="function">INKConfigSet</code> and then retrieve the
+              <code class="function">INKConfig</code> pointer
+              <code class="code"><em class="replaceable"><code>configp</code></em></code> with a call to
+              <code class="function">INKConfigGet</code>. See the code snippet in the
+              previous section.</p></dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+</div>
+</body>
+</html>

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

Added: incubator/trafficserver/site/trunk/docs/sdk/PluginConfigurations.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/PluginConfigurations.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/PluginConfigurations.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/PluginConfigurations.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,151 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Chapter 13. Plugin Configurations</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="prev" href="WritingHandlerFunctions.html" title="Writing Handler Functions">
+<link rel="next" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="section" href="PluginConfigurations.html#Plugin_Configs" title="Plugin Configurations">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="WritingHandlerFunctions.html">Prev</a> — Writing Handler Functions</div>
+<div class="navnext">Chapter 14. Actions Guide — <a accesskey="n" href="ActionsGuide.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="chapter" lang="en">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="PluginConfigurations"></a>Chapter 13. Plugin Configurations</h2></div></div></div>
+<div class="toc">
+<p><b>Table of Contents</b></p>
+<dl><dt><span class="section"><a href="PluginConfigurations.html#Plugin_Configs">Plugin Configurations</a></span></dt></dl>
+</div>
+<p>This chapter contains:</p>
+<div class="itemizedlist"><ul type="disc"><li><p><a href="PluginConfigurations.html#Plugin_Configs" title="Plugin Configurations">“Plugin Configurations”</a></p></li></ul></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="Plugin_Configs"></a>Plugin Configurations</h2></div></div></div>
+<p>The <code class="function">INKConfig</code> family of functions provides a
+      mechanism for accessing and changing global configuration information
+      within a plugin.</p>
+<p>If you want to set up a web interface for configuring your plugin
+      through Traffic Manager, see <a href="PluginManagement.html#SetUpPluginMgmtInterface" title="Setting Up a Plugin Management Interface">“Setting Up a Plugin Management Interface”</a>.</p>
+<p>The functions discussed in this section do not examine or modify
+      Traffic Server configuration variables. To examine Traffic Server
+      configuration and statistics variables, see <a href="ReadTESettingStats.html" title="Reading Traffic Server Settings and Statistics">“Reading Traffic Server Settings and Statistics”</a>.</p>
+<p>The <code class="function">INKConfig</code> family of functions is designed
+      to provide a fast and efficient mechanism for accessing and changing
+      global configuration information within a plugin. Such a mechanism is
+      simple enough to provide in a single-threaded program, but the
+      translation to a multi-threaded program such as Traffic Server is
+      difficult. A common technique is to have a single mutex protect the
+      global configuration information. The problem with this solution is that
+      a single mutex becomes a performance bottleneck very quickly.</p>
+<p>The <code class="function">INKConfig</code> family of functions define an
+      interface to storing and retrieving an opaque data pointer. Internally,
+      Traffic Server maintains reference count information about the data
+      pointer so that a call to <code class="function">INKConfigSet</code> will not
+      disturb another thread using the current data pointer. The philosophy is
+      that once a user has a hold of the configuration pointer it is okay for
+      him to use it even if the configuration changes. From the user’s
+      perspective all he wants is a non-changing snapshot of the
+      configuration. Inktomi recommends that you use
+      <code class="function">INKConfigSet</code> for all global data updates.</p>
+<p>Here’s how the interface works:</p>
+<pre class="programlisting">/* Assume that you have previously defined a plugin configuration
+ * data structure named ConfigData, along with its constructor
+ * plugin_config_allocator () and its destructor 
+ * plugin_config_destructor (ConfigData *data)
+ */
+ConfigData *plugin_config;
+
+/* You will need to assign plugin_config a unique identifier of type
+ * unsigned int. It is important to initialize this identifier to zero
+ * (see the documentation of the  function). 
+ */
+static unsigned int   my_id = 0;
+
+/* You will need an INKConfig pointer to access a snapshot of the 
+ * current plugin_config. 
+ */
+INKConfig config_ptr;
+
+/* Initialize plugin_config. */
+plugin_config = plugin_config_allocator();
+
+/* Assign plugin_config an identifier using INKConfigSet. */
+my_id = INKConfigSet (my_id, plugin_config, plugin_config_destructor);
+
+/* Get a snapshot of the current configuration using INKConfigGet. */
+config_ptr = INKConfigGet (my_id);
+
+/* With an INKConfig pointer to the current configuration, you can 
+ * retrieve the configuration’s current data using INKConfigDataGet. 
+ */
+plugin_config = (ConfigData*) INKConfigDataGet (config_ptr);
+
+/* Do something with plugin_config here. */
+
+/* When you are done with retrieving or modifying the plugin data, you
+ * release the pointers to the data with a call to INKConfigRelease.
+ */
+INKConfigRelease (my_id, config_ptr);
+
+/* Any time you want to modify plugin_config, you must repeat these
+ * steps, starting with 
+ * my_id = INKConfigSet (my_id,plugin_config, plugin_config_destructor);
+ * and continuing up to INKConfigRelease. 
+ */</pre>
+<p>The configuration functions are:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><code class="function"><a href="PluginConfigurationFunctions.html#INKConfigDataGet" title="INKConfigDataGet">INKConfigDataGet</a></code></p></li>
+<li><p><code class="function"><a href="INKConfigGet.html" title="INKConfigGet">INKConfigGet</a></code></p></li>
+<li><p><code class="function"><a href="INKConfigRelease.html" title="INKConfigRelease">INKConfigRelease</a></code></p></li>
+<li><p><code class="function"><a href="INKConfigSet.html" title="INKConfigSet">INKConfigSet</a></code></p></li>
+</ul></div>
+</div>
+</div>
+</body>
+</html>

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

Added: incubator/trafficserver/site/trunk/docs/sdk/PluginManagement.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/PluginManagement.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/PluginManagement.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/PluginManagement.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,139 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Chapter 16. Plugin Management</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="prev" href="CacheAPI_Example.html" title="Example">
+<link rel="next" href="ReadTESettingStats.html" title="Reading Traffic Server Settings and Statistics">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="section" href="PluginManagement.html#SetUpPluginMgmtInterface" title="Setting Up a Plugin Management Interface">
+<link rel="section" href="ReadTESettingStats.html" title="Reading Traffic Server Settings and Statistics">
+<link rel="section" href="AccessPluginFiles.html" title="Accessing Installed Plugin Files">
+<link rel="section" href="LicensingPlugin.html" title="Licensing Your Plugin">
+<link rel="section" href="SetUpLicensing.html" title="Setting Up Licensing">
+<link rel="section" href="GenerateLicenseKey.html" title="Generating a License Key">
+<link rel="section" href="LoggingAPI.html" title="Guide to the Logging API">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="CacheAPI_Example.html">Prev</a> — Example</div>
+<div class="navnext">Reading Traffic Server Settings and Statistics — <a accesskey="n" href="ReadTESettingStats.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="chapter" lang="en">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="PluginManagement"></a>Chapter 16. Plugin Management</h2></div></div></div>
+<div class="toc">
+<p><b>Table of Contents</b></p>
+<dl>
+<dt><span class="section"><a href="PluginManagement.html#SetUpPluginMgmtInterface">Setting Up a Plugin Management Interface</a></span></dt>
+<dt><span class="section"><a href="ReadTESettingStats.html">Reading Traffic Server Settings and Statistics</a></span></dt>
+<dt><span class="section"><a href="AccessPluginFiles.html">Accessing Installed Plugin Files</a></span></dt>
+<dt><span class="section"><a href="LicensingPlugin.html">Licensing Your Plugin</a></span></dt>
+<dd><dl><dt><span class="section"><a href="LicensingPlugin.html#Format_plugin.db">Format of plugin.db</a></span></dt></dl></dd>
+<dt><span class="section"><a href="SetUpLicensing.html">Setting Up Licensing</a></span></dt>
+<dd><dl><dt><span class="section"><a href="SetUpLicensing.html#Licensing_Example">Example</a></span></dt></dl></dd>
+<dt><span class="section"><a href="GenerateLicenseKey.html">Generating a License Key</a></span></dt>
+<dt><span class="section"><a href="LoggingAPI.html">Guide to the Logging API</a></span></dt>
+</dl>
+</div>
+<p>This chapter decribes:</p>
+<div class="itemizedlist"><ul type="disc">
+<li>
+<p><a href="PluginManagement.html#SetUpPluginMgmtInterface" title="Setting Up a Plugin Management Interface">“Setting Up a Plugin Management Interface”</a></p>
+<p>You can add your own HTML information pages or CGI forms to the
+        Traffic Manager UI. Traffic Manager can send configuration information
+        from a CGI form to your plugin.</p>
+</li>
+<li>
+<p><a href="ReadTESettingStats.html" title="Reading Traffic Server Settings and Statistics">“Reading Traffic Server Settings and Statistics”</a></p>
+<p>Using the functions in this chapter, plugins can read Traffic
+        Server configuration settings and statistics from the records.config
+        file.</p>
+</li>
+<li>
+<p><a href="AccessPluginFiles.html" title="Accessing Installed Plugin Files">“Accessing Installed Plugin Files”</a></p>
+<p>Have plugins access related files in the plugin installation
+        directory, and make sure that your plugins are preserved during
+        Traffic Server upgrades.</p>
+</li>
+<li><p><a href="LicensingPlugin.html" title="Licensing Your Plugin">“Licensing Your Plugin”</a></p></li>
+<li>
+<p><a href="LoggingAPI.html" title="Guide to the Logging API">“Guide to the Logging API”</a></p>
+<p>The logging API enables your plugin to log text entries in a
+        custom Traffic Server log file. This section gives a basic overview of
+        the logging interface.</p>
+</li>
+</ul></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="SetUpPluginMgmtInterface"></a>Setting Up a Plugin Management Interface</h2></div></div></div>
+<p>To set up a plugin management interface, follow these
+      steps:</p>
+<div class="orderedlist"><ol type="1">
+<li><p>Create your interface. It must be browser-based, since it is
+          accessed through the Traffic Manager UI. Your interface can be
+          static or dynamic. If you are using a dynamic interface, your CGI
+          form submission must set the <code class="varname">INK_PLUGIN_NAME</code>
+          variable to be the name of your plugin, as it is entered in the
+          <code class="function">INKMgmtUpdateRegister</code> function.</p></li>
+<li><p>Note the location of your interface files.</p></li>
+<li><p>Use the <code class="function">INKMgmtUpdateRegister</code> function in
+          your plugin. It should be part of
+          <code class="function">INKPluginInit</code>.</p></li>
+</ol></div>
+<p>The <code class="function">INKMgmtUpdateRegister</code> function does two
+      things:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p>Informs Traffic Manager of the location of your interface, so
+          that the links to your interface appear in the Traffic Manager
+          UI</p></li>
+<li><p>If you have a dynamic interface, it sets up a callback to your
+          plugin whenever configuration information is submitted through the
+          interface</p></li>
+</ul></div>
+</div>
+</div>
+</body>
+</html>

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

Added: incubator/trafficserver/site/trunk/docs/sdk/PlusingRegisAndVersionCkg.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/PlusingRegisAndVersionCkg.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/PlusingRegisAndVersionCkg.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/PlusingRegisAndVersionCkg.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,138 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Plugin Registration and Version Checking</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="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="prev" href="RestartingTS.html" title="Restart Traffic Server">
+<link rel="next" href="NamingConventions.html" title="Naming Conventions">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="RestartingTS.html">Prev</a> — Restart Traffic Server</div>
+<div class="navnext">Naming Conventions — <a accesskey="n" href="NamingConventions.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="PlusingRegisAndVersionCkg"></a>Plugin Registration and Version Checking<a class="indexterm" name="id307848"></a></h2></div></div></div>
+<p>You need to make sure that the functions in your plugin are
+      supported in your version of Traffic Server.</p>
+<div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="images/docbook/important.png"></td>
+<th align="left">Important</th>
+</tr>
+<tr><td align="left" valign="top"><p>Previous versions of Traffic Server<a class="indexterm" name="id307865"></a> are named Traffic Server<a class="indexterm" name="id307874"></a>. Throughout this manual, previous versions of Traffic
+        Server are referred to as: Traffic Server, Traffic Server 3.0, Traffic
+        Server 3.5, and Traffic Server 5.2. For version checking purposes,
+        Traffic Server 1.5 is equivalent to Traffic Server 5.5.</p></td></tr>
+</table></div>
+<p>Use the following interfaces:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><a href="INKPluginRegister.html" title="INKPluginRegister">“INKPluginRegister”</a></p></li>
+<li><p><a href="INKTrafficServerVersionGet.html" title="INKTrafficServerVersionGet">“INKTrafficServerVersionGet”</a></p></li>
+</ul></div>
+<p>The following version of <code class="filename">hello-world</code>
+      registers the plugin and ensures it's running with a compatible version
+      of Traffic Server.<a class="indexterm" name="id324299"></a></p>
+<pre class="programlisting">#include &lt;stdio.h&gt;
+#include "InkAPI.h"
+int
+check_ts_version() {
+ const char* ts_version = INKTrafficServerVersionGet();
+ int result = 0;
+
+   if (ts_version) {
+    int major_ts_version = 0;
+    int minor_ts_version = 0;
+    int patch_ts_version = 0;
+
+   if (sscanf(ts_version, "%d.%d.%d", &amp;major_ts_version,
+      &amp;minor_ts_version, &amp;patch_ts_version) != 3) {
+      return 0;
+  }
+
+  /* Since this is an TS-SDK 2.0 plugin, we need at
+     least Traffic Server 3.5.2 to run */
+
+   if (major_ts_version &gt; 3) {
+      result = 1;
+   } else if (major_ts_version == 3) {
+         if (minor_ts_version &gt; 5) {
+             result = 1;
+   } else if (minor_ts_version == 5) {
+         if (patch_ts_version &gt;= 2) {
+          result = 1;
+         }
+       }
+     }
+   }
+   return result;
+}
+
+void
+INKPluginInit (int argc, const char *argv[])<a class="indexterm" name="id324315"></a>
+{
+
+      INKPluginRegistrationInfo info;
+
+      info.plugin_name = "hello-world";
+      info.vendor_name = "MyCompany";
+      info.support_email = "ts-api-support@MyCompany.com";
+
+      if (!INKPluginRegister (INK_SDK_VERSION_2_0 , &amp;info)) {
+         INKError ("Plugin registration failed. \n");
+      }
+
+      if (!check_ts_version()) {
+         INKError ("Plugin requires Traffic Server 3.5.2 or later\n");
+         return;
+      }
+
+      INKDebug ("debug-hello", "Hello World!\n");
+}</pre>
+</div>
+</body>
+</html>

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

Added: incubator/trafficserver/site/trunk/docs/sdk/Preface.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/Preface.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/Preface.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/Preface.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,92 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Preface</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="prev" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="next" href="pr01s02.html" title="How to Use This Book">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="section" href="Preface.html#Audience" title="Audience">
+<link rel="section" href="pr01s02.html" title="How to Use This Book">
+<link rel="section" href="Conventions.html" title="Typographical Conventions">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="index.html">Prev</a> — Traffic Server Software Developers Kit</div>
+<div class="navnext">How to Use This Book — <a accesskey="n" href="pr01s02.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="preface" lang="en">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="Preface"></a>Preface</h2></div></div></div>
+<div class="toc">
+<p><b>Table of Contents</b></p>
+<dl>
+<dt><span class="section"><a href="Preface.html#Audience">Audience</a></span></dt>
+<dt><span class="section"><a href="pr01s02.html">How to Use This Book</a></span></dt>
+<dt><span class="section"><a href="Conventions.html">Typographical Conventions</a></span></dt>
+</dl>
+</div>
+<p>The <span class="emphasis"><em>Traffic Server Software Developers Kit</em></span> is a
+    reference for creating plugins. Plugins are programs that add services
+    (such as filtering or content transformation) or entire features such as
+    new protocol support, to Traffic Server. If you are new to writing Traffic
+    Server plugins, then read the first two chapters, <a href="GetingStarted.html#GettingStarted">Getting Started</a> and <a href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">Creating Traffic Server Plugins</a>;
+    use the remaining chapters as needed. <a href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">Header-Based Plugin Examples</a> provides
+    details about plugins that work on HTTP headers, while <a href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">HTTP Transformation Plugins</a>
+    explains how to write a plugin that transforms or scans the body of an
+    HTTP response. If you want to support your own protocol on Traffic Server,
+    then reference <a href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">Chapter 6, <i>New Protocol Plugins</i></a>.</p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="Audience"></a>Audience</h2></div></div></div>
+<p>This manual is intended for programmers who want to write plugin
+      programs that add services or features to Traffic Server. It assumes a
+      cursory knowledge of the C programming language, Hyper-Text Transfer
+      Protocol (HTTP), and Multipurpose Internet Mail Extensions
+      (MIME).</p>
+</div>
+</div>
+</body>
+</html>

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

Added: incubator/trafficserver/site/trunk/docs/sdk/ReadTESettingStats.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/ReadTESettingStats.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/ReadTESettingStats.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/ReadTESettingStats.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,101 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Reading Traffic Server Settings and Statistics</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="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="next" href="AccessPluginFiles.html" title="Accessing Installed Plugin Files">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="PluginManagement.html">Prev</a> — Chapter 16. Plugin Management</div>
+<div class="navnext">Accessing Installed Plugin Files — <a accesskey="n" href="AccessPluginFiles.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="ReadTESettingStats"></a>Reading Traffic Server Settings and Statistics</h2></div></div></div>
+<p>Your plugin might need to know information about Traffic Server’s
+      current configuration and performance. The functions described in this
+      section read this information from the Traffic Server
+      <code class="filename">records.config</code> file. Configuration settings are
+      stored in <code class="varname">CONFIG</code> variables and statistics are stored
+      in <code class="varname">PROCESS</code> variables.</p>
+<div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Caution">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/docbook/caution.png"></td>
+<th align="left">Caution</th>
+</tr>
+<tr><td align="left" valign="top"><p>Not all <code class="varname">CONFIG</code> and <code class="varname">PROCESS</code>
+        variables in records.config are relevant to Traffic Server’s
+        configuration and statistics. Retrieve only the records.config
+        variables that are documented in the Traffic Server Administrator’s
+        Guide.</p></td></tr>
+</table></div>
+<p>To retrieve a variable, you need to know its type
+      (<code class="code">int</code>, <code class="code">counter</code>, <code class="code">float</code>, or
+      <code class="code">string</code>). Plugins store the records.config values as an
+      <code class="function">INKMgmtInt</code>, <code class="function">INKMgmtCounter</code>,
+      <code class="function">INKMgmtFloat</code>, or
+      <code class="function">INKMgmtString</code>. You can look up
+      <code class="filename">records.config</code> variable types in the Traffic Server
+      Administrator’s Guide.</p>
+<p>Depending on the result type, use
+      <code class="function">INKMgmtIntGet</code>,
+      <code class="function">INKMgmtCounterGet</code>,
+      <code class="function">INKMgmtFloatGet</code>, or
+      <code class="function">INKMgmtStringGet</code> to obtain the variable
+      value.</p>
+<p>See the example for <a href="INKMgmtIntGet.html" title="INKMgmtIntGet">“INKMgmtIntGet”</a>.</p>
+<p>The <code class="function">INKMgmt*Get</code> functions are:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><a href="TEConfigReadFunctions.html#INKMgmtCounterGet" title="INKMgmtCounterGet">“INKMgmtCounterGet”</a></p></li>
+<li><p><a href="INKMgmtFloatGet.html" title="INKMgmtFloatGet">“INKMgmtFloatGet”</a></p></li>
+<li><p><a href="INKMgmtIntGet.html" title="INKMgmtIntGet">“INKMgmtIntGet”</a></p></li>
+<li><p><a href="INKMgmtStringGet.html" title="INKMgmtStringGet">“INKMgmtStringGet”</a></p></li>
+</ul></div>
+</div>
+</body>
+</html>

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

Added: incubator/trafficserver/site/trunk/docs/sdk/RestartingTS.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/RestartingTS.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/RestartingTS.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/RestartingTS.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,82 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Restart Traffic Server</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="SpecifyingPluginLocation.html" title="Specify the Plugin’s Location">
+<link rel="next" href="PlusingRegisAndVersionCkg.html" title="Plugin Registration and Version Checking">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="SpecifyingPluginLocation.html">Prev</a> — Specify the Plugin’s Location</div>
+<div class="navnext">Plugin Registration and Version Checking — <a accesskey="n" href="PlusingRegisAndVersionCkg.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="RestartingTS"></a>Restart Traffic Server</h3></div></div></div>
+<p>The last step is to start (or restart) Traffic Server. Shown
+        below is the output displayed after you've created and loaded your
+        <code class="filename">hello-world</code> plugin.</p>
+<pre class="programlisting"># grep proxy.config.plugin.plugin_dir config/records.config
+CONFIG proxy.config.plugin.plugin_dir STRING config/plugins
+# ls config/plugins
+hello-world.so*
+# bin/traffic_server
+[Mar 27 19:06:31.669] NOTE: updated diags config
+[Mar 27 19:06:31.680] NOTE: loading plugin 'config/plugins/hello-world.so'
+hello world
+[Mar 27 19:06:32.046] NOTE: cache disabled (initializing)
+[Mar 27 19:06:32.053] NOTE: cache enabled
+[Mar 27 19:06:32.526] NOTE: Traffic Server running</pre>
+<p>Note that in the example above, Traffic Server notes are
+        directed to the console by specifying <code class="code">E</code> for
+        <code class="varname">proxy.config.diags.output.note</code> in
+        <code class="filename">records.config</code>. The second note shows Traffic
+        Server attempting to load our <code class="filename">hello-world</code> plugin.
+        The third line of Traffic Server output is from your plugin.</p>
+</div>
+</body>
+</html>

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

Added: incubator/trafficserver/site/trunk/docs/sdk/RlsMarshalBufHandles.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/RlsMarshalBufHandles.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/RlsMarshalBufHandles.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/RlsMarshalBufHandles.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,113 @@
+<html>
+<head>
+<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="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">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="MIMEFldsBelongAssocMIMEHdr.html">Prev</a> — MIME Fields Always Belong to an Associated MIME
+        Header</div>
+<div class="navnext">Deprecated Functions — <a accesskey="n" href="DeprecatedMarshBufFuncs.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<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> for a string location. You can manipulate the object through
+        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
+        exception is the string returned by
+        <code class="function">INKUrlStringGet</code>, which must be freed by a call to
+        <code class="function">INKfree</code>.</p>
+<p><a class="indexterm" name="id381213"></a>The handle release functions expect three arguments: the
+        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>
+<pre class="programlisting">url_loc = INKHttpHdrUrlGet (bufp, hdr_loc);
+host_string = INKUrlHostGet (bufp, url_loc, &amp;host_length);</pre>
+<p>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>.
+        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, &amp;bufp, &amp;hdr_loc);</pre>
+<p>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
+        <code class="function">INKHttpTxn*Get</code> functions.</p>
+<p>Here’s an example using a new
+        <code class="function">INKMimeHdrField</code> function:</p>
+<pre class="programlisting">INKHttpTxnServerRespGet( txnp, &amp;resp_bufp, &amp;resp_hdr_loc );
+new_field_loc = INKMimeHdrFieldCreate (resp_bufp, resp_hdr_loc);
+INKHandleMLocRelease ( resp_bufp, resp_hdr_loc, new_field_loc);
+INKHandleMLocRelease ( resp_bufp, INK_NULL_MLOC, resp_hdr_loc);</pre>
+<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>
+<th align="left">Tip</th>
+</tr>
+<tr><td align="left" valign="top"><p>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>
+</table></div>
+</div>
+</body>
+</html>

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

Added: 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=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/Roadmap_CreatingPlugins.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/Roadmap_CreatingPlugins.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,132 @@
+<html>
+<head>
+<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">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="CreatingTSPlugins.html">Prev</a> — Chapter 2. How to Create Traffic Server Plugins</div>
+<div class="navnext">Chapter 3. Remap Plugin — <a accesskey="n" href="ch03.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="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
+      functions. These are quite broad:</p>
+<div class="itemizedlist"><ul type="disc">
+<li>
+<p>HTTP header manipulation functions</p>
+<p>Obtain information about and manipulate HTTP headers, URLs,
+          MIME headers.</p>
+</li>
+<li>
+<p>HTTP transaction functions</p>
+<p>Get information about and modify HTTP transactions (for
+          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>Manipulate vconnections (virtual connections, used for network
+          and disk I/O).</p>
+</li>
+<li>
+<p>Network connection functions</p>
+<p>Open connections to remote servers.</p>
+</li>
+<li>
+<p>Statistics functions</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>
+</li>
+</ul></div>
+<p>Here 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
+          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
+          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>
+<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>
+<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>
+</ol></div>
+</div>
+</body>
+</html>

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



Mime
View raw message