trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dia...@apache.org
Subject svn commit: r930361 - /incubator/trafficserver/site/trunk/docs/v2/sdk/
Date Fri, 02 Apr 2010 19:47:32 GMT
Author: dianes
Date: Fri Apr  2 19:47:31 2010
New Revision: 930361

URL: http://svn.apache.org/viewvc?rev=930361&view=rev
Log:
Edits & ongoing work that's part of TS-233

Modified:
    incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPHeaders.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPTransactionFunctions.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/INKVIONBytesSet.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/INKVIONTodoGet.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/IOBuffers_IO.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/IOGuide.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/InitializationFunctions.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/Interface_ThreadFunctions.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/ThreadFunctions.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/VIOFunctions.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/VIOs_IO.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/VconnectionFunctions.html

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPHeaders.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPHeaders.html?rev=930361&r1=930360&r2=930361&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPHeaders.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPHeaders.html Fri Apr  2 19:47:31 2010
@@ -15,7 +15,7 @@
 <a name="HTTPHeaders"></a>Chapter 10. HTTP Headers</h2></div></div></div>
 <p>This chapter explains the functions used to manipulate HTTP
     headers.</p>
-<div class="itemizedlist"><ul type="disc">
+<div class="itemizedlist"><ul type="disc"><b>
 <li><a href="HTTPHeaders.html#AboutHTTPHeaders" title="About HTTP Headers">About
HTTP Headers</a></li>
 <li><a href="GuideTSHTTPHdrSyst.html" title="Guide to Traffic Server HTTP Header
System">Guide to Traffic Server HTTP Header System</a></li>
 <ul><li><span class="section"><a href="DuplicateMIMEFlds.html">Duplicate
MIME Fields Are Not Coalesced</a></span></li>
@@ -26,31 +26,30 @@
 <li><a href="MarshalBuffers.html" title="Marshal Buffers">Marshal Buffers</a></li>
 <li><a href="HTTPHeaders2.html" title="HTTP Headers">HTTP Headers</a></li>
 <li><a href="URLs.html" title="URLs">URLs</a></li>
-<li><a href="MIMEHeaders.html" title="MIME Headers">MIME Headers</a></li>
+<li><a href="MIMEHeaders.html" title="MIME Headers">MIME Header</a></li>
+</b>
 </ul></div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="AboutHTTPHeaders"></a>About HTTP Headers</h2></div></div></div>
-<p>An HTTP message consists of the following:</p>
+<p>An <u><b>HTTP message </b></u>consists of the following:</p>
 <div class="itemizedlist"><ul type="disc">
 <li>HTTP header<a class="indexterm" name="id380485"></a></li>
 <li>body</li>
 <li>trailer</li>
 </ul></div>
-<p>The HTTP header consists of:</p>
+<p>The <b><u>HTTP header</u></b> consists of:
 <div class="itemizedlist"><ul type="disc">
-<li>
-<p>A request or response line</p>
-<div class="itemizedlist"><ul type="circle">
+<li>A request or response line</li>
+<ul>
 <li>An HTTP <b>request line</b> contains a method, URL, and version</li>
-<li>A <b>response line</b>  contains a version, status code, and reason
phrase</li>
-</ul></div></li>
+<li>A <b>response line</b> contains a version, status code, and reason
phrase</li>
+</ul>
 <li>A MIME header<a class="indexterm" name="id380540"></a></li>
-</ul></div>
-<p>A MIME header is comprised of zero or more MIME fields. A <b>MIME
+</ul></div></p>
+<p>A <b>MIME header </b>is comprised of zero or more MIME fields. A <b>MIME
       field</b><a class="indexterm" name="id380553"></a> is composed of
a field name, a colon, and (zero or more)
-      field values. The values in a field are separated by commas.</p>
-<p>An HTTP header containing a request line is usually referred to as
+      field values. The values in a field are separated by commas.  An HTTP header containing
a request line is usually referred to as
       a <b>request</b>. The following example shows a typical request header.</p>
 <pre class="programlisting">GET http://www.tiggerwigger.com/ HTTP/1.0
 Proxy-Connection: Keep-Alive
