trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dia...@apache.org
Subject svn commit: r931330 - /incubator/trafficserver/site/trunk/docs/v2/sdk/
Date Tue, 06 Apr 2010 21:09:59 GMT
Author: dianes
Date: Tue Apr  6 21:09:59 2010
New Revision: 931330

URL: http://svn.apache.org/viewvc?rev=931330&view=rev
Log:
Edits, plus work for ts-233 and some nav reorg fallout

Modified:
    incubator/trafficserver/site/trunk/docs/v2/sdk/CoupledStatsFunctions.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/CustInstallLicenseFunctions.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/INKMgmtFloatGet.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/INKMgmtIntGet.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/INKMgmtStringGet.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/INKPluginDirGet.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/StatisticsFunctions.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/TEConfigReadFunctions.html

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/CoupledStatsFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/CoupledStatsFunctions.html?rev=931330&r1=931329&r2=931330&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/CoupledStatsFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/CoupledStatsFunctions.html Tue Apr  6 21:09:59
2010
@@ -5,19 +5,32 @@
 <!--#include file="top.html" -->
 <div class="navheader">
 <div class="navprev">
-<a accesskey="p" href="StatisticsFunctions.html">Prev</a> - Statistics Functions</div>
+<a accesskey="p" href="StatisticsFunctions.html">Prev</a> - Uncoupled Statistics
Functions</div>
 <div class="navnext">Logging Functions - <a accesskey="n" href="LoggingFunctions.html">Next</a>
 </div>
 </div>
 <div id="toc"></div>
 <div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="CoupledStatsFunctions"></a>Coupled Statistics</h3></div></div></div>
-<p></p>
+<div class="titlepage"><div><div>
+  <h3 class="title">
+<a name="CoupledStatsFunctions"></a>Coupled Statistics Functions</h3></div></div></div>
+
+
+<b>
+<ul>
+<li><a href="CoupledStatsFunctions.html#INKStatCoupledGlobalAdd">INKStatCoupledGlobalAdd</a></li>
+<li><a href="CoupledStatsFunctions.html#INKStatCoupledGlobalCategoryCreate">INKStatCoupledGlobalCategoryCreate</a></li>
+<li><a href="CoupledStatsFunctions.html#INKStatCoupledLocalAdd">INKStatCoupledLocalAdd</a></li>
+<li><a href="CoupledStatsFunctions.html#INKStatCoupledLocalCopyCreate">INKStatCoupledLocalCopyCreate</a></li>
+<li><a href="CoupledStatsFunctions.html#INKStatCoupledLocalCopyDestroy">INKStatCoupledLocalCopyDestroy</a></li>
+<li><a href="CoupledStatsFunctions.html#INKStatsCoupledUpdate">INKStatsCoupledUpdate</a></li>
+</ul>
+</b>
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKStatCoupledGlobalAdd"></a>INKStatCoupledGlobalAdd</h4></div></div></div>
-<p>.Creates a global coupled stat.</p>
+<p>.Creates a global coupled statistic.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">INKStat INKStatCoupledGlobalAdd (INKCoupledStat
@@ -27,100 +40,105 @@
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p><code class="code"><em class="replaceable"><code>global_copy </code></em></code>
is
-                the name of the global coupled stat category to which your new
-                coupled stat belongs.</p>
+                the name of the global coupled statistics category to which your new
+                coupled statistic belongs.</p>
 <p><code class="code"><em class="replaceable"><code>the_name </code></em></code>
