You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by di...@apache.org on 2009/12/23 23:00:19 UTC
svn commit: r893636 - /incubator/trafficserver/site/trunk/docs/sdk/
Author: dianes
Date: Wed Dec 23 22:00:18 2009
New Revision: 893636
URL: http://svn.apache.org/viewvc?rev=893636&view=rev
Log:
2nd pass edits
Modified:
incubator/trafficserver/site/trunk/docs/sdk/INKActionDone.html
incubator/trafficserver/site/trunk/docs/sdk/INKAssert.html
incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyHostNameSet.html
incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyPinnedSet.html
incubator/trafficserver/site/trunk/docs/sdk/INKCacheRead.html
incubator/trafficserver/site/trunk/docs/sdk/INKCacheRemove.html
incubator/trafficserver/site/trunk/docs/sdk/INKConfigGet.html
incubator/trafficserver/site/trunk/docs/sdk/INKConfigSet.html
incubator/trafficserver/site/trunk/docs/sdk/INKContDestroy.html
incubator/trafficserver/site/trunk/docs/sdk/INKContSchedule.html
incubator/trafficserver/site/trunk/docs/sdk/INKHttpTxnServerIntercept.html
incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockReadStart.html
incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferCopy.html
incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferReaderClone.html
incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferSizedCreate.html
incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWaterMarkGet.html
incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWaterMarkSet.html
incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamilyFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/INKfread.html
incubator/trafficserver/site/trunk/docs/sdk/INKfwrite.html
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKActionDone.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKActionDone.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKActionDone.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKActionDone.html Wed Dec 23 22:00:18 2009
@@ -80,7 +80,7 @@
</tr>
<tr><td align="left" valign="top">
<p>Always use <code class="function">INKActionDone</code>
- immediately after the call that assigns the action. For
+ immediately after the call that assigns the action. <br> For
example:</p>
<pre class="programlisting">actionp = INKContSchedule(contp, SOME_TIMEOUT_VALUE);
if (INKActionDone(actionp)){
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKAssert.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKAssert.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKAssert.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKAssert.html Wed Dec 23 22:00:18 2009
@@ -66,10 +66,10 @@
<dd><p>A boolean expression.</p></dd>
<dt><span class="term"><b>Description</b></span></dt>
<dd>
- <p>In debug mode, causes the Traffic Server to print the file
+ <p>In <code>debug</code> mode, causes the Traffic Server to print the file
name, line number, and expression before it aborts.</p>
-<p>In optim mode, the expression is <u>not</u> removed, but the
- effect of printing an error message and aborting are. This is an
+<p>In <code>optim</code> mode, the expression is <u>not</u> removed, but the
+ effects of printing an error message and aborting are. This is an
artifact of the way the system assert is normally used and
permits:</p>
<pre class="programlisting">ink_assert(!setsockopt(...));
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyHostNameSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyHostNameSet.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyHostNameSet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyHostNameSet.html Wed Dec 23 22:00:18 2009
@@ -63,13 +63,13 @@
<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">INKReturnCode INKCacheKeyHostNameSet(INKCacheKey
<em class="replaceable"><code>key</code></em>, const unsigned char
- *<em class="replaceable"><code>hostname</code></em>, int
+ <em class="replaceable"><code>*hostname</code></em>, int
<em class="replaceable"><code>host_len</code></em>;</code></p></dd>
<dt><span class="term"><b>Arguments</b></span></dt>
<dd>
<p><code>INKCacheKey</code> <code class="code"><em class="replaceable"><code>key </code></em></code> is
the key to the cached object.</p>
-<p><code class="code">const unsigned char <i>*hostname </i></code> is
+<p><code class="code">const unsigned char <em class="replaceable"><code>*hostname</code></em> <i> </i></code> is
the host name you are associating with the cache key.</p>
<p><code class="code">int <em class="replaceable"><code>host_len </code></em></code> is
the length of the string
@@ -84,9 +84,9 @@
under which cache partition the object should be stored.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
-<p><code class="code">INK_SUCCESS</code> if the host name was successfully
+<p><code class="code">INK_SUCCESS</code> if the <code class="code"><em class="replaceable"><code> hostname </code></em></code> is successfully
associated with the cache key.</p>
-<p><code class="code">INK_ERROR</code> if <code class="code">hostname</code> could not
+<p><code class="code">INK_ERROR</code> if <code class="code"><em class="replaceable"><code>hostname</code></em> </code>cannot
be set or is invalid.</p>
</dd>
</dl></div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyPinnedSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyPinnedSet.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyPinnedSet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyPinnedSet.html Wed Dec 23 22:00:18 2009
@@ -67,7 +67,7 @@
<em class="replaceable"><code>pin_in_cache</code></em>)</code></p></dd>
<dt><span class="term"><b>Arguments</b></span></dt>
<dd>
-<p>INKCacheKey <code class="code"><em class="replaceable"><code>key </code></em></code> is
+<p><code>INKCacheKey</code> <code class="code"><em class="replaceable"><code>key </code></em></code> is
the cache key for the document to be pinned.</p>
<p><code class="code">time_t
<em class="replaceable"><code>pin_in_cache </code></em></code> represents the
@@ -83,17 +83,15 @@
document is pinned, the garbage collection will not delete this
document from the specifed number of seconds and the document
can even persist across Traffic Server re-runs. However, after
- the <code class="code"><em class="replaceable"><code>pin_in_cache</code></em></code>
+ the <code class="code"><em class="replaceable"><code>pin_in_cache </code></em></code>
interval has expired, the cache may delete the document at any
time in order to reclaim space.</p>
-<p>To delete this document before the
- <code class="code">pin_in_cache</code> interval expires, call the
- <code class="function">INKCacheRemove</code>() function with the
+<p>To delete this document before the <code class="code"><em class="replaceable"><code>pin_in_cache</code></em> </code>interval expires, call the <code class="function">INKCacheRemove()</code> function with the
documentâs cache key. </p>
<p><code class="methodname">InkCacheKeyPinnedSet()</code> should be
used after a key is created and before writing the document to
- cache using I<code class="methodname">NKCacheWrite()</code>.</p>
-<p>By default, a document is not pinned in the cache, so it
+ cache using <code>I</code><code class="methodname">NKCacheWrite()</code>.</p>
+<p>Because a document is not pinned in the cache by default, it
can be garbage-collected at anytime.</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKCacheRead.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheRead.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheRead.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheRead.html Wed Dec 23 22:00:18 2009
@@ -101,11 +101,14 @@
<code class="code"><em class="replaceable"><code>contp</code></em></code>. The error code
can be:</p>
<div class="itemizedlist"><ul type="disc">
-<li><p><code class="code">INK_CACHE_ERROR_NOT_READY</code>: Trying to
+<li>
+ <p><code class="code">INK_CACHE_ERROR_NOT_READY</code>: trying to
access to the cache while it's not yet initialized.</p></li>
-<li><p><code class="code">INK_CACHE_ERROR_NO_DOC</code>: Document does not
+<li>
+ <p><code class="code">INK_CACHE_ERROR_NO_DOC</code>: document does not
exist in cache.</p></li>
-<li><p><code class="code">INK_CACHE_ERROR_DOC_BUSY</code>: Trying to read
+<li>
+ <p><code class="code">INK_CACHE_ERROR_DOC_BUSY</code>: trying to read
a document while another continuation is writing on
it.</p></li>
<li><p>Any other value: unknown read failure</p></li>
@@ -128,7 +131,7 @@
unless all the data from the <code class="code">cache iobuffer</code> is
consumed.</p>
<p>Reentrant calls are possible; in other words, the cache
- can call back the user (<code class="code">contp</code>) in the same
+ can call back the user (<code class="code"><em class="replaceable"><code>contp</code></em></code>) in the same
call.</p>
</td></tr>
</table></div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKCacheRemove.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheRemove.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheRemove.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheRemove.html Wed Dec 23 22:00:18 2009
@@ -81,7 +81,7 @@
<p>If the object was removed successfully, then the cache calls
<code class="code"><em class="replaceable"><code>contp </code></em></code> back with the
event <code class="code">INK_EVENT_CACHE_REMOVE</code>.</p>
-<p>If the object was not found in the cache, the cache calls
+<p>If the object was not found in the cache, then the cache calls
<code class="code"><em class="replaceable"><code>contp </code></em></code> back with the
event <code class="code">INK_EVENT_CACHE_REMOVE_FAILED</code>. An error code
is passed in the <code class="code">void *edata</code> argument of
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKConfigGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKConfigGet.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKConfigGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKConfigGet.html Wed Dec 23 22:00:18 2009
@@ -78,7 +78,7 @@
must set the identifier
<code class="code"><em class="replaceable"><code>id </code></em></code> to some plugin
configuration data using <code class="function">INKConfigSet</code> (see
- code snippet in the previous section).</p>
+ the code snippet in the previous section).</p>
</dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd><p>A pointer to the current Traffic Server
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKConfigSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKConfigSet.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKConfigSet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKConfigSet.html Wed Dec 23 22:00:18 2009
@@ -74,7 +74,7 @@
You can enter 0 as <code class="code"><em class="replaceable"><code>id</code></em></code>,
however, and <code class="function">INKConfigSet</code> will allocate an
identifier for you (with a value of 3 or greater). There is an
- internal upper limit of 100 on
+ internal upper limit of 100 for
<code class="code"><em class="replaceable"><code>id</code></em></code>.</p>
<p><code class="code">void
*</code><code class="code"><em class="replaceable"><code>data </code></em></code> points to
@@ -119,7 +119,7 @@
</table></div>
<p>The <code class="code"><em class="replaceable"><code>funcp </code></em></code>
parameter is a pointer to a destroy function that is
- called with <code class="code"><em class="replaceable"><code>data</code></em></code> as its
+ called with <code class="code"><em class="replaceable"><code>data </code></em></code> as its
only parameter when Traffic Server determines there are no
more references to
<code class="code"><em class="replaceable"><code>data</code></em></code>.</p>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKContDestroy.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKContDestroy.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKContDestroy.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKContDestroy.html Wed Dec 23 22:00:18 2009
@@ -67,7 +67,7 @@
<p>Destroys the continuation
<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
+ 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>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKContSchedule.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKContSchedule.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKContSchedule.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKContSchedule.html Wed Dec 23 22:00:18 2009
@@ -71,7 +71,7 @@
refers to a time (in milliseconds) from the present to
send the event. When
<code class="code"><em class="replaceable"><code>contp </code></em></code> is called back and
- if <code class="code"><em class="replaceable"><code>timeout</code></em></code> is 0, then
+ if <code class="code"><em class="replaceable"><code>timeout </code></em></code> is 0, then
the event sent will be <code class="code">INK_EVENT_IMMEDIATE</code>. If
<code class="code"><em class="replaceable"><code>timeout </code></em></code> is greater than
0, then the event sent will be
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKHttpTxnServerIntercept.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKHttpTxnServerIntercept.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKHttpTxnServerIntercept.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKHttpTxnServerIntercept.html Wed Dec 23 22:00:18 2009
@@ -76,7 +76,7 @@
<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Enables a plugin to intercept an HTTP request sent to an
- origin server, and to then serve the content in place of the origin
+ origin server, and then serve the content in place of the origin
server. The origin server is not contacted.</p>
<p>This API should be used in the
<code class="code">INK_HTTP_READ_REQUEST_HDR_HOOK</code> hook.</p>
@@ -86,9 +86,7 @@
<code class="code">INK_EVENT_NET_ACCEPT</code>. Note that the continuation
passed should not have a <code class="code">NULL</code> mutex; if it does, then an error is
returned.</p>
-<p>The void *<code class="code"><em class="replaceable"><code>data </code></em></code>
- passed to the handler of the continuation
- <code class="code"><em class="replaceable"><code>contp </code></em></code> is a data of type
+<p>The void <code>*</code><code class="code"><em class="replaceable"><code>data </code></em></code><em><code> </code></em>passed to the handler of the continuation <code class="code"><em class="replaceable"><code>contp </code></em></code> is a data of type
<code>NetVConnection</code> representing the connection.</p>
<p>Once the vconnection is established, you can use regular
vconnection operations (<code class="function">INKVConnRead</code>,
@@ -107,12 +105,12 @@
<li>
<p>Use <code class="function">INKVConnRead</code> to get the HTTP
header. Note that you will not receive an event
- <code class="code">INK_VCONN_READ_COMPLETE</code>; you will only receive the event
+ <code class="code">INK_VCONN_READ_COMPLETE</code> - you will only receive the event
<code class="code">INK_VCONN_READ_READY</code> because the number of
characters to read is unknown. You should rely on
<code class="function">INKTHttpParser</code> to parse the request and
- return a status <code class="code">INK_PARSE_DONE</code> when request is
- fully received (escape sequence <code class="code">\r\n\r\n</code>
+ return a status <code class="code">INK_PARSE_DONE</code> when the request is
+ fully-received (escape sequence <code class="code">\r\n\r\n</code>
read).</p></li>
<li><p>Use <code class="function">INKHttpParser</code> to parse the
request.</p></li>
@@ -125,7 +123,7 @@
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>The request and response go through the Traffic Server
- HTTP SM. The request and response can be cached. The request
+ HTTP SM. The request and response can be cached; the request
is logged in <code class="filename">squid.log</code>.</p></td></tr>
</table></div>
</dd>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockReadStart.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockReadStart.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockReadStart.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockReadStart.html Wed Dec 23 22:00:18 2009
@@ -74,7 +74,7 @@
the amount of data available for reading in the parameter
<code class="code"><em class="replaceable"><code>avail</code></em></code>. This is the same
value that <code class="function">INKIOBufferBlockReadAvail</code>
- returns. If <code class="code"><em class="replaceable"><code>avail</code></em></code> is
+ returns. If <code class="code"><em class="replaceable"><code>avail </code></em></code> is
<code class="code">NULL</code>, then no attempt is made to dereference
it.</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
@@ -95,7 +95,7 @@
<dd>
<p>A pointer to the starting point for reading from the
specified IO buffer block.</p>
-<p><code class="code">INK_ERROR_PTR</code> in case of an error.</p>
+<p><code class="code">INK_ERROR_PTR</code> if there is an error.</p>
</dd>
<dt><span class="term"><b>Example</b></span></dt>
<dd>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferCopy.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferCopy.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferCopy.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferCopy.html Wed Dec 23 22:00:18 2009
@@ -70,8 +70,7 @@
<p>Copies <code class="code"><em class="replaceable"><code>length </code></em></code>
bytes of data from the IO buffer reader
<code class="code"><em class="replaceable"><code>readerp </code></em></code> to the IO buffer
- <code class="code"><em class="replaceable"><code>bufp</code></em></code>. As described
- above, <code>INKIOBufferCopy</code> does not actually copy the data - it
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>. As previously described, <code>INKIOBufferCopy</code> does not actually copy the data - it
simply copies pointers and adjusts reference counts
appropriately. The parameter <code class="code"><em class="replaceable"><code>offset </code></em></code> specifies the
offset from <code class="code"><em class="replaceable"><code>readerp</code></em></code>'s
@@ -79,7 +78,7 @@
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>The number of bytes actually copied.</p>
-<p><code class="code">INK_ERROR</code></p>
+<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
</dl></div>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferReaderClone.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferReaderClone.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferReaderClone.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferReaderClone.html Wed Dec 23 22:00:18 2009
@@ -64,11 +64,12 @@
(INKIOBufferReader
<em class="replaceable"><code>readerp</code></em>)</code></p></dd>
<dt><span class="term"><b>Description</b></span></dt>
-<dd><p>Makes a clone of the IO buffer reader
+<dd>
+ <p>Makes a clone of the IO buffer reader
<code class="code"><em class="replaceable"><code>readerp</code></em></code>. The cloned
- reader will point to the same IO buffer and initially have the
+ reader points to the same IO buffer and initially has the
same read offset as
- <code class="code"><em class="replaceable"><code>readerp</code></em></code>.</p></dd>
+ <code class="code"><em class="replaceable"><code>readerp</code></em></code>.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>A handle to the cloned IO buffer.</p>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferSizedCreate.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferSizedCreate.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferSizedCreate.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferSizedCreate.html Wed Dec 23 22:00:18 2009
@@ -64,8 +64,8 @@
(INKIOBufferSizeIndex
<em class="replaceable"><code>index</code></em>)</code></p></dd>
<dt><span class="term"><b>Arguments</b></span></dt>
- <dd><code class="function">INKIOBufferSizeIndex</code> index is the
- size of the new <code class="code">IOBuffer</code> to create and should be
+ <dd><code class="function">INKIOBufferSizeIndex</code><code class="code"><em class="replaceable"><code> index </code></em></code> is the
+ size of the new <code class="code">IOBuffer</code> to create. It should be
one of the following values:
<ul>
<li><code class="code">INK_IOBUFFER_SIZE_INDEX_128</code></li>
@@ -76,13 +76,10 @@
<li><code class="code">INK_IOBUFFER_SIZE_INDEX_4K</code></li>
<li><code class="code">INK_IOBUFFER_SIZE_INDEX_8K</code></li>
<li><code class="code">INK_IOBUFFER_SIZE_INDEX_16K</code></li>
- <li><code class="code">INK_IOBUFFER_SIZE_INDEX_32K</code></li>
- </ul>
- </dd>
+ <li><code class="code">INK_IOBUFFER_SIZE_INDEX_32K</code></li></ul></dd>
</dl>
- <blockquote> </blockquote>
<dl>
- <dt><span class="term"><b>Description</b></span></dt>
+ <dt><span class="term"><b>Description</b></span></dt>
<dd><p>Creates an <code class="function">INKIOBuffer</code> of the
specifed size.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWaterMarkGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWaterMarkGet.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWaterMarkGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWaterMarkGet.html Wed Dec 23 22:00:18 2009
@@ -76,7 +76,7 @@
<p>Gets the current watermark for the specified buffer. A
water mark applies only to a <code><b>NetVConnection</b></code> and should therefore
only be used when reading data from one.</p>
-<p>When the watermark is set to <code>N</code> and after <code class="function">INKVConnRead</code> is called, the Net processor calls back
+<p>When the watermark is set to <code>N</code> and after <code class="function">INKVConnRead</code> is called, the net processor calls back
the reader (with an event <code class="code">INK_VCONN_READ_READY</code>)
only when at least <code>N</code> bytes of data are available for
reading.</p>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWaterMarkSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWaterMarkSet.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWaterMarkSet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWaterMarkSet.html Wed Dec 23 22:00:18 2009
@@ -76,7 +76,7 @@
<p>Sets the current watermark of the specified buffer.</p>
<p>A water mark applies only to a <code><b>NetVConnection</b></code> and should
therefore be used only when reading data from one. When the watermark is
- set to N and after <code class="function">INKVConnRead</code> is called, the Net processor calls back
+ set to N and after <code class="function">INKVConnRead</code> is called, the net processor calls back
the reader (with an event <code class="code">INK_VCONN_READ_READY</code>)
only when at least N bytes of data are available for
reading.</p>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamilyFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamilyFunctions.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamilyFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamilyFunctions.html Wed Dec 23 22:00:18 2009
@@ -78,7 +78,7 @@
intended for high speed IO or flexibility. These routines are intended for
reading and writing configuration information when corresponding usage
of the <code>fopen</code> family of functions is inappropriate because of file
- descriptor and portability limitations. The <code class="function">INKfopen</code> family of functions consists of the following:</p>
+ descriptor and portability limitations. The <code class="function">INKfopen</code> family of functions consists of the functions below.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="INKfclose"></a>INKfclose</h3></div></div></div>
@@ -98,7 +98,7 @@
structures & buffers associated with it. If the file was
opened for writing, then any pending data is flushed.</p></dd>
<dt><span class="term"><b>Example</b></span></dt>
-<dd><p>See the example for <a href="INKfopen.html" title="INKfopen"><code class="code">INKfopen</code></a></p></dd>
+<dd><p>See the example for <a href="INKfopen.html" title="INKfopen">INKfopen</a></p></dd>
</dl></div>
</div>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKfread.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKfread.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKfread.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKfread.html Wed Dec 23 22:00:18 2009
@@ -84,10 +84,10 @@
opened for reading, then <code class="code"><code class="function">INKfread</code></code>
returns <code>-1</code>. If an error occurs while reading the file, then <code class="code"><code class="function">INKfread</code></code> returns <code>-1</code>. If the
end of the file is reached, then <code class="function">INKfread</code>
- returns <code>0</code>. Otherwise, <code class="function">INKfread</code> returns the
+ returns <code>0</code>; otherwise, <code class="function">INKfread</code> returns the
number of bytes read.</p></dd>
<dt><span class="term"><b>Example</b></span></dt>
-<dd><p>See the example for <a href="INKfopen.html" title="INKfopen"><code class="code">INKfopen</code></a></p></dd>
+<dd><p>See the example for <a href="INKfopen.html" title="INKfopen">INKfopen</a></p></dd>
</dl></div>
</div>
</body>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKfwrite.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKfwrite.html?rev=893636&r1=893635&r2=893636&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKfwrite.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKfwrite.html Wed Dec 23 22:00:18 2009
@@ -60,8 +60,8 @@
<p>Writes a specified number of bytes to a file.</p>
<div class="variablelist"><dl>
<dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code>int INKfwrite (INKFile <i>filep</i>, void *<i>buf</i>, int
- <i>length</i>)</code></p></dd>
+<dd><p><code>int INKfwrite (INKFile <i class="replaceable">filep</i>, void *<i class="replaceable">buf</i>, int
+ <i class="replaceable">length</i>)</code></p></dd>
<dt><span class="term"><b>Arguments</b></span></dt>
<dd>
<p><code class="code"><em class="replaceable"><code>filep </code></em></code> is the file