trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mlib...@apache.org
Subject svn commit: r882316 [1/10] - /incubator/trafficserver/site/trunk/docs/sdk/
Date Thu, 19 Nov 2009 21:58:30 GMT
Author: mlibbey
Date: Thu Nov 19 21:58:27 2009
New Revision: 882316

URL: http://svn.apache.org/viewvc?rev=882316&view=rev
Log:
DianeS doc changes + self-closing tags + changing to unix line changes from dos

Modified:
    incubator/trafficserver/site/trunk/docs/sdk/HTTPHooksAndTransactions.html
    incubator/trafficserver/site/trunk/docs/sdk/HTTPSessionFunctions.html
    incubator/trafficserver/site/trunk/docs/sdk/HTTPSessions.html
    incubator/trafficserver/site/trunk/docs/sdk/HTTPTransactionFunctions.html
    incubator/trafficserver/site/trunk/docs/sdk/HTTPTransformationPlugins.html
    incubator/trafficserver/site/trunk/docs/sdk/INKActionDone.html
    incubator/trafficserver/site/trunk/docs/sdk/INKAssert.html
    incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDestroy.html
    incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDigestSet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyHostNameSet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyPinnedSet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKCacheRead.html
    incubator/trafficserver/site/trunk/docs/sdk/INKCacheReady.html
    incubator/trafficserver/site/trunk/docs/sdk/INKCacheRemove.html
    incubator/trafficserver/site/trunk/docs/sdk/INKCacheWrite.html
    incubator/trafficserver/site/trunk/docs/sdk/INKConfigGet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKConfigRelease.html
    incubator/trafficserver/site/trunk/docs/sdk/INKConfigSet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKContCreate.html
    incubator/trafficserver/site/trunk/docs/sdk/INKContDataGet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKContDataSet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKContDestroy.html
    incubator/trafficserver/site/trunk/docs/sdk/INKContMutexGet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKContSchedule.html
    incubator/trafficserver/site/trunk/docs/sdk/INKError.html
    incubator/trafficserver/site/trunk/docs/sdk/INKHostLookupResultIPGet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKHttpTxnServerIntercept.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockReadAvail.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockReadStart.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockWriteAvail.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockWriteStart.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferCopy.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferCreate.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferDestroy.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferProduce.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferReaderAlloc.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferReaderAvail.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferReaderClone.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferReaderConsume.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferReaderFree.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferReaderStart.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferSizedCreate.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferStart.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWaterMarkGet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWaterMarkSet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWrite.html
    incubator/trafficserver/site/trunk/docs/sdk/INKVConnCacheObjectSizeGet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKfflush.html
    incubator/trafficserver/site/trunk/docs/sdk/INKfgets.html
    incubator/trafficserver/site/trunk/docs/sdk/INKfopen.html
    incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamily.html
    incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamilyFunctions.html
    incubator/trafficserver/site/trunk/docs/sdk/INKfread.html
    incubator/trafficserver/site/trunk/docs/sdk/INKfwrite.html
    incubator/trafficserver/site/trunk/docs/sdk/IOBufferInterfaceFunctions.html
    incubator/trafficserver/site/trunk/docs/sdk/ImplementHandler_GetTransHandle.html
    incubator/trafficserver/site/trunk/docs/sdk/InitializationFunctions.html
    incubator/trafficserver/site/trunk/docs/sdk/InitiateConnectionFunctions.html
    incubator/trafficserver/site/trunk/docs/sdk/InitiateHTTPConnection.html
    incubator/trafficserver/site/trunk/docs/sdk/PluginConfigurationFunctions.html
    incubator/trafficserver/site/trunk/docs/sdk/index.html

Modified: incubator/trafficserver/site/trunk/docs/sdk/HTTPHooksAndTransactions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTPHooksAndTransactions.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTPHooksAndTransactions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTPHooksAndTransactions.html Thu Nov 19 21:58:27
2009
@@ -1,50 +1,50 @@
 <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 8. HTTP Hooks and Transactions</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="ch07s05.html" title="Cache Events">