@@ -62,7 +61,7 @@ Accept: image/gif, image/x-xbitmap, imag
 Accept-Encoding: gzip
 Accept-Language: en
 Accept-Charset: iso-8859-1, *, utf-8</pre>
-<p>The response header for the above request might look like the
+<p>The <b>response header </b>for the above request might look like the
       following:</p>
 <pre class="programlisting">HTTP/1.0 200 OK
 Date: Fri, 13 Nov 2009 06:57:43 GMT
@@ -80,7 +79,7 @@ Proxy-Connection: close</pre>
 <a name="Fig_ReqRespHeaderStruc"></a><p class="title"><b>Figure 10.1. HTTP
Request/Response and Header Structure</b></p>
 <div class="mediaobject"><img src="images/http_header_struct.jpg" alt="HTTP Request/Response
and Header Structure" /></div>
 </div>
-<p>The  figure below shows examples of HTTP request and response
+<p>The  figure below shows example HTTP request and response
       headers.</p>
 <div class="figure">
 <a name="Fig_HTTPReqRespHdrs"></a><p class="title"><b>Figure 10.2. Examples
of HTTP Request and Response Headers</b></p>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPTransactionFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPTransactionFunctions.html?rev=930361&r1=930360&r2=930361&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPTransactionFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPTransactionFunctions.html Fri Apr 
2 19:47:31 2010
@@ -79,7 +79,7 @@
       present in the cache and was fresh. Document will be served
       from the cache.</li>
     <li><code class="code">INK_CACHE_LOOKUP_SKIPPED</code> - Traffic Server
-      didn't perform a cache lookup because the request was not cacheable
+      didn't perform a cache lookup because the request wasn't cacheable
       (this can happen when the URL looks dynamic or the request is marked as noncacheable).</li>
   </ul>
   </dd>
@@ -643,16 +643,14 @@
     
     
   <dt><span class="term"><b>Example</b></span></dt>
+  
   <dd>
