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/17 22:32:49 UTC
svn commit: r891922 [1/2] - /incubator/trafficserver/site/trunk/docs/sdk/
Author: dianes
Date: Thu Dec 17 21:32:47 2009
New Revision: 891922
URL: http://svn.apache.org/viewvc?rev=891922&view=rev
Log:
2nd pass edits
Modified:
incubator/trafficserver/site/trunk/docs/sdk/CacheAPI_Example.html
incubator/trafficserver/site/trunk/docs/sdk/CacheInterfaceFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/DebuggingFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/Dep_IOBufferInterface.html
incubator/trafficserver/site/trunk/docs/sdk/Dep_MutexFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/DeprecatedMarshBufFuncs.html
incubator/trafficserver/site/trunk/docs/sdk/DoACacheRemove.html
incubator/trafficserver/site/trunk/docs/sdk/FunctionReference.html
incubator/trafficserver/site/trunk/docs/sdk/GenerateLicenseKey.html
incubator/trafficserver/site/trunk/docs/sdk/GetingStarted.html
incubator/trafficserver/site/trunk/docs/sdk/GuideTSHTTPHdrSyst.html
incubator/trafficserver/site/trunk/docs/sdk/HTTPAlternateSelection.html
incubator/trafficserver/site/trunk/docs/sdk/HTTPHeaderFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/HTTPHeaders.html
incubator/trafficserver/site/trunk/docs/sdk/HTTPHeaders2.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/HTTP_Transactions.html
incubator/trafficserver/site/trunk/docs/sdk/HeaderBasedPluginEx.html
incubator/trafficserver/site/trunk/docs/sdk/HostLookupFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/HostsLookupAPI.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/index.html
Modified: incubator/trafficserver/site/trunk/docs/sdk/CacheAPI_Example.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/CacheAPI_Example.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/CacheAPI_Example.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/CacheAPI_Example.html Thu Dec 17 21:32:47 2009
@@ -82,10 +82,10 @@
int ndone = INKVIONDoneGet (cache_vio);
(consume data in cache_bufp)
INKVIOReenable (cache_vio);</pre>
-<p>Do not try to get continuations or vios from
- <code class="function">INKVConn</code> objects for Cache VConnections. Also
- note that the following APIs can only be used on Transformation
- VConnections and must not be used on Cache or Net VConnections:</p>
+<p>Do not try to get continuations or VIOs from
+ <code class="function">INKVConn</code> objects for cache vconnections. Also
+ note that the following APIs can only be used on transformation
+ vconnections and must not be used on cache vconnections or net vconnections:</p>
<div class="itemizedlist"><ul type="disc">
<li><p><code class="function">INKVConnWriteVIOGet</code></p></li>
<li><p><code class="function">INKVConnReadVIOGet</code></p></li>
@@ -94,7 +94,7 @@
<p>APIs such as <code class="function">INKVConnRead</code>,
<code class="function">INKVConnWrite</code>,
<code class="function">INKVConnClose</code>, <code class="function">INKVConnAbort</code>, and <code class="function">INKVConnShutdown</code> can be used on any kind of
- VConnections.</p>
+ vconnections.</p>
<p>When you are finished:</p>
<pre class="programlisting">INKCacheKeyDestroy (key);</pre>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/CacheInterfaceFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/CacheInterfaceFunctions.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/CacheInterfaceFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/CacheInterfaceFunctions.html Thu Dec 17 21:32:47 2009
@@ -88,7 +88,7 @@
<code class="function">INKCacheKeyDigestSet</code>.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
-<p><code class="code">INK_SUCCESS</code> if success.</p>
+<p><code class="code">INK_SUCCESS</code> if successful.</p>
<p><code class="code">INK_ERROR</code> if the cache key could not be
allocated.</p>
</dd>
Modified: incubator/trafficserver/site/trunk/docs/sdk/DebuggingFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/DebuggingFunctions.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/DebuggingFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/DebuggingFunctions.html Thu Dec 17 21:32:47 2009
@@ -73,16 +73,15 @@
<em class="replaceable"><code>*format_str</code></em>, ...)</code></p></dd>
<dt><span class="term"><b>Arguments</b></span></dt>
<dd>
-<p><code><i>tag </i></code> is the Traffic Server parameter
- that enables Traffic Server to print out
- <em class="parameter"><code>format_str</code></em></p>
+<p><code class="code"><em class="replaceable"><code>tag</code></em></code><i><code> </code></i>is the Traffic Server parameter
+ that enables Traffic Server to print out
+ <em class="parameter"><code> </code><code class="code"><em class="replaceable"><code> format_str</code></em></code></em></p>
<p><code class="code">... </code>is a variable for
<code><i>format_str</i></code></p>
</dd>
<dt><span class="term"><b>Description</b></span></dt>
<dd>
-<p>If debugging is enabled, then <code class="code">INKDebug</code> prints out the statement
- <code class="code">format_str</code>. There are two
+<p>If debugging is enabled, then <code class="code">INKDebug</code> prints out the statement <em class="parameter"><code class="code"><em class="replaceable"><code>format_str</code></em></code></em>. There are two
ways to enable debugging:</p>
<div class="itemizedlist"><ul type="disc">
<li>
Modified: incubator/trafficserver/site/trunk/docs/sdk/Dep_IOBufferInterface.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/Dep_IOBufferInterface.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/Dep_IOBufferInterface.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/Dep_IOBufferInterface.html Thu Dec 17 21:32:47 2009
@@ -103,11 +103,9 @@
that will be used as the start for the block. The two
common uses for <code class="function">INKIOBufferBlockCreate</code>
are to create an empty block (by specifying size as 0) and to
- create a full block (by specifying size as the total size of
- <code class="code">datap</code>). The newly-created block should be added
- almost immediately to an IO buffer by a call to
- <code class="function">INKIOBufferAppend</code>, since there is no
- function for destroying a buffer block other than simply relying
+ create a full block (by specifying size as the total size of <code class="code"><em class="replaceable"><code>datap</code></em></code>). The newly-created block should be added
+ almost immediately to an IO buffer by a call to <code class="function">INKIOBufferAppend</code>, since there is no
+ function for destroying a buffer block other than simply relying
on its automatic destruction by an IO buffer.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
@@ -131,7 +129,7 @@
<code class="code"><em class="replaceable"><code> size</code></em></code>. The
<code class="code"><em class="replaceable"><code>flags </code></em></code> parameter
specifies how to interpret data.</p>
-<p><code class="code">INK_DATA_ALLOCATE</code></p>
+<p><code class="code">INK_DATA_ALLOCATE</code> </p>
<p>The data pointer is <code class="code">NULL</code> and the data
associated with the <code class="function">INKIOBufferData</code>
should be allocated.
Modified: incubator/trafficserver/site/trunk/docs/sdk/Dep_MutexFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/Dep_MutexFunctions.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/Dep_MutexFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/Dep_MutexFunctions.html Thu Dec 17 21:32:47 2009
@@ -78,9 +78,9 @@
</dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
-<p>If the mutex was successfully locked, then 1 will be
+<p>If the mutex was successfully locked, then 1 is
returned.</p>
-<p>If mutex is already locked, then 0 will be
+<p>If mutex is already locked, then 0 is
returned.</p>
</dd>
<dt><span class="term"><b>Example</b></span></dt>
Modified: incubator/trafficserver/site/trunk/docs/sdk/DeprecatedMarshBufFuncs.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/DeprecatedMarshBufFuncs.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/DeprecatedMarshBufFuncs.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/DeprecatedMarshBufFuncs.html Thu Dec 17 21:32:47 2009
@@ -68,7 +68,7 @@
<li><p><code class="function">INKMBufferUnref</code></p></li>
</ul></div>
<p>The following MIME field functions are deprecated. If you need
- to support these functions in existing code, then reference <a href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions"><i>Deprecated Functions</i></a>.</p>
+ to support these functions in existing code, then reference <a href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">Deprecated Functions</a>.</p>
<div class="itemizedlist"><ul type="disc">
<li><p><code class="function">INKMimeFieldCreate</code></p></li>
<li><p><code class="function">INKMimeFieldDestroy</code></p></li>
Modified: incubator/trafficserver/site/trunk/docs/sdk/DoACacheRemove.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/DoACacheRemove.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/DoACacheRemove.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/DoACacheRemove.html Thu Dec 17 21:32:47 2009
@@ -60,8 +60,9 @@
<p>Use <code class="function">INKCacheRemove</code> to remove items from the
cache. Possible callback events include:</p>
<div class="itemizedlist"><ul type="disc">
-<li><p><code class="code">INK_EVENT_CACHE_REMOVE</code> - item was removed.
- There is not data payload for this event.</p></li>
+<li>
+ <p><code class="code">INK_EVENT_CACHE_REMOVE</code> - the item was removed.
+ There is no data payload for this event.</p></li>
<li>
<p><code class="code">INK_EVENT_CACHE_REMOVE_FAILED</code> - indicates
the cache was unable to remove the item idetified by the cache
Modified: incubator/trafficserver/site/trunk/docs/sdk/FunctionReference.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/FunctionReference.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/FunctionReference.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/FunctionReference.html Thu Dec 17 21:32:47 2009
@@ -447,36 +447,35 @@
</div>
<p>This chapter provides a description of each function in the Traffic
Server API. The functions are grouped according to what they do. The
- following section lists all the function groups; you can also look up functions
- alphabetically in the <a href="FunctionIndex.html" title="Appendix D. Function Index"><i>Function Index</i></a>.</p>
+ following section lists all the function groups; to look up functions alphabetically, use the <a href="FunctionIndex.html" title="Appendix D. Function Index">Function Index</a>.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="ListOfFunctionGroups"></a>List of Function Groups</h2></div></div></div>
<div class="itemizedlist"><ul type="disc">
-<li><p><a href="InitializationFunctions.html" title="Initialization Functions">âInitialization Functionsâ</a></p></li>
-<li><p><a href="DebuggingFunctions.html" title="Debugging Functions">âDebugging Functionsâ</a></p></li>
-<li><p><a href="INKfopenFamilyFunctions.html" title="The INKfopen Family">âThe INKfopen Familyâ</a></p></li>
-<li><p><a href="MemoryAllocationFunctions.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="HTTPFunctions.html" title="HTTP Functions">âHTTP Functionsâ</a></p></li>
-<li><p><a href="InitiateConnectionFunctions.html" title="Initiate Connection">âInitiate Connectionâ</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="MutexFunctions.html" title="Mutex Functions">âMutex Functionsâ</a></p></li>
-<li><p><a href="ContinuationFunctions.html" title="Continuation Functions">âContinuation Functionsâ</a></p></li>
-<li><p><a href="PluginConfigurationFunctions.html" title="Plugin Configuration Functions">âPlugin Configuration Functionsâ</a></p></li>
-<li><p><a href="ActionFunctions.html" title="Action Functions">âAction Functionsâ</a></p></li>
-<li><p><a href="HostLookupFunctions.html" title="Host Lookup Functions">âHost Lookup Functionsâ</a></p></li>
-<li><p><a href="VconnectionFunctions.html" title="Vconnection Functions">âVconnection Functionsâ</a></p></li>
-<li><p><a href="NetvconnectionFunctions.html" title="Netvconnection Functions">âNetvconnection Functionsâ</a></p></li>
-<li><p><a href="CacheInterfaceFunctions.html" title="Cache Interface Functions">âCache Interface Functionsâ</a></p></li>
-<li><p><a href="TransformationFunctions.html" title="Transformation Functions">âTransformation Functionsâ</a></p></li>
-<li><p><a href="VIOFunctions.html" title="VIO Functions">âVIO Functionsâ</a></p></li>
-<li><p><a href="IOBufferInterfaceFunctions.html" title="IO Buffer Interface">âIO Buffer Interfaceâ</a></p></li>
-<li><p><a href="ManagementInterfaceFunctions.html" title="Management Interface Functions">âManagement Interface Functionsâ</a></p></li>
-<li><p><a href="TEConfigReadFunctions.html" title="Traffic Server Configuration Read Functions">âTraffic Server Configuration Read Functionsâ</a></p></li>
-<li><p><a href="CustInstallLicenseFunctions.html" title="Customer Installation and Licensing Functions">âCustomer Installation and Licensing Functionsâ</a></p></li>
-<li><p><a href="StatisticsFunctions.html" title="Statistics Functions">âStatistics Functionsâ</a></p></li>
-<li><p><a href="LoggingFunctions.html" title="Logging Functions">âLogging Functionsâ</a></p></li>
+<li><p><a href="InitializationFunctions.html" title="Initialization Functions">Initialization Functions</a></p></li>
+<li><p><a href="DebuggingFunctions.html" title="Debugging Functions">Debugging Functions</a></p></li>
+<li><p><a href="INKfopenFamilyFunctions.html" title="The INKfopen Family">The INKfopen Family</a></p></li>
+<li><p><a href="MemoryAllocationFunctions.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="HTTPFunctions.html" title="HTTP Functions">HTTP Functions</a></p></li>
+<li><p><a href="InitiateConnectionFunctions.html" title="Initiate Connection">Initiate Connection</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="MutexFunctions.html" title="Mutex Functions">Mutex Functions</a></p></li>
+<li><p><a href="ContinuationFunctions.html" title="Continuation Functions">Continuation Functions</a></p></li>
+<li><p><a href="PluginConfigurationFunctions.html" title="Plugin Configuration Functions">Plugin Configuration Functions</a></p></li>
+<li><p><a href="ActionFunctions.html" title="Action Functions">Action Functions</a></p></li>
+<li><p><a href="HostLookupFunctions.html" title="Host Lookup Functions">Host Lookup Functions</a></p></li>
+<li><p><a href="VconnectionFunctions.html" title="Vconnection Functions">Vconnection Functions</a></p></li>
+<li><p><a href="NetvconnectionFunctions.html" title="Netvconnection Functions">Netvconnection Functions</a></p></li>
+<li><p><a href="CacheInterfaceFunctions.html" title="Cache Interface Functions">Cache Interface Functions</a></p></li>
+<li><p><a href="TransformationFunctions.html" title="Transformation Functions">Transformation Functions</a></p></li>
+<li><p><a href="VIOFunctions.html" title="VIO Functions">VIO Functions</a></p></li>
+<li><p><a href="IOBufferInterfaceFunctions.html" title="IO Buffer Interface">IO Buffer Interface</a></p></li>
+<li><p><a href="ManagementInterfaceFunctions.html" title="Management Interface Functions">Management Interface Functions</a></p></li>
+<li><p><a href="TEConfigReadFunctions.html" title="Traffic Server Configuration Read Functions">Traffic Server Configuration Read Functions</a></p></li>
+<li><p><a href="CustInstallLicenseFunctions.html" title="Customer Installation and Licensing Functions">Customer Installation and Licensing Functions</a></p></li>
+<li><p><a href="StatisticsFunctions.html" title="Statistics Functions">Statistics Functions</a></p></li>
+<li><p><a href="LoggingFunctions.html" title="Logging Functions">Logging Functions</a></p></li>
</ul></div>
</div>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/GenerateLicenseKey.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/GenerateLicenseKey.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/GenerateLicenseKey.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/GenerateLicenseKey.html Thu Dec 17 21:32:47 2009
@@ -71,21 +71,21 @@
directory in your SDK package. </p></li>
<li>
<p>Then, enter the following:</p>
-<p><code class="code">gen_key <i>plugin_name</i> <i> ID</i> <i> expiration</i></code></p>
+<p><code class="code">gen_key <i class="replaceable">plugin_name </i> <i class="replaceable"> ID </i> <i class="replaceable"> expiration</i></code></p>
<div class="itemizedlist"><ul type="disc">
<li>
- <p><code class="filename"><i>plugin_name </i></code> is the name of the
+ <p><code class="replaceable"><i>plugin_name </i></code> is the name of the
plugin; it needs to match the name specified in
<code class="filename">plugin.db</code></p></li>
<li>
- <p><code class="code"><i>ID </i></code> is a string of 5 alphanumeric characters,
+ <p><code class="replaceable"><i>ID </i></code> is a string of 5 alphanumeric characters,
used to identify different customers</p></li>
<li>
-<p><code class="code"><i>expiration </i></code> is the expiration date of the
+<p><code class="replaceable"><i>expiration </i></code> is the expiration date of the
plugin in the following format:
<code class="code">mmddyyyy</code></p>
-<p>For example: Enter <code class="code">03312001</code> for March 31, 2001. Use
- <code class="code">0</code> for no expiration.</p>
+<p>For example: you should enter <code class="code">03312001</code> for March 31, 2001. To indicate no expiration, use
+ <code class="code">0</code>.</p>
</li>
</ul></div>
</li>
Modified: incubator/trafficserver/site/trunk/docs/sdk/GetingStarted.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/GetingStarted.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/GetingStarted.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/GetingStarted.html Thu Dec 17 21:32:47 2009
@@ -99,11 +99,11 @@
<p><a href="ASimplePlugin.html" title="A Simple Plugin">A Simple Plugin</a> â walks through compiling and
loading an example <code>hello world</code> plugin.</p></li>
<li>
- <p><a href="PlusingRegisAndVersionCkg.html" title="Plugin Registration and Version Checking">Plugin Registration and Version Checking</a> âshows you how to
- register your plugin and check that it's compatible with the version
- of Traffic Server you're using.</p></li>
+ <p><a href="PlusingRegisAndVersionCkg.html" title="Plugin Registration and Version Checking">Plugin Registration and Version Checking</a> â shows you how to
+ register your plugin and make sure it's compatible with the version
+ of Traffic Server you're using.</p></li>
<li>
- <p><a href="NamingConventions.html" title="Naming Conventions">Naming Conventions</a> âoutlines Traffic Server API
+ <p><a href="NamingConventions.html" title="Naming Conventions">Naming Conventions</a> â outlines Traffic Server API
naming conventions. For guidelines on creating plugin source code, see
<a href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">How to Create Traffic Server Plugins</a>.</p></li>
</ul></div>
@@ -148,10 +148,12 @@
<a name="PossibleUses"></a>Possible Uses for Plugins</h3></div></div></div>
<p>Possible uses for plugins include the following:</p>
<div class="itemizedlist"><ul type="disc">
-<li><p>HTTP processing (plugins can filter, blacklist, authorize
- users, transform content)</p></li>
-<li><p>Protocol support (plugins can enable Traffic Server to
- proxy-cache new protocol content)</p></li>
+<li>
+ <p>HTTP processing: plugins can filter, blacklist, authorize
+ users, transform content</p></li>
+<li>
+ <p>Protocol support: plugins can enable Traffic Server to
+ proxy-cache new protocol content</p></li>
</ul></div>
<p>Some examples of plugins include:</p>
<div class="itemizedlist"><ul type="disc">
@@ -165,17 +167,19 @@
server that compresses the data (alternatively, a compression
library local to the Traffic Server host machine could do the
compression).</p></li>
-<li><p><b>Authorization plugin</b>: checks userâs permissions to access
+<li>
+ <p><b>Authorization plugin</b>: checks a userâs permissions to access
particular web sites. The plugin could consult a local
authorization program or send queries to an authorization
server.</p></li>
-<li><p>A <b>plugin that gathers client information</b> from request
+<li><p><b>A plugin that gathers client information</b> from request
headers and enters this information in a database.</p></li>
-<li><p><b>Protocol plugin</b>: listens for specific protocol requests on a
- designated port, and then uses Traffic Serverâs proxy server &
+<li>
+ <p><b>Protocol plugin</b>: listens for specific protocol requests on a
+ designated port and then uses Traffic Serverâs proxy server &
cache to serve client requests.</p></li>
</ul></div>
-<p>The figure below, <a href="GetingStarted.html#Fig_PossibleTSPlugins" title="Figure 1.2. Possible Traffic Server Plugins">âPossible Traffic Server Pluginsâ</a>, illustrates several
+<p>The figure below, <a href="GetingStarted.html#Fig_PossibleTSPlugins" title="Figure 1.2. Possible Traffic Server Plugins">Possible Traffic Server Plugins</a>, illustrates several
types of plugins.</p>
<div class="figure">
<a name="Fig_PossibleTSPlugins"></a><p class="title"><b>Figure 1.2. Possible Traffic Server Plugins</b></p>
@@ -186,7 +190,7 @@
<div class="itemizedlist"><ul type="disc">
<li>
<p><code class="filename">append-transform.c</code> adds text from a
- specified file to HTTP/text responses. This plugin is explained in <a href="AppendTransformPlugin.html" title="The Append-Transform Plugin">â The Append-Transform Pluginâ</a>.</p></li>
+ specified file to HTTP/text responses. This plugin is explained in <a href="AppendTransformPlugin.html" title="The Append-Transform Plugin"> The Append-Transform Plugin</a>.</p></li>
<li>
<p>The compression plugin in the figure communicates with the
server that actually does the compression. The
@@ -201,7 +205,7 @@
<p><code class="filename">blacklist-1.c</code> reads blacklisted servers
from a configuration file and denies client access to these
servers. This plugin is explained
- in <a href="BlacklistPlugin.html" title="The Blacklist Plugin">âThe Blacklist Pluginâ</a> .</p></li>
+ in <a href="BlacklistPlugin.html" title="The Blacklist Plugin">The Blacklist Plugin</a>.</p></li>
</ul></div>
</div>
<div class="section" lang="en">
@@ -214,15 +218,15 @@
are to be passed to each pluginâs initialization function,
<code class="function">INKPluginInit</code>. The
<code class="filename">records.config</code> file defines the path to each
- plugin shared library, as described in <a href="SpecifyingPluginLocation.html" title="Specify the Pluginâs Location">âSpecify the Pluginâs Locationâ</a>.</p>
+ plugin shared library, as described in <a href="SpecifyingPluginLocation.html" title="Specify the Pluginâs Location">Specify the Pluginâs Location</a>.</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>The path for each of these files is
- <code class="filename"><code class="varname"><<i>root_dir</i>></code>/config/</code>,
- where <code class="varname"><root_dir></code> is where you installed
+ <code class="filename"><code class="varname"><<i class="replaceable">root_dir</i>></code>/config/</code>,
+ where <code class="varname"><<span class="replaceable">root_dir</span>></code> is where you installed
Traffic Server.</p></td></tr>
</table></div>
</div>
@@ -292,7 +296,7 @@
the actual arguments defined in the
<code class="filename">plugin.config</code> file for that plugin</p></li>
</ul></div>
-<p>See <a href="InitializationFunctions.html#INKPluginInit" title="INKPluginInit">âINKPluginInitâ</a> for details about
+<p>See <a href="InitializationFunctions.html#INKPluginInit" title="INKPluginInit">INKPluginInit</a> for details about
<code class="function">INKPluginInit</code>.</p>
</div>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/GuideTSHTTPHdrSyst.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/GuideTSHTTPHdrSyst.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/GuideTSHTTPHdrSyst.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/GuideTSHTTPHdrSyst.html Thu Dec 17 21:32:47 2009
@@ -67,17 +67,17 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="NoNullTerminatedStrings"></a>No Null-Terminated Strings<a class="indexterm" name="id380931"></a></h3></div></div></div>
-<p>It is not safe to assume that the
- string data contained in marshal buffers (data such as URLs and MIME
- fields) is stored in null-terminated string copies. This means that
+<p>It's not safe to assume that
+ string data contained in marshal buffers (such as URLs and MIME
+ fields) is stored in null-terminated string copies. Therefore,
your plugins should always use the length parameter when retrieving or
manipulating these strings. You <span class="bold"><strong>cannot</strong></span> pass in <code class="code">NULL</code> for
- string-length return values. String values returned from marshall
+ string-length return values; string values returned from marshall
buffers are not null-terminated. If you need a null-terminated value,
- use <code class="function">INKstrndup</code> to automatically null-terminate a
- string. The strings that come back, which are not null-terminated,
+ then use <code class="function">INKstrndup</code> to automatically null-terminate a
+ string. The strings that come back and are not null-terminated
<span class="bold"><strong>cannot</strong></span> be passed into the common
- <code class="code">str*()</code> routines.</p>
+ <code class="code">str*()</code> routines</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
Modified: incubator/trafficserver/site/trunk/docs/sdk/HTTPAlternateSelection.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTPAlternateSelection.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTPAlternateSelection.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTPAlternateSelection.html Thu Dec 17 21:32:47 2009
@@ -68,7 +68,7 @@
<p>The alternate selection mechanism is invoked when Traffic Server
looks up a URL in its cache. For each URL, Traffic Server stores a vector
of alternates. For each alternate in this vector, Traffic Server
- computes a quality value between 0 and 1 for how âgoodâ the alternate
+ computes a quality value between 0 and 1 that represents how âgoodâ the alternate
is. A quality value of 0 means that the alternate is unacceptable;
a value of 1 means that the alternate is a perfect match.</p>
<p>If a plugin hooks onto <code class="code">theINK_HTTP_SELECT_ALT_HOOK</code>, then it
@@ -82,7 +82,7 @@
select alternate hooks with the <code class="code">INK_EVENT_HTTP_SELECT_ALT</code> event. The <code>void *edata</code> argument
that is passed to the continuation is a pointer to an <code class="code">INKHttpAltInfo</code><a class="indexterm" name="id379481"></a> structure. It can be used later to call the HTTP
alternate selection functions listed at the end of this section. Unlike
- other hooks, this alternate selection callout is non-blocking and the
+ other hooks, this alternate selection callout is non-blocking; the
expectation is that the quality value for the alternate will be changed
by a call to <code class="function">INKHttpAltInfoQualitySet</code>.</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
@@ -95,7 +95,7 @@
from the function.</p></td></tr>
</table></div>
<p>The sample code below shows how to call the
- Alternate APIs.</p>
+ alternate APIs.</p>
<pre class="programlisting">static void handle_select_alt(INKHttpAltInfo infop)
{
INKMBuffer client_req_buf, cache_resp_buf;
Modified: incubator/trafficserver/site/trunk/docs/sdk/HTTPHeaderFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTPHeaderFunctions.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTPHeaderFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTPHeaderFunctions.html Thu Dec 17 21:32:47 2009
@@ -106,8 +106,7 @@
request header, then make sure that it has a valid <em>method</em>, <em>url</em>,
<em>protocol</em>, and <em>version</em>. If the HTTP header located at the <code class="code"><em class="replaceable"><code>src_hdr </code></em></code> is a HTTP
response header, then make sure that it has a valid <em>protocol</em>, <em>version</em>, <em>status</em>, and <em>reason</em>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code> if it is
- a transaction header.</p>
+<p>If it is a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
<p>Release the returned handle with a call to
<code class="function">INKHandleMLocRelease</code>.</p>
</dd>
@@ -152,8 +151,7 @@
<code class="function">INKHttpHdrTypeSet</code>. Do not call
<code class="function">INKHttpHdrTypeSet</code> on the destination
header after using <code class="function">INKHttpHdrCopy</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code> if it is
- a transaction header.</p>
+<p>If it is a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
@@ -281,8 +279,7 @@
<p>It is an error to try to retrieve the method from an
HTTP header that is not of type
<code class="code">INK_HTTP_TYPE_REQUEST</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code> if it is
- a transaction header.</p>
+<p>If it is a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
<p>Release with a call to
<code class="function">INKHandleStringRelease</code>.</p>
</dd>
@@ -319,8 +316,7 @@
<code class="function">INKHttpHdrMethodSet</code>. It is an error to
try to set the method in an HTTP header that is not of type
<code class="code">INK_HTTP_TYPE_REQUEST</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code> if it is
- a transaction header.</p>
+<p>If it is a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
@@ -376,8 +372,7 @@
an error to try to retrieve the reason phrase from an HTTP
header that is not of type
<code class="code">INK_HTTP_TYPE_RESPONSE</code>.</p>
-<p>Call after <code class="code">READ_RESPONSE_HDR_HOOK</code> if it is
- a transaction header.</p>
+<p>If it is a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
@@ -393,7 +388,7 @@
<dd>
<p>Pointer to the reason phrase in the specified HTTP
header.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
</dd>
</dl></div>
</div>
@@ -418,7 +413,7 @@
<dd>
<p>Pointer to the default reason phrase for the specified
Traffic Server status code.</p>
-<p><code>INK_ERROR_PTR</code> if error.</p>
+<p><code>INK_ERROR_PTR</code> if an error occurs.</p>
</dd>
</dl></div>
</div>
@@ -450,8 +445,7 @@
an error to try to set the reason phrase in an HTTP header
that is not of type
<code class="code">INK_HTTP_TYPE_RESPONSE</code>.</p>
-<p>Call after <code class="code">READ_RESPONSE_HDR_HOOK</code> if it is
- a transaction header.</p>
+<p>If it is a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
@@ -481,13 +475,12 @@
<code class="code">INK_HTTP_TYPE_RESPONSE</code>.
<code class="function">INKHttpStatus</code> is an enumerated
type.</p>
-<p>Call after <code class="code">READ_RESPONSE_HDR_HOOK</code> if it is
- a transaction header.</p>
+<p>If it is a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>The status code from the specified HTTP header.</p>
-<p><code class="code">INK_ERROR</code> if error.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
<dt><span class="term"><b>Example</b></span></dt>
<dd>
@@ -561,8 +554,7 @@
<code class="code"><em class="replaceable"><code>status </code></em></code> code in an HTTP
header that is not of type
<code class="code">INK_HTTP_TYPE_RESPONSE</code>.</p>
-<p>Call after <code class="code">READ_RESPONSE_HDR_HOOK</code> if it is
- a transaction header.</p>
+<p>If it is a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
@@ -595,7 +587,7 @@
<dd> </dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd><p>The type of the specified HTTP header.</p>
-<p><code class="code">INK_ERROR</code> if error.</p>
+<p><code class="code">INK_ERROR</code> if there is error.</p>
</dd>
</dl>
</div>
@@ -643,14 +635,13 @@
<em class="replaceable"><code>req_hdr_loc</code></em>) </code></p></dd>
<dt><span class="term"><b>Description</b></span></dt>
<dd>
-<p>Retrieves the URL from the HTTP header located at
+<p>Retrieves the URL from the HTTP header located at
<code class="code"><em class="replaceable"><code>req_hdr_loc </code></em></code> within the
marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.
It is an error to try to retrieve the URL from an HTTP header
that is not of type
<code class="code">INK_HTTP_TYPE_REQUEST</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- a transaction header.</p>
+<p>If it is a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
<p>Release with a call to
<code class="function">INKHandleMLocRelease</code>. When you release
the handle created by <code class="function">INKHttpHdrUrlGet</code>,
@@ -660,7 +651,7 @@
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>The URL from the specified HTTP header.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</p>
+<p><code class="code">INK_ERROR_PTR</code> if there is an error.</p>
</dd>
</dl></div>
</div>
@@ -681,8 +672,7 @@
marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.
It is an error to try to set the URL in an HTTP header that
is not of type <code class="code">INK_HTTP_TYPE_REQUEST</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code> if it is
- a transaction header.</p>
+<p>If it is a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
@@ -711,13 +701,12 @@
of the returned integer and the minor version in the lower 16
bits. The macros <code class="code">INK_HTTP_MAJOR</code><code> (ver) </code>and <code class="code">INK_HTTP_MINOR</code><code> (ver) </code>can be used to extract the
major and minor versions, respectively.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code> if it is
- a transaction header.</p>
+<p>If it is a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>The HTTP version from the specified HTTP header.</p>
-<p><code class="code">INK_ERROR</code> if error.</p>
+<p><code class="code">INK_ERROR</code> if there is an error.</p>
</dd>
</dl></div>
</div>
@@ -742,8 +731,7 @@
integer and the minor version in the lower 16 bits. The macro
<code class="code">INK_HTTP_VERSION</code> <code>(maj, min) </code>can be used to encode
a major and minor version into the single integer expected by <code class="function">INKHttpHdrVersionSet</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- a transaction header.</p>
+<p>If it is a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
@@ -795,7 +783,7 @@
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>Parser structure for HTTP headers.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
</dd>
</dl></div>
</div>
@@ -856,7 +844,7 @@
</dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
-<p><code class="code">INK_PARSE_ERROR</code> is returned on
+<p><code class="code">INK_PARSE_ERROR</code> is returned if there is an
error.</p>
<p><code class="code">INK_PARSE_DONE</code> is returned when a <code>\r\n\r\n </code>pattern is encountered, indicating the end of the
header.</p>
@@ -900,7 +888,7 @@
</dd>
<dt><b><span class="term">Returns</span></b></dt>
<dd>
-<p><code class="code">INK_PARSE_ERROR</code> is returned on
+<p><code class="code">INK_PARSE_ERROR</code> is returned if there is an
error.</p>
<p><code class="code">INK_PARSE_DONE</code> is returned when a
<code class="code">\r\n\r\n</code> pattern is encountered, indicating the
Modified: incubator/trafficserver/site/trunk/docs/sdk/HTTPHeaders.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTPHeaders.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTPHeaders.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTPHeaders.html Thu Dec 17 21:32:47 2009
@@ -96,7 +96,7 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="AboutHTTPHeaders"></a>About HTTP Headers</h2></div></div></div>
-<p>An HTTP message consists of:</p>
+<p>An HTTP message consists of the following:</p>
<div class="itemizedlist"><ul type="disc">
<li>HTTP header<a class="indexterm" name="id380485"></a></li>
<li><p>body</p></li>
@@ -108,23 +108,23 @@
<p>Request or response line</p>
<div class="itemizedlist"><ul type="circle">
<li>
- <p>An HTTP <i>request line </i>is composed of a method, URL, and
+ <p>An HTTP <b>request line</b> contains a method, URL, and
version</p></li>
<li>
- <p>A <i>response line</i> is composed of a version, status code,
+ <p>A <b>response line </b> contains a version, status code,
and reason phrase</p></li>
</ul></div>
</li>
<li><p>MIME header<a class="indexterm" name="id380540"></a></p></li>
</ul></div>
-<p>A MIME header is made up of zero or more MIME fields. A <b>MIME
+<p>A MIME header is comprised of zero or more MIME fields. A <b>MIME
field</b><a class="indexterm" name="id380553"></a> is composed of a field name, a colon, and zero or more
field values. The values in a field are separated by commas.</p>
<p>An HTTP header containing a request line is usually referred to as
- a request. The following example shows a typical request header.</p>
+ a <b>request</b>. The following example shows a typical request header.</p>
<pre class="programlisting">GET http://www.tiggerwigger.com/ HTTP/1.0
Proxy-Connection: Keep-Alive
-User-Agent: Mozilla/4.08 [en] (X11; I; Linux 2.2.3 i686)
+User-Agent: Mozilla/5.0 [en] (X11; I; Linux 2.2.3 i686)
Host: www.tiggerwigger.com
Accept: image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, image/png, */
*
Modified: incubator/trafficserver/site/trunk/docs/sdk/HTTPHeaders2.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTPHeaders2.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTPHeaders2.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTPHeaders2.html Thu Dec 17 21:32:47 2009
@@ -64,7 +64,7 @@
composed of a request or response line followed by zero or more MIME
fields. In fact, an HTTP header is a subclass of a MIME header; all
of the MIME header routines operate on HTTP headers.</p>
-<p>An HTTP <b>request line</b> is composed of a method, a URL and version. A <b>response line</b> is composed of a version, status code and reason
+<p>An HTTP <b>request line</b> is composed of a method, a URL, and version. A <b>response line</b> is composed of a version, status code, and reason
phrase. See <a href="HTTPHeaders.html#AboutHTTPHeaders" title="About HTTP Headers">About HTTP Headers </a> for additional details and examples.</p>
<p>To facilitate fast comparisons and reduce storage
size, Traffic Server defines several pre-allocated method names. These
Modified: incubator/trafficserver/site/trunk/docs/sdk/HTTPSessions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTPSessions.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTPSessions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTPSessions.html Thu Dec 17 21:32:47 2009
@@ -58,11 +58,10 @@
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="HTTPSessions"></a>HTTP Sessions</h2></div></div></div>
<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
+ clientâs TCP session. The Traffic Server API enables you to add a global
+ hook to the start or end of an HTTP session, as well as 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
+ session. 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 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>
@@ -70,20 +69,20 @@
<div class="itemizedlist"><ul type="disc">
<li>
<p><code class="code">INK_HTTP_SSN_START_HOOK<a class="indexterm" name="id378868"></a></code></p>
-<p>Called when an HTTP session is started. A session starts when
- a client connects to Traffic Server. This hook must be added as a
+<p>Called when an HTTP session is started (a session starts when
+ a client connects to Traffic Server). This hook must be added as a
global hook.</p>
</li>
<li>
<p><code class="code">INK_HTTP_SSN_CLOSE_HOOK<a class="indexterm" name="id378886"></a></code></p>
-<p>Called when an HTTP session ends. A session ends when the
- client connection is closed. This hook must be added as a global
+<p>Called when an HTTP session ends ( a session ends when the
+ client connection is closed). This hook must be added as a global
hook.</p>
</li>
</ul></div>
<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">INKHttpSsn</code> object). If you want your plugin to be
+ called back for each transaction within the session, then use
<code class="code">INKHttpSsnHookAdd</code>.</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>
Modified: incubator/trafficserver/site/trunk/docs/sdk/HTTPTransactionFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTPTransactionFunctions.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTPTransactionFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTPTransactionFunctions.html Thu Dec 17 21:32:47 2009
@@ -106,7 +106,7 @@
<p>The possible status values returned in
<code class="code"><em class="replaceable"><code>lookup_status </code></em></code>
are:
- <ul>
+ </p><ul>
<li><code class="code">INK_CACHE_LOOKUP_MISS</code> - Document was not in
the cache; it will be fetched from the OS.</li>
<li><code class="code">INK_CACHE_LOOKUP_HIT_STALE</code> - Document was
@@ -121,7 +121,7 @@
</ul>
</dd>
</dl>
- </p>
+ <p></p>
<dl>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
@@ -175,7 +175,7 @@
<li><code class="code">INK_CACHE_LOOKUP_SKIPPED</code> - Traffic Server
didn't perform a cache lookup because the request was not cacheable
(this can happen when the URL looks dynamic or the request is marked as noncacheable).</li>
-</p>
+<p></p>
</ul>
</dd>
<dt><span class="term"><b>Returns</b></span></dt>
@@ -220,7 +220,7 @@
<dd>
<p>If the cached response header does not exist, then
<code class="function">INKHttpTxnCachedRespGet</code> returns 0.</p>
-<p>Otherwise, returns 1.</p>
+<p>Otherwise, it returns 1.</p>
</dd>
</dl></div>
</div>
@@ -346,10 +346,9 @@
</dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
-<p>If the client request header does not exist or in case
- of an error, then <code class="function">INKHttpTxnClientReqGet</code>
+<p>If the client request header does not exist or if there is an error, then <code class="function">INKHttpTxnClientReqGet</code>
returns 0.</p>
-<p>Otherwise, returns 1.</p>
+<p>Otherwise, 1 is returned.</p>
</dd>
</dl>
</div>
@@ -382,7 +381,7 @@
<dd>
<p>If the client response header does not exist or if there is an error, then
<code class="function">INKHttpTxnClientRespGet</code> returns 0.</p>
-<p>Otherwise, returns 1.</p>
+<p>Otherwise, 1 is returned.</p>
</dd>
</dl></div>
</div>
@@ -446,7 +445,7 @@
you allocate
<code class="code"><em class="replaceable"><code>mimetype </code></em></code> with a call
to <code class="function">INKmalloc</code>. Traffic Server
- automatically calls <code class="function">INKfree</code> to free
+ automatically calls <code class="function">INKfree</code> to free
<code class="code"><em class="replaceable"><code>mimetype</code></em></code>.</p></td></tr>
</table></div>
<p>Call after <code class="code">SEND_RESPONSE_HDR_HOOK</code>.</p>
@@ -533,10 +532,9 @@
<p>Retrieves the value set previously by
<code class="function">INKHttpParentProxySet</code>. Does not return
values set in
- <code class="filename">parent.config</code> file or in <code class="filename">records.config</code> for the
+ <code class="filename">parent.config</code> or <code class="filename">records.config</code> for the
<code><i>proxy.config.http.parent_proxies </i></code>parameter.</p>
-<p>This function can be called from within any
- <code class="code">txn</code> hook.</p>
+<p>This function can be called from within any<code> </code>transaction hook.</p>
<p>The <code class="code"><i>hostname </i></code> string returned must not be
deallocated.</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
@@ -546,7 +544,7 @@
</tr>
<tr><td align="left" valign="top"><p>If parent proxying is not enabled, then
<code class="function">INKHttpTxnParentProxyGet</code> returns
- <code class="code">NULL</code> for <code><i>hostname </i></code> and <code>-1</code> for <code><i>port</i></code>.</p></td></tr>
+ <code class="code">NULL</code> for <code class="code"><em class="replaceable"><code>hostname</code></em></code><i><code> </code></i>and <code>-1</code> for <code class="replaceable"><i>port</i></code>.</p></td></tr>
</table></div>
</dd>
<dt><span class="term"><b>Returns</b></span></dt>
@@ -596,7 +594,7 @@
<em class="replaceable"><code>event</code></em>) </code></p></dd>
<dt><span class="term"><b>Description</b></span></dt>
<dd>
- <p>Notifies the HTTP transaction <code><i>txnp </i></code> that the plugin is
+ <p>Notifies the HTTP transaction <code class="replaceable"><i>txnp </i></code> that the plugin is
finished 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 transaction to continue. If
@@ -612,7 +610,7 @@
Traffic Server performs different processing depending on the
type of hook involved.</p>
<ul>
- <li><code class="code">INK_HTTP_TXN_START_HOOK</code>: The transaction is
+ <li><code class="code">INK_HTTP_TXN_START_HOOK</code>: the transaction is
stopped right away, then the client connection is closed
and no response is sent back to the origin server.</li>
<li><code class="code">INK_HTTP_READ_REQUEST_HDR_HOOK</code>: Traffic
@@ -631,12 +629,14 @@
Server receives all headers in the origin server's response, closes the connection to the origin server,
and sends a <code>500</code> status message back to the client. Traffic Server does not receive the
response body.</li>
- <li><code class="code">INK_HTTP_TXN_CLOSE_HOOK</code>: The client
+ <li><code class="code">INK_HTTP_TXN_CLOSE_HOOK</code>: the client
receives whatever answer was sent by the origin server because
with this hook, the response has already been sent to the
client.</li>
</ul>
+
</dd>
+<dt> </dt>
<dt><span class="term"><b>Returns</b></span></dt>
</dl>
<dl>
@@ -703,7 +703,7 @@
<p>If the server request header does not exist or in the
case of an error, then
<code class="function">INKHttpTxnServerReqGet</code> returns 0.</p>
-<p>Otherwise, returns 1.</p>
+<p>Otherwise, it returns 1.</p>
</dd>
</dl></div>
</div>
@@ -736,7 +736,7 @@
<p>If the server response header does not exist or if there
is an error, then
<code class="function">INKHttpTxnServerRespGet</code> returns 0.</p>
-<p>Otherwise, returns 1.</p>
+<p>Otherwise, 1 is returned.</p>
</dd>
</dl></div>
</div>
@@ -793,8 +793,8 @@
</tr>
<tr><td align="left" valign="top"><p>This function does not overwrite HTTP directives (like
<code class="code">Cache-Control</code> or <code class="code">Expires</code>) that
- determine whether document is cached. If the
- document can be cached, then this function determines if the transformed version shou8ld be cached. Untransformed and
+ determine whether a document is cached. If the
+ document can be cached, then this function determines if the transformed version should be cached. Untransformed and
transformed documents are cached as HTTP alternates.</p></td></tr>
</table></div>
<p>Call from within or after hook
@@ -836,14 +836,14 @@
<p>If the transform response header does not exist, then
<code class="function">INKHttpTxnTransformRespGet</code> returns
0.</p>
-<p>Otherwise, returns 1.</p>
+<p>Otherwise, 1 is returned.</p>
</dd>
</dl></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="INKHttpTxnUntransformedRespCache"></a>INKHttpTxnUntransformedRespCache</h4></div></div></div>
-<p>Indicates whether or not Traffic Server writes untransformed
+<p>Indicates whether Traffic Server writes untransformed
documents to cache.</p>
<div class="variablelist"><dl>
<dt><span class="term"><b>Prototype</b></span></dt>
Modified: incubator/trafficserver/site/trunk/docs/sdk/HTTPTransformationPlugins.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTPTransformationPlugins.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTPTransformationPlugins.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTPTransformationPlugins.html Thu Dec 17 21:32:47 2009
@@ -88,16 +88,16 @@
<p>This chapter explains how to write transform plugins. The
following examples are discussed in detail:</p>
<div class="itemizedlist"><ul type="disc">
-<li><p><a href="SampleNullTransformPlugin.html" title="The Sample Null Transform Plugin">The Sample Null Transform Plugin</a></p></li>
-<li><p><a href="AppendTransformPlugin.html" title="The Append-Transform Plugin">The Append-Transform Plugin</a></p></li>
-<li><p><a href="SampleBufferedNullTransformPlugin.html" title="The Sample Buffered Null Transform Plugin">The Sample Buffered Null Transform Plugin</a></p></li>
+<li><p><a href="SampleNullTransformPlugin.html" title="The Sample Null Transform Plugin">Sample Null Transform Plugin</a></p></li>
+<li><a href="AppendTransformPlugin.html" title="The Append-Transform Plugin">Append-Transform Plugin</a></li>
+<li><p><a href="SampleBufferedNullTransformPlugin.html" title="The Sample Buffered Null Transform Plugin">Sample Buffered Null Transform Plugin</a></p></li>
</ul></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="WritingContentTransformPlugins"></a>Writing Content Transform Plugins<a class="indexterm" name="id374305"></a></h2></div></div></div>
<p>Content transformation plugins transform HTTP response content
- (such as images or HTML documents), and HTTP request content such as
- client <code>POST</code> data. Because the data stream to be transformed is of
+ (such as images or HTML documents) and HTTP request content (such as
+ client <code>POST</code> data). Because the data stream to be transformed is of
variable length, these plugins must use a mechanism that passes data
from buffer to buffer <i>and</i> checks to see if the end of the data stream is
reached. This mechanism is provided by virtual connections (vconnections)
@@ -134,7 +134,7 @@
responsible only for reading the data from the input buffer,
transforming it, and then writing it to the output buffer. The upstream
vconnection writes the incoming data to the transformationâs input
- buffer. In the figure above, <a href="HTTPTransformationPlugins.html#Fig_TransformationAndVIOs" title="Figure 5.1. A Transformation and its VIOs">âA Transformation and its VIOsâ</a>, the input VIO
+ buffer. In the figure above, <a href="HTTPTransformationPlugins.html#Fig_TransformationAndVIOs" title="Figure 5.1. A Transformation and its VIOs">A Transformation and its VIOs</a>, the input VIO
describes the progress of the upstream vconnectionâs write operation on
the transformation, while the output VIO describes the progress of the
transformationâs write operation on the output (downstream) vconnection.
@@ -189,7 +189,7 @@
multiple readers. In order for the readers to have no knowledge of
each other, they manipulate IO buffers through
the<code class="code">INKIOBufferReader</code> data structure. Since only a single
- writer is allowed, as there is no corresponding
+ writer is allowed, there is no corresponding
<code class="code">INKIOBufferWriter</code> data structure. The writer simply
modifies the IO buffer directly.</p>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/HTTP_Transactions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTP_Transactions.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTP_Transactions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTP_Transactions.html Thu Dec 17 21:32:47 2009
@@ -62,17 +62,17 @@
particular HTTP transactions.</p>
<p>As described in the section on HTTP sessions, an <b>HTTP transaction</b> is an object defined for the lifetime of a single request from a client
and the corresponding response from Traffic Server. The <code class="function">INKHttpTxn</code><a class="indexterm" name="id378960"></a> structure is the main handle given to a plugin for
- manipulating a transactions; internal state. Additionally, an HTTP
+ manipulating a transaction's internal state. Additionally, an HTTP
transaction has a reference back to the HTTP session that created
it.</p>
-<p>Below is sample code that illustrates how to register locally
- to a transaction, and then associate data to the transaction.</p>
+<p>The sample code below illustrates how to register locally
+ to a transaction and associate data to the transaction.</p>
<pre class="programlisting">/*
* Simple plugin that illustrates:
-* - how to register locally to a txn
-* - how to deal with data associated to a txn
+* - how to register locally to a transaction
+* - how to deal with data associated with a txn
*
-* Note: for code lisibility, error checking is omitted
+* Note: for readability, error checking is omitted
*/
#include "InkAPI.h"
@@ -182,7 +182,7 @@
INKHttpHookAdd(INK_HTTP_TXN_START_HOOK, contp);
}</pre>
<p>See <a href="AddingHooks.html" title="Adding Hooks">Adding Hooks</a> for background about HTTP
- transactions and HTTP hooks, as well as <a href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions"><i>HTTP Hooks and Transactions</i></a>. Also see the <a href="HTTPHooksAndTransactions.html#Fig_HHTTPTxStateDiag" title="Figure 8.1. HTTP Transaction State Diagram">HTTP Transaction State Diagram </a> for an illustration of the steps
+ transactions and HTTP hooks, as well as <a href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">HTTP Hooks and Transactions</a>. Also see the <a href="HTTPHooksAndTransactions.html#Fig_HHTTPTxStateDiag" title="Figure 8.1. HTTP Transaction State Diagram">HTTP Transaction State Diagram </a> for an illustration of the steps
involved in a typical HTTP transaction.</p>
<p>The HTTP transaction functions are:</p>
<div class="itemizedlist"><ul type="disc">
Modified: incubator/trafficserver/site/trunk/docs/sdk/HeaderBasedPluginEx.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HeaderBasedPluginEx.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HeaderBasedPluginEx.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HeaderBasedPluginEx.html Thu Dec 17 21:32:47 2009
@@ -117,8 +117,9 @@
<li><p>If the plugin needs to do something to transactions in
specific cases, then it sets up a transaction hook for a particular
event.</p></li>
-<li><p>The plugin obtains client header information and does
- something based on it.</p></li></ul></div>
+<li>
+ <p>The plugin obtains client header information and does
+ something based on that information.</p></li></ul></div>
<p>This chapter demonstrates how these components
are implemented in SDK sample code.</p>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/HostLookupFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HostLookupFunctions.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HostLookupFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HostLookupFunctions.html Thu Dec 17 21:32:47 2009
@@ -63,7 +63,7 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="INKHostLookup"></a>INKHostLookup</h3></div></div></div>
-<p>Instructs Traffic Server to do a DNS lookup of a host name.</p>
+<p>Instructs Traffic Server to do a DNS lookup on a host name.</p>
<div class="variablelist"><dl>
<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">INKAction INKHostLookupResult (INKCont
Modified: incubator/trafficserver/site/trunk/docs/sdk/HostsLookupAPI.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HostsLookupAPI.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HostsLookupAPI.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HostsLookupAPI.html Thu Dec 17 21:32:47 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>Hosts Lookup API</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="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="prev" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="next" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="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="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="prev" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="next" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
<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,13 +57,13 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="HostsLookupAPI"></a>Hosts Lookup API</h2></div></div></div>
-<p>The hosts lookup allows plugins to ask Traffic Server to do a host
- lookup of a host name. This is in some way similar to a DNS
+<p>The hosts lookup enables plugins to ask Traffic Server to do a host
+ lookup of a host name, in a way much like a DNS
lookup.</p>
-<p>The hosts lookup functions are:</p>
+<p>The hosts lookup functions are the following:</p>
<div class="itemizedlist"><ul type="disc">
-<li><p><a href="HostLookupFunctions.html#INKHostLookup" title="INKHostLookup">âINKHostLookupâ</a></p></li>
-<li><p><a href="INKHostLookupResultIPGet.html" title="INKHostLookupResultIPGet">âINKHostLookupResultIPGetâ</a></p></li>
+<li><p><a href="HostLookupFunctions.html#INKHostLookup" title="INKHostLookup">INKHostLookup</a></p></li>
+<li><p><a href="INKHostLookupResultIPGet.html" title="INKHostLookupResultIPGet">INKHostLookupResultIPGet</a></p></li>
</ul></div>
</div>
</body>
Modified: incubator/trafficserver/site/trunk/docs/sdk/ImplementHandler_GetTransHandle.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/ImplementHandler_GetTransHandle.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/ImplementHandler_GetTransHandle.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/ImplementHandler_GetTransHandle.html Thu Dec 17 21:32:47 2009
@@ -62,7 +62,6 @@
Transaction</h3></div></div></div>
<p>The handler function for the pluginâs parent continuation is
implemented as follows:</p>
-<p> </p>
<pre class="programlisting">static int
auth_plugin (INKCont contp, INKEvent event, void *edata)
{
Modified: incubator/trafficserver/site/trunk/docs/sdk/InitializationFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/InitializationFunctions.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/InitializationFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/InitializationFunctions.html Thu Dec 17 21:32:47 2009
@@ -65,24 +65,26 @@
<a name="INKPluginInit"></a>INKPluginInit</h3></div></div></div>
<div class="variablelist"><dl>
<dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">void INKPluginInit (int <code class="varname">argc</code>,
- const char <code class="varname">*argv[]</code>)</code></p></dd>
+<dd>
+ <p><code class="code">void INKPluginInit (int <code class="replaceable">argc</code>,
+ const <span class="replaceable">char</span> <code class="varname"> *<span class="replaceable">argv</span>[]</code>)</code></p></dd>
<dt><span class="term"><b>Arguments</b></span></dt>
<dd>
-<p><code class="varname">argc</code> is a count of the number of
- arguments in the argument vector, <code class="varname">argv</code>. The
+<p><code class="code"><code class="replaceable">argc</code> </code>is a count of the number of
+ arguments in the argument vector, <code class="code"><code class="varname"><span class="replaceable">argv</span></code></code>. The
count has a value of at least one because the first argument in the argument
vector is the pluginâs name, which must exist in order for the
plugin to be loaded.</p>
-<p><code class="varname">argv</code> is the vector of arguments. The
- number of arguments in the vector is <code class="varname">argc</code>; <code class="varname">argv[0]</code> always contains the name of the
+<p><code class="code"><code class="varname"><span class="replaceable">argv</span></code> </code>is the vector of arguments. The
+ number of arguments in the vector is <code class="code"><code class="replaceable">argc</code></code>; <code class="varname">argv[0]</code> always contains the name of the
plugin shared library.</p>
</dd>
<dt><span class="term"><b>Description</b></span></dt>
-<dd><p>This function must be defined by all plugins. Traffic
+<dd>
+ <p>This function must be defined by all plugins. Traffic
Server calls this initialization routine when it loads the
- plugin and sets <code class="varname">argc</code> and
- <code class="varname">argv</code> based on the values in
+ plugin and sets <code class="replaceable">argc </code> and
+ <code class="replaceable">argv </code> based on the values in
<code class="filename">plugin.config</code>.</p></dd>
</dl></div>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/InitiateConnectionFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/InitiateConnectionFunctions.html?rev=891922&r1=891921&r2=891922&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/InitiateConnectionFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/InitiateConnectionFunctions.html Thu Dec 17 21:32:47 2009
@@ -91,16 +91,16 @@
<dd>
<p>Sends an HTTP request through the Traffic Server HTTP SM.
The HTTP request goes through the Traffic Server the same way a
- request from a client (such as a browser) does.</p>
-<p>A typical scenario when using is as follows:</p>
+ request from a client (such as a browser) does. A typical usage scenario is as follows:</p>
<div class="itemizedlist"><ul type="disc">
<li><p>Call <code class="function">INKHttpConnect</code>.</p></li>
<li><p>Use <code class="function">INKVConnWrite</code> to send an HTTP
request.</p></li>
<li><p>Use <code class="function">INKVConnRead</code> to get the HTTP
response.</p></li>
-<li><p>If needed, use <code class="function">INKHttpParser</code> to
- parse the response.</p></li>
+<li>
+ <p>Use <code class="function">INKHttpParser</code> to
+ parse the response (if needed).</p></li>
</ul></div>
<p><b>Note:</b> the request and response go through the Traffic
Server HTTP SM. The request and the response can be cached and