trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dia...@apache.org
Subject svn commit: r936059 - in /incubator/trafficserver/site/trunk/docs/v2/sdk: App_DeprecatedFunctions.html Dep_IOBufferInterface.html Dep_MutexFunctions.html OtherDeprecatedFunctions.html
Date Tue, 20 Apr 2010 20:59:36 GMT
Author: dianes
Date: Tue Apr 20 20:59:35 2010
New Revision: 936059

URL: http://svn.apache.org/viewvc?rev=936059&view=rev
Log:
ts-299

Modified:
    incubator/trafficserver/site/trunk/docs/v2/sdk/App_DeprecatedFunctions.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/Dep_IOBufferInterface.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/Dep_MutexFunctions.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/OtherDeprecatedFunctions.html

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/App_DeprecatedFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/App_DeprecatedFunctions.html?rev=936059&r1=936058&r2=936059&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/App_DeprecatedFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/App_DeprecatedFunctions.html Tue Apr 20
20:59:35 2010
@@ -6,19 +6,65 @@
 <div class="navheader">
 <div class="navprev">
 <a accesskey="p" href="App_SampleSourceCode.html">Prev</a> - Appendix A. Sample
Source Code</div>
-<div class="navnext">Other Deprecated Functions - <a accesskey="n" href="OtherDeprecatedFunctions.html">Next</a>
+<div class="navnext">Other Deprecated Functions:  Statistics Fxns - <a accesskey="n"
href="OtherDeprecatedFunctions.html">Next</a>
 </div>
 </div>
 <div id="toc"></div>
 <div class="appendix" lang="en">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="App_DeprecatedFunctions"></a>Appendix B. Deprecated Functions</h2></div></div></div>
-<p>This appendix lists the functions that will be deprecated in current and future
versions of Traffic Server.</p>
+<p>This appendix lists the functions that are deprecated in current and all subsequent
versions of Traffic Server.</p>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="DepMimeHdrFunctions"></a>Deprecated MIME Header Functions</h2></div></div></div>
-<p>The following MIME field functions are deprecated in the current SDK
-      version.</p>
+
+
+<ul><b>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldCopy">INKMimeFieldCopy</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldCopyValues">INKMimeFieldCopyValues</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldCreate">INKMimeFieldCreate</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldDestroy">INKMimeFieldDestroy</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldLengthGet">INKMimeFieldLengthGet</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldNameGet">INKMimeFieldNameGet</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldNameSet">INKMimeFieldNameSet</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldNext">INKMimeFieldNext</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueAppend">INKMimeFieldValueAppend</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueDelete">INKMimeFieldValueDelete</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueGet">INKMimeFieldValueGet</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueGetDate">INKMimeFieldValueGetDate</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueGetInt">INKMimeFieldValueGetInt</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueGetUint">INKMimeFieldValueGetUint</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueInsertDate">INKMimeFieldValueInsertDate</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueInsertInt">INKMimeFieldValueInsertInt</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueInsertUint">INKMimeFieldValueInsertUint</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValuesClear">INKMimeFieldValuesClear</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValuesCount">INKMimeFieldValuesCount</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueSet">INKMimeFieldValueSet</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueSetDate">INKMimeFieldValueSetDate</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueSetInt">INKMimeFieldValueSetInt</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueSetUint">INKMimeFieldValueSetUint</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueGet">INKMimeHdrFieldValueGet</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueGetDate">INKMimeHdrFieldValueGetDate</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueGetInt">INKMimeHdrFieldValueGetInt</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueGetUInt">INKMimeHdrFieldValueGetUInt</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueInsert">INKMimeHdrFieldValueInsert</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueInsertDate">INKMimeHdrFieldValueInsertDate</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueInsertInt">INKMimeHdrFieldValueInsertInt</a></li>
+
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueInsertUInt">INKMimeHdrFieldValueInsertUInt</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueSet">INKMimeHdrFieldValueSet</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueSetDate">INKMimeHdrFieldValueSetDate</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueSetInt">INKMimeHdrFieldValueSetInt</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueSetUInt">INKMimeHdrFieldValueSetUInt</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldDelete">INKMimeHdrFieldDelete</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldInsert">INKMimeHdrFieldInsert</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldRetrieve">INKMimeHdrFieldRetrieve</a></li>
+
+
+
+</b>
+</ul>
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="INKMimeFieldCopy"></a>INKMimeFieldCopy</h3></div></div></div>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/Dep_IOBufferInterface.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/Dep_IOBufferInterface.html?rev=936059&r1=936058&r2=936059&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/Dep_IOBufferInterface.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/Dep_IOBufferInterface.html Tue Apr 20 20:59:35
2010
@@ -5,26 +5,32 @@
 <!--#include file="top.html" -->
 <div class="navheader">
 <div class="navprev">
