trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From andrew...@apache.org
Subject svn commit: r831152 [17/37] - in /incubator/trafficserver/site/trunk/docs: ./ admin/ admin/images/ sdk/ sdk/css/ sdk/images/ sdk/images/docbook/ sdk/js/
Date Thu, 29 Oct 2009 23:23:36 GMT
Added: 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=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTP_Transactions.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTP_Transactions.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,220 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>HTTP Transactions</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="prev" href="HTTPSessions.html" title="HTTP Sessions">
+<link rel="next" href="InterceptingHTTPTx.html" title="Intercepting HTTP Transactions">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</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>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="HTTPSessions.html">Prev</a> — HTTP Sessions</div>
+<div class="navnext">Intercepting HTTP Transactions — <a accesskey="n" href="InterceptingHTTPTx.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="HTTP_Transactions"></a>HTTP Transactions</h2></div></div></div>
+<p>The HTTP transaction functions allow you to set up plugin
+      callbacks to HTTP transactions, and obtain and modify information about
+      particular HTTP transactions.</p>
+<p>As described in the section on HTTP sessions, an HTTP transaction
+      is an object defined for the lifetime of a single request from a client
+      and the 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 internal state about a transaction. Additionally, an HTTP
+      transaction has a reference back to the HTTP session that created
+      it.</p>
+<p>Below is a sample of code that 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
+*
+* Note: for code lisibility, error checking is omitted
+*/
+
+#include "InkAPI.h"
+
+#define DBG_TAG "txn"
+
+/* Structure to be associated to txns */
+typedef struct {
+   int i;
+   float f;
+   char *s;
+} TxnData;
+
+/* Allocate memory and init a TxnData structure */
+TxnData *
+txn_data_alloc()
+{
+   TxnData *data;
+   data = INKmalloc(sizeof(TxnData));
+
+   data-&gt;i = 1;
+   data-&gt;f = 0.5;
+   data-&gt;s = "Constant String";
+   return data;
+}
+
+/* Free up a TxnData structure */
+void
+txn_data_free(TxnData *data)
+{
+   INKfree(data);
+}
+
+/* handler for event READ_REQUEST and TXN_CLOSE */
+static int
+local_hook_handler (INKCont contp, INKEvent event, void *edata)
+{
+   INKHttpTxn txnp = (INKHttpTxn) edata;
+   TxnData *txn_data = INKContDataGet(contp);
+   switch (event) {
+   case INK_EVENT_HTTP_READ_REQUEST_HDR:
+      /* Modify values of txn data */
+      txn_data-&gt;i = 2;
+      txn_data-&gt;f = 3.5;
+      txn_data-&gt;s = "Constant String 2";
+      break;
+
+   case INK_EVENT_HTTP_TXN_CLOSE:
+      /* Print txn data values */
+      INKDebug(DBG_TAG, "Txn data i=%d f=%f s=%s", txn_data-&gt;i, txn_data-&gt;f,
+   txn_data-&gt;s);
+
+      /* Then destroy the txn cont and it's data */
+      txn_data_free(txn_data);
+      INKContDestroy(contp);
+      break;
+
+   default:
+       INKAssert(!"Unexpected event");
+       break;
+   }
+
+   INKHttpTxnReenable(txnp, INK_EVENT_HTTP_CONTINUE);
+   return 1;
+}
+
+/* Handler for event TXN_START */
+static int
+global_hook_handler (INKCont contp, INKEvent event, void *edata)
+{
+   INKHttpTxn txnp = (INKHttpTxn) edata;
+   INKCont txn_contp;
+   TxnData *txn_data;
+
+   switch (event) {
+   case INK_EVENT_HTTP_TXN_START:
+      /* Create a new continuation for this txn and associate data to it */
+      txn_contp = INKContCreate(local_hook_handler, INKMutexCreate());
+      txn_data = txn_data_alloc();
+      INKContDataSet(txn_contp, txn_data);
+
+      /* Registers locally to hook READ_REQUEST and TXN_CLOSE */
+      INKHttpTxnHookAdd(txnp, INK_HTTP_READ_REQUEST_HDR_HOOK, txn_contp);
+      INKHttpTxnHookAdd(txnp, INK_HTTP_TXN_CLOSE_HOOK, txn_contp);
+      break;
+
+   default:
+      INKAssert(!"Unexpected event");
+      break;
+   }
+
+   INKHttpTxnReenable(txnp, INK_EVENT_HTTP_CONTINUE);
+   return 1;
+}
+
+
+void
+INKPluginInit (int argc, const char *argv[])
+{
+   INKCont contp;
+
+   /* Note that we do not need a mutex for this txn as it registers globally
+      and doesn't have any data associated with it */
+   contp = INKContCreate(global_hook_handler, NULL);
+
+   /* Register gloabally */
+   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. See <a href="HTTPHooksAndTransactions.html#Fig_HHTTPTxStateDiag" title="Figure 8.1. HTTP Transaction State Diagram">Figure 8.1, “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">
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnCacheLookupStatusGet" title="INKHttpTxnCacheLookupStatusGet">“INKHttpTxnCacheLookupStatusGet”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnCachedReqGet" title="INKHttpTxnCachedReqGet">“INKHttpTxnCachedReqGet”</a>—Note that it is an
+          error to modify cached headers.</p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnCachedRespGet" title="INKHttpTxnCachedRespGet">“INKHttpTxnCachedRespGet”</a>—Note that it is an
+          error to modify cached headers.</p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnClientIncomingPortGet" title="INKHttpTxnClientIncomingPortGet">“INKHttpTxnClientIncomingPortGet”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnClientIPGet" title="INKHttpTxnClientIPGet">“INKHttpTxnClientIPGet”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnClientRemotePortGet" title="INKHttpTxnClientRemotePortGet">“INKHttpTxnClientRemotePortGet”</a></p></li>
+<li><p><a href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">Chapter 8, <i>HTTP Hooks and Transactions</i></a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnClientReqGet" title="INKHttpTxnClientReqGet">“INKHttpTxnClientReqGet”</a>—Plugins that must
+          read client request headers use this call to retrieve the HTTP
+          header.</p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnClientRespGet" title="INKHttpTxnClientRespGet">“INKHttpTxnClientRespGet”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnErrorBodySet" title="INKHttpTxnErrorBodySet">“INKHttpTxnErrorBodySet”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnHookAdd" title="INKHttpTxnHookAdd">“INKHttpTxnHookAdd”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnNextHopIPGet" title="INKHttpTxnNextHopIPGet">“INKHttpTxnNextHopIPGet”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnNextHopIPGet" title="INKHttpTxnNextHopIPGet">“INKHttpTxnNextHopIPGet”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnParentProxySet" title="INKHttpTxnParentProxySet">“INKHttpTxnParentProxySet”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnReenable" title="INKHttpTxnReenable">“INKHttpTxnReenable”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnServerIPGet" title="INKHttpTxnServerIPGet">“INKHttpTxnServerIPGet”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnServerReqGet" title="INKHttpTxnServerReqGet">“INKHttpTxnServerReqGet”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnServerRespGet" title="INKHttpTxnServerRespGet">“INKHttpTxnServerRespGet”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnSsnGet" title="INKHttpTxnSsnGet">“INKHttpTxnSsnGet”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnTransformedRespCache" title="INKHttpTxnTransformedRespCache">“INKHttpTxnTransformedRespCache”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnTransformRespGet" title="INKHttpTxnTransformRespGet">“INKHttpTxnTransformRespGet”</a></p></li>
+<li><p><a href="HTTPTransactionFunctions.html#INKHttpTxnUntransformedRespCache" title="INKHttpTxnUntransformedRespCache">“INKHttpTxnUntransformedRespCache”</a></p></li>
+</ul></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/HTTP_Transactions.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/HeaderBasedPluginEx.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HeaderBasedPluginEx.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HeaderBasedPluginEx.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/HeaderBasedPluginEx.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,127 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Chapter 4. Header-Based Plugin Examples</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="prev" href="ch03s04.html" title="Examples">
+<link rel="next" href="BlacklistPlugin.html" title="The Blacklist Plugin">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="section" href="HeaderBasedPluginEx.html#HeaderBasedEx_Overview" title="Overview">
+<link rel="section" href="BlacklistPlugin.html" title="The Blacklist Plugin">
+<link rel="section" href="BasicAuthorizatonPlugin.html" title="The Basic Authorization Plugin">
+<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>
+</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>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="ch03s04.html">Prev</a> — Examples</div>
+<div class="navnext">The Blacklist Plugin — <a accesskey="n" href="BlacklistPlugin.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="chapter" lang="en">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="HeaderBasedPluginEx"></a>Chapter 4. Header-Based Plugin Examples</h2></div></div></div>
+<div class="toc">
+<p><b>Table of Contents</b></p>
+<dl>
+<dt><span class="section"><a href="HeaderBasedPluginEx.html#HeaderBasedEx_Overview">Overview</a></span></dt>
+<dt><span class="section"><a href="BlacklistPlugin.html">The Blacklist Plugin</a></span></dt>
+<dd><dl>
+<dt><span class="section"><a href="BlacklistPlugin.html#CreatingParentContinuation">Creating the Parent Continuation</a></span></dt>
+<dt><span class="section"><a href="SettingGlobalHook.html">Setting a Global Hook</a></span></dt>
+<dt><span class="section"><a href="SettingUpUIUpdateCallbacks.html">Setting Up UI Update Callbacks</a></span></dt>
+<dt><span class="section"><a href="AccessingTransactionProc.html">Accessing the Transaction Being Processed</a></span></dt>
+<dt><span class="section"><a href="SettingUpTransacHook.html">Setting Up a Transaction Hook</a></span></dt>
+<dt><span class="section"><a href="WorkWHTTPHeaderFunc.html">Working with HTTP Header Functions</a></span></dt>
+</dl></dd>
+<dt><span class="section"><a href="BasicAuthorizatonPlugin.html">The Basic Authorization Plugin</a></span></dt>
+<dd><dl>
+<dt><span class="section"><a href="BasicAuthorizatonPlugin.html#CreatePluginParentCont_GlHk">Creating the Plugin's Parent Continuation and Global
+        Hook</a></span></dt>
+<dt><span class="section"><a href="ImplementHandler_GetTransHandle.html">Implementing the Handler and Getting a Handle to the
+        Transaction</a></span></dt>
+<dt><span class="section"><a href="WorkWithHTTPHeaders.html">Working With HTTP Headers</a></span></dt>
+<dt><span class="section"><a href="SetTransactionHook.html">Setting a Transaction Hook</a></span></dt>
+</dl></dd>
+</dl>
+</div>
+<p>Header-based plugins read or modify the headers of HTTP messages
+    that Traffic Server sends and receives. Reading this chapter will help you
+    to understand the following topics:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p>Creating continuations for your plugins</p></li>
+<li><p>Adding global hooks</p></li>
+<li><p>Adding transaction hooks</p></li>
+<li><p>Working with HTTP header functions</p></li>
+</ul></div>
+<p>The two sample plugins discussed in this chapter are
+    <code class="filename">blacklist-1.c</code> and
+    <code class="filename">basic-auth.c</code>.</p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="HeaderBasedEx_Overview"></a>Overview</h2></div></div></div>
+<p>Header-based plugins take actions based on the contents of HTTP
+      request or response headers. Examples include filtering (on the basis of
+      requested URL, source IP address, or other request header), user
+      authentication, or user redirection. Header-based plugins have the
+      following common elements:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p>The plugin has a static parent continuation that scans all
+          Traffic Server headers (either request headers, response headers, or
+          both).</p></li>
+<li><p>The plugin has a global hook. This enables the plugin to check
+          all transactions to determine if the plugin needs to do
+          something.</p></li>
+<li><p>The plugin gets a handle to the transaction being processed
+          through the global hook.</p></li>
+<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>
+<p>In the remainder of this chapter, you’ll see how these components
+      are implemented in SDK sample code.</p>
+</div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/HeaderBasedPluginEx.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/HostLookupFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HostLookupFunctions.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HostLookupFunctions.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/HostLookupFunctions.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,131 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Host Lookup Functions</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="prev" href="INKActionDone.html" title="INKActionDone">
+<link rel="next" href="INKHostLookupResultIPGet.html" title="INKHostLookupResultIPGet">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="subsection" href="HostLookupFunctions.html#INKHostLookup" title="INKHostLookup">
+<link rel="subsection" href="INKHostLookupResultIPGet.html" title="INKHostLookupResultIPGet">
+<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>
+</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>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKActionDone.html">Prev</a> — INKActionDone</div>
+<div class="navnext">INKHostLookupResultIPGet — <a accesskey="n" href="INKHostLookupResultIPGet.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="HostLookupFunctions"></a>Host Lookup Functions</h2></div></div></div>
+<p></p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKHostLookup"></a>INKHostLookup</h3></div></div></div>
+<p>Asks Traffic Server to do a DNS lookup of a host name.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">INKAction INKHostLookupResult (INKCont
+              <em class="replaceable"><code>contp</code></em>, char
+              *<em class="replaceable"><code>hostname</code></em>, int
+              <em class="replaceable"><code>namelen</code></em>)</code></p></dd>
+<dt><span class="term">Arguments</span></dt>
+<dd>
+<p><code class="function">INKCont</code>
+              <code class="code"><em class="replaceable"><code>contp</code></em></code> is the
+              continuation that Traffic Server calls back when the DNS lookup
+              occurs.</p>
+<p><code class="code">char
+              *</code><code class="code"><em class="replaceable"><code>hostname</code></em></code> is the
+              name to look up. Null terminated.</p>
+<p><code class="code">int
+              </code><code class="code"><em class="replaceable"><code>namelen</code></em></code> is the
+              length of <code class="code"><em class="replaceable"><code>hostname</code></em></code> +1
+              (add one to account for null termination).</p>
+</dd>
+<dt><span class="term">Description</span></dt>
+<dd>
+<p>Initiates a DNS lookup of
+              <code class="code"><em class="replaceable"><code>hostname</code></em></code>. When the
+              lookup occurs, Traffic Server sends contp
+              <code class="code">INK_EVENT_DNS_LOOKUP</code>. If the lookup is successful
+              (IP address resolved), the <code class="code">void *
+              </code><code class="code"><em class="replaceable"><code>data</code></em></code> passed to
+              the handler of the continuation
+              <code class="code"><em class="replaceable"><code>contp</code></em></code> is a data of type
+              <code class="function">INKHostLookupResult</code>. You can then use
+              <code class="function">INKHostLookupResultIPGet</code> to convert this
+              information to an unsigned int representing the IP
+              address.</p>
+<p>If the lookup fails (IP address not resolved), the
+              <code class="code">void *</code> <code class="code"><em class="replaceable"><code>data</code></em></code>
+              passed to the handler of continuation
+              <code class="code"><em class="replaceable"><code>contp</code></em></code> is a null
+              pointer.</p>
+<p>You have the option to cancel the action returned by
+              <code class="function">INKHostLookup</code> by using
+              <code class="function">INKActionCancel</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>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top"><p>Reentrant calls are possible, i.e. the cache can call
+                back the user (<code class="code">contp</code>) in the same call.</p></td></tr>
+</table></div>
+</dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p>An <code class="function">INKAction</code> object if
+              successful.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an argument is incorrect or
+              if the API fails.</p>
+</dd>
+<dt><span class="term">First Release</span></dt>
+<dd><p>Traffic Server 5.2</p></dd>
+</dl></div>
+</div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/HostLookupFunctions.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/HostsLookupAPI.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HostsLookupAPI.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HostsLookupAPI.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/HostsLookupAPI.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,70 @@
+<html>
+<head>
+<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">
+<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>
+</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>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="ActionsGuide.html">Prev</a> — Chapter 14. Actions Guide</div>
+<div class="navnext">Chapter 15. IO Guide — <a accesskey="n" href="IOGuide.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="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
+      lookup.</p>
+<p>The hosts lookup functions are:</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>
+</ul></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/HostsLookupAPI.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/INKActionDone.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKActionDone.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKActionDone.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKActionDone.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,105 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>INKActionDone</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="ActionFunctions.html" title="Action Functions">
+<link rel="prev" href="ActionFunctions.html" title="Action Functions">
+<link rel="next" href="HostLookupFunctions.html" title="Host Lookup Functions">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<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>
+</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>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="ActionFunctions.html">Prev</a> — Action Functions</div>
+<div class="navnext">Host Lookup Functions — <a accesskey="n" href="HostLookupFunctions.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKActionDone"></a>INKActionDone</h3></div></div></div>
+<p>Tells you if an action is completed.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">int INKActionDone (INKAction
+              <em class="replaceable"><code>actionp</code></em>)</code></p></dd>
+<dt><span class="term">Description</span></dt>
+<dd>
+<p>Is <code class="code"><em class="replaceable"><code>actionp</code></em></code> a
+              completed action. If a <code class="code">NULL</code> argument is passed to
+              <code class="function">INKActionDone</code>, Traffic Server will crash
+              and will not return <code class="code">INK_ERROR</code>. Note that it is the
+              programmer’s responsibility to ensure that a non-null value is
+              passed to INKActionDone.</p>
+<div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="images/docbook/important.png"></td>
+<th align="left">Important</th>
+</tr>
+<tr><td align="left" valign="top">
+<p>Always use <code class="function">INKActionDone</code>
+                immediately after the call that assigns the action. For
+                example:</p>
+<pre class="programlisting">actionp = INKContSchedule(contp, SOME_TIMEOUT_VALUE);
+if (INKActionDone(actionp)){
+    //event has already occurred 
+   }</pre>
+</td></tr>
+</table></div>
+<p>If you call
+              <code class="function">INKActionDone</code>(<code class="code"><em class="replaceable"><code>actionp</code></em></code>)
+              some time later or some where else, it always returns false, and
+              therefore does not accurately reflect whether the action is
+              completed.</p>
+</dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p>0 if the action has not completed.</p>
+<p>1 if the action has completed</p>
+<p><code class="code">INK_ERROR</code> if an error has occurred.</p>
+</dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/INKActionDone.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/INKAssert.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKAssert.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKAssert.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKAssert.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,96 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>INKAssert</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="DebuggingFunctions.html" title="Debugging Functions">
+<link rel="prev" href="INKError.html" title="INKError">
+<link rel="next" href="INKReleaseAssert.html" title="INKReleaseAssert">
+<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>
+</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>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKError.html">Prev</a> — INKError</div>
+<div class="navnext">INKReleaseAssert — <a accesskey="n" href="INKReleaseAssert.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKAssert"></a>INKAssert</h3></div></div></div>
+<p>Allows the use of assertion in a plugin</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">void
+              INKAssert(<em class="replaceable"><code>expression</code></em>); </code></p></dd>
+<dt><span class="term">Arguments</span></dt>
+<dd><p>A boolean expression.</p></dd>
+<dt><span class="term">Description</span></dt>
+<dd>
+<p>If expression is false:</p>
+<p>In debug mode, causes the Traffic Server to print the file
+              name, line number and expression, then to abort.</p>
+<p>In optim mode, the expression is *not* removed. But the
+              effect of printing an error message and aborting are. This is an
+              artifact of the way the system assert is normally used and
+              permits:</p>
+<pre class="programlisting">ink_assert(!setsockopt(...)); </pre>
+<p>Allows the use of assertion in a plugin.</p>
+<p>Note that when using the system “assert”, you do not have
+              to worry about the condition as the code will be 'dead code
+              eliminated' by the compiler. With <code class="code">INKAssert</code> you
+              do.</p>
+</dd>
+<dt><span class="term">Example</span></dt>
+<dd><pre class="programlisting">switch (event) {
+case EVENT_IMMEDIATE:
+....
+default:
+INKAssert (!setsockopt(...));
+break;
+}</pre></dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 5.2</p></dd>
+</dl></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/INKAssert.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDestroy.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDestroy.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDestroy.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDestroy.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,85 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>INKCacheKeyDestroy</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="CacheInterfaceFunctions.html" title="Cache Interface Functions">
+<link rel="prev" href="INKCacheKeyHostNameSet.html" title="INKCacheKeyHostNameSet">
+<link rel="next" href="INKCacheRead.html" title="INKCacheRead">
+<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>
+</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>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKCacheKeyHostNameSet.html">Prev</a> — INKCacheKeyHostNameSet</div>
+<div class="navnext">INKCacheRead — <a accesskey="n" href="INKCacheRead.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKCacheKeyDestroy"></a>INKCacheKeyDestroy</h3></div></div></div>
+<p>Destroys a cache key.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">INKReturnCode INKCacheKeyDestroy(INKCacheKey
+              <em class="replaceable"><code>key</code></em>)</code></p></dd>
+<dt><span class="term">Arguments</span></dt>
+<dd><p><code class="function">INKCacheKey</code>
+              <code class="code"><em class="replaceable"><code>key</code></em></code> is the key to be
+              destroyed.</p></dd>
+<dt><span class="term">Description</span></dt>
+<dd><p>Destroys a cache key (deallocate memory). You must destroy
+              cache keys when you are finished with them (after all reads and
+              writes are completed).</p></dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the cache key was successfully
+              destroyed.</p>
+<p><code class="code">INK_ERROR</code> if key could not be deallocated or
+              was not valid.</p>
+</dd>
+<dt><span class="term">First Release</span></dt>
+<dd><p>Traffic Server 5.2</p></dd>
+</dl></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDestroy.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDigestSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDigestSet.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDigestSet.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDigestSet.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,106 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>INKCacheKeyDigestSet</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="CacheInterfaceFunctions.html" title="Cache Interface Functions">
+<link rel="prev" href="CacheInterfaceFunctions.html" title="Cache Interface Functions">
+<link rel="next" href="INKCacheKeyHostNameSet.html" title="INKCacheKeyHostNameSet">
+<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>
+</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>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="CacheInterfaceFunctions.html">Prev</a> — Cache Interface Functions</div>
+<div class="navnext">INKCacheKeyHostNameSet — <a accesskey="n" href="INKCacheKeyHostNameSet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKCacheKeyDigestSet"></a>INKCacheKeyDigestSet</h3></div></div></div>
+<p>Generates and assigns a cache key to an object to be
+        cached.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">INKReturnCode INKCacheKeyDigestSet(INKCacheKey
+              <em class="replaceable"><code>key</code></em>, const unsigned char
+              *<em class="replaceable"><code>input</code></em>, int
+              <em class="replaceable"><code>length</code></em>)</code></p></dd>
+<dt><span class="term">Arguments</span></dt>
+<dd>
+<p><code class="function">INKCacheKey</code>
+              <code class="code"><em class="replaceable"><code>key</code></em></code> is the key to be
+              associated to the cached object. Before calling
+              <code class="function">INKCacheKeyDigestSet</code> you must create the
+              key with <code class="function">INKCacheKeyCreate</code>. Note that in
+              order to generate unique keys, you must use unique input
+              strings. In other words, if the input strings are identical,
+              <code class="function">INKCacheKeyCreate</code> will generate identical
+              keys.</p>
+<p><code class="code">const unsigned char
+              *</code><code class="code"><em class="replaceable"><code>input</code></em></code> is a
+              character string that uniquely identifies the object. In most
+              cases, it is the URL of the object.</p>
+<p><code class="code">int
+              </code><code class="code"><em class="replaceable"><code>length</code></em></code> is the
+              length of the string input.</p>
+</dd>
+<dt><span class="term">Description</span></dt>
+<dd><p>Generates and assigns a cache key to an object to be
+              cached.</p></dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the cache key was successfully
+              generated.</p>
+<p><code class="code">INK_ERROR</code> if digest could not be set.</p>
+</dd>
+<dt><span class="term">Example</span></dt>
+<dd><pre class="programlisting">const char *digest_string = "mydigest" 
+INKCacheKey mykey; 
+INKCacheKeyCreate(&amp;mykey); 
+INKCacheKeyDigestSet(mykey,digest_string, strlen(digest_string);</pre></dd>
+<dt><span class="term">First Release</span></dt>
+<dd><p>Traffic Server 5.2</p></dd>
+</dl></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDigestSet.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyHostNameSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyHostNameSet.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyHostNameSet.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyHostNameSet.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,96 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>INKCacheKeyHostNameSet</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="CacheInterfaceFunctions.html" title="Cache Interface Functions">
+<link rel="prev" href="INKCacheKeyDigestSet.html" title="INKCacheKeyDigestSet">
+<link rel="next" href="INKCacheKeyDestroy.html" title="INKCacheKeyDestroy">
+<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>
+</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>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKCacheKeyDigestSet.html">Prev</a> — INKCacheKeyDigestSet</div>
+<div class="navnext">INKCacheKeyDestroy — <a accesskey="n" href="INKCacheKeyDestroy.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKCacheKeyHostNameSet"></a>INKCacheKeyHostNameSet</h3></div></div></div>
+<p>Associates a host name to a cache key. Use if you want to
+        support cache partitioning by host name.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">INKReturnCode INKCacheKeyHostNameSet(INKCacheKey
+              <em class="replaceable"><code>key</code></em>, const unsigned char
+              *<em class="replaceable"><code>hostname</code></em>, int
+              <em class="replaceable"><code>host_len</code></em>;</code></p></dd>
+<dt><span class="term">Arguments</span></dt>
+<dd>
+<p>INKCacheKey <code class="code"><em class="replaceable"><code>key</code></em></code> is
+              the key to the cached object.</p>
+<p><code class="code">const unsigned char *</code><code class="code">hostname</code> is
+              the host name you are associating to the cache key.</p>
+<p><code class="code">int <em class="replaceable"><code>host_len</code></em></code> is
+              the length of the string
+              <code class="code"><em class="replaceable"><code>hostname</code></em></code>.</p>
+</dd>
+<dt><span class="term">Description</span></dt>
+<dd><p>Associates a host name to a cache key. The host name
+              setting is used in conjunction with the TS config file
+              <code class="filename">partition.config</code> and
+              <code class="filename">hosting.config</code> that allows you to specify
+              under which cache partition the object should be stored.</p></dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the host name was successfully
+              associated with the cache key.</p>
+<p><code class="code">INK_ERROR</code> if <code class="code">hostname</code> could not
+              be set or is invalid.</p>
+</dd>
+<dt><span class="term">First Release</span></dt>
+<dd><p>Traffic Server 5.2</p></dd>
+</dl></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyHostNameSet.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyPinnedSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyPinnedSet.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyPinnedSet.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyPinnedSet.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,122 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>INKCacheKeyPinnedSet</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="CacheInterfaceFunctions.html" title="Cache Interface Functions">
+<link rel="prev" href="INKCacheRemove.html" title="INKCacheRemove">
+<link rel="next" href="INKVConnCacheObjectSizeGet.html" title="INKVConnCacheObjectSizeGet">
+<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>
+</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>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKCacheRemove.html">Prev</a> — INKCacheRemove</div>
+<div class="navnext">INKVConnCacheObjectSizeGet — <a accesskey="n" href="INKVConnCacheObjectSizeGet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKCacheKeyPinnedSet"></a>INKCacheKeyPinnedSet</h3></div></div></div>
+<p>Pins the document corresponding to the specified key in the
+        cache so that the garbage collection process will not delete the
+        document from the cache for the specified number of seconds.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">INKReturnCode INKCacheKeyPinnedSet (INKCacheKey
+              <em class="replaceable"><code>key</code></em>, time_t
+              <em class="replaceable"><code>pin_in_cache</code></em>)</code></p></dd>
+<dt><span class="term">Arguments</span></dt>
+<dd>
+<p>INKCacheKey <code class="code"><em class="replaceable"><code>key</code></em></code> is
+              the cache key for the document to be pinned.</p>
+<p><code class="code">time_t
+              <em class="replaceable"><code>pin_in_cache</code></em></code> represents the
+              number of seconds the document is to be pinned in the
+              cache.</p>
+</dd>
+<dt><span class="term">Description</span></dt>
+<dd>
+<p>Pins the document corresponding to the specified
+              <code class="code"><em class="replaceable"><code>key</code></em></code> in the cache for the
+              specified number of seconds specified in
+              <code class="code"><em class="replaceable"><code>pin_in_cache</code></em></code>. Once the
+              document is pinned, the garbage collection will not delete this
+              document from the specifed number of seconds and the document
+              can even persist across Traffic Server re-runs. However, after
+              the <code class="code"><em class="replaceable"><code>pin_in_cache</code></em></code>
+              interval has expired, the cache may delete the document at any
+              time in order to reclaim space.</p>
+<p>To delete this document before the
+              <code class="code">pin_in_cache</code> interval expires, call the
+              <code class="function">INKCacheRemove</code>() function with the
+              document’s cache key.</p>
+<p><code class="methodname">InkCacheKeyPinnedSet()</code> should be
+              used after a key is created and before writing the document to
+              cache using I<code class="methodname">NKCacheWrite()</code>.</p>
+<p>By default, a document is not pinned in the cache and so
+              can be garbage collected at anytime.</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>It is important that the
+                <code class="filename">records.config</code> variable
+                <code class="varname">proxy.config.cache.permit.pinning</code> be set to
+                1 in <code class="filename">records.config</code> to enable
+                pinning.</p></td></tr>
+</table></div>
+</dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the specified object was
+              successfully pinned in the cache.</p>
+<p><code class="code">INK_ERROR</code> if the pin could not be set or is
+              invalid.</p>
+</dd>
+<dt><span class="term">First Release</span></dt>
+<dd><p>Traffic Server 5.2</p></dd>
+</dl></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyPinnedSet.html
------------------------------------------------------------------------------
    svn:keywords = Id



Mime
View raw message