trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dia...@apache.org
Subject svn commit: r935051 - /incubator/trafficserver/site/trunk/docs/v2/sdk/
Date Fri, 16 Apr 2010 19:29:38 GMT
Author: dianes
Date: Fri Apr 16 19:29:38 2010
New Revision: 935051

URL: http://svn.apache.org/viewvc?rev=935051&view=rev
Log:
ts-233 and some minor edits & formatting

Modified:
    incubator/trafficserver/site/trunk/docs/v2/sdk/ContinuationFunctions.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/INKContCreate.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/INKContDataGet.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/INKContDataSet.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/INKContDestroy.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/INKContMutexGet.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/INKMutexLock.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/INKMutexLockTry.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/INKMutexUnlock.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/MutexFunctions.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/MutexGuide.html

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/ContinuationFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/ContinuationFunctions.html?rev=935051&r1=935050&r2=935051&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/ContinuationFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/ContinuationFunctions.html Fri Apr 16 19:29:38
2010
@@ -13,7 +13,19 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="ContinuationFunctions"></a>Continuation Functions</h2></div></div></div>
-<p></p>
+
+
+<ul><b>
+<li><a href="ContinuationFunctions.html#INKContCall">INKContCall</a></li>
+<li><a href="INKContCreate.html">INKContCreate</a></li>
+<li><a href="INKContDataGet.html">INKContDataGet</a></li>
+<li><a href="INKContDataSet.html">INKContDataSet</a></li>
+<li><a href="INKContDestroy.html">INKContDestroy</a></li>
+<li><a href="INKContMutexGet.html">INKContMutexGet</a></li>
+<li><a href="INKContSchedule.html">INKContSchedule</a> </li>
+</b>
+</ul>
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="INKContCall"></a>INKContCall</h3></div></div></div>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/INKContCreate.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/INKContCreate.html?rev=935051&r1=935050&r2=935051&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/INKContCreate.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/INKContCreate.html Fri Apr 16 19:29:38
2010
@@ -5,7 +5,7 @@
 <!--#include file="top.html" -->
 <div class="navheader">
 <div class="navprev">
-<a accesskey="p" href="ContinuationFunctions.html">Prev</a> - Continuation Functions</div>
+<a accesskey="p" href="ContinuationFunctions.html">Prev</a> - Continuation Functions:
 INKContCall</div>
 <div class="navnext">INKContDataGet - <a accesskey="n" href="INKContDataGet.html">Next</a>
 </div>
 </div>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/INKContDataGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/INKContDataGet.html?rev=935051&r1=935050&r2=935051&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/INKContDataGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/INKContDataGet.html Fri Apr 16 19:29:38
2010
@@ -26,7 +26,7 @@
               is up to the plugin to allocate/deallocate the pointer.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p>The pointer on the data for continuation <code class="code">contp</code>.
</p>
+<p>The pointer on the data for continuation <code class="code"> <em class="replaceable"><code>
contp</code></em></code>. </p>
 <p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
 </dd>
 </dl></div>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/INKContDataSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/INKContDataSet.html?rev=935051&r1=935050&r2=935051&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/INKContDataSet.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/INKContDataSet.html Fri Apr 16 19:29:38
2010
@@ -22,8 +22,8 @@
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
   <p>Sets the data pointer of
-              <code class="code"><em class="replaceable"><code>contp </code></em></code>
to
-              <code class="code"><em class="replaceable"><code>data</code></em></code>.
The data can later
+              <code class="code"><em class="replaceable"><code> contp </code></em></code>
to
+              <code class="code"><em class="replaceable"><code> data</code></em></code>.
The data can later
               be retrieved by a call to
               <code class="function">INKContDataGet</code>.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/INKContDestroy.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/INKContDestroy.html?rev=935051&r1=935050&r2=935051&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/INKContDestroy.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/INKContDestroy.html Fri Apr 16 19:29:38
2010
@@ -21,12 +21,12 @@
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
   <p>Destroys the continuation
-              <code class="code"><em class="replaceable"><code>contp</code></em></code>.
+              <code class="code"><em class="replaceable"><code> contp</code></em></code>.
               <code class="function">INKContDestroy</code> is used to destroy
both
-              continuations and  <a href="IOGuide.html#Vconnections" title="Vconnections">vconnections</a>.
The internal continuation data
-              structures are destroyed, but it's not guaranteed
-              that there are no outstanding references to this
-              continuation.</p></dd>
+              continuations and  <a href="IOGuide.html#Vconnections" title="Vconnections">vconnections</a>.
Although the internal continuation data
+              structures are destroyed,  it cannot be guaranteed
+              that there are no outstanding references to the destroyed 
+      continuation.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the continuation is

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/INKContMutexGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/INKContMutexGet.html?rev=935051&r1=935050&r2=935051&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/INKContMutexGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/INKContMutexGet.html Fri Apr 16 19:29:38
2010
@@ -21,7 +21,7 @@
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
   <p>Gets the mutex for the continuation 
