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 [6/10] - /incubator/trafficserver/site/trunk/docs/sdk/
Modified: incubator/trafficserver/site/trunk/docs/sdk/SettingUpTransacHook.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/SettingUpTransacHook.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/SettingUpTransacHook.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/SettingUpTransacHook.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 Up 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="BlacklistPlugin.html" title="The Blacklist Plugin">
-<link rel="prev" href="AccessingTransactionProc.html" title="Accessing the Transaction Being Processed">
-<link rel="next" href="WorkWHTTPHeaderFunc.html" title="Working with HTTP Header 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">
+<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="AccessingTransactionProc.html" title="Accessing the Transaction Being Processed" />
+<link rel="next" href="WorkWHTTPHeaderFunc.html" title="Working with HTTP Header 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>
@@ -45,7 +45,7 @@
<body>
<div class="doctitle">
<a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
<div class="navprev">
@@ -57,9 +57,9 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="SettingUpTransacHook"></a>Setting Up a Transaction Hook<a class="indexterm" name="id373445"></a></h3></div></div></div>
-<p>The Blacklist plugin sends âaccess forbiddenâ messages to
- clients if their requests are directed to blacklisted hosts. Therefore
- the plugin needs a transaction hook, so that it is called back when
+<p>The Blacklist plugin sends "access forbidden" messages to
+ clients if their requests are directed to blacklisted hosts. Therefore,
+ the plugin needs a transaction hook so it will be called back when
Traffic Serverâs HTTP state machine reaches the âsend response headerâ
event. In the Blacklist pluginâs <code class="code">handle_dns</code> routine, the
transaction hook is added as follows:</p>
@@ -82,43 +82,42 @@
done:
INKHttpTxnReenable (txnp, INK_EVENT_HTTP_CONTINUE);
}</pre>
-<p>This code fragment shows some interesting features. Whatâs
- happening is that the plugin is comparing the requested site to the
+<p>This code fragment shows some interesting features. The plugin is comparing the requested site to the
list of blacklisted sites. While the plugin is using the blacklist, it
- must acquire the mutex lock for the blacklist. This prevents
+ must acquire the mutex lock for the blacklist to prevent
configuration changes in the middle of a blacklisting operation. If
- the requested site is blacklisted, two things happen:</p>
+ the requested site is blacklisted, then the following things happen:</p>
<div class="orderedlist"><ol type="1">
-<li><p>A transaction hook is added with
- <code class="code">INKHttpTxnHookAdd</code>, so that the plugin is called back
- at the âsend response headerâ event (the plugin sends an âaccess
- forbiddenâ message to the client). You can see that in order to
+<li>
+ <p>A transaction hook is added with
+ <code class="code">INKHttpTxnHookAdd</code>; the plugin is called back
+ at the âsend response headerâ event (i.e., the plugin sends an <code>Access
+ forbidden</code> message to the client). You can see that in order to
add a transaction hook, you need a handle to the transaction being
- processed.</p></li>
-<li><p>The transaction is reenabled using
+ processed.</p></li>
+<li>
+ <p>The transaction is reenabled using
<code class="code">INKHttpTxnReenable</code> with
<code class="code">INK_EVENT_HTTP_ERROR</code> as its event argument.
Reenabling with an error event tells the HTTP state machine to
stop the transaction and jump to the âsend response headerâ state.
- Notice that if the requested site is not blacklisted, the
+ Notice that if the requested site is not blacklisted, then the
transaction is reenabled with the
<code class="code">INK_EVENT_HTTP_CONTINUE</code> event.</p></li>
-<li><p>The string and <code class="function">INKMLoc</code> data stored in
+<li>
+ <p>The string and <code class="function">INKMLoc</code> data stored in
the marshal buffer <code class="code">bufp</code> is released by
<code class="function">INKHandleStringRelease</code> and
- <code class="code">INKHandleMLocRelease</code>. See <a href="RlsMarshalBufHandles.html" title="Release Marshal Buffer Handles">âRelease Marshal Buffer Handlesâ</a>. Release these handles before
- reenabling the transaction.</p></li>
+ <code class="code">INKHandleMLocRelease</code> (see <a href="RlsMarshalBufHandles.html" title="Release Marshal Buffer Handles">Release Marshal Buffer Handles</a>). Release these handles before
+ reenabling the transaction.</p></li>
</ol></div>
<p>In general, whenever the plugin is doing something to a
- transaction, it must reenable the transaction when it is finished. Put
- another way, every time your handler function handles a transaction
+ transaction, it must reenable the transaction when it is finished. In other words: every time your handler function handles a transaction
event, it must call <code class="code">INKHttpTxnReenable</code> when it is
- finished.</p>
-<p>Similarly, after your plugin handles session events
+ finished. Similarly, after your plugin handles session events
(<code class="code">INK_EVENT_HTTP_SSN_START</code> and
- <code class="code">INK_EVENT_HTTP_SSN_CLOSE</code>) it must reenable the session
- with <code class="code">INKHttpSsnReenable</code>.</p>
-<p>Reenabling the transaction twice in the same plugin routine is a
+ <code class="code">INK_EVENT_HTTP_SSN_CLOSE</code>), it must reenable the session
+ with <code class="code">INKHttpSsnReenable</code>. Reenabling the transaction twice in the same plugin routine is a
bad error.</p>
</div>
</body>
Modified: incubator/trafficserver/site/trunk/docs/sdk/SettingUpUIUpdateCallbacks.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/SettingUpUIUpdateCallbacks.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/SettingUpUIUpdateCallbacks.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/SettingUpUIUpdateCallbacks.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 Up UI Update Callbacks</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="SettingGlobalHook.html" title="Setting a Global Hook">
-<link rel="next" href="AccessingTransactionProc.html" title="Accessing the Transaction Being Processed">
-<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="SettingGlobalHook.html" title="Setting a Global Hook" />
+<link rel="next" href="AccessingTransactionProc.html" title="Accessing the Transaction Being Processed" />
+<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,19 +58,16 @@
<div class="titlepage"><div><div><h3 class="title">
<a name="SettingUpUIUpdateCallbacks"></a>Setting Up UI Update Callbacks</h3></div></div></div>
<p>The Blacklist plugin must be called back whenever its
- configuration is changed by an administrator through the Traffic
- Manager UI. To get the interface working, you need an interface
+ configuration is changed by an administrator. To get the interface working, you need an interface
program (such as a CGI form) to display an interface and obtain
- configuration information, and a text file that the CGI program edits
+ configuration information and a text file that the CGI program edits
and the Blacklist plugin reads. The callback to the plugin is
established in <code class="function">INKPluginInit</code> by:</p>
-<pre class="programlisting">INKMgmtUpdateRegister (contp, "Inktomi Blacklist Plugin", "blacklist.cgi");</pre>
-<p>Where <code class="code">contp</code> is the pluginâs static parent
- continuation, âInktomi Blacklist Pluginâ is the name of the plugin as
- specified by the CGI formâs <code class="code">INK_PLUGIN_NAME</code> variable, and
- "<code class="filename">blacklist.cgi</code>" is the path to the pluginâs
- interface program, relative to the Traffic Server plugins directory.
- For more details see <a href="PluginManagement.html#SetUpPluginMgmtInterface" title="Setting Up a Plugin Management Interface">âSetting Up a Plugin Management Interfaceâ</a>.</p>
+<pre class="programlisting">INKMgmtUpdateRegister (contp, "Dianes Blacklist Plugin", "blacklist.cgi");</pre>
+<p>Above, <code class="code">contp</code> is the pluginâs static parent
+ continuation, <code>Dianes Blacklist Plugin </code>is the name of the plugin as
+ specified by the CGI formâs <code class="replaceable">INK_PLUGIN_NAME </code> variable, and <code class="filename">blacklist.cgi</code> is the path to the pluginâs
+ interface program (relative to the Traffic Server plugins directory). </p>
</div>
</body>
</html>
Modified: incubator/trafficserver/site/trunk/docs/sdk/SpecifyingPluginLocation.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/SpecifyingPluginLocation.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/SpecifyingPluginLocation.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/SpecifyingPluginLocation.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>Specify the Pluginâs Location</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="Updatingplugin.configFile.html" title="Update the plugin.config File">
-<link rel="next" href="RestartingTS.html" title="Restart Traffic Server">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="ASimplePlugin.html" title="A Simple Plugin" />
+<link rel="prev" href="Updatingplugin.configFile.html" title="Update the plugin.config File" />
+<link rel="next" href="RestartingTS.html" title="Restart Traffic Server" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
document.write("<style> div.toc {display: none} </style>");
</script>
@@ -45,7 +45,7 @@
<body>
<div class="doctitle">
<a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
<div class="navprev">
@@ -59,7 +59,7 @@
<a name="SpecifyingPluginLocation"></a>Specify the Pluginâs Location</h3></div></div></div>
<p>All plugins must be located in the directory specified by the
configuration variable
- <code class="varname">proxy.config.plugin.plugin_dir</code>, which is located in
+ <code class="replaceable">proxy.config.plugin.plugin_dir</code>, which is located in
the <code class="filename">records.config</code> file. The directory can be
specified as an absolute or relative path.</p>
<p>If a relative path is used, then the starting directory will be
Modified: incubator/trafficserver/site/trunk/docs/sdk/StatisticsFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/StatisticsFunctions.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/StatisticsFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/StatisticsFunctions.html Tue Dec 15 20:36:40 2009
@@ -1,45 +1,45 @@
<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>Statistics 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="INKPluginLicenseRequired.html" title="INKPluginLicenseRequired">
-<link rel="next" href="CoupledStatsFunctions.html" title="Coupled 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="subsection" href="StatisticsFunctions.html#UncoupledStatsFuncs" title="Uncoupled Statistics">
-<link rel="subsection" href="CoupledStatsFunctions.html" title="Coupled Statistics">
+<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="INKPluginLicenseRequired.html" title="INKPluginLicenseRequired" />
+<link rel="next" href="CoupledStatsFunctions.html" title="Coupled 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="subsection" href="StatisticsFunctions.html#UncoupledStatsFuncs" title="Uncoupled Statistics" />
+<link rel="subsection" href="CoupledStatsFunctions.html" title="Coupled Statistics" />
<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>
@@ -47,7 +47,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">
@@ -67,40 +67,36 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="INKStatFloatGet"></a>INKStatFloatGet</h4></div></div></div>
-<p>Obtains the value of a float stat.</p>
+<p>Obtains the value of a float statistic.</p>
<div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">INKReturnCode INKStatFloatGet(INKStat
<em class="replaceable"><code>stat</code></em>, float
*<em class="replaceable"><code>value</code></em>)</code></p></dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if the API is called
successfully.</p>
<p><code class="code">INK_ERROR</code> if an error occurs while calling
the API or if an argument is invalid.</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="INKStatIntGet"></a>INKStatIntGet</h4></div></div></div>
-<p>Obtains the value of an integer stat.</p>
+<p>Obtains the value of an integer statistic.</p>
<div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
-<dd><p><code class="code">INKReturnCode INKStatIntGet(INKStat stat, INK64
- *value)</code></p></dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKReturnCode INKStatIntGet(INKStat <span class="replaceable">stat</span>, INK64
+ *<span class="replaceable">value</span>)</code></p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if the API is called
successfully.</p>
<p><code class="code">INK_ERROR</code> if an error occurs while calling
the API or if an argument is invalid.</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">
@@ -108,19 +104,17 @@
<a name="INKStatFloatAddTo"></a>INKStatFloatAddTo</h4></div></div></div>
<p>Adds a float value to a float statistic.</p>
<div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">INKReturnCode INKStatFloatAddTo ( INKStat
- the_stat, float amount)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+ <span class="replaceable">the_stat</span>, float <span class="replaceable">amount</span>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
<dd><p>Adds a float value to a float statistic.</p></dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if the operation completes
successfully.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</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">
@@ -128,19 +122,18 @@
<a name="INKStatIntAddTo"></a>INKStatIntAddTo</h4></div></div></div>
<p>Adds an INK64 value to an integer statistic.</p>
<div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
-<dd><p><code class="code">INKReturnCode INKStatIntAddTo ( INKStat the_stat,
- INK64 amount)</code></p></dd>
-<dt><span class="term">Description</span></dt>
-<dd><p>Adds an INK64 value to an integer statistic</p></dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKReturnCode INKStatIntAddTo ( INKStat <span class="replaceable">the_stat</span>,
+ INK64 <span class="replaceable">amount</span>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Adds an <code>INK64</code> value to an integer statistic.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if the operation completes
successfully.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</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">
@@ -148,25 +141,24 @@
<a name="INKStatCreate"></a>INKStatCreate</h4></div></div></div>
<p>Creates a new <code class="code">INKStat</code>.</p>
<div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">INKStat INKStatCreate ( const char *
<em class="replaceable"><code>the_name</code></em>, INKStatTypes
<em class="replaceable"><code>the_type</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
-<dd><p>Creates a new <code class="code">INKStat</code>. The value pointed to
- by <code class="code"><em class="replaceable"><code>the_name</code></em></code> is the
- name you use to view the statistic using Traffic Line. See
- <a href="ViewStatsUsingTrafLine.html" title="Viewing Statistics Using Traffic Line">âViewing Statistics Using Traffic Lineâ</a>. There are two
- <code class="code">INKStatTypes</code>: <code class="code">INKSTAT_TYPE_INT64</code>,
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Creates a new <code class="code">INKStat</code>. The value pointed to
+ by <code class="code"><em class="replaceable"><code>the_name </code></em></code> is the
+ name you use to view the statistic using Traffic Line (see
+ <a href="ViewStatsUsingTrafLine.html" title="Viewing Statistics Using Traffic Line">Viewing Statistics Using Traffic Line</a>). There are two
+ <code class="code">INKStatTypes</code>: <code class="code">INKSTAT_TYPE_INT64</code>
and <code class="code">INKSTAT_TYPE_FLOAT</code>.</p></dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
-<p>A handle to the newly created
+<p>A handle to the newly-created
<code class="code">INKStat</code>.</p>
<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.5</p></dd>
</dl></div>
</div>
<div class="section" lang="en">
@@ -174,19 +166,17 @@
<a name="INKStatDecrement"></a>INKStatDecrement</h4></div></div></div>
<p>Decrements a stat.</p>
<div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">INKReturnCode INKStatDecrement(INKStat
<em class="replaceable"><code>the_stat</code></em> )</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd><p>Decrements a stat.</p></dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if the operation completes
successfully.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</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">
@@ -194,19 +184,18 @@
<a name="INKStatIncrement"></a>INKStatIncrement</h4></div></div></div>
<p>Increments a stat.</p>
<div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">INKReturnCode INKStatIncrement(INKStat
<em class="replaceable"><code>the_stat</code></em> )</code></p></dd>
-<dt><span class="term">Description</span></dt>
-<dd><p>Increments a stat.</p></dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Increments a statistic.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if the operation completes
successfully.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</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">
@@ -214,21 +203,19 @@
<a name="INKStatFloatSet"></a>INKStatFloatSet</h4></div></div></div>
<p>Sets the value of a float stat to a particular value.</p>
<div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">INKReturnCode INKStatFloatSet(INKStat
- <em class="replaceable"><code>the_stat</code></em> , float
+ <em class="replaceable"><code>the_stat</code></em>, float
<em class="replaceable"><code>the_value</code></em> )</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd><p>Sets the value of a float stat to the specified
value.</p></dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if the operation completes
successfully.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</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">
@@ -237,21 +224,19 @@
<p>Sets the value of an integer stat to a particular
value.</p>
<div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">INKReturnCode INKStatIntSet(INKStat
- <em class="replaceable"><code>the_stat</code></em> , INK64
+ <em class="replaceable"><code>the_stat</code></em>, INK64
<em class="replaceable"><code>the_value</code></em> )</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd><p>Sets the value of a integer stat to a particular
value.</p></dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if the operation completes
successfully.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.5</p></dd>
</dl></div>
</div>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/TEConfigReadFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/TEConfigReadFunctions.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/TEConfigReadFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/TEConfigReadFunctions.html Tue Dec 15 20:36:40 2009
@@ -1,47 +1,47 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Traffic Server Configuration Read 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="ManagementInterfaceFunctions.html" title="Management Interface Functions">
-<link rel="next" href="INKMgmtFloatGet.html" title="INKMgmtFloatGet">
-<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="TEConfigReadFunctions.html#INKMgmtCounterGet" title="INKMgmtCounterGet">
-<link rel="subsection" href="INKMgmtFloatGet.html" title="INKMgmtFloatGet">
-<link rel="subsection" href="INKMgmtIntGet.html" title="INKMgmtIntGet">
-<link rel="subsection" href="INKMgmtStringGet.html" title="INKMgmtStringGet">
+<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="ManagementInterfaceFunctions.html" title="Management Interface Functions" />
+<link rel="next" href="INKMgmtFloatGet.html" title="INKMgmtFloatGet" />
+<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="TEConfigReadFunctions.html#INKMgmtCounterGet" title="INKMgmtCounterGet" />
+<link rel="subsection" href="INKMgmtFloatGet.html" title="INKMgmtFloatGet" />
+<link rel="subsection" href="INKMgmtIntGet.html" title="INKMgmtIntGet" />
+<link rel="subsection" href="INKMgmtStringGet.html" title="INKMgmtStringGet" />
<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
document.write("<style> div.toc {display: none} </style>");
</script>
@@ -49,7 +49,7 @@
<body>
<div class="doctitle">
<a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
<div class="navprev">
@@ -65,34 +65,38 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="INKMgmtCounterGet"></a>INKMgmtCounterGet</h3></div></div></div>
-<p>Get a <code class="filename">records.config</code> variable of type
+<p>Gets a <code class="filename">records.config</code> variable of type
<code class="code">counter</code>.</p>
<div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">int INKMgmtCounterGet (const char
*<em class="replaceable"><code>var_name</code></em>, INKMgmtCounter
*<em class="replaceable"><code>result</code></em>)</code></p></dd>
-<dt><span class="term">Arguments</span></dt>
+<dt><span class="term"><b>Arguments</b></span></dt>
<dd>
-<p><code class="code"><em class="replaceable"><code>var_name</code></em></code> is the
+<p><code class="code"><em class="replaceable"><code>var_name </code></em></code> is the
name of the variable you want from
<code class="filename">records.config</code>.</p>
-<p><code class="code"><em class="replaceable"><code>result</code></em></code> is a
- pointer to the value of the variable. This value is of type
+<p><code class="code"><em class="replaceable"><code>result </code></em></code> is a
+ pointer to the value of the variable; this value is of type
<code class="function">INKMgmtCounter</code>.</p>
</dd>
-<dt><span class="term">Description</span></dt>
-<dd><p><code class="function">INKMgmtCounterGet</code> obtains the value
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p><code class="function">INKMgmtCounterGet</code> obtains the value
of the specified <code class="filename">records.config</code> variable of
- type <code class="code">counter</code>, and stores the value in
+ type <code class="code">counter</code>, and then stores the value in
<code class="code"><em class="replaceable"><code>result</code></em></code>.</p></dd>
-<dt><span class="term">Returns</span></dt>
-<dd><p>If <code class="function">INKMgmtCounterGet</code> could not get
- the variable, it returns zero. If successful, a nonzero value is
- returned.</p></dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.5</p></dd>
-</dl></div>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+ <p>If <code class="function">INKMgmtCounterGet</code> could not get
+ the variable, then it returns zero. </p></dd>
+<dd>
+ <p>If <code class="function">INKMgmtCounterGet</code> is successful, then a nonzero value is
+ returned.</p>
+</dd>
+</dl>
+</div>
</div>
</div>
</body>
Modified: incubator/trafficserver/site/trunk/docs/sdk/ThreadFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/ThreadFunctions.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/ThreadFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/ThreadFunctions.html Tue Dec 15 20:36:40 2009
@@ -1,47 +1,47 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Thread Functions</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="prev" href="INKstrndup.html" title="INKstrndup">
-<link rel="next" href="INKThreadDestroy.html" title="INKThreadDestroy">
-<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="ThreadFunctions.html#INKThreadCreate" title="INKThreadCreate">
-<link rel="subsection" href="INKThreadDestroy.html" title="INKThreadDestroy">
-<link rel="subsection" href="INKThreadInit.html" title="INKThreadInit">
-<link rel="subsection" href="INKThreadSelf.html" title="INKThreadSelf">
+<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="INKstrndup.html" title="INKstrndup" />
+<link rel="next" href="INKThreadDestroy.html" title="INKThreadDestroy" />
+<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="ThreadFunctions.html#INKThreadCreate" title="INKThreadCreate" />
+<link rel="subsection" href="INKThreadDestroy.html" title="INKThreadDestroy" />
+<link rel="subsection" href="INKThreadInit.html" title="INKThreadInit" />
+<link rel="subsection" href="INKThreadSelf.html" title="INKThreadSelf" />
<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
document.write("<style> div.toc {display: none} </style>");
</script>
@@ -49,7 +49,7 @@
<body>
<div class="doctitle">
<a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
<div class="navprev">
@@ -66,51 +66,49 @@
enables a single program to have more than one stream of execution and
to process more than one transaction at a time.</p>
<p>Threads serialize their access to shared resources and data using
- the INKMutex type, described in <a href="MutexGuide.html#Mutexes" title="Mutexes">âMutexesâ</a>.</p>
-<p>The thread functions are:</p>
+ the <code>INKMutex</code> type, as described in <a href="MutexGuide.html#Mutexes" title="Mutexes">Mutexes</a>.</p>
+<p>The thread functions are described below.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="INKThreadCreate"></a>INKThreadCreate</h3></div></div></div>
<p>Creates a new thread.</p>
<div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">INKThread INKThreadCreate (INKThreadFunc
<em class="replaceable"><code>func</code></em>, void
<em class="replaceable"><code>*data</code></em>)</code></p></dd>
-<dt><span class="term">Arguments</span></dt>
+<dt><span class="term"><b>Arguments</b></span></dt>
<dd>
<p><code class="function">INKThreadFunc</code>
- <code class="code"><em class="replaceable"><code>func</code></em></code> is the function
- that the new thread executes.</p>
-<p><code class="code">void <em class="replaceable"><code>*data</code></em></code> is the
+ <code class="code"><em class="replaceable"><code>func </code></em></code> is the function
+ the new thread executes.</p>
+<p><code class="code">void <em class="replaceable"><code>*data </code></em></code> is the
data passed as an argument to
<code class="code"><em class="replaceable"><code>func</code></em></code>.</p>
</dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Creates a new thread and calls
- <code class="code"><em class="replaceable"><code>func</code></em></code> with the argument
+ <code class="code"><em class="replaceable"><code>func </code></em></code> with the argument
<code class="code"><em class="replaceable"><code>data</code></em></code>. When
- <code class="code"><em class="replaceable"><code>func</code></em></code> exits, the thread
- is destroyed automatically.</p>
+ <code class="code"><em class="replaceable"><code>func </code></em></code> exits, the thread
+ is automatically destroyed.</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png"></td>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>The <code class="function">INKThread</code> return pointer does
- not provide any indication of the status of the new thread,
+ not indicate the status of the new thread
and cannot be modified.</p></td></tr>
</table></div>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>A valid pointer to an <code class="function">INKThread</code>
object if successful.</p>
-<p>A <code class="code">NULL</code> pointer in case of an error.</p>
+<p>A <code class="code">NULL</code> pointer if there is an error.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
</div>