-<link rel="next" href="AddingHooks.html" title="Adding Hooks">
-<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="HTTPHooksAndTransactions.html#SetOfHooks" title="The Set of
Hooks">
-<link rel="section" href="AddingHooks.html" title="Adding Hooks">
-<link rel="section" href="HTTPSessions.html" title="HTTP Sessions">
-<link rel="section" href="HTTP_Transactions.html" title="HTTP Transactions">
-<link rel="section" href="InterceptingHTTPTx.html" title="Intercepting HTTP Transactions">
-<link rel="section" href="InitiateHTTPConnection.html" title="Initiate HTTP Connection">
-<link rel="section" href="HTTPAlternateSelection.html" title="HTTP Alternate Selection">
+<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="ch07s05.html" title="Cache Events" />
+<link rel="next" href="AddingHooks.html" title="Adding Hooks" />
+<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="HTTPHooksAndTransactions.html#SetOfHooks" title="The Set of
Hooks" />
+<link rel="section" href="AddingHooks.html" title="Adding Hooks" />
+<link rel="section" href="HTTPSessions.html" title="HTTP Sessions" />
+<link rel="section" href="HTTP_Transactions.html" title="HTTP Transactions" />
+<link rel="section" href="InterceptingHTTPTx.html" title="Intercepting HTTP Transactions"
/>
+<link rel="section" href="InitiateHTTPConnection.html" title="Initiate HTTP Connection"
/>
+<link rel="section" href="HTTPAlternateSelection.html" title="HTTP Alternate Selection"
/>
 <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>
@@ -52,7 +52,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">
@@ -79,50 +79,51 @@
 <p>Hooks are points in Traffic Server transaction processing where
     plugins can step in and do some work. Registering a plugin function for
     callback amounts to “adding” the function to a hook. You can register your
-    plugin to be called back for every single transaction, or for specific
-    transactions only.</p>
+    plugin to be called back for every single transaction or only for specific
+    transactions.</p>
 <p>This chapter contains the following sections:</p>
 <div class="itemizedlist"><ul type="disc">
-<li><p><a href="AddingHooks.html" title="Adding Hooks">“Adding Hooks”</a></p></li>
-<li><p><a href="HTTPSessions.html" title="HTTP Sessions">“HTTP Sessions”</a></p></li>
-<li><p><a href="HTTP_Transactions.html" title="HTTP Transactions">“HTTP
Transactions”</a></p></li>
-<li><p><a href="InterceptingHTTPTransactionFuncs.html" title="Intercepting
HTTP Transaction Functions">“Intercepting HTTP Transaction Functions”</a></p></li>
-<li><p><a href="InitiateHTTPConnection.html" title="Initiate HTTP Connection">“Initiate
HTTP Connection”</a></p></li>
-<li><p><a href="HTTPAlternateSelection.html" title="HTTP Alternate Selection">“HTTP
Alternate Selection”</a></p></li>
+<li><p><a href="AddingHooks.html" title="Adding Hooks">Adding Hooks</a></p></li>
+<li><p><a href="HTTPSessions.html" title="HTTP Sessions">HTTP Sessions</a></p></li>
+<li><p><a href="HTTP_Transactions.html" title="HTTP Transactions">HTTP
Transactions</a></p></li>
+<li><p><a href="InterceptingHTTPTransactionFuncs.html" title="Intercepting
HTTP Transaction Functions">Intercepting HTTP Transaction Functions</a></p></li>
+<li><p><a href="InitiateHTTPConnection.html" title="Initiate HTTP Connection">Initiate
HTTP Connection</a></p></li>
+<li><p><a href="HTTPAlternateSelection.html" title="HTTP Alternate Selection">HTTP
Alternate Selection</a></p></li>
 </ul></div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="SetOfHooks"></a>The Set of Hooks</h2></div></div></div>
-<p>First you need the following terminology:</p>
+<p>you should be familiar with the following terminology:</p>
 <div class="variablelist"><dl>
-<dt><span class="term">HTTP Transaction</span></dt>
+<dt><span class="term"><b>HTTP Transaction</b></span></dt>
 <dd>
