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 [3/10] - /incubator/trafficserver/site/trunk/docs/sdk/
Modified: incubator/trafficserver/site/trunk/docs/sdk/MiscellaneousInterfaceGuide.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/MiscellaneousInterfaceGuide.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/MiscellaneousInterfaceGuide.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/MiscellaneousInterfaceGuide.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>Chapter 9. Miscellaneous Interface Guide</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="prev" href="HTTPAlternateSelection.html" title="HTTP Alternate Selection">
-<link rel="next" href="INKfopenFamily.html" title="The INKfopen Family">
-<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="MiscellaneousInterfaceGuide.html#Interface_Debugging" title="Debugging Functions">
-<link rel="section" href="INKfopenFamily.html" title="The INKfopen Family">
-<link rel="section" href="MemoryAllocation.html" title="Memory Allocation">
-<link rel="section" href="Interface_ThreadFunctions.html" title="Thread Functions">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="prev" href="HTTPAlternateSelection.html" title="HTTP Alternate Selection" />
+<link rel="next" href="INKfopenFamily.html" title="The INKfopen Family" />
+<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="MiscellaneousInterfaceGuide.html#Interface_Debugging" title="Debugging Functions" />
+<link rel="section" href="INKfopenFamily.html" title="The INKfopen Family" />
+<link rel="section" href="MemoryAllocation.html" title="Memory Allocation" />
+<link rel="section" href="Interface_ThreadFunctions.html" title="Thread Functions" />
<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
document.write("<style> div.toc {display: none} </style>");
</script>
@@ -49,7 +49,7 @@
<body>
<div class="doctitle">
<a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
<div class="navprev">
@@ -73,33 +73,38 @@
<p>Most of the functions in the Traffic Server API provide an interface
to specific code modules within Traffic Server. The miscellaneous
functions described in this chapter provide some useful general
- capabilities:</p>
+ capabilities. They are as follows:</p>
<div class="itemizedlist"><ul type="disc">
-<li><p><a href="DebuggingFunctions.html" title="Debugging Functions">âDebugging Functionsâ</a></p></li>
-<li><p><a href="INKfopenFamily.html" title="The INKfopen Family">âThe INKfopen Familyâ</a></p></li>
-<li><p><a href="MemoryAllocation.html" title="Memory Allocation">âMemory Allocationâ</a></p></li>
-<li><p><a href="ThreadFunctions.html" title="Thread Functions">âThread Functionsâ</a></p></li>
+<li><p><a href="DebuggingFunctions.html" title="Debugging Functions">Debugging Functions</a></p></li>
+<li>
+ <p><a href="INKfopenFamily.html" title="The INKfopen Family">The INKfopen Family</a></p></li>
+<li><p><a href="MemoryAllocation.html" title="Memory Allocation">Memory Allocation</a></p></li>
+<li><p><a href="ThreadFunctions.html" title="Thread Functions">Thread Functions</a></p></li>
</ul></div>
<p>While the C library already provides functions such as
<code class="function">printf</code>, <code class="function">malloc</code>, and
- <code class="function">fopen</code> that perform these tasks, the Traffic Server
+ <code class="function">fopen</code> to perform these tasks, the Traffic Server
API versions overcome various C library limitations (such as portability
to all Traffic Server-supported platforms).</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="Interface_Debugging"></a>Debugging Functions</h2></div></div></div>
-<p>Debugging functions</p>
<div class="itemizedlist"><ul type="disc">
-<li><p><a href="DebuggingFunctions.html#INKDebug" title="INKDebug">âINKDebugâ</a> prints out a formatted statement
+<li>
+ <p><a href="DebuggingFunctions.html#INKDebug" title="INKDebug">INKDebug</a> prints out a formatted statement
if you are running Traffic Server in debug mode.</p></li>
-<li><p><a href="INKIsDebugTagSet.html" title="INKIsDebugTagSet">âINKIsDebugTagSetâ</a> finds out if a debug tag
- is set. If the debug tag is set, Traffic Server prints out any debug
- statements associated to the debug tag.</p></li>
-<li><p><a href="INKError.html" title="INKError">âINKErrorâ</a> prints error messages to Traffic
+<li>
+ <p><a href="INKIsDebugTagSet.html" title="INKIsDebugTagSet">INKIsDebugTagSet</a> checks to see if a debug tag
+ is set. If the debug tag is set, then Traffic Server prints out any debug
+ statements associated with the tag.</p></li>
+<li>
+ <p><a href="INKError.html" title="INKError">INKError</a> prints error messages to Traffic
Serverâs error log</p></li>
-<li><p><a href="INKAssert.html" title="INKAssert">âINKAssertâ</a> allows the use of assertion in a
- plugin.</p></li>
-<li><p><a href="INKReleaseAssert.html" title="INKReleaseAssert">âINKReleaseAssertâ</a> allows the use of
+<li>
+ <p><a href="INKAssert.html" title="INKAssert">INKAssert</a> enables the use of assertion in a
+ plugin.</p></li>
+<li>
+ <p><a href="INKReleaseAssert.html" title="INKReleaseAssert">INKReleaseAssert</a> enables the use of
assertion in a plugin.</p></li>
</ul></div>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/MutexFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/MutexFunctions.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/MutexFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/MutexFunctions.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>Mutex 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="MimeHeadersFunctions.html" title="MIIME Headers">
-<link rel="next" href="INKMutexLock.html" title="INKMutexLock">
-<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="MutexFunctions.html#INKMutexCreate" title="INKMutexCreate">
-<link rel="subsection" href="INKMutexLock.html" title="INKMutexLock">
-<link rel="subsection" href="INKMutexLockTry.html" title="INKMutexLockTry">
-<link rel="subsection" href="INKMutexUnlock.html" title="INKMutexUnlock">
+<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="MimeHeadersFunctions.html" title="MIIME Headers" />
+<link rel="next" href="INKMutexLock.html" title="INKMutexLock" />
+<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="MutexFunctions.html#INKMutexCreate" title="INKMutexCreate" />
+<link rel="subsection" href="INKMutexLock.html" title="INKMutexLock" />
+<link rel="subsection" href="INKMutexLockTry.html" title="INKMutexLockTry" />
+<link rel="subsection" href="INKMutexUnlock.html" title="INKMutexUnlock" />
<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">
@@ -67,17 +67,15 @@
<a name="INKMutexCreate"></a>INKMutexCreate</h3></div></div></div>
<p>Creates a new <code class="code">INKMutex</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">INKMutex INKMutexCreate (void)</code></p></dd>
-<dt><span class="term">Description</span></dt>
-<dd><p>Creates a new INKMutex.</p></dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd><p>Creates a new <code>INKMutex</code>.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
-<p>A handle to the newly created mutex.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</p>
+<p>A handle to the newly-created mutex.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/MutexGuide.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/MutexGuide.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/MutexGuide.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/MutexGuide.html Tue Dec 15 20:36:40 2009
@@ -1,44 +1,44 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Chapter 11. Mutex Guide</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="prev" href="MIMEHeaders.html" title="MIME Headers">
-<link rel="next" href="Continuations.html" title="Chapter 12. Continuations">
-<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="MutexGuide.html#Mutexes" title="Mutexes">
+<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="MIMEHeaders.html" title="MIME Headers" />
+<link rel="next" href="Continuations.html" title="Chapter 12. Continuations" />
+<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="MutexGuide.html#Mutexes" title="Mutexes" />
<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
document.write("<style> div.toc {display: none} </style>");
</script>
@@ -46,7 +46,7 @@
<body>
<div class="doctitle">
<a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
<div class="navprev">
@@ -75,12 +75,12 @@
</dl></dd>
</dl>
</div>
-<p>Use mutexes to lock shared data. This chapter explains how to use
+<p>Mutexes are used to lock shared data. This chapter explains how to use
the mutex interface.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="Mutexes"></a>Mutexes<a class="indexterm" name="id385032"></a></h2></div></div></div>
-<p>A mutex is the basic synchronization<a class="indexterm" name="id385044"></a> method used within Traffic Server to protect data from
+<p>A <b>mutex</b> is the basic synchronization<a class="indexterm" name="id385044"></a> method used within Traffic Server to protect data from
simultaneous access by multiple threads. A mutex acts as a lock that
protects data in one program thread from being accessed by another
thread.</p>
@@ -89,110 +89,113 @@
<code class="function">INKMutexLock</code>. <code class="function">INKMutexLock</code> is
a blocking call; if you use it, you can slow Traffic Server performance
(transaction processing pauses until the mutex is unlocked). It should
- be used only on threads created by the plugin
- (<code class="function">INKContThreadCreate</code>). Never use it on a
- continuation handler called back by HTTP SM or Cache, Net or Event
+ be used only on threads created by the plugin <code class="function">INKContThreadCreate</code>. Never use it on a
+ continuation handler called back by the Cache, Net, or Event
Processor. Even if the critical section is very small, do not use it. If
- you need to update a flag, set a variable, use atomic operations. If
+ you need to update a flag, then set a variable and/or use atomic operations. If
<code class="function">INKMutexLock</code> is used in any case other than the one
- recommended above, the result will cause serious performance impact.
- <code class="function">INKMutexLockTry</code>, on the other hand, attempts to
- lock the mutex only if it is unlocked (not being used by another
- thread). It should be used in all cases other than the above mentioned
- <code class="function">INKMutexLock</code> case. If the
- <code class="function">INKMutexLockTry</code> attempt fails, you can schedule a
- future attempt, which must be at least 10 milliseconds later. See for an
- example.</p>
-<p>Inktomi recommends that, in general, you use
+ recommended above, then the result will cause serious performance impact. </p>
+<p><code class="function">INKMutexLockTry</code>, on the other hand, attempts to
+ lock the mutex only if it is unlocked (i.e., not being used by another
+ thread). It should be used in all cases other than the above mentioned
+ <code class="function">INKMutexLock</code> case. If the
+ <code class="function">INKMutexLockTry</code> attempt fails, then you can schedule a
+ future attempt (which must be at least 10 milliseconds later). </p>
+<p>In general, you should use
<code class="code">INKMutexLockTry</code> rather than
<code class="code">INKMutexLock</code>.</p>
<div class="itemizedlist"><ul type="disc">
-<li><p><code class="function">InkMutexLockTry</code> is required if you are
- tying to lock Traffic Server internal or system resources, such as
- network, cache, eventProcessor, HTTP state machines and IO
- buffers.</p></li>
-<li><p><code class="function">InkMutexLockTry</code> is required if you are
- making any blocking calls, such as network or cache or file IO
- calls.</p></li>
-<li><p><code class="function">INKMutexLock</code> might not be necessary if
- you are not making blocking calls, and if you are only accessing
- local resources.</p></li>
+<li>
+ <p><code class="function">InkMutexLockTry</code> is required if you are
+ tying to lock Traffic Server internal or system resources (such as
+ the network, cache, eventProcessor, HTTP state machines, and IO
+ buffers).</p></li>
+<li>
+ <p><code class="function">InkMutexLockTry</code> is required if you are
+ making any blocking calls m(such as network, cache, or file IO
+ calls).</p></li>
+<li>
+ <p><code class="function">INKMutexLock</code> might <i>not</i> be necessary if
+ you are not making blocking calls and if you are only accessing
+ local resources.</p></li>
</ul></div>
-<p>Traffic Server API uses the <code class="function">INKMutex</code> type for
- a mutex.</p>
-<p>There are two typical uses of mutex. One use is to lock global
+<p>The Traffic Server API uses the <code class="function">INKMutex</code> type for
+ a mutex. There are two typical uses of mutex. One use is for locking global
data or data shared by various continuations. The other typical usage is
- to lock data associated to a continuation (data that might be accessed
+ for locking data associated with a continuation (i.e., data that might be accessed
by other continuations).</p>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
+ <div class="titlepage"><div><div><h3 class="title">
<a name="LockingGlobalData"></a>Locking Global Data</h3></div></div></div>
<p>The <code class="filename">blacklist-1.c</code> sample plugin implements
- an example of this type. The blacklist plugin reads its blacklisted
- sites from a configuration file. File read operations are protected by
+ a mutex that locks global data. The blacklist plugin reads its blacklisted
+ sites from a configuration fille; file read operations are protected by
a mutex created in <code class="filename">INKPluginInit</code>. The
<code class="filename">blacklist-1.c</code> code uses
<code class="filename">INKMutexLockTry</code> instead of
- <code class="filename">InkMutexLock</code>. See <a href="App_SampleSourceCode.html#Sample_blacklist-1.c" title="blacklist-1.c">âblacklist-1.câ</a> for the
- <code class="filename">blacklist-1.c</code> code (start by looking at the <a href="InitializationFunctions.html#INKPluginInit" title="INKPluginInit"><code class="code">INKPluginInit</code></a> function).
- The general guideline for locking shared data is:</p>
+ <code class="filename">InkMutexLock</code>. For more detailed information, see the <a href="App_SampleSourceCode.html#Sample_blacklist-1.c" title="blacklist-1.c"><code>blacklist-1.c</code></a> <code class="filename"></code> code - start by looking at the <a href="InitializationFunctions.html#INKPluginInit" title="INKPluginInit"><code class="code">INKPluginInit</code></a> function. </p>
+<p>General guidelines for locking shared data are as follows:</p>
<div class="orderedlist"><ol type="1">
-<li><p>Create a mutex for this shared data using <a href="MutexFunctions.html#INKMutexCreate" title="INKMutexCreate"><code class="code">INKMutexCreate</code></a>.</p></li>
-<li><p>Whenever you need to read or modify this data, first lock it
- by calling <a href="INKMutexLockTry.html" title="INKMutexLockTry"><code class="code">INKMutexLockTry</code></a>.
- Then read or modify the data.</p></li>
-<li><p>When you are done with the data, unlock it with <a href="INKMutexUnlock.html" title="INKMutexUnlock">INKMutexUnlock</a>. If you are
+<li>
+ <p>Create a mutex for the shared data with <a href="MutexFunctions.html#INKMutexCreate" title="INKMutexCreate"><code class="code">INKMutexCreate</code></a>.</p></li>
+<li>
+ <p>Whenever you need to read or modify this data, first lock it
+ by calling <a href="INKMutexLockTry.html" title="INKMutexLockTry"><code class="code">INKMutexLockTry</code></a>; then read or modify the data.</p></li>
+<li>
+ <p>When you are done with the data, unlock it with <a href="INKMutexUnlock.html" title="INKMutexUnlock"><code>INKMutexUnlock</code></a>. If you are
unlocking data accessed during the processing of an HTTP
- transaction, you must unlock it before calling <a href="HTTPTransactionFunctions.html#INKHttpTxnReenable" title="INKHttpTxnReenable">INKHttpTxnReenable</a>.</p></li>
+ transaction, then you must unlock it before calling <a href="HTTPTransactionFunctions.html#INKHttpTxnReenable" title="INKHttpTxnReenable"><code>INKHttpTxnReenable</code></a>.</p></li>
</ol></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="ProtectContinuationData"></a>Protecting a Continuationâs Data</h3></div></div></div>
-<p>You need to create a mutex to protect a continuationâs data if
+<p>You must create a mutex to protect a continuationâs data if
it might be accessed by other continuations or processes.</p>
<div class="orderedlist"><ol type="1">
<li>
<p>Create a mutex for the continuation using
- <code class="function">INKMutexCreate</code>. For example,</p>
+ <code class="function">INKMutexCreate</code>. <br /> For example:</p>
<pre class="programlisting">INKMutex mutexp;
mutexp = INKMutexCreate ();</pre>
</li>
<li>
<p>When you create the continuation, specify this mutex as the
- continuationâs mutex. For example,</p>
+ continuationâs mutex. <br /> For example:</p>
<pre class="programlisting">INKCont contp;
contp = INKContCreate (handler, mutexp);</pre>
</li>
</ol></div>
-<p>If any other functions want to access contpâs data, it is up to
- them to get contpâs mutex (using, for example,
- <code class="function">INKContMutexGet</code>) and lock it. See the sample
- Protocol plugin for usage.</p>
+<p>If any other functions want to access <code>contp</code>âs data, then it is up to
+ them to get <code>contp</code>âs mutex (using, for example, <code class="function">INKContMutexGet</code>) to lock it (see the sample
+ Protocol plugin for usage).</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="AssocContinuationToHTTPTx"></a>How to Associate a Continuation to Every HTTP
Transaction</h3></div></div></div>
-<p>There might be several reasons to create a continuation for each
- HTTP transaction that calls back your plugin. Some examples
- include:</p>
+<p>There could be several reasons you'd want to create a continuation for each
+ HTTP transaction that calls back your plugin. <br />
+ Some potential scenarios
+ are listed below.</p>
<div class="itemizedlist"><ul type="disc">
-<li><p>register hooks locally with the new continuation instead of
+<li>
+ <p>You want to register hooks locally with the new continuation instead of
registering them globally to the continuation plugin.</p></li>
-<li><p>store data specific to each HTTP transaction that you might
+<li>
+ <p>You want to store data specific to each HTTP transaction that you might
need to reuse across various hooks.</p></li>
-<li><p>use of APIs (like <code class="function">INKHostLookup</code>) which
- will call back this continuation with a certain event.</p></li>
+<li>You're using APIs (like <code class="function">INKHostLookup</code>) that
+ will call back this continuation with a certain event.</li>
</ul></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="AddNewContinuation"></a>How to Add the New Continuation</h3></div></div></div>
-<p>A typical way of adding the new continuation is to register the
+<p>A typical way of adding the new continuation is by registering the
plugin continuation to be called back by HTTP transactions globally
when they reach <code class="code">INK_HTTP_TXN_START_HOOK</code>. Refer to the
- example below using a transaction specific continuation called
+ example below, which uses a transaction specific continuation called
<code class="code">txn_contp</code>.</p>
<pre class="programlisting"> void INKPluginInit(int argc, const char *argv[])
{
@@ -207,7 +210,7 @@
}
}</pre>
<p>In the plugin continuation handler, create the new continuation
- <code class="code">txn_contp</code>, and register it to be called back at
+ <code class="code">txn_contp</code> and then register it to be called back at
<code class="code">INK_HTTP_TXN_CLOSE_HOOK</code>:</p>
<pre class="programlisting">static int plugin_cont_handler(INKCont contp, INKEvent event, void *edata)
{
@@ -237,7 +240,8 @@
return 0;
}</pre>
-<p>Have the <code class="code">txn_contp</code></p>
+<p>Remember that the <code class="code">txn_contp</code> handler must destory itself when the HTTP transaction is
+ closed. If you forget, then your plugin will have a memory leak.</p>
<pre class="programlisting">static int txn_cont_handler(INKCont txn_contp, INKEvent event, void *edata)
{
INKHttpTxn txnp;
@@ -257,23 +261,19 @@
}
return 0;
- }</pre>
-<p> handler destory itself when the HTTP transaction is
- closed. If you forget, your plugin will have a big memory leak.</p>
-</div>
+ }</pre></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="StoreDataSpecificHTTPTx"></a>How to Store Data Specific to Each HTTP Transaction</h3></div></div></div>
-<p>For the example above, store the data in the txn_contp data
- structure. This means that you will create your own data structure.
- Suppose you want to store the state of the HTTP transaction:</p>
+<p>For the example above, store the data in the <code>txn_contp</code> data
+ structure - this means that you'll create your own data structure.
+ Now suppose you want to store the state of the HTTP transaction:</p>
<pre class="programlisting"> typedef struct {
int state;
} ContData;</pre>
<p>You would need to allocate the memory and initialize this
- structure for each HTTP txnp. You can do that in the plugin
- continuation handler when it is called back with
- <code class="code">INK_EVENT_HTTP_TXN_START</code></p>
+ structure for each HTTP <code>txnp</code>. You can do that in the plugin
+ continuation handler when it is called back with <code class="code">INK_EVENT_HTTP_TXN_START</code></p>
<pre class="programlisting">static int plugin_cont_handler(INKCont contp, INKEvent event, void *edata)
{
INKHttpTxn txnp = (INKHttpTxn)edata;
@@ -346,8 +346,8 @@
}
return 0;
- }</pre>
-<p>:</p>
+ }
+</pre>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
@@ -355,37 +355,36 @@
<p>You do not need to use locks when a continuation has registered
itself to be called back by HTTP hooks and it only uses the HTTP APIs.
In the example above, the continuation <code class="code">txn_contp</code> has
- registered itself to be called back at HTTP hooks, and it only uses
+ registered itself to be called back at HTTP hooks and it only uses
the HTTP APIs. In this case only, it is safe to access data shared
between <code class="code">txnp</code> and <code class="code">txn_contp</code> without grabbing
a lock. In the example above <code class="code">txn_contp</code> is created with a
<code class="code">NULL</code> mutex. This works because the HTTP transaction
- <code class="code">txnp</code> is the only which will call back
+ <code class="code">txnp</code> is the only one that will call back
<code class="code">txn_contp</code>, and you are guaranteed that
<code class="code">txn_contp</code> will be called back only one hook at a time.
- After processing is done <code class="code">txn_contp</code> will reenable
+ After processing is finished, <code class="code">txn_contp</code> will reenable
<code class="code">txnp</code>.</p>
<p>In all other cases, you should create a mutex with the
- continuation. Basically in the case where you are using iocore APIs,
+ continuation. In general, a lock is needed when you're using iocore APIs
or any other API where <code class="code">txn_contp</code> is scheduled to be
- called back by a processor (the cache processor, the DNS
- processor...), a lock is needed. This ensures that
- <code class="code">txn_contp</code> will be called back only one at a time, (i.e.
- you are sure that <code class="code">txn_contp</code> will not be called back by
- both <code class="code">txnp</code> and by the cache processor simultaneously,
- which would result in a situation where you are executing two pieces
- of code in conflict!)</p>
+ called back by a processor (such as the cache processor, the DNS
+ processor, etc.). This ensures that
+ <code class="code">txn_contp</code> is called back sequentially and not simultaneously. In other words,
+ you need to ensure that <code class="code">txn_contp</code> will not be called back by
+ both <code class="code">txnp</code> and the cache processor at the same time,
+ since this will result in a situation wherein you're executing two pieces
+ of code in conflict!</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="ContinuationsCreatedHTTPTx"></a>Special Case: Continuations Created for HTTP
Transactions</h3></div></div></div>
<p>If your plugin creates a new continuation for each HTTP
- transaction, you probably do not have to create a new mutex for it,
+ transaction, then you probably do not have to create a new mutex for it
because each HTTP transaction (<code class="code">INKHttpTxn</code> object) already
has its own mutex.</p>
-<p>For example, if you have code such as the following, it is not
- necessary to specify a mutex for the continuation created in
+<p>In the example below, it is not necessary to specify a mutex for the continuation created in
<code class="code">txn_handler</code>:</p>
<pre class="programlisting">static void
txn_handler (INKHttpTxn txnp, INKCont contp) {
@@ -412,11 +411,11 @@
}
return 0;
}</pre>
-<p>The mutex functions are:</p>
+<p>The mutex functions are listed below:</p>
<div class="itemizedlist"><ul type="disc">
-<li><p><a href="MutexFunctions.html#INKMutexCreate" title="INKMutexCreate">âINKMutexCreateâ</a></p></li>
-<li><p><a href="INKMutexLock.html" title="INKMutexLock">âINKMutexLockâ</a></p></li>
-<li><p><a href="INKMutexLockTry.html" title="INKMutexLockTry">âINKMutexLockTryâ</a></p></li>
+<li><p><a href="MutexFunctions.html#INKMutexCreate" title="INKMutexCreate">INKMutexCreate</a></p></li>
+<li><p><a href="INKMutexLock.html" title="INKMutexLock">INKMutexLock</a></p></li>
+<li><p><a href="INKMutexLockTry.html" title="INKMutexLockTry">INKMutexLockTry</a></p></li>
</ul></div>
</div>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/NamingConventions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/NamingConventions.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/NamingConventions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/NamingConventions.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>Naming Conventions</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="PlusingRegisAndVersionCkg.html" title="Plugin Registration and Version Checking">
-<link rel="next" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="prev" href="PlusingRegisAndVersionCkg.html" title="Plugin Registration and Version Checking" />
+<link rel="next" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
document.write("<style> div.toc {display: none} </style>");
</script>
@@ -45,7 +45,7 @@
<body>
<div class="doctitle">
<a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
<div class="navprev">
@@ -60,34 +60,35 @@
<p>The Traffic Server API adheres to the following naming
conventions:</p>
<div class="itemizedlist"><ul type="disc">
-<li><p>The <code class="filename">INK</code> prefix is used for all function
- and variable names defined in the Traffic Server API. For example:
- <code class="filename">INK_EVENT_NONE</code>,<code class="filename">INKMutex</code>
- and <code class="filename">INKContCreate</code>.</p></li>
-<li><p>Enumerated values are always written in all uppercase letters.
- Examples: <em class="parameter"><code>INK_EVENT_NONE</code></em> and
- <em class="parameter"><code>INK_VC_CLOSE_ABORT</code></em>.</p></li>
-<li><p>Constant values are all upper case. Enumerated values can be
- seen as a subset of constants. Examples:
- <code class="code"><code class="constant">INK_URL_SCHEME_FILE</code></code> and
- <code class="code">INK_MIME_FIELD_ACCEPT</code>.</p></li>
-<li><p>The names of defined types are mixed-case. Examples:
- <em class="parameter"><code>INKHttpSsn</code></em> and
- <em class="parameter"><code>INKHttpTxn</code></em>.</p></li>
-<li><p>Function names are mixed-case. Examples:
- <code class="function">INKUrlCreate</code> and
- <code class="function">INKContDestroy</code>.</p></li>
-<li><p>Function names use the following subject-verb naming style:
+<li>
+ <p>The <code class="filename">INK</code> prefix is used for all function
+ and variable names defined in the Traffic Server API. <b>Examples</b>: <code class="filename">INK_EVENT_NONE</code>,<code class="filename"> INKMutex</code>, and <code class="filename">INKContCreate</code></p></li>
+<li>
+ <p>Enumerated values are always written in all uppercase letters.
+ <b>Examples</b>: <em class="parameter"><code>INK_EVENT_NONE</code></em> and
+ <em class="parameter"><code>INK_VC_CLOSE_ABORT</code></em></p></li>
+<li>
+ <p>Constant values are all uppercase; enumerated values can be
+ seen as a subset of constants. <b>Examples</b>: <code class="code"><code class="constant">INK_URL_SCHEME_FILE</code></code> and
+ <code class="code">INK_MIME_FIELD_ACCEPT</code></p></li>
+<li>
+ <p>The names of defined types are mixed-case. <b>Examples</b>: <em class="parameter"><code>INKHttpSsn</code></em> and
+ <em class="parameter"><code>INKHttpTxn</code></em></p></li>
+<li>
+ <p>Function names are mixed-case. <b>Examples</b>: <code class="function">INKUrlCreate</code> and
+ <code class="function">INKContDestroy</code></p></li>
+<li>
+ <p>Function names use the following subject-verb naming style:
<code class="code">INK-<subject>-<verb></code>, where
<code class="code"><subject></code> goes from general to specific. This
makes it easier to determine what a function does by reading its
- name. For example, the function to retrieve the password field (the
- specific subject) from a URL (the general subject) is
- <code class="code">INKUrlPasswordGet</code>.</p></li>
-<li><p>Common verbs like <code class="code">Create</code>, <code class="code">Destroy</code>,
+ name. <b>For</b> <b>example</b>: the function to retrieve the password field (the
+ specific subject) from a URL (the general subject) is <code class="code">INKUrlPasswordGet</code>.</p></li>
+<li>
+ <p>Common verbs like <code class="code">Create</code>, <code class="code">Destroy</code>,
<code class="code">Get</code>, <code class="code">Set</code>, <code class="code">Copy</code>,
<code class="code">Find</code>, <code class="code">Retrieve</code>, <code class="code">Insert</code>,
- <code class="code">Remove</code> and <code class="code">Delete</code> are used only when
+ <code class="code">Remove</code>, and <code class="code">Delete</code> are used only when
appropriate.</p></li>
</ul></div>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/NetVconnections.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/NetVconnections.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/NetVconnections.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/NetVconnections.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>Net Vconnections</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="prev" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="next" href="Transformations_IO.html" title="Transformations">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="prev" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="next" href="Transformations_IO.html" title="Transformations" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
document.write("<style> div.toc {display: none} </style>");
</script>
@@ -45,7 +45,7 @@
<body>
<div class="doctitle">
<a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
<div class="navprev">
@@ -57,15 +57,15 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="NetVconnections"></a>Net Vconnections</h2></div></div></div>
-<p>A network vconnection (netvconnection) is a wrapper around a TCP
+<p>A <b>network</b> <b>vconnection</b> (or<b> netvconnection</b>) is a wrapper around a TCP
socket that allows the socket to work within the Traffic Server
- vconnection framework. See <a href="IOGuide.html#Vconnections" title="Vconnections">âVconnectionsâ</a> for more
+ vconnection framework. See <a href="IOGuide.html#Vconnections" title="Vconnections">Vconnections</a> for more
information about the Traffic Server abstraction for doing asynchronous
IO.</p>
<p>The net vconnection functions are:</p>
<div class="itemizedlist"><ul type="disc">
-<li><p><a href="NetvconnectionFunctions.html#INKNetAccept" title="INKNetAccept">âINKNetAcceptâ</a></p></li>
-<li><p><a href="INKNetConnect.html" title="INKNetConnect">âINKNetConnectâ</a></p></li>
+<li><p><a href="NetvconnectionFunctions.html#INKNetAccept" title="INKNetAccept">INKNetAccept</a></p></li>
+<li><p><a href="INKNetConnect.html" title="INKNetConnect">INKNetConnect</a></p></li>
</ul></div>
</div>
</body>
Modified: incubator/trafficserver/site/trunk/docs/sdk/NetvconnectionFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/NetvconnectionFunctions.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/NetvconnectionFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/NetvconnectionFunctions.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>Netvconnection 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="INKVConnWriteVIOGet.html" title="INKVConnWriteVIOGet">
-<link rel="next" href="INKNetConnect.html" title="INKNetConnect">
-<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="NetvconnectionFunctions.html#INKNetAccept" title="INKNetAccept">
-<link rel="subsection" href="INKNetConnect.html" title="INKNetConnect">
-<link rel="subsection" href="INKNetVConnRemoteIPGet.html" title="INKNetVConnRemoteIPGet">
-<link rel="subsection" href="INKNetVConnRemotePortGet.html" title="INKNetVConnRemotePortGet">
+<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="INKVConnWriteVIOGet.html" title="INKVConnWriteVIOGet" />
+<link rel="next" href="INKNetConnect.html" title="INKNetConnect" />
+<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="NetvconnectionFunctions.html#INKNetAccept" title="INKNetAccept" />
+<link rel="subsection" href="INKNetConnect.html" title="INKNetConnect" />
+<link rel="subsection" href="INKNetVConnRemoteIPGet.html" title="INKNetVConnRemoteIPGet" />
+<link rel="subsection" href="INKNetVConnRemotePortGet.html" title="INKNetVConnRemotePortGet" />
<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">
@@ -67,48 +67,46 @@
<a name="INKNetAccept"></a>INKNetAccept</h3></div></div></div>
<p>Accepts a TCP/IP connection on a specified port.</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">INKAction INKNetAccept (INKCont
<em class="replaceable"><code>contp</code></em>, int
<em class="replaceable"><code>port</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">INKCont</code>
- <code class="code"><em class="replaceable"><code>contp</code></em></code> is the
- continuation that is called back when a connection is
+ <code class="code"><em class="replaceable"><code>contp </code></em></code> is the
+ continuation that's called back when a connection is
accepted.</p>
<p><code class="code">int
- </code><code class="code"><em class="replaceable"><code>port</code></em></code> is the port
- to listen to for incoming TCP/IP connections.</p>
+ </code><code class="code"><em class="replaceable"><code>port </code></em></code> is the port
+ that will listen for incoming TCP/IP connections.</p>
</dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Accepts a TCP/IP connection on
<code class="code"><em class="replaceable"><code>port</code></em></code>. When Traffic
Server receives a connection on a specified port, it calls back
- <code class="code"><em class="replaceable"><code>contp</code></em></code> with the event
+ <code class="code"><em class="replaceable"><code>contp </code></em></code> with the event
<code class="code">INK_EVENT_NET_ACCEPT</code> or
- <code class="code">INK_EVENT_NET_ACCEPT_FAILED</code></p>
-<p>If event is <code class="code">INK_EVENT_NET_ACCEPT</code>, the
- <code class="code">void * </code><code class="code"><em class="replaceable"><code>data</code></em></code>
+ <code class="code">INK_EVENT_NET_ACCEPT_FAILED</code>.</p>
+<p>If event is <code class="code">INK_EVENT_NET_ACCEPT</code>, then the
+ <code class="code">void * </code><code class="code"><em class="replaceable"><code>data </code></em></code>
passed to the handler of the continuation
- <code class="code"><em class="replaceable"><code>contp</code></em></code> is a data of type
- NetVConnection representing the connection.</p>
-<p>If event is <code class="code">INK_EVENT_NET_ACCEPT_FAILED</code>, it
- means an attempt of connection was aborted or failed. The plugin
+ <code class="code"><em class="replaceable"><code>contp </code></em></code> is a
+ NetVConnection datatype that represents the connection.</p>
+<p>If event is <code class="code">INK_EVENT_NET_ACCEPT_FAILED</code>, then it
+ means a connection attempt was aborted or failed. The plugin
should just return from the continuation's handler.</p>
<p>The user (<code class="code"><em class="replaceable"><code>contp</code></em></code>)
- has the option to cancel the action returned by INKNetAccept by
+ has the option to cancel the action returned by <code>INKNetAccept</code> by
using <code class="function">INKActionCancel</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
-<p>An INKAction object if successful.</p>
+<p>An <code>INKAction</code> object if successful.</p>
<p><code class="code">INK_ERROR_PTR</code> if an argument was incorrect or
if the API failed.</p>
</dd>
-<dt><span class="term">First Release</span></dt>
-<dd><p>Traffic Server 5.2</p></dd>
</dl></div>
</div>
</div>