is the
                 name you use to view the statistic using Traffic Line (see
                 <a href="ViewStatsUsingTrafLine.html" title="Viewing Statistics Using
Traffic Line">Viewing Statistics Using Traffic Line)</a>. There are two
                 <code class="function">INKStatTypes</code>:
-                <code class="code">INKSTAT_TYPE_INT64</code>, and
+                <code class="code">INKSTAT_TYPE_INT64</code>  and
                 <code class="code">INKSTAT_TYPE_FLOAT</code>  (see <a href="CoupledStatistics.html#AddCoupledStats">How
to Add Coupled Statistics</a>).</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>A handle to the newly-created global coupled
-                stat.</p>
+                statistic.</p>
 <p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
 </dd>
 </dl></div>
 </div>
+
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="INKStatCoupledLocalAdd"></a>INKStatCoupledLocalAdd</h4></div></div></div>
-<p>Creates a local copy of a global coupled stat.</p>
+<a name="INKStatCoupledGlobalCategoryCreate"></a>INKStatCoupledGlobalCategoryCreate</h4></div></div></div>
+<p>Creates a global coupled statistics category.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">INKStat INKStatCoupledLocalAdd (INKCoupledStat
-                <em class="replaceable"><code>local_copy</code></em>
, const char *
-                <em class="replaceable"><code>the_name</code></em>
, INKStatTypes
-                <em class="replaceable"><code>the_type</code></em>
)</code></p></dd>
+<dd><p><code class="code">INKCoupledStat INKStatCoupledGlobalCategoryCreate
+                ( const char * <em class="replaceable"><code>the_name</code></em>
+                )</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p><code class="code"><em class="replaceable"><code>local_copy </code></em></code>
is
-                the name of the local coupled stat category to which your new
-                coupled stat belongs.</p>
-<p><code class="code"><em class="replaceable"><code>the_name </code></em></code>
is the
-                name you use to view the statistic using Traffic Line (see
-                <a href="ViewStatsUsingTrafLine.html" title="Viewing Statistics Using
Traffic Line">Viewing Statistics Using Traffic Line</a>). There are two
-                <code class="function">INKStatTypes</code>:
-                <code class="code">INKSTAT_TYPE_INT64</code>, and
-                <code class="code">INKSTAT_TYPE_FLOAT</code> (see <a href="CoupledStatistics.html#AddCoupledStats">To
Add Coupled Statistics</a>).</p>
+<p>Returns a new global coupled statistics category; use this
+                function in <code class="function">INKPluginInit</code>. The
name
+                argument is the name you use to access this statistic in Traffic
+                Line. For more information, see <a href="ViewStatsUsingTrafLine.html"
title="Viewing Statistics Using Traffic Line">Viewing Statistics Using Traffic Line</a>
and <a href="CoupledStatistics.html#AddCoupledStats">How to Add Coupled Statistics</a>.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p>A handle to a local copy of the global coupled
-                stat.</p>
+<p>A handle to a the newly-created global coupled statistics
+                category.</p>
 <p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
 </dd>
 </dl></div>
 </div>
+
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="INKStatCoupledGlobalCategoryCreate"></a>INKStatCoupledGlobalCategoryCreate</h4></div></div></div>
-<p>Creates a global coupled stat category.</p>
+<a name="INKStatCoupledLocalAdd"></a>INKStatCoupledLocalAdd</h4></div></div></div>
+<p>Creates a local copy of a global coupled statistic.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">INKCoupledStat INKStatCoupledGlobalCategoryCreate
-                ( const char * <em class="replaceable"><code>the_name</code></em>
-                )</code></p></dd>
+<dd><p><code class="code">INKStat INKStatCoupledLocalAdd (INKCoupledStat
+                <em class="replaceable"><code>local_copy</code></em>,
const char *
+                <em class="replaceable"><code>the_name</code></em>,
INKStatTypes
+                <em class="replaceable"><code>the_type</code></em>
)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>Returns a new global coupled stat category; use this
-                function in <code class="function">INKPluginInit</code>. The
name
-                argument is the name you use to access this stat in Traffic
-                Line (see <a href="ViewStatsUsingTrafLine.html" title="Viewing Statistics
Using Traffic Line">Viewing Statistics Using Traffic Line</a> and <a href="CoupledStatistics.html#AddCoupledStats">To
Add Coupled Statistics</a>).</p>
+<p><code class="code"><em class="replaceable"><code>local_copy </code></em></code>
is
+                the name of the local coupled stat category to which your new
+                coupled stat belongs.</p>
+<p><code class="code"><em class="replaceable"><code>the_name </code></em></code>
is the
+                name you use to view the statistic using Traffic Line (see
+                <a href="ViewStatsUsingTrafLine.html" title="Viewing Statistics Using
Traffic Line">Viewing Statistics Using Traffic Line</a>). There are two
+                <code class="function">INKStatTypes</code>:
+                <code class="code">INKSTAT_TYPE_INT64</code>  and
+                <code class="code">INKSTAT_TYPE_FLOAT</code> (see <a href="CoupledStatistics.html#AddCoupledStats">How
to Add Coupled Statistics</a>).</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p>A handle to a the newly-created global coupled stat
-                category.</p>
+<p>A handle to a local copy of the global coupled
+                statistic.</p>
 <p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
 </dd>
 </dl></div>
 </div>
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKStatCoupledLocalCopyCreate"></a>INKStatCoupledLocalCopyCreate</h4></div></div></div>
-<p>.Creates a local copy of a global coupled stat
+<p>.Creates a local copy of a global coupled statistics
           category.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">INKCoupledStat INKStatCoupledLocalCopyCreate
(
-                const char * <em class="replaceable"><code>the_name</code></em>
,
+<dd>
+  <p><code class="code">INKCoupledStat INKStatCoupledLocalCopyCreate (const char
* <em class="replaceable"><code>the_name</code></em>,
                 INKCoupledStat
                 <em class="replaceable"><code>global_copy</code></em>)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>Returns a new local coupled stat category; use this
+<p>Returns a new local coupled statistics category; use this
                 function in any routine where you need to modify local copies
                 of global statistics. The name argument is the name you use to
-                access this stat in Traffic Line (see <a href="ViewStatsUsingTrafLine.html"
title="Viewing Statistics Using Traffic Line">Viewing Statistics Using Traffic Line</a>
and <a href="CoupledStatistics.html#AddCoupledStats">How to Add Coupled Statistics</a>).</p>
+                access this statistic in Traffic Line. For additional information, see <a
href="ViewStatsUsingTrafLine.html" title="Viewing Statistics Using Traffic Line">Viewing
Statistics Using Traffic Line</a> and <a href="CoupledStatistics.html#AddCoupledStats">How
to Add Coupled Statistics</a>.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p>A handle to the local copy of the global coupled stat
+<p>A handle to the local copy of the global coupled statistics
                 category.</p>
-<p><code class="code">INK_ERROR_PTR</code></p>
+<p><code class="code">INK_ERROR_PTR</code> if  an error occurs.</p>
 </dd>
 </dl></div>
 </div>
@@ -156,9 +174,9 @@
                 <em class="replaceable"><code>local_copy</code></em>)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-  <p>Updates all of the coupled stats belonging to the
+  <p>Updates all of the coupled statistics belonging to the
                 category <code class="code"><em class="replaceable"><code>local_copy</code></em></code>.
-        See <a href="CoupledStatistics.html#AddCoupledStats">How to Add Coupled Statistics</a>.</p></dd>
+        For further information, see <a href="CoupledStatistics.html#AddCoupledStats">How
to Add Coupled Statistics</a>.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the operation completes

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/CustInstallLicenseFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/CustInstallLicenseFunctions.html?rev=931330&r1=931329&r2=931330&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/CustInstallLicenseFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/CustInstallLicenseFunctions.html Tue Apr
 6 21:09:59 2010
@@ -13,14 +13,23 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="CustInstallLicenseFunctions"></a>Customer Installation and Licensing
Functions</h2></div></div></div>
-<p></p>
+
+
+<ul><b>
+<li><a href="CustInstallLicenseFunctions.html#INKInstallDirGet">INKInstallDirGet</a></li>
+<li><a href="INKPluginDirGet.html">INKPluginDirGet</a></li>
+<li><a href="INKPluginLicenseRequired.html">INKPluginLicenseRequired</a></li>
+</b>
+</ul>
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="INKInstallDirGet"></a>INKInstallDirGet</h3></div></div></div>
 <p>Gets the Traffic Server install directory.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">const char * INKInstallDirGet(void)</code></p></dd>
+<dd>
+  <p><code class="code">const char *INKInstallDirGet(void)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
   <p>Gets the Traffic Server installation directory.</p></dd>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/INKMgmtFloatGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/INKMgmtFloatGet.html?rev=931330&r1=931329&r2=931330&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/INKMgmtFloatGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/INKMgmtFloatGet.html Tue Apr  6 21:09:59
2010
@@ -5,7 +5,7 @@
 <!--#include file="top.html" -->
 <div class="navheader">
 <div class="navprev">
-<a accesskey="p" href="TEConfigReadFunctions.html">Prev</a> - Traffic Server
Configuration Read Functions</div>
+<a accesskey="p" href="TEConfigReadFunctions.html">Prev</a> - Configuration Read
Functions</div>
 <div class="navnext">INKMgmtIntGet - <a accesskey="n" href="INKMgmtIntGet.html">Next</a>
 </div>
 </div>
@@ -22,7 +22,7 @@
 <dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
 <p><code class="replaceable"><i>var_name </i></code> is the
name of the variable you want
-              from <code class="filename">records.config</code>.</p>
+              from the <code class="filename">records.config</code> file.</p>
 <p><code class="replaceable"><i>result </i></code> is a pointer
to the value of the
               variable, which is of type
               <code class="function">INKMgmtFloat</code>.</p>
@@ -38,7 +38,7 @@
   <p>If <code class="function">INKMgmtFloatGet</code> cannot get the
               variable, then it returns zero. </p></dd>
 <dd>
-  <p>If successful, then a nonzero value
+  <p>If it is successful, then a nonzero value
     is returned.</p>
 </dd>
 </dl>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/INKMgmtIntGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/INKMgmtIntGet.html?rev=931330&r1=931329&r2=931330&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/INKMgmtIntGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/INKMgmtIntGet.html Tue Apr  6 21:09:59
2010
@@ -17,12 +17,12 @@
         <code class="code">int</code>.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">int INKMgmtIntGet (const char *<i>var_name</i>,
INKMgmtInt
-              *<i>result</i>)</code></p></dd>
+<dd><p><code class="code">int INKMgmtIntGet (const char *<i class="replaceable">var_name</i>,
INKMgmtInt
+      *<i class="replaceable">result</i>)</code></p></dd>
 <dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
 <p><code class="replaceable"><i>var_name </i></code> is the
name of the variable you want
-              from <code class="filename">records.config</code>.</p>
+              from the <code class="filename">records.config</code> file.</p>
 <p><code class="replaceable"><i>result </i></code> is a pointer
to the variable's value, which is of type <code class="code">INKMgmtInt</code>.</p>
 </dd>
 <dt><span class="term"><b>Description</b></span></dt>
@@ -52,7 +52,7 @@ else INKError ("could not retrieve value
         variable, then zero is returned. </p>
 </dd>
 <dd>
-  <p>If  successful, then it returns a nonzero value.</p>
+  <p>If  it is successful, then it returns a nonzero value.</p>
 </dd>
 </dl>
 </div></div></body>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/INKMgmtStringGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/INKMgmtStringGet.html?rev=931330&r1=931329&r2=931330&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/INKMgmtStringGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/INKMgmtStringGet.html Tue Apr  6 21:09:59
2010
@@ -21,7 +21,7 @@
 <dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
 <p><code class="replaceable"><i>var_name </i></code> is the
name of the variable you want
-              from <code class="filename">records.config</code></p>
+              from the <code class="filename">records.config</code> file.</p>
 <p><code class="replaceable"><i>result </i></code> is a pointer
to the value of the
               variable. This value is of type
               <code class="code">INKMgmtString</code>.</p>
@@ -38,10 +38,10 @@
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-  <p>If <code class="function">INKMgmtStringGet</code> could not get the
+  <p>If <code class="function">INKMgmtStringGet</code> cannot get the
               variable, then it returns zero. </p></dd>
 <dd>
-  <p>If  successful, then a nonzero value
+  <p>If  it is successful, then a nonzero value
     is returned.</p>
 </dd>
 </dl>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/INKPluginDirGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/INKPluginDirGet.html?rev=931330&r1=931329&r2=931330&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/INKPluginDirGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/INKPluginDirGet.html Tue Apr  6 21:09:59
2010
@@ -16,19 +16,20 @@
 <p>Gets the plugin directory.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">const char * INKPluginDirGet(void)</code></p></dd>
+<dd>
+  <p><code class="code">const char *INKPluginDirGet(void)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Gets the plugin directory relative to Traffic Server's
               install directory. This path (relative to the Traffic Server
               install directory) is stored in the
               <code class="filename">records.config</code> variable
-              <code class="varname"><i>proxy.config.plugin.plugin_dir</i></code>.
The default value is <code>config/plugin</code>.</p>
+              <code class="varname"><i> proxy.config.plugin.plugin_dir</i></code>.
The default value is <code>config/plugin</code>.</p>
 </dd>
 <dt><span class="term"><b>Example</b></span></dt>
 <dd>
-<p>To open the file
-              <code class="filename">Blacklist/ui/blacklist_config.txt</code>,
+<p>To open the  
+              <code class="filename">Blacklist/ui/blacklist_config.txt</code>
file,
               use the following:</p>
 <pre class="programlisting">INKfopen ("INKInstallDirGet()/INKPluginDirGet()/Blacklist/ui/blacklist_config.txt");</pre>
 </dd>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/StatisticsFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/StatisticsFunctions.html?rev=931330&r1=931329&r2=931330&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/StatisticsFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/StatisticsFunctions.html Tue Apr  6 21:09:59
2010
@@ -6,53 +6,95 @@
 <div class="navheader">
 <div class="navprev">
 <a accesskey="p" href="INKPluginLicenseRequired.html">Prev</a> - INKPluginLicenseRequired</div>
-<div class="navnext">Coupled Statistics - <a accesskey="n" href="CoupledStatsFunctions.html">Next</a>
+<div class="navnext">Coupled Statistics Functions- <a accesskey="n" href="CoupledStatsFunctions.html">Next</a>
 </div>
 </div>
 <div id="toc"></div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="StatisticsFunctions"></a>Statistics Functions</h2></div></div></div>
+
+
+<ul><b>
+<li><a href="StatisticsFunctions.html#UncoupledStatsFuncs">Uncoupled Statistics
Functions</a></li>
+
+<ul>
+<li><a href="StatisticsFunctions.html#INKStatCreate">INKStatCreate</a></li>
+<li><a href="StatisticsFunctions.html#INKStatDecrement">INKStatDecrement</a></li>
+<li><a href="StatisticsFunctions.html#INKStatFloatAddTo">INKStatFloatAddTo</a></li>
+<li><a href="StatisticsFunctions.html#INKStatFloatGet">INKStatFloatGet</a></li>
+<li><a href="StatisticsFunctions.html#INKStatFloatSet">INKStatFloatSet</a></li>
+<li><a href="StatisticsFunctions.html#INKStatIncrement">INKStatIncrement</a></li>
+<li><a href="StatisticsFunctions.html#INKStatIntAddTo">INKStatIntAddTo</a></li>
+<li><a href="StatisticsFunctions.html#INKStatIntGet">INKStatIntGet</a></li>
+
+<li><a href="StatisticsFunctions.html#INKStatIntSet">INKStatIntSet</a></li>
+</ul>
+
+<li><a href="CoupledStatsFunctions.html#CoupledStatsFunctions">Coupled Statistics
Functions</a></li>
+
+<ul>
+<li><a href="CoupledStatsFunctions.html#INKStatCoupledGlobalAdd">INKStatCoupledGlobalAdd</a></li>
+<li><a href="CoupledStatsFunctions.html#INKStatCoupledGlobalCategoryCreate">INKStatCoupledGlobalCategoryCreate</a></li>
+<li><a href="CoupledStatsFunctions.html#INKStatCoupledLocalAdd">INKStatCoupledLocalAdd</a></li>
+<li><a href="CoupledStatsFunctions.html#INKStatCoupledLocalCopyCreate">INKStatCoupledLocalCopyCreate</a></li>
+<li><a href="CoupledStatsFunctions.html#INKStatCoupledLocalCopyDestroy">INKStatCoupledLocalCopyDestroy</a></li>
+<li><a href="CoupledStatsFunctions.html#INKStatsCoupledUpdate">INKStatsCoupledUpdate</a></li>
+</ul>
+
+</b>
+</ul>
+
+<div class="section" lang="en">
+<div class="titlepage"><div><div>
+  <h3 class="title">
+<a name="UncoupledStatsFuncs"></a>Uncoupled Statistics Functions</h3></div></div></div>
 <p></p>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="UncoupledStatsFuncs"></a>Uncoupled Statistics</h3></div></div></div>
-<p></p>
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="INKStatFloatGet"></a>INKStatFloatGet</h4></div></div></div>
-<p>Obtains the value of a float statistic.</p>
+<a name="INKStatCreate"></a>INKStatCreate</h4></div></div></div>
+<p>Creates a new <code class="code">INKStat</code>.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">INKReturnCode INKStatFloatGet(INKStat
-                <em class="replaceable"><code>stat</code></em>, float
-                *<em class="replaceable"><code>value</code></em>)</code></p></dd>
+<dd><p><code class="code">INKStat INKStatCreate ( const char *
+                <em class="replaceable"><code>the_name</code></em>,
INKStatTypes
+                <em class="replaceable"><code>the_type</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+  <p>Creates a new <code class="code">INKStat</code>. The value pointed
to
+                by <code class="code"><em class="replaceable"><code>the_name
</code></em></code> is the
+                name you use to view the statistic via Traffic Line (see
+                <a href="ViewStatsUsingTrafLine.html" title="Viewing Statistics Using
Traffic Line">Viewing Statistics Using Traffic Line</a>). There are two
+                <code class="code">INKStatTypes</code>: <code class="code">INKSTAT_TYPE_INT64</code>

+                and <code class="code">INKSTAT_TYPE_FLOAT</code>.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p><code class="code">INK_SUCCESS</code> if the API is called
-                successfully.</p>
-<p><code class="code">INK_ERROR</code> if an error occurs while calling
-                the API or if an argument is invalid.</p>
+<p>A handle to the newly-created
+                <code class="code">INKStat</code>.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
 </dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="INKStatIntGet"></a>INKStatIntGet</h4></div></div></div>
-<p>Obtains the value of an integer statistic.</p>
+<a name="INKStatDecrement"></a>INKStatDecrement</h4></div></div></div>
+<p>Decrements a stat.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">INKReturnCode INKStatIntGet(INKStat <span
class="replaceable">stat</span>, INK64
-                *<span class="replaceable">value</span>)</code></p></dd>
+<dd><p><code class="code">INKReturnCode INKStatDecrement(INKStat
+                <em class="replaceable"><code>the_stat</code></em>
)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd><p>Decrements a stat.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p><code class="code">INK_SUCCESS</code> if the API is called
+<p><code class="code">INK_SUCCESS</code> if the operation completes
                 successfully.</p>
-<p><code class="code">INK_ERROR</code> if an error occurs while calling
-                the API or if an argument is invalid.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs.</p>
 </dd>
 </dl></div>
 </div>
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKStatFloatAddTo"></a>INKStatFloatAddTo</h4></div></div></div>
@@ -71,60 +113,61 @@
 </dd>
 </dl></div>
 </div>
+
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="INKStatIntAddTo"></a>INKStatIntAddTo</h4></div></div></div>
-<p>Adds an INK64 value to an integer statistic.</p>
+<a name="INKStatFloatGet"></a>INKStatFloatGet</h4></div></div></div>
+<p>Obtains the value of a float statistic.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">INKReturnCode INKStatIntAddTo ( INKStat <span
class="replaceable">the_stat</span>,
-                INK64 <span class="replaceable">amount</span>)</code></p></dd>
-<dt><span class="term"><b>Description</b></span></dt>
-<dd>
-  <p>Adds an <code>INK64</code> value to an integer statistic.</p></dd>
+<dd><p><code class="code">INKReturnCode INKStatFloatGet(INKStat
+                <em class="replaceable"><code>stat</code></em>, float
+                *<em class="replaceable"><code>value</code></em>)</code></p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p><code class="code">INK_SUCCESS</code> if the operation completes
+<p><code class="code">INK_SUCCESS</code> if the API is called
                 successfully.</p>
-<p><code class="code">INK_ERROR</code> if an error occurs.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs while calling
+                the API or if an argument is invalid.</p>
 </dd>
 </dl></div>
 </div>
+
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="INKStatCreate"></a>INKStatCreate</h4></div></div></div>
-<p>Creates a new <code class="code">INKStat</code>.</p>
+<a name="INKStatFloatSet"></a>INKStatFloatSet</h4></div></div></div>
+<p>Sets the value of a float statistic to a particular value.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">INKStat INKStatCreate ( const char *
-                <em class="replaceable"><code>the_name</code></em>,
INKStatTypes
-                <em class="replaceable"><code>the_type</code></em>)</code></p></dd>
+<dd><p><code class="code">INKReturnCode INKStatFloatSet(INKStat
+                <em class="replaceable"><code>the_stat</code></em>,
float
+                <em class="replaceable"><code>the_value</code></em>
)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
-<dd>
-  <p>Creates a new <code class="code">INKStat</code>. The value pointed
to
-                by <code class="code"><em class="replaceable"><code>the_name
</code></em></code> is the
-                name you use to view the statistic using Traffic Line (see
-                <a href="ViewStatsUsingTrafLine.html" title="Viewing Statistics Using
Traffic Line">Viewing Statistics Using Traffic Line</a>). There are two
-                <code class="code">INKStatTypes</code>: <code class="code">INKSTAT_TYPE_INT64</code>

-                and <code class="code">INKSTAT_TYPE_FLOAT</code>.</p></dd>
+<dd><p>Sets the value of a float stat to the specified
+                value.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p>A handle to the newly-created
-                <code class="code">INKStat</code>.</p>
-<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
+<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>
 </dl></div>
 </div>
+
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="INKStatDecrement"></a>INKStatDecrement</h4></div></div></div>
-<p>Decrements a stat.</p>
+<a name="INKStatIncrement"></a>INKStatIncrement</h4></div></div></div>
+<p>Increments a statistic.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">INKReturnCode INKStatDecrement(INKStat
+<dd><p><code class="code">INKReturnCode INKStatIncrement(INKStat
                 <em class="replaceable"><code>the_stat</code></em>
)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
-<dd><p>Decrements a stat.</p></dd>
+<dd>
+  <p>Increments a statistic.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the operation completes
@@ -133,17 +176,19 @@
 </dd>
 </dl></div>
 </div>
+
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="INKStatIncrement"></a>INKStatIncrement</h4></div></div></div>
-<p>Increments a stat.</p>
+<a name="INKStatIntAddTo"></a>INKStatIntAddTo</h4></div></div></div>
+<p>Adds an <code>INK64</code> value to an integer statistic.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">INKReturnCode INKStatIncrement(INKStat
-                <em class="replaceable"><code>the_stat</code></em>
)</code></p></dd>
+<dd><p><code class="code">INKReturnCode INKStatIntAddTo ( INKStat <span
class="replaceable">the_stat</span>,
+                INK64 <span class="replaceable">amount</span>)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-  <p>Increments a statistic.</p></dd>
+  <p>Adds an <code>INK64</code> value to an integer statistic.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the operation completes
@@ -152,30 +197,34 @@
 </dd>
 </dl></div>
 </div>