-<a accesskey="p" href="OtherDeprecatedFunctions.html">Prev</a> - Other Deprecated
Functions</div>
-<div class="navnext">Mutex Function - <a accesskey="n" href="Dep_MutexFunctions.html">Next</a>
+<a accesskey="p" href="OtherDeprecatedFunctions.html">Prev</a> - Other Deprecated
Functions:  Deprecated Statistics Fxns</div>
+<div class="navnext">Deprecated Mutex Functions - <a accesskey="n" href="Dep_MutexFunctions.html">Next</a>
 </div>
 </div>
 <div id="toc"></div>
 <div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="Dep_IOBufferInterface"></a>IO Buffer Interface</h3></div></div></div>
-<p></p>
+<div class="titlepage"><div><div>
+  <h3 class="title">
+<a name="Dep_IOBufferInterface"></a>Deprecated IO Buffer Interface Functions</h3></div></div></div>
+<ul><b>
+<li><a href="Dep_IOBufferInterface.html#INKIOBufferAppend">INKIOBufferAppend</a></li>
+<li><a href="Dep_IOBufferInterface.html#INKIOBufferBlockCreate">INKIOBufferBlockCreate</a></li>
+<li><a href="Dep_IOBufferInterface.html#INKIOBufferDataCreate">INKIOBufferDataCreate</a></li>
+</b>
+</ul>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKIOBufferAppend"></a>INKIOBufferAppend</h4></div></div></div>
 <p>Appends to an IO buffer.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code>INKReturnCode INKIOBufferAppend (INKIOBuffer bufp,
-                INKIOBufferBlock blockp)</code></p></dd>
+<dd><p><code>INKReturnCode INKIOBufferAppend (INKIOBuffer <span class="replaceable">bufp</span>,
+        INKIOBufferBlock <span class="replaceable">blockp</span>)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
-<dd><p>Appends a block to the IO buffer <code>bufp</code>. The data
in the
-                appended block is made available for reading.</p></dd>
+<dd><p>Appends a block to the IO buffer <code class="replaceable"> bufp</code>.
The data in the
+        appended block is made available for reading.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code>INK_SUCCESS</code> if the block was successfully appended to
@@ -47,19 +53,29 @@
 <dd>
   <p>Creates a new IO buffer block and initializes it with
                 the IO buffer data 
-                <code class="code"><em class="replaceable"><code>datap</code></em></code>.
The
-                <code class="code"><em class="replaceable"><code>size </code></em></code>
parameter is the
-                amount of data initially available for reading in this
-                new buffer block. The
-                <code class="code"><em class="replaceable"><code>offset
</code></em></code> parameter is
-                the offset into <code class="code"><em class="replaceable"><code>
datap </code></em></code>
-                 that will be used as the start for the block. The two
-                common uses for <code class="function">INKIOBufferBlockCreate</code>
-                are to create an empty block (by specifying size as 0) and to
-                create a full block (by specifying size as the total size of <code class="code"><em
class="replaceable"><code>datap</code></em></code>). The newly-created
block should be added
-                almost immediately to an IO buffer by a call to <code class="function">INKIOBufferAppend</code>,
since there is no
-                function for destroying a buffer block other than  simply relying 
-                on its automatic  destruction by an IO buffer.</p></dd>
+                <code class="code"><em class="replaceable"><code> datap</code></em></code>.
</p></dd>
+<dd>
+  <p>The <code class="code"><em class="replaceable"><code> size </code></em></code>
parameter is the
+    amount of data initially available for reading in this
+    new buffer block. </p>
+</dd>
+<dd>
+  <p>The <code class="code"><em class="replaceable"><code>offset
</code></em></code> parameter is
+    the offset into <code class="code"><em class="replaceable"><code> datap
</code></em></code>
+    that will be used as the start for the block. </p>
+</dd>
+<dd>
+  <p>Two
+     common uses for <code class="function">INKIOBufferBlockCreate</code>
+    are to create an empty block (by specifying size as <code>0</code>) and to
+    create a full block (by specifying <code class="code"><em class="replaceable"><code>size
</code></em></code> as the total size of <code class="code"><em
class="replaceable"><code>datap</code></em></code>). </p>
+</dd>
+<dd>
+  <p>The newly-created block should be added
+    almost immediately to an IO buffer by a call to <code class="function">INKIOBufferAppend</code>,
since there is no
+    function for destroying a buffer block other than  simply relying 
+    on its automatic  destruction by an IO buffer.</p>
+</dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
   <p>The newly-created IO buffer block.</p></dd>
