trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From andrew...@apache.org
Subject svn commit: r831152 [8/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/AddingHooks.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/AddingHooks.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/AddingHooks.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/AddingHooks.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,229 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Adding Hooks</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="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks
and Transactions">
+<link rel="next" href="HTTPSessions.html" title="HTTP Sessions">
+<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="HTTPHooksAndTransactions.html">Prev</a> — Chapter 8. HTTP
Hooks and Transactions</div>
+<div class="navnext">HTTP Sessions — <a accesskey="n" href="HTTPSessions.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="AddingHooks"></a>Adding Hooks</h2></div></div></div>
+<p>There are several ways of adding hooks to your plugin.</p>
+<div class="itemizedlist"><ul type="disc">
+<li>
+<p>global HTTP hooks<a class="indexterm" name="id378262"></a></p>
+<p>HTTP transaction hooks are set on a global basis using the
+          function <code class="code">INKHttpHookAdd</code>. This means that
the
+          continuation specified as the parameter to
+          <code class="code">INKHttpHookAdd</code> is called for every transaction.
+          <code class="code">INKHttpHookAdd</code> must be used in
+          <code class="code">INKPluginInit</code>.</p>
+</li>
+<li>
+<p>transaction hooks</p>
+<p>Transaction hooks can be used to call plugins back for a
+          specific HTTP transaction. You cannot add transaction hooks in
+          <code class="code">INKPluginInit</code>; you first need a handle to
a
+          transaction. See <a href="AccessingTransactionProc.html" title="Accessing the
Transaction Being Processed">“Accessing the Transaction Being Processed”</a>.</p>
+</li>
+<li>
+<p>transformation hooks</p>
+<p>Transformation hooks are a special case of transaction hooks.
+          See <a href="INKVConnCacheObjectSizeGet.html" title="INKVConnCacheObjectSizeGet">“INKVConnCacheObjectSizeGet”</a>
for more
+          information on the transformation hooks. You add a transformation
+          hook using <code class="code">INKHttpTxnHookAdd</code>, described in
<a href="HTTP_Transactions.html" title="HTTP Transactions">“HTTP Transactions”</a>.</p>
+</li>
+<li>
+<p>session hooks</p>
+<p>An HTTP session starts when a client opens a connection to
+          Traffic Server and ends when the connection closes. A session can
+          consist of several transactions. Session hooks allow you to hook
+          your plugin to a particular point in every transaction within a
+          specified session. See <a href="HTTPSessions.html" title="HTTP Sessions">“HTTP
Sessions”</a>. Session
+          hooks are added in a manner similar to transaction hooks (you first
+          need a handle to an HTTP session).</p>
+</li>
+<li>
+<p>HTTP select alternate hook</p>
+<p>Alternate selection hooks allow you to hook on to the
+          alternate selection state. These hooks must be added globally, since
+          Traffic Server does not have a handle to a transaction or session
+          when alternate selection is taking place. See <a href="HTTPAlternateSelection.html"
title="HTTP Alternate Selection">“HTTP Alternate Selection”</a> for information
on the alternate
+          selection mechanism.</p>
+</li>
+</ul></div>
+<p>All of the hook addition functions (<a href="HTTPFunctions.html#INKHttpHookAdd"
title="INKHttpHookAdd"><code class="code">INKHttpHookAdd</code></a>,
<a href="HTTPSessionFunctions.html#INKHttpSsnHookAdd" title="INKHttpSsnHookAdd"><code
class="code">INKHttpSsnHookAdd</code></a>, <a href="HTTPSessionFunctions.html#INKHttpSsnReenable"
title="INKHttpSsnReenable"><code class="code">INKHttpSsnReenable</code></a>)take
+      an <code class="code">INKHttpHookID</code> identifying the hook to add
on to and an
+      <code class="code">INKCont</code> which is the basic callback mechanism
in Traffic
+      Server. A single INKCont can be added to any number of hooks at a given
+      time.</p>
+<p>An HTTP hook is identified by the enumerated type
+      <code class="code">INKHttpHookID</code>. The values for <code class="code">INKHttpHookID</code>
+      are:</p>
+<table frame="box" id="Tbl_INKHttpHookIDValues" rules="all">
+<caption>Table 8.1. INKHttpHookID Values</caption>
+<thead><tr align="center">
+            <th rowspan="1" colspan="1"><span class="bold"><strong>Values
for INKHttpHookID</strong></span></th>
+
+            <th rowspan="1" colspan="1"><span class="bold"><strong>Description</strong></span></th>
+          </tr></thead>
+<tbody>
+<tr>
+            <td rowspan="1" colspan="1">INK_HTTP_READ_REQUEST_HDR_HOOK</td>
+
+            <td rowspan="1" colspan="1">Called immediately after the request header
is read from the
+            client. Corresponds to the event
+            <code class="code">INK_EVENT_HTTP_READ_REQUEST_HDR</code>.</td>
+          </tr>
+<tr>
+            <td rowspan="1" colspan="1">INK_HTTP_OS_DNS_HOOK</td>
+
+            <td rowspan="1" colspan="1">Called immediately after the HTTP state machine
has completed
+            a DNS lookup of the origin server. The HTTP state machine will
+            know the origin server's IP address at this point which is useful
+            for performing both authentication and blacklisting. Corresponds
+            to the event <code class="code">INK_EVENT_HTTP_OS_DNS</code>.</td>
+          </tr>
+<tr>
+            <td rowspan="1" colspan="1">INK_HTTP_SEND_REQUEST_HDR_HOOK</td>
+
+            <td rowspan="1" colspan="1">Called immediately before the proxy's request
header is sent
+            to the origin server or the parent proxy. Notice that this hook
+            will not be called if the document is being served from cache.
+            This hook is usually used for modifying the proxy's request header
+            before it is sent to the origin server or parent proxy.</td>
+          </tr>
+<tr>
+            <td rowspan="1" colspan="1">INK_HTTP_READ_CACHE_HDR_HOOK</td>
+
+            <td rowspan="1" colspan="1">Called immediately after the request and response
header of a
+            previously cached object is read from cache. Notice that this hook
+            will only be called if the document is being served from cache.
+            Corresponds to the event
+            <code class="code">INK_EVENT_HTTP_READ_CACHE_HDR</code>.</td>
+          </tr>
+<tr>
+            <td rowspan="1" colspan="1">INK_HTTP_READ_RESPONSE_HDR_HOOK</td>
+
+            <td rowspan="1" colspan="1">Called immediately after the response header
is read from the
+            origin server or parent proxy. Corresponds to the event
+            <code class="code">INK_EVENT_HTTP_READ_RESPONSE_HDR</code>.</td>
+          </tr>
+<tr>
+            <td rowspan="1" colspan="1">INK_HTTP_SEND_RESPONSE_HDR_HOOK</td>
+
+            <td rowspan="1" colspan="1">Called immediately before the proxy's response
header is
+            written to the client. This hook is usually used for modifying the
+            response header. Corresponds to the event
+            <code class="code">INK_EVENT_HTTP_SEND_RESPONSE_HDR</code>.</td>
+          </tr>
+<tr>
+            <td rowspan="1" colspan="1">INK_HTTP_REQUEST_TRANSFORM_HOOK</td>
+
+            <td rowspan="1" colspan="1">See<a href="HTTPTransformationPlugins.html#Transformations"
title="Transformations">“Transformations”</a> for information on the
+            transformation hooks.</td>
+          </tr>
+<tr>
+            <td rowspan="1" colspan="1">INK_HTTP_RESPONSE_TRANSFORM_HOOK</td>
+
+            <td rowspan="1" colspan="1">See “<a href="HTTPTransformationPlugins.html#Transformations"
title="Transformations">“Transformations”</a> for information on the
+            transformation hooks.</td>
+          </tr>
+<tr>
+            <td rowspan="1" colspan="1">INK_HTTP_TXN_START_HOOK</td>
+
+            <td rowspan="1" colspan="1">Called when an HTTP transaction is started.
A transaction
+            starts when either a client connects to Traffic Server and data is
+            available on the connection or a previous client connection left
+            open for keep alive has ne w data available.</td>
+          </tr>
+<tr>
+            <td rowspan="1" colspan="1">INK_HTTP_TXN_CLOSE_HOOK</td>
+
+            <td rowspan="1" colspan="1">Called when an HTTP transaction ends.</td>
+          </tr>
+<tr>
+            <td rowspan="1" colspan="1">INK_HTTP_SELECT_ALT_HOOK</td>
+
+            <td rowspan="1" colspan="1">See <a href="HTTPAlternateSelection.html"
title="HTTP Alternate Selection">“HTTP Alternate Selection”</a> for information
+            on the alternate selection mechanism.</td>
+          </tr>
+<tr>
+            <td rowspan="1" colspan="1">INK_HTTP_SSN_START_HOOK</td>
+
+            <td rowspan="1" colspan="1">Called when an HTTP session is started. A session
starts when
+            a client connects to Traffic Server. You can only add this hook as
+            a global hook.</td>
+          </tr>
+<tr>
+            <td rowspan="1" colspan="1">INK_HTTP_SSN_CLOSE_HOOK</td>
+
+            <td rowspan="1" colspan="1">Called when an HTTP session ends. A session
ends when the
+            client connection is closed. You can only add this hook as a
+            global hook</td>
+          </tr>
+<tr>
+            <td rowspan="1" colspan="1">INK_HTTP_CACHE_LOOKUP_COMPLETE_HOOK</td>
+
+            <td rowspan="1" colspan="1">Called once the HTTP state machine has commpleted
the cache
+            lookup for the document requested in the ongoing transaction.
+            Register this hook either using either
+            <code class="code">INKHttpTxnHookAdd</code> or <code class="code">INKHttpHookAdd</code>.
+            Corresponds to the event
+            <code class="code">INK_EVENT_HTTP_CACHE_LOOKUP_COMPLETE</code>.</td>
+          </tr>
+</tbody>
+</table>
+<p>The function you use to add a global HTTP hook is <a href="HTTPFunctions.html#INKHttpHookAdd"
title="INKHttpHookAdd"><code class="code">INKHttpHookAdd</code></a>.</p>
+</div>
+</body>
+</html>

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

Added: incubator/trafficserver/site/trunk/docs/sdk/AddingStatistics.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/AddingStatistics.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/AddingStatistics.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/AddingStatistics.html Thu Oct 29 23:23:25
2009
@@ -0,0 +1,117 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Chapter 17. Adding Statistics</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="LoggingAPI.html" title="Guide to the Logging API">
+<link rel="next" href="CoupledStatistics.html" title="Coupled Statistics">
+<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="AddingStatistics.html#UncoupledStatistics" title="Uncoupled
Statistics">
+<link rel="section" href="CoupledStatistics.html" title="Coupled Statistics">
+<link rel="section" href="ViewStatsUsingTrafLine.html" title="Viewing Statistics Using
Traffic Line">
+<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="LoggingAPI.html">Prev</a> — Guide to the Logging
API</div>
+<div class="navnext">Coupled Statistics — <a accesskey="n" href="CoupledStatistics.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="chapter" lang="en">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="AddingStatistics"></a>Chapter 17. Adding Statistics</h2></div></div></div>
+<div class="toc">
+<p><b>Table of Contents</b></p>
+<dl>
+<dt><span class="section"><a href="AddingStatistics.html#UncoupledStatistics">Uncoupled
Statistics</a></span></dt>
+<dt><span class="section"><a href="CoupledStatistics.html">Coupled Statistics</a></span></dt>
+<dd><dl><dt><span class="section"><a href="CoupledStatistics.html#Examp_redirect-1.c">Example
Using the redirect-1.c Sample Plugin</a></span></dt></dl></dd>
+<dt><span class="section"><a href="ViewStatsUsingTrafLine.html">Viewing
Statistics Using Traffic Line</a></span></dt>
+</dl>
+</div>
+<p>This chapter describes how to add statistics to your plugins.
+    Statistics can be coupled or uncoupled. Coupled statistics are quantities
+    that are related and must be updated together. The Traffic Server API
+    statistics functions add your plugin’s statistics to the Traffic Server
+    statistics system. You can view your plugin statistics as you would any
+    Traffic Server statistic, using Traffic Line (Traffic Server’s command
+    line interface). This chapter contains the following topics:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><a href="AddingStatistics.html#UncoupledStatistics" title="Uncoupled
Statistics">“Uncoupled Statistics”</a></p></li>
+<li><p><a href="CoupledStatistics.html" title="Coupled Statistics">“Coupled
Statistics”</a></p></li>
+<li><p><a href="ViewStatsUsingTrafLine.html" title="Viewing Statistics Using
Traffic Line">“Viewing Statistics Using Traffic Line”</a></p></li>
+</ul></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="UncoupledStatistics"></a>Uncoupled Statistics</h2></div></div></div>
+<p>A statistic is an object of type <code class="code">INKStat</code>.
The value
+      of the statistic is of type <code class="code">INKStatType</code>. The
possible
+      <code class="code">INKStatTypes</code> are:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><code class="code">INKSTAT_TYPE_INT64</code></p></li>
+<li><p><code class="code">INKSTAT_TYPE_FLOAT</code></p></li>
+</ul></div>
+<p>There is <span class="emphasis"><em>no</em></span>
+      <code class="code">INKSTAT_TYPE_INT32</code>.</p>
+<p>To add uncoupled statistics, follow these steps:</p>
+<div class="orderedlist"><ol type="1">
+<li>
+<p>Declare your statistic as a global variable in your plugin.
+          For example:</p>
+<pre class="programlisting">static INKStat my_statistic;</pre>
+</li>
+<li>
+<p>In <code class="function">INKPluginInit</code>, create new statistics
+          using <code class="function">INKStatCreate</code>.</p>
+<p>When you create a new statistic, you need to give it an
+          “external” name that the Traffic Server command line interface
+          (Traffic Line) uses to access the statistic. For example:</p>
+<pre class="programlisting">my_statistic = INKStatCreate (“my.statistic”,
INKSTAT_TYPE_INT64);</pre>
+</li>
+<li><p>Modify (increment, decrement, or other modification) your
+          statistic in plugin functions.</p></li>
+</ol></div>
+</div>
+</div>
+</body>
+</html>

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

Added: incubator/trafficserver/site/trunk/docs/sdk/AlternateSelectionFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/AlternateSelectionFunctions.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/AlternateSelectionFunctions.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/AlternateSelectionFunctions.html Thu Oct 29
23:23:25 2009
@@ -0,0 +1,181 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Alternate Selection 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="InterceptingHTTPTransactionFuncs.html" title="Intercepting HTTP Transaction
Functions">
+<link rel="prev" href="INKHttpTxnServerIntercept.html" title="INKHttpTxnServerIntercept">
+<link rel="next" href="ch18s09s04.html" title="Handle Release Functions">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create
Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based
Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP
Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol
Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP
Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous
Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample
Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated
Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting
Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="subsection" href="AlternateSelectionFunctions.html#INKHttpAltInfoCachedReqGet"
title="INKHttpAltInfoCachedReqGet">
+<link rel="subsection" href="AlternateSelectionFunctions.html#INKHttpAltInfoCachedRespGet"
title="INKHttpAltInfoCachedRespGet">
+<link rel="subsection" href="AlternateSelectionFunctions.html#INKHttpAltInfoClientReqGet"
title="INKHttpAltInfoClientReqGet">
+<link rel="subsection" href="AlternateSelectionFunctions.html#INKHttpAltInfoQualitySet"
title="INKHttpAltInfoQualitySet">
+<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="INKHttpTxnServerIntercept.html">Prev</a> — INKHttpTxnServerIntercept</div>
+<div class="navnext">Handle Release Functions — <a accesskey="n" href="ch18s09s04.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="AlternateSelectionFunctions"></a>Alternate Selection Functions</h3></div></div></div>
+<p></p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="INKHttpAltInfoCachedReqGet"></a>INKHttpAltInfoCachedReqGet</h4></div></div></div>
+<p>Gets the cached request header from the specified alternate
+          information.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">INKReturnCode INKHttpAltInfoCachedReqGet
+                (INKHttpAltInfo <em class="replaceable"><code>infop</code></em>,
INKMBuffer
+                *<em class="replaceable"><code>bufp</code></em>,
INKMLoc
+                *<em class="replaceable"><code>offset</code></em>)</code></p></dd>
+<dt><span class="term">Description</span></dt>
+<dd>
+<p>Retrieves the cached client request header from the
+                alternate information
+                <code class="code"><em class="replaceable"><code>infop</code></em></code>.</p>
+<p>Call from within
+                <code class="code">HTTP_SELECT_ALT_HOOK</code>.</p>
+</dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the operation completes
+                successfully.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs.</p>
+</dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="INKHttpAltInfoCachedRespGet"></a>INKHttpAltInfoCachedRespGet</h4></div></div></div>
+<p>Gets the cached response header from the specified alternate
+          information.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">INKReturnCode INKHttpAltInfoCachedRespGet
+                (INKHttpAltInfo <em class="replaceable"><code>infop</code></em>,
INKMBuffer
+                *<em class="replaceable"><code>bufp</code></em>,
INKMLoc
+                *<em class="replaceable"><code>offset</code></em>)</code></p></dd>
+<dt><span class="term">Description</span></dt>
+<dd>
+<p>Retrieves the cached client response header from the
+                alternate information
+                <code class="code"><em class="replaceable"><code>infop</code></em></code>.</p>
+<p>Call from within
+                <code class="code">HTTP_SELECT_ALT_HOOK</code>.</p>
+</dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the operation completes
+                successfully.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs.</p>
+</dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="INKHttpAltInfoClientReqGet"></a>INKHttpAltInfoClientReqGet</h4></div></div></div>
+<p>Gets the client request header from the specified alternate
+          information.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">INKReturnCode INKHttpAltInfoClientReqGet
+                (INKHttpAltInfo <em class="replaceable"><code>infop</code></em>,
INKMBuffer
+                *<em class="replaceable"><code>bufp</code></em>,
INKMLoc
+                *<em class="replaceable"><code>offset</code></em>)</code></p></dd>
+<dt><span class="term">Description</span></dt>
+<dd>
+<p>Retrieves the client request header from the alternate
+                information
+                <code class="code"><em class="replaceable"><code>infop</code></em></code>.</p>
+<p>Call from within
+                <code class="code">HTTP_SELECT_ALT_HOOK</code>.</p>
+</dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the operation completes
+                successfully.</p>
+<p><code class="code">INK_ERROR</code> if an error occurrs.</p>
+</dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="INKHttpAltInfoQualitySet"></a>INKHttpAltInfoQualitySet</h4></div></div></div>
+<p>Sets the quality value for the specified alternate
+          information.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">INKReturnCode INKHttpAltInfoQualitySet
+                (INKHttpAltInfo <em class="replaceable"><code>infop</code></em>,
float
+                <em class="replaceable"><code>quality</code></em>)</code></p></dd>
+<dt><span class="term">Description</span></dt>
+<dd>
+<p>Sets the quality value for this alternate information
+                <code class="code"><em class="replaceable"><code>infop</code></em></code>.</p>
+<p>Call from within
+                <code class="code">HTTP_SELECT_ALT_HOOK</code>.</p>
+</dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the operation completes
+                successfully.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs.</p>
+</dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+</div>
+</body>
+</html>

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



Mime
View raw message