+
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="INKStatFloatSet"></a>INKStatFloatSet</h4></div></div></div>
-<p>Sets the value of a float stat to a particular value.</p>
+<a name="INKStatIntGet"></a>INKStatIntGet</h4></div></div></div>
+<p>Obtains the value of an integer statistic.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">INKReturnCode INKStatFloatSet(INKStat
-                <em class="replaceable"><code>the_stat</code></em>,
float
-                <em class="replaceable"><code>the_value</code></em>
)</code></p></dd>
-<dt><span class="term"><b>Description</b></span></dt>
-<dd><p>Sets the value of a float stat to the specified
-                value.</p></dd>
+<dd><p><code class="code">INKReturnCode INKStatIntGet(INKStat <span
class="replaceable">stat</span>, INK64
+                *<span class="replaceable">value</span>)</code></p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p><code class="code">INK_SUCCESS</code> if the operation completes
+<p><code class="code">INK_SUCCESS</code> if the API is called
                 successfully.</p>
-<p><code class="code">INK_ERROR</code> if an error occurs.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs while calling
+                the API or if an argument is invalid.</p>
 </dd>
 </dl></div>
 </div>
+
+
+
+
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKStatIntSet"></a>INKStatIntSet</h4></div></div></div>
-<p>Sets the value of an integer stat to a particular
+<p>Sets the value of an integer statistic to a particular
           value.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