-              <code class="code"><em class="replaceable"><code>contp</code></em></code>.</p></dd>
+              <code class="code"><em class="replaceable"><code> contp</code></em></code>.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>A handle to the mutex for the specified

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/INKMutexLock.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/INKMutexLock.html?rev=935051&r1=935050&r2=935051&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/INKMutexLock.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/INKMutexLock.html Fri Apr 16 19:29:38 2010
@@ -24,11 +24,14 @@
               <code class="code"><em class="replaceable"><code>mutexp</code></em></code>.
If
               <code class="code"><em class="replaceable"><code>mutexp </code></em></code>
is already locked,
               then <code class="function">INKMutexLock</code>  blocks until the
-              mutex is unlocked. An <code class="function">INKMutex</code> will
be
-              recursively locked if <code class="function">INKMutexLock</code>
is
-              called on the same mutex twice from the same thread. Thus,  
-              the following example will succeed and not block on the second
-              call to <code class="function">INKMutexLock</code>.</p></dd>
+              mutex is unlocked. </p></dd>
+<dd>
+  <p>An <code class="function">INKMutex</code> will be
+    recursively locked if <code class="function">INKMutexLock</code> is
+    called on the same mutex twice from the same thread. Thus,  
+    the following example will succeed and not block on the second
+    call to <code class="function">INKMutexLock</code>.</p>
+</dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the mutex is successfully

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/INKMutexLockTry.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/INKMutexLockTry.html?rev=935051&r1=935050&r2=935051&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/INKMutexLockTry.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/INKMutexLockTry.html Fri Apr 16 19:29:38
2010
@@ -33,9 +33,8 @@
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p>If the mutex was successfully locked, then <code>1</code> is 
-              returned.</p>
-<p>If mutex is already locked, then <code>0</code> is returned.</p>
+<p><code>1</code> if the mutex is successfully locked.</p>
+<p><code>0</code> if the mutex is already locked.</p>
 </dd>
 <dt><span class="term"><a name="INKEvent_2"></a><b>Example</b></span></dt>
 <dd>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/INKMutexUnlock.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/INKMutexUnlock.html?rev=935051&r1=935050&r2=935051&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/INKMutexUnlock.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/INKMutexUnlock.html Fri Apr 16 19:29:38
2010
@@ -21,8 +21,8 @@
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
   <p>Unlocks the <code class="function">INKMutex </code>
-              <code class="code"><em class="replaceable"><code>mutexp</code></em></code>.
If
-              <code class="code"><em class="replaceable"><code>mutexp </code></em></code>
was recursively
+              <code class="code"><em class="replaceable"><code> mutexp</code></em></code>.
If
+              <code class="code"><em class="replaceable"><code> mutexp
</code></em></code> was recursively
               locked, then <code class="function">INKMutexUnlock</code> does
not
               actually unlock the mutex - it simply decrements the recursion
               count.</p></dd>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/MutexFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/MutexFunctions.html?rev=935051&r1=935050&r2=935051&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/MutexFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/MutexFunctions.html Fri Apr 16 19:29:38
2010
@@ -13,7 +13,16 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="MutexFunctions"></a>Mutex Functions</h2></div></div></div>
-<p></p>
+
+
+<ul><b>
+<li><a href="MutexFunctions.html#INKMutexCreate">INKMutexCreate</a></li>
+<li><a href="INKMutexLock.html">INKMutexLock</a></li>
+<li><a href="INKMutexLockTry.html">INKMutexLockTry</a></li>
+<li><a href="INKMutexUnlock.html">INKMutexUnlock</a></li>
+</b>
+</ul>
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="INKMutexCreate"></a>INKMutexCreate</h3></div></div></div>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/MutexGuide.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/MutexGuide.html?rev=935051&r1=935050&r2=935051&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/MutexGuide.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/MutexGuide.html Fri Apr 16 19:29:38 2010
@@ -13,25 +13,25 @@
 <div class="chapter" lang="en">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="MutexGuide"></a>Chapter 11. Mutex Guide</h2></div></div></div>