@@ -77,27 +93,24 @@
                 <em class="replaceable"><code>flags</code></em>)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>Creates a new IO buffer data and initialize it with 
-                <code class="code"><em class="replaceable"><code>data</code></em></code>,
+<p>Creates  new IO buffer data and initializes it with 
+                <code class="code"><em class="replaceable"><code> data</code></em></code>,

                 <code class="code"><em class="replaceable"><code> size</code></em></code>.
The
                 <code class="code"><em class="replaceable"><code>flags
</code></em></code> parameter
-                specifies how to interpret data.</p>
-<p><code class="code">INK_DATA_ALLOCATE</code> </p>
-<p>The data pointer is <code class="code">NULL</code> and the data
+                specifies how to interpret the data:</p>
+<li><code class="code"><b>INK_DATA_ALLOCATE</b></code></li>
+  <p>The data pointer is <code class="code">NULL</code> and the data
                 associated with the <code class="function">INKIOBufferData</code>
                 should be allocated.
                 <code class="function">INKIOBufferDataCreate</code> rounds size
to a
-                power of 2 less than or equal to 32K.</p>
-<p><code class="code">INK_DATA_MALLOCED</code></p>
-<p>The data pointer was allocated by
+                power of 2 less than or equal to 32K.</p><li><code class="code"><b>INK_DATA_MALLOCED</b></code></li>
+  <p>The data pointer was allocated by
                 <code class="function">INKmalloc</code> and will be freed when
the last
                 reference to the new <code class="function">INKIOBufferData</code>
is
-                released by a call to <code class="function">INKfree</code>.</p>
-<p><code class="code">INK_DATA_CONSTANT</code></p>
-<p>The data pointer is data that should not be freed when
+                released by a call to <code class="function">INKfree</code>.</p><li><code
class="code"><b>INK_DATA_CONSTANT</b></code></li>
+  <p>The data pointer is data that should not be freed when
                 the last reference to the new
-                <code class="function">INKIOBufferData</code> is released.</p>
-</dd>
+                <code class="function">INKIOBufferData</code> is released.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
   <p>A handle to the newly-created IO buffer.</p></dd>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/Dep_MutexFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/Dep_MutexFunctions.html?rev=936059&r1=936058&r2=936059&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/Dep_MutexFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/Dep_MutexFunctions.html Tue Apr 20 20:59:35
2010
@@ -5,19 +5,24 @@
 <!--#include file="top.html" -->
 <div class="navheader">
 <div class="navprev">
-<a accesskey="p" href="Dep_IOBufferInterface.html">Prev</a> - IO Buffer Interface</div>
+<a accesskey="p" href="Dep_IOBufferInterface.html">Prev</a> - Deprecated IO Buffer
Interface Functions</div>
 <div class="navnext">Appendix C. Troubleshooting Tips - <a accesskey="n" href="App_Troubleshooting.html">Next</a>
 </div>
 </div>
 <div id="toc"></div>
 <div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="Dep_MutexFunctions"></a>Mutex Function</h3></div></div></div>
-<p></p>
+<div class="titlepage"><div><div>
+  <h3 class="title">
+<a name="Dep_MutexFunctions"></a>Deprecated Mutex Functions</h3></div></div></div>
+<ul><b>
+<li><a href="Dep_MutexFunctions.html#INKMutexTryLock">INKMutexTryLock</a></li>
+</b>
+</ul>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKMutexTryLock">INKMutexTryLock</a></h4></div></div></div>
-<p>Tries to lock an <code class="code">INKMutex</code>.</p>
+<p>Tries to lock an <code class="code">INKMutex</code>. This API has been
replaced by
+    <code class="code">INKMutexLockTry</code>.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">INKReturnCode InkMutexTryLock (INKMutex
@@ -26,22 +31,21 @@
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Tries to lock the <code class="code">INKMutex</code> mutex.</p>
-<p>In general, use <code class="code">InkMutexTryLock</code> to obtain
a
-                mutex (see the example below).</p>
-<p>This API has been deprecated by
-                <code class="code">INKMutexLockTry</code>.</p>
+<p>In general, you should use <code class="code">InkMutexTryLock</code>
(or rather, <code>INKMutexLockTry</code>) to obtain a
+                mutex. See the example below.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p>If the mutex was successfully locked, then 1 is
+<p>If the mutex was successfully locked, then <code>1</code> is
                 returned.</p>