@@ -183,7 +232,8 @@
                 <em class="replaceable"><code>the_stat</code></em>,
INK64
                 <em class="replaceable"><code>the_value</code></em>
)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
-<dd><p>Sets the value of a integer stat to a particular
+<dd>
+  <p>Sets the value of a integer statistic to the specified 
                 value.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/TEConfigReadFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/TEConfigReadFunctions.html?rev=931330&r1=931329&r2=931330&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/TEConfigReadFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/TEConfigReadFunctions.html Tue Apr  6 21:09:59
2010
@@ -12,8 +12,18 @@
 <div id="toc"></div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title">
-<a name="TEConfigReadFunctions"></a>Traffic Server Configuration Read Functions</h2></div></div></div>
-<p></p>
+<a name="TEConfigReadFunctions"></a>Configuration Read Functions</h2></div></div></div>
+
+
+<ul><b>
+<li><a href="TEConfigReadFunctions.html#INKMgmtCounterGet">INKMgmtCounterGet</a></li>
+<li><a href="INKMgmtFloatGet.html">INKMgmtFloatGet</a></li>
+<li><a href="INKMgmtIntGet.html">INKMgmtIntGet</a></li>
+<li><a href="INKMgmtStringGet.html">INKMgmtStringGet</a></li>
+
+</b>
+</ul>
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="INKMgmtCounterGet"></a>INKMgmtCounterGet</h3></div></div></div>
@@ -27,8 +37,8 @@
 <dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
 <p><code class="code"><em class="replaceable"><code>var_name </code></em></code>
is the
-              name of the variable you want from
-              <code class="filename">records.config</code>.</p>
+              name of the variable you want from the 
+              <code class="filename">records.config</code> file.</p>
 <p><code class="code"><em class="replaceable"><code>result </code></em></code>
is a
               pointer to the value of the variable; this value is of type
               <code class="function">INKMgmtCounter</code>.</p>
@@ -41,7 +51,7 @@
               <code class="code"><em class="replaceable"><code>result</code></em></code>.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-  <p>If <code class="function">INKMgmtCounterGet</code> could not get
+  <p>If <code class="function">INKMgmtCounterGet</code> cannot get
               the variable, then it returns zero. </p></dd>
 <dd>
   <p>If <code class="function">INKMgmtCounterGet</code> is successful,
then a nonzero value is



Mime
View raw message