-<div class="toc">
-<p><b>Table of Contents</b></p>
-<dl>
-<dt><span class="section"><a href="MutexGuide.html#Mutexes">Mutexes</a></span></dt>
-<dd><dl>
-<dt><span class="section"><a href="MutexGuide.html#LockingGlobalData">Locking
Global Data</a></span></dt>
-<dt><span class="section"><a href="MutexGuide.html#ProtectContinuationData">Protecting
a Continuation's Data</a></span></dt>
-<dt><span class="section"><a href="MutexGuide.html#AssocContinuationToHTTPTx">How
to Associate a Continuation to Every HTTP
-        Transaction</a></span></dt>
-<dt><span class="section"><a href="MutexGuide.html#AddNewContinuation">How
to Add the New Continuation</a></span></dt>
-<dt><span class="section"><a href="MutexGuide.html#StoreDataSpecificHTTPTx">How
to Store Data Specific to Each HTTP Transaction</a></span></dt>
-<dt><span class="section"><a href="MutexGuide.html#UsingLocks">Using Locks</a></span></dt>
-<dt><span class="section"><a href="MutexGuide.html#ContinuationsCreatedHTTPTx">Special
Case: Continuations Created for HTTP
-        Transactions</a></span></dt>
-</dl></dd>
-</dl>
-</div>
 <p>Mutexes are used to lock shared data. This chapter explains how to use
     the mutex interface.</p>
+<ul>
+<li><a href="MutexGuide.html#Mutexes"><b>Mutexes</b></a></li>
+
+<li><b><a href="MutexGuide.html#LockingGlobalData">Locking Global Data</a></span></dt>
+</b>
+<li><b><a href="MutexGuide.html#ProtectContinuationData">Protecting a Continuation's
Data</a></b></li>
+<li><b><a href="MutexGuide.html#AssocContinuationToHTTPTx">How to Associate
a Continuation With Every HTTP
+        Transaction</a></b></li>
+<li><b><a href="MutexGuide.html#AddNewContinuation">How to Add the New
Continuation</a></b></li>
+<li><b><a href="MutexGuide.html#StoreDataSpecificHTTPTx">How to Store Data
Specific to Each HTTP Transaction</a></b></li>
+<li><b><a href="MutexGuide.html#UsingLocks">Using Locks</a></b></li>
+<li><b><a href="MutexGuide.html#ContinuationsCreatedHTTPTx">Special Case:
Continuations Created for HTTP
+        Transactions</a></b></li>
+</ul>
+
+
+    </div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="Mutexes"></a>Mutexes<a class="indexterm" name="id385032"></a></h2></div></div></div>
@@ -41,36 +41,36 @@
       thread.</p>
 <p><a class="indexterm" name="id385054"></a>The Traffic Server API provides
two functions that attempt
       to access and lock the data: <code class="function">InkMutexLockTry</code>
and
-      <code class="function">INKMutexLock</code>. <code class="function">INKMutexLock</code>
is
-      a blocking call; if you use it, you can slow Traffic Server performance
-      (transaction processing pauses until the mutex is unlocked). It should
+      <code class="function">INKMutexLock</code>. <code class="function"><b>INKMutexLock</b></code>
is
+      a blocking call - if you use it, you can slow Traffic Server performance
+      because transaction processing pauses until the mutex is unlocked. It should
       be used only on threads created by the plugin      <code class="function">INKContThreadCreate</code>.
Never use it on a
       continuation handler called back by the Cache, Net, or Event
       Processor. Even if the critical section is very small, do not use it. If
       you need to update a flag, then set a variable and/or use atomic operations. If
       <code class="function">INKMutexLock</code> is used in any case other than
the one
-      recommended above, then the result will cause serious performance impact.      </p>
-<p><code class="function">INKMutexLockTry</code>, on the other hand, attempts
to
+      recommended above, then the result will be a serious performance impact.      </p>
+<p><code class="function"><b>INKMutexLockTry</b></code>, on
the other hand, attempts to
   lock the mutex only if it is unlocked (i.e., not being used by another
   thread). It should be used in all cases other than the above mentioned
   <code class="function">INKMutexLock</code> case. If the
   <code class="function">INKMutexLockTry</code> attempt fails, then you can schedule
a
   future attempt (which must be at least 10 milliseconds later). </p>
 <p>In general, you should  use
-      <code class="code">INKMutexLockTry</code> rather than
+      <code class="code">INKMutexLockTry</code> instead of 
       <code class="code">INKMutexLock</code>.</p>
 <div class="itemizedlist"><ul type="disc">
 <li>
   <p><code class="function">InkMutexLockTry</code> is required if you are
           tying to lock Traffic Server internal or system resources (such as
-          the network, cache, eventProcessor, HTTP state machines, and IO
+          the network, cache, event processor, HTTP state machines, and IO
           buffers).</p></li>
 <li>
   <p><code class="function">InkMutexLockTry</code> is required if you are