-<p>A transaction consists of a single HTTP request from a
-            client and the response that Traffic Server sends to that client.
-            A transaction begins when Traffic Server receives a request, and
+<p>A <i>transaction</i> consists of a single HTTP request from a
+            client and the response  Traffic Server sends to that client.
+            Thus, a transaction begins when Traffic Server receives a request and
             ends when Traffic Server sends the response.</p>
-<p>Traffic Server uses HTTP state machines to process
+<p>Traffic Server uses <i>HTTP state machines</i> to process
             transactions. The state machines follow a complex set of states
             involved in sophisticated caching and document retrieval (taking
             into account, for example, alternate selection, freshness
             criteria, and hierarchical caching). The Traffic Server API
-            provides hooks to a subset of these states, illustrated in <a href="HTTPHooksAndTransactions.html#Fig_HHTTPTxStateDiag"
title="Figure 8.1. HTTP Transaction State Diagram">Figure 8.1, “HTTP Transaction
State Diagram”</a>.</p>
+            provides hooks to a subset of these states, as illustrated in the <a href="HTTPHooksAndTransactions.html#Fig_HHTTPTxStateDiag"
title="Figure 8.1. HTTP Transaction State Diagram">HTTP Transaction State Diagram</a>
below.</p>
 </dd>
-<dt><span class="term">transform hooks</span></dt>
-<dd><p>The two transform hooks,
-            <code class="code">INK_HTTP_REQUEST_TRANSFORM_HOOK</code> and
-            <code class="code">INK_HTTP_RESPONSE_TRANSFORM_HOOK</code> are called
in the
+<dt><span class="term"><b>Transform hooks</b></span></dt>
+<dd>
+  <p>The two <i>transform hooks</i>, <code class="code">INK_HTTP_REQUEST_TRANSFORM_HOOK</code>
and
+            <code class="code">INK_HTTP_RESPONSE_TRANSFORM_HOOK</code>, are called
in the
             course of an HTTP transform. To see where in the HTTP transaction
-            they are called, look for the “set up transform” ovals in <a href="HTTPHooksAndTransactions.html#Fig_HHTTPTxStateDiag"
title="Figure 8.1. HTTP Transaction State Diagram">Figure 8.1, “HTTP Transaction
State Diagram”</a>.</p></dd>
-<dt><span class="term">HTTP session</span></dt>
-<dd><p>A session consists of a single client connection to Traffic
-            Server. A session can consist of several transactions, in
-            succession. The session starts when the client connection opens,
-            and ends when the connection closes.</p></dd>
+        they are called, look for the “set up transform” ovals in the <a href="HTTPHooksAndTransactions.html#Fig_HHTTPTxStateDiag"
title="Figure 8.1. HTTP Transaction State Diagram">HTTP Transaction State Diagram</a>.</p></dd>
+<dt><span class="term"><b>HTTP session</b></span></dt>
+<dd>
+  <p>A <i>session</i> consists of a single client connection to Traffic
+            Server; it may consist of a single transaction or several transactions in
+            succession. The session starts when the client connection opens
+        and ends when the connection closes.</p></dd>
 </dl></div>
 <div class="figure">
 <a name="Fig_HHTTPTxStateDiag"></a><p class="title"><b>Figure 8.1. HTTP
Transaction State Diagram</b></p>
-<div class="mediaobject"><img src="images/http_state2.jpg" alt="HTTP Transaction
State Diagram"></div>
+<div class="mediaobject"><img src="images/http_state2.jpg" alt="HTTP Transaction
State Diagram" /></div>
 </div>
 </div>
 </div>