-   
-   
-    <pre class="programlisting">
-    if (INKHttpTxnPristineUrlGet(txnp, &amp;bufp, &amp;url_loc) == INK_SUCCESS)</code></p>
-    <code>    {                 value = INKUrlHostGet(bufp, url_loc, &amp;len);
                INKDebug (DEBUG_TAG, "Pristine Host: %s", value);                  INKHandleMLocRelease
(bufp, INK_NULL_MLOC, url_loc);             }
-    </code>
-    <p><code> else {                 INKError ("INKHttpTxnPristineUrlGet returns
0.\n");             }</pre></p>
-  </dd>
-  <dd>&nbsp;
+    
+    
+    <pre class="programlisting"> if (INKHttpTxnPristineUrlGet(txnp, &amp;bufp,
&amp;url_loc) == INK_SUCCESS)
+ {value = INKUrlHostGet(bufp, url_loc, &amp;len); INKDebug (DEBUG_TAG, "Pristine Host:
%s", value); INKHandleMLocRelease (bufp, INK_NULL_MLOC, url_loc);}
+ else {INKError ("INKHttpTxnPristineUrlGet returns 0.\n");</pre>
+  
   </dd>
   </dl>
 </div>
@@ -708,14 +706,10 @@
     <li><code class="code">INK_HTTP_TXN_CLOSE_HOOK</code>: the client
       receives whatever answer was sent by the origin server because
       with this hook, the response has already been sent to the
-      client.</li>
-  </ul>
-  
-</dd>
+      clie</li></ul></dd>
 <dt>&nbsp;</dt>
 <dt><span class="term"><b>Returns</b></span></dt>
-</dl>
-  <dl>
+
   <dd>
     <p><code class="code">INK_SUCCESS</code> if the operation completes
       successfully.</p>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/INKVIONBytesSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/INKVIONBytesSet.html?rev=930361&r1=930360&r2=930361&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/INKVIONBytesSet.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/INKVIONBytesSet.html Fri Apr  2 19:47:31
2010
@@ -28,11 +28,14 @@
               even then, the user should do so very carefully: <code class="function">INKVIONBytesSet</code>
               should only be used to set the number of bytes to be done by the
               IO operation to a value that's greater than or equal to
-              <code class="function">INKVIONDoneGet</code>. Common usage of this
-              function is to indicate to a vconnection that enough IO has been
-              performed. The user can indicate to the vconnection that the
-              operation has completed by setting <code><i>nbytes </i></code>
to the number done and then re-enabling
-              the operation.</p></dd>
+              <code class="function">INKVIONDoneGet</code>. </p></dd>
+<dd>
+  <p>Common usage of this
+    function is to indicate to a vconnection that enough IO has been
+    performed. The user can indicate to the vconnection that the
+    operation has completed by setting <code><i>nbytes </i></code>
to the number done and then re-enabling
+    the operation.</p>
+</dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the number of bytes associated

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/INKVIONTodoGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/INKVIONTodoGet.html?rev=930361&r1=930360&r2=930361&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/INKVIONTodoGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/INKVIONTodoGet.html Fri Apr  2 19:47:31
2010
@@ -22,10 +22,9 @@
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Gets the number of bytes left to do on the IO operation
-              described by <code class="code"><em class="replaceable"><code>viop</code></em></code>.<br>
-              Number of bytes left to do = (total #  bytes
+              described by <code class="code"><em class="replaceable"><code>viop</code></em></code>.
The number of bytes left to do = (total #  bytes
               to perform on the IO operation) - (# of bytes  that have been
-              done on the operation) </p>
+              done on the operation). </p>
 <p><code class="function">INKVIONTodoGet</code> is a convenience
               function.</p>
 </dd>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/IOBuffers_IO.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/IOBuffers_IO.html?rev=930361&r1=930360&r2=930361&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/IOBuffers_IO.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/IOBuffers_IO.html Fri Apr  2 19:47:31 2010
@@ -18,11 +18,11 @@
       is composed of a list of buffer blocks that point to buffer
       data. Both the buffer block (<code class="function">INKIOBufferBlock</code>)
and
       buffer data (<code class="function">INKIOBufferData</code>) data structures
are
-      reference-counted so that they can reside in multiple buffers at the
+      reference-counted, so  they can reside in multiple buffers at the
       same time. This makes it extremely efficient to copy data from one IO
       buffer to another via <code class="function">INKIOBufferCopy</code>, since
       Traffic Server must only  copy pointers and adjust reference counts
-      appropriately and doesn't actually copy any data.</p>
+      appropriately (and doesn't actually copy any data).</p>
 <p>The IO buffer abstraction provides for a single writer and
       multiple readers. In order for the readers to have no knowledge of each
       other, they manipulate IO buffers through the
@@ -30,7 +30,7 @@
       single writer is allowed, there is no corresponding
       <code class="function">INKIOBufferWriter</code> data structure. The writer
simply
       modifies the IO buffer directly. To see an example that illustrates how
-      to use IOBuffers, refer to the sample code in the description of <a href="INKIOBufferBlockReadStart.html"
title="INKIOBufferBlockReadStart">INKIOBufferBlockReadStart</a>.</p>
+      to use IOBuffers, refer to the sample code in the description of <a href="INKIOBufferBlockReadStart.html"
title="INKIOBufferBlockReadStart"><code>INKIOBufferBlockReadStart</code></a>.</p>
 <p>Additional information about  IO buffer functions:</p>
 <div class="itemizedlist"><ul type="disc">
 <li>
@@ -38,7 +38,7 @@
            tracks  how much data in  <code class="function">INKIOBuffer</code>
           has been read. It has an offset number of bytes that is the current
           start point of a particular buffer reader (for every read operation
-      on an <code><b>INKIOBuffer</b></code>, you must allocate an
<code class="function">INKIOBufferReader</code>).</p></li>
+      on an <code>INKIOBuffer</code>, you must allocate an <code class="function">INKIOBufferReader</code>).</p></li>
 <li>Bytes that  have already been read may not
           necessarily be freed within the <code class="code">INKIOBuffer</code>.
To consume bytes that have been read, you must call
       <code class="function">INKIOBufferConsume</code>.</li>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/IOGuide.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/IOGuide.html?rev=930361&r1=930360&r2=930361&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/IOGuide.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/IOGuide.html Fri Apr  2 19:47:31 2010
@@ -14,71 +14,71 @@
 <div class="titlepage"><div><div><h2 class="title">
 <a name="IOGuide"></a>Chapter 15. IO Guide</h2></div></div></div>
 <p>This chapter contains the following sections:</p>
-<div class="itemizedlist"><ul type="disc">
-<li><p><a href="IOGuide.html#Vconnections" title="Vconnections">Vconnections</a></p></li>
-<li><p><a href="NetVconnections.html" title="Net Vconnections">Net Vconnections</a></p></li>
-<li><p><a href="Transformations_IO.html" title="Transformations">Transformations</a></p></li>
-<li><p><a href="HTTPTransformationPlugins.html#VIOs" title="VIOs">VIOs</a></p></li>
-<li><p><a href="HTTPTransformationPlugins.html#IOBuffers" title="IO Buffers">IO
Buffers</a></p></li>
-<li><p><a href="CacheAPI.html" title="Guide to the Cache API">Guide to
the Cache API</a></p></li>
+<div class="itemizedlist"><ul type="disc"><b>
+<li><a href="IOGuide.html#Vconnections" title="Vconnections">Vconnections</a></li>
+<li><a href="NetVconnections.html" title="Net Vconnections">Net Vconnections</a></li>
+<li><a href="Transformations_IO.html" title="Transformations">Transformations</a></li>
+<li><a href="HTTPTransformationPlugins.html#VIOs" title="VIOs">VIOs</a></li>
+<li><a href="HTTPTransformationPlugins.html#IOBuffers" title="IO Buffers">IO
Buffers</a></li>
+<li><a href="CacheAPI.html" title="Guide to the Cache API">Guide to the Cache
API</a></li>
 <ul>
 <li><span class="section"><a href="CacheAPI.html#DoACacheRead">How to Do
a Cache Read</a></span></li>
 <li><span class="section"><a href="DoACacheWrite.html">How to Do a Cache
Write</a></span></li>
 <li><span class="section"><a href="DoACacheRemove.html">How to Do a Cache
Remove</a></span></li>
 <li><span class="section"><a href="Errors_Cache.html">Errors</a></span></li>
 <li><span class="section"><a href="CacheAPI_Example.html">Example</a></span></li></ul>
-</ul></div>
+</b></ul></div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="Vconnections"></a>Vconnections</h2></div></div></div>
 <p></p>
 <div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="VconnectionUsersView"></a>The vconnection user’s view</h3></div></div></div>
-<p>To use a vconnection, a user first needs to get a handle to one.
-        This is usually accomplished by having it handed to the user or by the
-        user issuing a call that creates a vconnection (such as
+<div class="titlepage"><div><div>
+  <h3 class="title">
+<a name="VconnectionUsersView"></a>Vconnections: a User’s Perspective</h3></div></div></div>
+<p>To use a vconnection, a user must first  get a handle to one.
+        This is usually accomplished by having it handed to the user; the
+        user may also simply issue a call that creates a vconnection (such as
         <code class="function">INKNetConnect)</code>. In the case of transform
plugins,
-        the plugin creates a transformation vconnection using
+        the plugin creates a transformation vconnection viav
         <code class="function">INKTransformCreate</code> and then accesses the
output
         vconnection using
         <code class="function">INKTransformOutputVConnGet</code>.</p>
-<p>Once the user has a handle to a vconnection, she can then issue a
+<p>After getting  a handle to a vconnection, the user can then issue a
         read or write call. It’s important to note that not all vconnections
         support both reading and writing - as of yet, there has not  been a  need
-        to query a vconnection as to whether it can perform a read or write
-        operation. That ability is obvious from context.</p>
+        to query a vconnection about whether it can perform a read or write
+        operation. That ability should be obvious from context.</p>
 <p>To issue a read or write operation, a user calls
         <code class="function">INKVConnRead</code> or
         <code class="function">INKVConnWrite</code>. These two operations both
return
-        VIO (<code>INKVIO</code>). The VIO describes the operation being performed
and how
+        <code>VIO (INKVIO)</code>. The VIO describes the operation being performed
and how
         much progress has been made. Transform plugins initiate output to the downstream
vconnection
         by calling <code class="function">INKVConnWrite</code>.</p>
 <p>A vconnection read or write operation is different from a normal
-        UNIX read(2) or write(2) operation. Specifically, the vconnection operation can specify
+        UNIX <code>read(2)</code> or <code>write(2)</code> operation.
Specifically, the vconnection operation can specify
         more data to be read or written than exists in the buffer handed to
-        the operation. For example, it's typical to issue a read for
-        <code class="code">INT_MAX</code> <a class="indexterm" name="id387878"></a>(4
billion) bytes from a network vconnection in order to
+        the operation. For example, it's typical to issue a read for <code class="code">INT_MAX</code>
<a class="indexterm" name="id387878"></a>(4 billion) bytes from a network vconnection
in order to
         read all the data from the network connection until the end
         of stream is reached. This contrasts with the usual UNIX fashion of issuing repeated
-        calls to read(2), until one of the calls finally returns 0 to indicate the
+        calls to <code>read(2)</code> until one of the calls finally returns
<code>0</code> to indicate the
         end of stream was reached (indeed, the underlying implementation of
-        vconnections on UNIX still does issue those calls to read(2), but the
+        vconnections on UNIX still does issue those calls to <code>read(2)</code>,
but the
         interface does not expose that detail).</p>
-<p>A given vconnection can have at most one read operation and one
+<p>At most, a given vconnection can have  one read operation and one
         write operation being performed on it. This is restricted both by
-        design and common sense: if two write operations were to be performed
+        design and common sense: if two write operations were performed
         on a single vconnection, then the user would not be able to specify which
          should occur first and the output would occur in an intermingled
         fashion. Note that both a read operation and a write operation can
-        happen on a single vconnection at the same time; the restriction is on
-        more than one operation of a given type.</p>
+        happen on a single vconnection at the same time; the restriction is for
+        more than one operation of the same type.</p>
 <p>One obvious issue is that the buffer passed to
         <code class="function">INKVConnRead</code> and
         <code class="function">INKVConnWrite</code> won’t be large enough
- there is no
         reasonable way to make a buffer that can hold <code class="code">INT_MAX</code>
(4
-        billion) bytes. The secret is that vconnections engage in a protocol
-        whereby they signal to the user (the continuation passed to
+        billion) bytes! The secret is that vconnections engage in a protocol
+        whereby they signal to the user (via the continuation passed to
         <code class="function">INKVConnRead</code> and
         <code class="function">INKVConnWrite</code>) that they have emptied 
the
         buffers passed to them and are ready for more data. When this occurs,
@@ -122,7 +122,7 @@
 <td><code>INK_EVENT_ERROR</code></td>
 <td>Indicates  an error has occurred on the
                 vconnection. This will happen for network IO if the underlying
-                read(2) or write(2) call returns an error.</td>
+                <code>read(2)</code> or <code>write(2)</code> call
returns an error.</td>
 </tr>
 <tr>
 <td><code>INK_EVENT_VCONN_READ_READY</code></td>
@@ -151,8 +151,7 @@
 <tr>
 <td><code>INK_EVENT_VCONN_WRITE_COMPLETE</code></td>
 <td>The vconnection has written all the bytes specified by
-                an <code class="function">INKVConnWrite</code> operation. The
-                vconnection can now be used to initiate a new IO
+                an <code class="function">INKVConnWrite</code> operation and
can now be used to initiate a new IO
                 operation.</td>
 </tr>
 <tr>
@@ -192,18 +191,17 @@
         <code class="code">INK_EVENT_VCONN_WRITE_COMPLETE</code> events will
not be produced. In the null transform plugin, the write operation is shut down
         with a call to <code class="function">INKVConnShutdown</code>. To learn
 how vconnections are used in transformation
         plugins, see <a href="HTTPTransformationPlugins.html#WritingContentTransformPlugins"
title="Writing Content Transform Plugins">Writing Content Transform Plugins</a>.</p>
-<p>The vconnection functions are:</p>
-<div class="itemizedlist"><ul type="disc">
-<li><p><code class="function">INKVConnAbort</code></p></li>
-<li><p><code class="function">INKVConnClose</code></p></li>
-<li><p><code class="function">INKVConnClosedGet</code> (used for
-            Transformations only)</p></li>
-<li><p><code class="function">INKVConnCreate</code></p></li>
-<li><p><code class="function">INKVConnRead</code></p></li>
-<li><p><code class="function">INKVConnReadVIOGet</code></p></li>
-<li><p><code class="function">INKVConnShutdown</code></p></li>
-<li><p><code class="function">INKVConnWrite</code></p></li>
-<li><p><code class="function">INKVConnWriteVIOGet</code></p></li>
+<p>The vconnection functions are listed below:</p>
+<div class="itemizedlist"><ul><b>
+<li><a href="VconnectionFunctions.html#INKVConnAbort">INKVConnAbort</a></li>
+<li><a href="INKVConnClose.html">INKVConnClose</a></li>
+<li><a href="INKVConnClosedGet.html">INKVConnClosedGet</a></li>
+<li><a href="INKVConnRead.html">INKVConnRead</a></li>
+<li><a href="INKVConnReadVIOGet.html">INKVConnReadVIOGet</a></li>
+<li><a href="INKVConnShutdown.html">INKVConnShutdown</a></li>
+<li><a href="INKVConnWrite.html">INKVConnWrite</a> </li>
+<li><a href="INKVConnWriteVIOGet.html">INKVConnWriteVIOGet</a></li>
+</b>
 </ul></div>
 </div>
 </div>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/InitializationFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/InitializationFunctions.html?rev=930361&r1=930360&r2=930361&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/InitializationFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/InitializationFunctions.html Fri Apr  2
19:47:31 2010
@@ -15,9 +15,9 @@
 <a name="InitializationFunctions"></a>Initialization Functions</h2></div></div></div>
 
 <ul>
-<li><span class="section"><a href="InitializationFunctions.html#INKPluginInit">INKPluginInit</a></span></li>
-<li><span class="section"><a href="INKPluginRegister.html">INKPluginRegister</a></span></li>
-<li><span class="section"><a href="INKTrafficServerVersionGet.html">INKTrafficServerVersionGet</a></span></li>
+<li><span class="section"><a href="InitializationFunctions.html#INKPluginInit"><b>INKPluginInit</b></a></span></li>
+<li><b><span class="section"><a href="INKPluginRegister.html">INKPluginRegister</a></span></b></li>
+<li><b><span class="section"><a href="INKTrafficServerVersionGet.html">INKTrafficServerVersionGet</a></span></b><span
class="section"><a href="INKTrafficServerVersionGet.html"></a></span></li>
 </ul>
 
 
@@ -28,11 +28,11 @@
 <dt><span class="term"><b>Prototype</b></span></dt>
 <dd>
   <p><code class="code">void INKPluginInit (int <code class="replaceable">argc</code>,
-        const <span class="replaceable">char</span> <code class="varname">
*<span class="replaceable">argv</span>[]</code>)</code></p></dd>
+        const <span class="replaceable">char</span> <code class="varname">
*<span class="replaceable">argv</span> []</code>)</code></p></dd>
 <dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
 <p><code class="code"><code class="replaceable">argc</code> </code>is
a count of the number of
-              arguments in the argument vector, <code class="code"><code class="varname"><span
class="replaceable">argv</span></code></code>. The
+              arguments in the argument vector, <code class="code"><code class="varname"><span
class="replaceable"> argv</span></code></code>. The
               count has a value of at least one because the first argument in the argument
               vector is the plugin’s name, which must exist in order for the
               plugin to be loaded.</p>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/Interface_ThreadFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/Interface_ThreadFunctions.html?rev=930361&r1=930360&r2=930361&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/Interface_ThreadFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/Interface_ThreadFunctions.html Fri Apr
 2 19:47:31 2010
@@ -16,15 +16,14 @@
 <p>The Traffic Server API thread functions enable you to create,
       destroy, and identify threads within Traffic Server. Multithreading
       enables a single program to have more than one stream of execution and
-      to process more than one transaction at a time.</p>
-<p>Threads serialize their access to shared resources and data using
+      to process more than one transaction at a time. Threads serialize their access to shared
resources and data using
       the <code class="function">INKMutex</code> type, as described in <a
href="MutexGuide.html#Mutexes" title="Mutexes">Mutexes</a>.</p>
-<p>The thread functions are:</p>
-<div class="itemizedlist"><ul type="disc">
-<li><p><a href="ThreadFunctions.html#INKThreadCreate" title="INKThreadCreate">INKThreadCreate</a></p></li>
-<li><p><a href="INKThreadDestroy.html" title="INKThreadDestroy">INKThreadDestroy</a></p></li>
-<li><p><a href="INKThreadInit.html" title="INKThreadInit">INKThreadInit</a></p></li>
-<li><p><a href="INKThreadSelf.html" title="INKThreadSelf">INKThreadSelf</a></p></li>
+<p>The thread functions are listed below:</p>
+<div class="itemizedlist"><ul type="disc"><b>
+<li><a href="ThreadFunctions.html#INKThreadCreate" title="INKThreadCreate">INKThreadCreate</a></li>
+<li><a href="INKThreadDestroy.html" title="INKThreadDestroy">INKThreadDestroy</a></li>
+<li><a href="INKThreadInit.html" title="INKThreadInit">INKThreadInit</a></li>
+<li><a href="INKThreadSelf.html" title="INKThreadSelf">INKThreadSelf</a></li></b>
 </ul></div>
 </div>
 </body>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/ThreadFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/ThreadFunctions.html?rev=930361&r1=930360&r2=930361&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/ThreadFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/ThreadFunctions.html Fri Apr  2 19:47:31
2010
@@ -16,8 +16,7 @@
 <p>The Traffic Server API thread functions enable you to create,
       destroy, and identify threads within Traffic Server. Multithreading
       enables a single program to have more than one stream of execution and
-      to process more than one transaction at a time.</p>
-<p>Threads serialize their access to shared resources and data using
+      to process more than one transaction at a time. Threads serialize their access to shared
resources and data using
       the <code>INKMutex</code> type, as described in <a href="MutexGuide.html#Mutexes"
title="Mutexes">Mutexes</a>.</p>
 <p>The thread functions are listed below:</p>
 
@@ -51,9 +50,9 @@
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Creates a new thread and calls
-              <code class="code"><em class="replaceable"><code>func </code></em></code>
with the argument
-              <code class="code"><em class="replaceable"><code>data</code></em></code>.
When
-              <code class="code"><em class="replaceable"><code>func </code></em></code>
exits, the thread
+              <code class="code"><em class="replaceable"><code> func </code></em></code>
with the argument
+              <code class="code"><em class="replaceable"><code> data</code></em></code>.
When
+              <code class="code"><em class="replaceable"><code> func </code></em></code>
exits, the thread
               is  automatically destroyed.</p>
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0"
summary="Note">
 <tr>
@@ -67,8 +66,8 @@
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p>A valid pointer to an <code class="function">INKThread</code>
-              object if successful.</p>
+<p>If successful, a  valid pointer to an <code class="function">INKThread</code>
+              object.</p>
 <p>A <code class="code">NULL</code> pointer if there is an error.</p>
 </dd>
 </dl></div>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/VIOFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/VIOFunctions.html?rev=930361&r1=930360&r2=930361&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/VIOFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/VIOFunctions.html Fri Apr  2 19:47:31 2010
@@ -13,7 +13,20 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="VIOFunctions"></a>VIO Functions</h2></div></div></div>
-<p></p>
+<ul><b>
+<li><a href="VIOFunctions.html#INKVIOBufferGet">INKVIOBufferGet</a></li>
+<li><a href="INKVIOVConnGet.html">INKVIOVConnGet</a></li>
+<li><a href="INKVIOContGet.html">INKVIOContGet</a></li>
+<li><a href="INKVIOMutexGet.html">INKVIOMutexGet</a></li>
+<li><a href="INKVIONBytesGet.html">INKVIONBytesGet</a></li>
+<li><a href="INKVIONBytesSet.html">INKVIONBytesSet</a></li>
+<li><a href="INKVIONDoneGet.html">INKVIONDoneGet</a> </li>
+<li><a href="INKVIONDoneSet.html">INKVIONDoneSet</a></li>
+<li><a href="INKVIONTodoGet.html">INKVIONTodoGet</a></li>
+<li><a href="INKVIOReaderGet.html">INKVIOReaderGet</a></li>
+<li><a href="INKVIOReenable.html">INKVIOReenable</a></li>
+</b>
+</ul>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="INKVIOBufferGet"></a>INKVIOBufferGet</h3></div></div></div>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/VIOs_IO.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/VIOs_IO.html?rev=930361&r1=930360&r2=930361&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/VIOs_IO.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/VIOs_IO.html Fri Apr  2 19:47:31 2010
@@ -13,8 +13,8 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="VIOs_IO"></a>VIOs</h2></div></div></div>
-<p>A <b>VIO</b>, or virtual IO, is a description of an IO
-      operation that's in progress. The VIO data structure is used by vconnection users to
+<p>A <b>VIO</b>, or <b>virtual IO</b>, is a description of
an IO
+      operation that's currently in progress. The VIO data structure is used by vconnection
users to
       determine how much progress has been made on a particular IO operation
       and to re-enable an IO operation when it stalls due to buffer space issues.
       VIOs are used by vconnection implementors to determine the buffer for an
@@ -31,20 +31,22 @@
     int nbytes;
     int ndone;
 } *INKVIO;</pre>
-<p>The functions below simply access and modify various parts of the
+<p>The VIO functions below  access and modify various parts of the
       data structure.</p>
 <div class="itemizedlist"><ul type="disc">
-<li><p><code class="function">INKVIOBufferGet</code></p></li>
-<li><p><code class="function">INKVIOVConnGet</code></p></li>
-<li><p><code class="function">INKVIOContGet</code></p></li>
-<li><p><code class="function">INKVIOMutexGet</code></p></li>
-<li><p><code class="function">INKVIONBytesGet</code></p></li>
-<li><p><code class="function">INKVIONBytesSet</code></p></li>
-<li><p><code class="function">INKVIONDoneGet</code></p></li>
-<li><p><code class="function">INKVIONDoneSet</code></p></li>
-<li><p><code class="function">INKVIONTodoGet</code></p></li>
-<li><p><code class="function">INKVIOReaderGet</code></p></li>
-<li><p><code class="function">INKVIOReenable</code></p></li>
+<b>
+<li><a href="VIOFunctions.html#INKVIOBufferGet">INKVIOBufferGet</a></li>
+<li><a href="INKVIOVConnGet.html">INKVIOVConnGet</a></li>
+<li><a href="INKVIOContGet.html">INKVIOContGet</a></li>
+<li><a href="INKVIOMutexGet.html">INKVIOMutexGet</a></li>
+<li><a href="INKVIONBytesGet.html">INKVIONBytesGet</a></li>
+<li><a href="INKVIONBytesSet.html">INKVIONBytesSet</a></li>
+<li><a href="INKVIONDoneGet.html">INKVIONDoneGet</a> </li>
+<li><a href="INKVIONDoneSet.html">INKVIONDoneSet</a></li>
+<li><a href="INKVIONTodoGet.html">INKVIONTodoGet</a></li>
+<li><a href="INKVIOReaderGet.html">INKVIOReaderGet</a></li>
+<li><a href="INKVIOReenable.html">INKVIOReenable</a></li>
+</b>
 </ul></div>
 </div>
 </body>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/VconnectionFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/VconnectionFunctions.html?rev=930361&r1=930360&r2=930361&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/VconnectionFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/VconnectionFunctions.html Fri Apr  2 19:47:31
2010
@@ -13,7 +13,20 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="VconnectionFunctions"></a>Vconnection Functions</h2></div></div></div>
-<p></p>
+
+
+<ul><b>
+<li><a href="VconnectionFunctions.html#INKVConnAbort">INKVConnAbort</a></li>
+<li><a href="INKVConnClose.html">INKVConnClose</a></li>
+<li><a href="INKVConnClosedGet.html">INKVConnClosedGet</a></li>
+<li><a href="INKVConnRead.html">INKVConnRead</a></li>
+<li><a href="INKVConnReadVIOGet.html">INKVConnReadVIOGet</a></li>
+<li><a href="INKVConnShutdown.html">INKVConnShutdown</a></li>
+<li><a href="INKVConnWrite.html">INKVConnWrite</a> </li>
+<li><a href="INKVConnWriteVIOGet.html">INKVConnWriteVIOGet</a></li>
+</b>
+</ul>
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="INKVConnAbort"></a>INKVConnAbort</h3></div></div></div>



Mime
View raw message