-          making any blocking calls m(such as network, cache, or file IO
+          making any blocking calls (such as network, cache, or file IO
           calls).</p></li>
 <li>
-  <p><code class="function">INKMutexLock</code> might <i>not</i>
be necessary if
+  <p><code class="function">INKMutexLock</code> might <u>not</u>
be necessary if
           you are not making blocking calls and if you are only accessing
         local resources.</p></li>
 </ul></div>
@@ -84,11 +84,11 @@
 <a name="LockingGlobalData"></a>Locking Global Data</h3></div></div></div>
 <p>The <code class="filename">blacklist-1.c</code> sample plugin implements
          a mutex that locks global data. The blacklist plugin reads its blacklisted
-        sites from a configuration fille; file read operations are protected by
+        sites from a configuration file; file read operations are protected by
         a mutex created in <code class="filename">INKPluginInit</code>. The
         <code class="filename">blacklist-1.c</code> code uses
         <code class="filename">INKMutexLockTry</code> instead of
-        <code class="filename">InkMutexLock</code>. For more detailed information,
see the <a href="App_SampleSourceCode.html#Sample_blacklist-1.c" title="blacklist-1.c"><code>blacklist-1.c</code></a>
<code class="filename"></code> code - start  by looking at the <a href="InitializationFunctions.html#INKPluginInit"
title="INKPluginInit"><code class="code">INKPluginInit</code></a> function.
       </p>
+        <code class="filename">InkMutexLock</code>. For more detailed information,
see the <a href="App_SampleSourceCode.html#Sample_blacklist-1.c" title="blacklist-1.c"><code>blacklist-1.c</code></a>
<code class="filename"></code> code; start  by looking at the <a href="InitializationFunctions.html#INKPluginInit"
title="INKPluginInit"><code class="code">INKPluginInit</code></a> function.
       </p>
 <p>General guidelines for locking shared data are as follows:</p>
 <div class="orderedlist"><ol type="1">
 <li>
@@ -106,7 +106,7 @@
 <div class="titlepage"><div><div><h3 class="title">
 <a name="ProtectContinuationData"></a>Protecting a Continuation's Data</h3></div></div></div>
 <p>You must create a mutex to protect a continuation's data if
-        it might be accessed by other continuations or processes.</p>
+        it might be accessed by other continuations or processes. Here's how:</p>
 <div class="orderedlist"><ol type="1">
 <li>
 <p>Create a mutex for the continuation using
@@ -115,21 +115,22 @@
 mutexp = INKMutexCreate ();</pre>
 </li>
 <li>
-<p>When you create the continuation, specify this mutex as the
-            continuation's mutex. <br /> For example:</p>
+When you create the continuation, specify this mutex as the
+            continuation's mutex. <br /> For example:
 <pre class="programlisting">INKCont contp;
 contp = INKContCreate (handler, mutexp);</pre>
 </li>
 </ol></div>
 <p>If any other functions want to access <code>contp</code>'s data, then
it is up to
-        them to get <code>contp</code>'s mutex (using, for example, <code
class="function">INKContMutexGet</code>) to lock it (see the sample
-        Protocol plugin for usage).</p>
+        them to get <code>contp</code>'s mutex (using, for example, <code
class="function">INKContMutexGet</code>) to lock it. For usage, ssee the sample
+        Protocol plugin.</p>
 </div>
 <div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="AssocContinuationToHTTPTx"></a>How to Associate a Continuation to Every
HTTP
+<div class="titlepage"><div><div>
+  <h3 class="title">
+<a name="AssocContinuationToHTTPTx"></a>How to Associate a Continuation With
Every HTTP
         Transaction</h3></div></div></div>
-<p>There could be several reasons you'd want to create a continuation for each
+<p>There could be several reasons why you'd want to create a continuation for each
         HTTP transaction that calls back your plugin. <br /> 
         Some potential scenarios
         are listed below.</p>
@@ -141,7 +142,7 @@ contp = INKContCreate (handler, mutexp);
   <p>You want to  store data specific to each HTTP transaction that you might
             need to reuse across various hooks.</p></li>
 <li>You're  using APIs (like <code class="function">INKHostLookup</code>)
that
-          will call back this continuation with a certain event.</li>
+          will call back the continuation with a certain event.</li>
 </ul></div>
 </div>
 <div class="section" lang="en">
