Author: mlibbey
Date: Thu Mar 4 22:39:45 2010
New Revision: 919219
URL: http://svn.apache.org/viewvc?rev=919219&view=rev
Log:
Add INKSetCacheUrl
Modified:
incubator/trafficserver/site/trunk/docs/sdk/CacheInterfaceFunctions.html
Modified:
incubator/trafficserver/site/trunk/docs/sdk/CacheInterfaceFunctions.html
URL:
http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/CacheInterfaceFunctions.html?rev=919219&r1=919218&r2=919219&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/CacheInterfaceFunctions.html
(original)
+++ incubator/trafficserver/site/trunk/docs/sdk/CacheInterfaceFunctions.html
Thu Mar 4 22:39:45 2010
@@ -2,9 +2,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Cache Interface 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" type="text/css"
href="http://yui.yahooapis.com/combo?2.2.2/build/reset/reset-min.css&2.2.2/build/fonts/fonts-min.css&2.2.2/build/treeview/assets/tree.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" />
@@ -48,52 +46,84 @@
<link rel="subsection" href="INKCacheRemove.html" title="INKCacheRemove" />
<link rel="subsection" href="INKCacheKeyPinnedSet.html"
title="INKCacheKeyPinnedSet" />
<link rel="subsection" href="INKVConnCacheObjectSizeGet.html"
title="INKVConnCacheObjectSizeGet" />
-<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">
+<script
src="http://yui.yahooapis.com/combo?2.2.2/build/yahoo/yahoo-min.js&2.2.2/build/event/event-min.js&2.2.2/build/treeview/treeview-min.js";></script>
+<script src="js/tocnodes.js"></script>
+<script src="js/toc.js"></script>
+<script>
document.write("<style> div.toc {display: none} </style>");
- </script>
+</script>
</head>
<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>
+<div class="doctitle"> <a href="index.html">Home</a> <img
src="images/docbook/ts75.png" />
+ <h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
-<div class="navprev">
-<a accesskey="p" href="INKNetVConnRemotePortGet.html">Prev</a> â
INKNetVConnRemotePortGet</div>
-<div class="navnext">INKCacheKeyDigestSet â <a accesskey="n"
href="INKCacheKeyDigestSet.html">Next</a>
-</div>
+ <div class="navprev"> <a accesskey="p"
href="INKNetVConnRemotePortGet.html">Prev</a> â INKNetVConnRemotePortGet</div>
+ <div class="navnext">INKCacheKeyDigestSet â <a accesskey="n"
href="INKCacheKeyDigestSet.html">Next</a> </div>
</div>
<div id="toc"></div>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="CacheInterfaceFunctions"></a>Cache Interface
Functions</h2></div></div></div>
-<p></p>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="INKCacheKeyCreate"></a>INKCacheKeyCreate</h3></div></div></div>
-<p>Creates a new cache key that will be assigned to an object to be
- cached.</p>
-<div class="variablelist"><dl>
-<dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">INKReturnCode INKCacheKeyCreate(InkCacheKey
- *<em
class="replaceable"><code>new_key</code></em>)</code></p></dd>
-<dt><span class="term"><b>Arguments</b></span></dt>
-<dd>
- <p><code class="function">INKCacheKey
- *</code><code class="code"><em class="replaceable"><code>new_key
</code></em></code> is
- set to the allocated key.</p></dd>
-<dt><span class="term"><b>Description</b></span></dt>
-<dd><p>Creates (allocates memory for) a new cache key. The key
- can then be generated and assigned to an object using
- <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 successful.</p>
-<p><code class="code">INK_ERROR</code> if the cache key could not be
- allocated.</p>
-</dd>
-</dl></div>
-</div>
+ <div class="titlepage">
+ <h2 class="title" style="clear: both;"> <a
name="CacheInterfaceFunctions">Cache Interface Functions</a></h2>
+ </div>
+ <div class="section" lang="en">
+ <div class="titlepage">
+ <h3 class="title"> <a name="INKCacheKeyCreate">INKCacheKeyCreate</a></h3>
+ </div>
+ <p>Creates a new cache key that will be assigned to an object to be
+ cached.</p>
+ <div class="variablelist">
+ <dl>
+ <dt><span class="term"><b>Prototype</b></span></dt>
+ <dd>
+ <p><code class="code">INKReturnCode INKCacheKeyCreate(InkCacheKey
+ *<em class="replaceable"><code>new_key</code></em>)</code></p>
+ </dd>
+ <dt><span class="term"><b>Arguments</b></span></dt>
+ <dd>
+ <p><code class="function">INKCacheKey
+ *</code><code class="code"><em class="replaceable"><code>new_key
</code></em></code> is
+ set to the allocated key.</p>
+ </dd>
+ <dt><span class="term"><b>Description</b></span></dt>
+ <dd>
+ <p>Creates (allocates memory for) a new cache key. The key
+ can then be generated and assigned to an object using <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 successful.</p>
+ <p><code class="code">INK_ERROR</code> if the cache key could not be
+ allocated.</p>
+ </dd>
+ </dl>
+ </div>
+ <div class="section" lang="en">
+ <div class="titlepage">
+ <h3 class="title"> <a name="INKSetCacheUrl">INKSetCacheUrl</a></h3>
+ </div>
+ <p>This is an API to set the cache URL. This will be the URL for the
cached object.</p>
+ <div class="variablelist">
+ <dl>
+ <dt><span class="term"><b>Prototype</b></span></dt>
+ <dd>
+ <p><code class="code">INKReturnCode INKSetCacheUrl(INKHttpTxn
txnp, const char* url)</code></p>
+ </dd>
+ <dt><span class="term"><b>Arguments</b></span></dt>
+ <dd>
+ <p>The URL for the cached object will be set to
<code>url</code>.</p>
+ </dd>
+ <dt><span class="term"><b>Example</b></span></dt>
+ <dd>
+ <p><code class="code">INKHttpTxn txnp = (INKHttpTxn)edata;<br>
+ if (INKSetCacheUrl(txnp, "http://www.yahoo.com";) != INK_SUCCESS)
{<br>
+ // ERROR<br>
+ }</code></p>
+ </dd>
+ </dl>
+ </div>
+ </div>
+ </div>
</div>
</body>
</html>