Modified: incubator/trafficserver/site/trunk/docs/sdk/HTTPSessionFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTPSessionFunctions.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTPSessionFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTPSessionFunctions.html Thu Nov 19 21:58:27
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>Session 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="HTTPFunctions.html" title="HTTP Functions">
-<link rel="prev" href="HTTPFunctions.html" title="HTTP Functions">
-<link rel="next" href="HTTPTransactionFunctions.html" title="HTTP Transaction 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="subsection" href="HTTPSessionFunctions.html#INKHttpSsnHookAdd" title="INKHttpSsnHookAdd">
-<link rel="subsection" href="HTTPSessionFunctions.html#INKHttpSsnReenable" title="INKHttpSsnReenable">
+<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="HTTPFunctions.html" title="HTTP Functions" />
+<link rel="prev" href="HTTPFunctions.html" title="HTTP Functions" />
+<link rel="next" href="HTTPTransactionFunctions.html" title="HTTP Transaction 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="subsection" href="HTTPSessionFunctions.html#INKHttpSsnHookAdd" title="INKHttpSsnHookAdd"
/>
+<link rel="subsection" href="HTTPSessionFunctions.html#INKHttpSsnReenable" title="INKHttpSsnReenable"
/>
 <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">
@@ -65,24 +65,25 @@
 <a name="INKHttpSsnHookAdd"></a>INKHttpSsnHookAdd</h4></div></div></div>
 <p>Adds an HTTP session hook.</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 INKHttpSsnHookAdd (INKHttpSsn
                 <em class="replaceable"><code>ssnp</code></em>, INKHttpHookID
                 <em class="replaceable"><code>id</code></em>, INKCont
                 <em class="replaceable"><code>contp</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
-<dd><p>Adds <code class="code"><em class="replaceable"><code>contp</code></em></code>
to
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+  <p>Adds <code class="code"><em class="replaceable"><code>contp
</code></em></code> to
                 the end of the list of HTTP transaction hooks specified by
                 <code class="code"><em class="replaceable"><code>id</code></em></code>.
This means that
-                <code class="code"><em class="replaceable"><code>contp</code></em></code>
is called back
+                <code class="code"><em class="replaceable"><code>contp
</code></em></code> is called back
                 for every transaction within the session, at the point
                 specified by the hook ID. Since
-                <code class="code"><em class="replaceable"><code>contp</code></em></code>
is added to a
+                <code class="code"><em class="replaceable"><code>contp
</code></em></code> is added to a
                 session, it is not possible to call
                 <code class="function">INKHttpSsnHookAdd</code> from the plugin
-                initialization routine; the plugin needs a handle to an HTTP
+                initialization routine. Therefore, the plugin needs a handle to an HTTP
                 session. See the following example.</p></dd>
-<dt><span class="term"><a name="INKEvent_1"></a>Example</span></dt>
+<dt><span class="term"><a name="INKEvent_1"></a><b>Example</b></span></dt>
 <dd><pre class="programlisting">#include InkAPI.h
 
 static void txn_handler (INKHttpTxn txnp, INKCont contp)
@@ -125,45 +126,44 @@
     contp = INKContCreate (ssn_handler, NULL);
     INKHttpHookAdd (INK_HTTP_SSN_START_HOOK, contp);
 }</pre></dd>
-<dt><span class="term">Returns</span></dt>
-<dd>
-<p><code class="code">INK_SUCCESS</code> if the hook is successfully
+<dt><span class="term"> </span></dt>
+<dd>&nbsp;</dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd><p><code class="code">INK_SUCCESS</code> if the hook is successfully
                 added.</p>
-<p><code class="code">INK_ERROR</code> if the hook is not added.</p>
+  <p><code class="code">INK_ERROR</code> if the hook is not added.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
-</dl></div>
+</dl>
+</div>
 </div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKHttpSsnReenable"></a>INKHttpSsnReenable</h4></div></div></div>