@@ -150,7 +151,7 @@ contp = INKContCreate (handler, mutexp);
 <p>A typical way of adding the new continuation is by registering the
         plugin continuation to be called back by HTTP transactions globally
         when they reach <code class="code">INK_HTTP_TXN_START_HOOK</code>. Refer
to the
-        example below, which uses a transaction specific continuation called
+        example below, which uses a transaction-specific continuation called
         <code class="code">txn_contp</code>.</p>
 <pre class="programlisting">   void INKPluginInit(int argc, const char *argv[]) 
      { 
@@ -196,7 +197,7 @@ LOG_ERROR("INKHttpHookAdd"); 
          return 0; 
      }</pre>
 <p>Remember that  the <code class="code">txn_contp</code> handler must
destory itself when the HTTP transaction is
-      closed. If you forget, then your plugin will have a  memory leak.</p>
+      closed. If you forget to do this, then your plugin will have a  memory leak.</p>
 <pre class="programlisting">static int txn_cont_handler(INKCont txn_contp, INKEvent
event, void *edata) 
      { 
          INKHttpTxn txnp; 
@@ -226,7 +227,7 @@ LOG_ERROR("INKHttpHookAdd"); 
 <pre class="programlisting">   typedef struct { 
          int state; 
      } ContData;</pre>
-<p>You would need to allocate the memory and initialize this
+<p>You  need to allocate the memory and initialize this
         structure for each HTTP <code>txnp</code>. You can do that in the plugin
         continuation handler when it is called back with <code class="code">INK_EVENT_HTTP_TXN_START</code></p>
 <pre class="programlisting">static int plugin_cont_handler(INKCont contp, INKEvent
event, void *edata) 
@@ -311,9 +312,9 @@ static int txn_cont_handler(INKCont txn_
         itself to be called back by HTTP hooks and it only uses the HTTP APIs.
         In the example above, the continuation <code class="code">txn_contp</code>
has
         registered itself to be called back at HTTP hooks and it only uses
-        the HTTP APIs. In this case only, it is safe to access data shared
+        the HTTP APIs. In this case only, it's safe to access data shared
         between <code class="code">txnp</code> and <code class="code">txn_contp</code>
without grabbing
-        a lock. In the example above <code class="code">txn_contp</code> is created
with a
+        a lock. In the example above, <code class="code">txn_contp</code> is
created with a
         <code class="code">NULL</code> mutex. This works because the HTTP transaction
         <code class="code">txnp</code> is the only one that will call back
         <code class="code">txn_contp</code>, and you are guaranteed that
@@ -329,17 +330,17 @@ static int txn_cont_handler(INKCont txn_
         you need to ensure that <code class="code">txn_contp</code> will not
be called back by
         both <code class="code">txnp</code> and  the cache processor at the same
time,
         since this will result in a situation wherein you're executing two pieces
-        of code in conflict!</p>
+        of code in conflict.</p>
 </div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="ContinuationsCreatedHTTPTx"></a>Special Case: Continuations Created
for HTTP
         Transactions</h3></div></div></div>
 <p>If your plugin creates a new continuation for each HTTP
-        transaction, then you probably do not have to create a new mutex for it
+        transaction, then you probably don't need to create a new mutex for it
         because each HTTP transaction (<code class="code">INKHttpTxn</code> object)
already
         has its own mutex.</p>
-<p>In the  example below, it is not necessary  to specify a mutex for the continuation
created in
+<p>In the  example below, it's not necessary  to specify a mutex for the continuation
created in
         <code class="code">txn_handler</code>:</p>
 <pre class="programlisting">static void
 txn_handler (INKHttpTxn txnp, INKCont contp) {
@@ -368,9 +369,9 @@ test_plugin (INKCont contp, INKEvent eve
 }</pre>
 <p>The mutex functions are listed below:</p>
 <div class="itemizedlist"><ul type="disc">
-<li><p><a href="MutexFunctions.html#INKMutexCreate" title="INKMutexCreate">INKMutexCreate</a></p></li>
-<li><p><a href="INKMutexLock.html" title="INKMutexLock">INKMutexLock</a></p></li>
-<li><p><a href="INKMutexLockTry.html" title="INKMutexLockTry">INKMutexLockTry</a></p></li>
+<li><a href="MutexFunctions.html#INKMutexCreate" title="INKMutexCreate"><code>INKMutexCreate</code></a></li>
+<li><code><a href="INKMutexLock.html" title="INKMutexLock">INKMutexLock</a></code></li>
+<li><code><a href="INKMutexLockTry.html" title="INKMutexLockTry">INKMutexLockTry</a></code></li>
 </ul></div>
 </div>
 </div>



Mime
View raw message