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 2010/03/26 21:37:50 UTC
svn commit: r928047 - in /incubator/trafficserver/site/trunk/docs/v2/sdk:
HTTPFunctions.html HTTPTransactionFunctions.html
Author: dianes
Date: Fri Mar 26 20:37:49 2010
New Revision: 928047
URL: http://svn.apache.org/viewvc?rev=928047&view=rev
Log:
ts-258 and ToC cleanup
Modified:
incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPFunctions.html
incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPTransactionFunctions.html
Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPFunctions.html?rev=928047&r1=928046&r2=928047&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPFunctions.html Fri Mar 26 20:37:49 2010
@@ -29,7 +29,9 @@
<ul>
<li><a href="HTTPTransactionFunctions.html#INKHttpTxnCacheLookupStatusGet">INKHttpTxnCacheLookupStatusGet</a></li>
-<ul><li><a href="HTTPTransactionFunctions.html#INKHttpTxnCachedReqGet">INKHttpTxnCachedReqGet</a></li>
+<ul>
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnCacheLookupStatusSet">INKHttpTxnCacheLookupStatusSet</a></b></li>
+ <li><a href="HTTPTransactionFunctions.html#INKHttpTxnCachedReqGet">INKHttpTxnCachedReqGet</a></li>
<li><a href="HTTPTransactionFunctions.html#INKHttpTxnCachedRespGet">INKHttpTxnCachedRespGet</a></li></ul>
@@ -46,16 +48,16 @@
<li><a href="HTTPTransactionFunctions.html#INKHttpTxnHookAdd">INKHttpTxnHookAdd</a></li>
<li><a href="HTTPTransactionFunctions.html#INKHttpTxnNextHopIPGet">INKHttpTxnNextHopIPGet</a></li>
<li><a href="HTTPTransactionFunctions.html#INKHttpTxnParentProxyGet">INKHttpTxnParentProxyGet</a></li>
-<li><a href="HTTPTransactionFunctions.html#INKHttpTxnParentProxySet">INKHttpTxnParentProxySet</a></li>
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnParentProxySet">INKHttpTxnParentProxySet</a></li>
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnPristineUrlGet"><b>INKHttpTxnPristineUrlGet</b></a></li>
<li><a href="HTTPTransactionFunctions.html#INKHttpTxnReenable">INKHttpTxnReenable</a></li>
<li><a href="HTTPTransactionFunctions.html#INKHttpTxnServerIPGet">INKHttpTxnServerIPGet</a></li>
<li><a href="HTTPTransactionFunctions.html#INKHttpTxnServerReqGet">INKHttpTxnServerReqGet</a></li>
-<li><a href="HTTPTransactionFunctions.html#INKHttpTxnServerRespGet">INKHttpTxnServerRespGet</a></li>
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnServerRespGet">INKHttpTxnServerRespGet</a></li>
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnSkipRww">INKHttpTxnSkipRww</a></b></li>
<li><a href="HTTPTransactionFunctions.html#INKHttpTxnSsnGet">INKHttpTxnSsnGet</a></li>
</ul>
-
-<li><a href="HTTPTransactionFunctions.html#INKHttpTxnPristineUrlGet">INKHttpTxnPristineUrlGet</a></li>
<li><a href="HTTPTransactionFunctions.html#INKHttpTxnTransformedRespCache">INKHttpTxnTransformedRespCache</a></li>
<ul><li><a href="HTTPTransactionFunctions.html#INKHttpTxnTransformRespGet">INKHttpTxnTransformRespGet</a></li></ul>
Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPTransactionFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPTransactionFunctions.html?rev=928047&r1=928046&r2=928047&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPTransactionFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPTransactionFunctions.html Fri Mar 26 20:37:49 2010
@@ -17,7 +17,7 @@
<ul>
<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnCacheLookupStatusGet">INKHttpTxnCacheLookupStatusGet</a></b></li>
<ul>
- <li>INKHttpCacheLookupStatusSet</li>
+ <li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnCacheLookupStatusSet">INKHttpTxnCacheLookupStatusSet</a></b></li>
<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnCachedReqGet">INKHttpTxnCachedReqGet</a></b></li>
<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnCachedRespGet">INKHttpTxnCachedRespGet</a></b></li>
</ul>
@@ -37,7 +37,7 @@
<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnParentProxyGet">INKHttpTxnParentProxyGet</a></b></li>
<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnParentProxySet">INKHttpTxnParentProxySet</a></b></li>
<li><a href="HTTPTransactionFunctions.html#INKHttpTxnPristineUrlGet"><b>INKHttpTxnPristineUrlGet</b></a></li>
-<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnParentProxySet">INKHttpTxnParentProxySet</a><a href="HTTPTransactionFunctions.html#INKHttpTxnReenable"></a></b></li>
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnReenable">INKHttpTxnReenable</a><a href="HTTPTransactionFunctions.html#INKHttpTxnReenable"></a></b></li>
<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnServerIPGet">INKHttpTxnServerIPGet</a></b></li>
<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnServerReqGet">INKHttpTxnServerReqGet</a></b></li>
<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnServerRespGet">INKHttpTxnServerRespGet</a></b></li>
@@ -110,32 +110,30 @@
<div class="section" lang="en">
<div class="titlepage"><div><div>
<h4 class="title">
-<a name="INKHttpTxnCacheLookupStatusGet"></a>INKHttpTxnCacheLookupStatusSet</h4></div></div></div>
+<a name="INKHttpTxnCacheLookupStatusSet"></a>INKHttpTxnCacheLookupStatusSet</h4></div></div></div>
<p>Sets the cache lookup status to the status that is passed in.</p>
<div class="variablelist"><dl>
<dt><span class="term"><b>Prototype</b></span></dt>
<dd>
- <p><code class="code">int INKReturnCode INKHttpTxnCacheLookupStatusGet
- (INKHttpTxn <em class="replaceable"><code>txnp</code></em>, int
- *<em class="replaceable"><code>lookup_status</code></em>)</code></p></dd>
+ <p><code class="code">int INKHttpTxnCacheLookupStatusSet
+ (INKHttpTxn <em class="replaceable"><code>txnp</code></em>, int <em class="replaceable"><code>lookup_status</code></em>)</code></p></dd>
<dt><span class="term"><b>Arguments</b></span></dt>
<dd>
- <p><code>INKHttpTxn <i>txnp </i></code> is the ongoing transaction.</p>
- <p><code>int <i>*lookup_status </i></code> is set to the lookup status.</p>
+ <p><code>INKHttpTxn </code><code class="code"><em class="replaceable"><code>txnp </code></em></code><i> </i> is the ongoing transaction.</p>
+ <p> </p>
</dd>
<dt><span class="term"><b>Description</b></span></dt>
<dd>
- <p>Obtains the status of the current cache lookup for the
- ongoing transaction
- <code class="code"><em class="replaceable"><code>txnp </code></em></code> in the
- <code class="code"><em class="replaceable"><code>lookup_status </code></em></code>
- variable.</p>
- <p>This function should only be called from
- <code class="code">INK_HTTP_CACHE_LOOKUP_COMPLETE_HOOK</code>.</p>
- <p>Possible status values returned in
+ <p>Sets the status of the current cache lookup for the ongoing transaction <code class="code"><em class="replaceable"><code>txnp </code></em></code> to whatever is specified in the <code class="code"><em class="replaceable"><code>lookup_status </code></em></code> variable. Changing the status from <code>INK_CACHE_LOOKUP_MISS</code> is not allowed. </p>
+ </dd>
+ <dd>
+ <p>For example, consider the following use-case scenario: A 'stale while revalidate' plugin has to serve stale data from the cache while it makes a request for new data asynchronously. The plugin forces the core to serve stale data by setting the cache lookup status to <code>INK_CACHE_LOOKUP_HIT_FRESH</code>.</p>
+
+<p>Possible status values for
<code class="code"><em class="replaceable"><code>lookup_status </code></em></code>
are:
- </p><ul>
+ </p>
+<ul>
<li><code class="code">INK_CACHE_LOOKUP_MISS</code> - Document was not in
the cache, so it will be fetched from the origin server.</li>
<li><code class="code">INK_CACHE_LOOKUP_HIT_STALE</code> - Document was
@@ -148,16 +146,15 @@
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>
</ul>
- </dd>
+</dd>
</dl>
<dl>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
- <p><code class="code">INK_SUCCESS</code> if the API is called
+ <p><code class="code">1</code> if the API is called
successfully.</p>
- <p><code class="code">INK_ERROR</code> if an error occurs while calling
- the API or if an argument is invalid.</p>
+ <p><code class="code">0</code> if an error occurs.</p>
</dd>
</dl>
</div>