-<p>If mutex is already locked, then 0 is
+<p>If the mutex is already locked, then <code>0</code> is
                 returned.</p>
 </dd>
 <dt><span class="term"><b>Example</b></span></dt>
-<dd><pre class="programlisting">int handler (INKCont contp, INKEvent event, void
*edata)
+<dd>
+  <pre class="programlisting">int handler (INKCont contp, INKEvent event, void *edata)
 {
-   //this continuation tries to grab a mutex
+   //This continuation tries to grab a mutex.
    int lock = InkMutexTryLock (mutex);
    if (!lock)
    {
@@ -50,7 +54,7 @@
       return INK_EVENT_IMMEDIATE;
    }
 
-   // Now the mutex is grabbed
+   // Now the mutex is grabbed.
    do_some_job ...
    INKMutexUnlock (mutexp);
 }</pre></dd>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/OtherDeprecatedFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/OtherDeprecatedFunctions.html?rev=936059&r1=936058&r2=936059&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/OtherDeprecatedFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/OtherDeprecatedFunctions.html Tue Apr 20
20:59:35 2010
@@ -5,15 +5,40 @@
 <!--#include file="top.html" -->
 <div class="navheader">
 <div class="navprev">
-<a accesskey="p" href="App_DeprecatedFunctions.html">Prev</a> - Appendix B. Deprecated
Functions</div>
-<div class="navnext">IO Buffer Interface - <a accesskey="n" href="Dep_IOBufferInterface.html">Next</a>
+<a accesskey="p" href="App_DeprecatedFunctions.html">Prev</a> - Appendix B. Deprecated
Fxns - MIME Header Fxns</div>
+<div class="navnext">Deprecated IO Buffer Interface Fxns- <a accesskey="n" href="Dep_IOBufferInterface.html">Next</a>
 </div>
 </div>
 <div id="toc"></div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="OtherDeprecatedFunctions"></a>Other Deprecated Functions</h2></div></div></div>
-<p></p>
+<p><b>Table Of Contents</b></p>
+
+<ul><b>
+  <li><a href="OtherDeprecatedFunctions.html#Dep_StatisticFunctions">Statistics
Functions</a></li>
+<ul>
+<li><a href="OtherDeprecatedFunctions.html#INKStatFloatRead">INKStatFloatRead</a></li>
+<li><a href="OtherDeprecatedFunctions.html#INKStatIntRead">INKStatIntRead</a></li>
+</ul>
+
+<li><a href="Dep_IOBufferInterface.html"> IO Buffer Interface Functions</a></li>
+<ul>
+<li><a href="Dep_IOBufferInterface.html#INKIOBufferAppend">INKIOBufferAppend</a></li>
+<li><a href="Dep_IOBufferInterface.html#INKIOBufferBlockCreate">INKIOBufferBlockCreate</a></li>
+  <li><a href="Dep_IOBufferInterface.html#INKIOBufferDataCreate">INKIOBufferDataCreate</a></li>

+  </ul>
+
+
+
+<li><a href="Dep_MutexFunctions.html"> Mutex Functions</a></li>
+<ul>
+  <li><a href="Dep_MutexFunctions.html#INKMutexTryLock">INKMutexTryLock</a></li>
+  </ul>
+</b>
+</ul>
+
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div>
   <h3 class="title">
@@ -29,28 +54,26 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKStatFloatRead"></a>INKStatFloatRead</h4></div></div></div>
-<p>Obtains the value of a float statistic.</p>
+<p>Obtains the value of a float statistic. This API has been succeeded by
+      <code class="function">INKStatFloatGet</code>.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
 <dd>
 <p><code class="code">float INKStatFloat(INKStat
                 <em class="replaceable"><code>the_stat</code></em>
)</code></p>
-<p>This API has been deprecated by
-                <code class="function">INKStatFloatGet</code>.</p>
 </dd>
 </dl></div>
 </div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKStatIntRead"></a>INKStatIntRead</h4></div></div></div>
-<p>Obtains the value of an integer statistic.</p>
+<p>Obtains the value of an integer statistic. This API has been succeeded by
+      <code class="function">INKStatIntGet</code>.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
 <dd>
 <p><code class="code">INK64 INKStatIntRead(INKStat
                 <em class="replaceable"><code>the_stat</code></em>
)</code></p>
-<p>This API has been deprecated by
-                <code class="function">INKStatIntGet</code>.</p>
 </dd>
 </dl></div>
 </div>



Mime
View raw message