-<p>Re-enables an HTTP session.</p>
+<p>Reenables an HTTP session.</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 INKHttpSsnReenable (INKHttpSsn
                 <em class="replaceable"><code>ssnp</code></em>, INKEvent
                 <em class="replaceable"><code>event</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
-<dd><p>Notifies the HTTP session
-                <code class="code"><em class="replaceable"><code>ssnp</code></em></code>
that the plugin
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+  <p>Notifies the HTTP session
+                <code class="code"><em class="replaceable"><code>ssnp </code></em></code>
that the plugin
                 is done processing the current hook. If
                 <code class="code">INK_EVENT_HTTP_CONTINUE</code> is specified
for
                 <code class="code"><em class="replaceable"><code>event</code></em></code>,
then the plugin
                 wants the session to continue. If
                 <code class="code">INK_EVENT_HTTP_ERROR</code> is specified for
                 <code class="code"><em class="replaceable"><code>event</code></em></code>,
then the plugin
-                wants the session to be terminated and for an error to be sent
+                wants the session to be terminated; an error  is sent
                 back to the client if no response has already been
                 sent.</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 session is successfully
-                re-enabled.</p>
+                reenabled.</p>
 <p><code class="code">INK_ERROR</code> if the hook is not added.</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/HTTPSessions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTPSessions.html?rev=882316&r1=882315&r2=882316&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTPSessions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTPSessions.html Thu Nov 19 21:58:27 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>HTTP Sessions</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="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks
and Transactions">
-<link rel="prev" href="AddingHooks.html" title="Adding Hooks">
-<link rel="next" href="HTTP_Transactions.html" title="HTTP Transactions">
-<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="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks
and Transactions" />
+<link rel="prev" href="AddingHooks.html" title="Adding Hooks" />
+<link rel="next" href="HTTP_Transactions.html" title="HTTP Transactions" />
+<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,14 +57,14 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="HTTPSessions"></a>HTTP Sessions</h2></div></div></div>
-<p>An HTTP session is an object that is defined for the lifetime of a
+<p>An <b>HTTP session</b> is an object that is defined for the lifetime
of a
       client’s TCP session. The Traffic Server API allows you to add a global
       hook to the start or end of an HTTP session, and you can add session
       hooks that call back your plugin for every transaction within a given
       session.</p>
-<p>When a client connects to Traffic Server it opens up a TCP
+<p>When a client connects to Traffic Server, it opens up a TCP
       connection and sends one or more HTTP requests. An individual request
-      and its response make up an HTTP transaction. The <a class="indexterm" name="id378839"></a>HTTP
session<a class="indexterm" name="id378848"></a> begins when the client opens
the connection, and ends
+      and its response comprise the HTTP transaction. The <a class="indexterm" name="id378839"></a>HTTP
session<a class="indexterm" name="id378848"></a> begins when the client opens
the connection and ends
       when the connection closes.</p>
 <p>The HTTP session hooks are:</p>
 <div class="itemizedlist"><ul type="disc">
@@ -81,16 +81,15 @@
           hook.</p>
 </li>
 </ul></div>
-<p>You use the session hooks to get a handle to a session (an
-      <code class="code">INKHttpSsn</code> object) and then if you want your
plugin to be
-      called back for each transaction within the session, you use
+<p>Use the session hooks to get a handle to a session (an
+      <code class="code">INKHttpSsn</code> object). If you then want your plugin
to be
+      called back for each transaction within the session,  use
       <code class="code">INKHttpSsnHookAdd</code>.</p>
-<p>Note that you must reenable the session with
-      <code class="code">INKHttpSsnReenable</code> after processing a session
hook.</p>
+<p><b>Note:</b> you must reenable the session with <code class="code">INKHttpSsnReenable</code>
after processing a session hook.</p>
 <p>The session hook functions are:</p>
 <div class="itemizedlist"><ul type="disc">
-<li><p><a href="HTTPSessionFunctions.html#INKHttpSsnHookAdd" title="INKHttpSsnHookAdd">“INKHttpSsnHookAdd”</a></p></li>
-<li><p><a href="HTTPSessionFunctions.html#INKHttpSsnReenable" title="INKHttpSsnReenable">“INKHttpSsnReenable”</a></p></li>
+<li><p><a href="HTTPSessionFunctions.html#INKHttpSsnHookAdd" title="INKHttpSsnHookAdd">INKHttpSsnHookAdd</a></p></li>
+<li><p><a href="HTTPSessionFunctions.html#INKHttpSsnReenable" title="INKHttpSsnReenable">INKHttpSsnReenable</a></p></li>
 </ul></div>
 </div>
 </body>



Mime
View raw message