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 2010/02/09 23:00:42 UTC
svn commit: r908249 - /incubator/trafficserver/site/trunk/docs/sdk/
Author: dianes
Date: Tue Feb 9 22:00:39 2010
New Revision: 908249
URL: http://svn.apache.org/viewvc?rev=908249&view=rev
Log:
minor edits, corrections
Modified:
incubator/trafficserver/site/trunk/docs/sdk/ActivateContinuations.html
incubator/trafficserver/site/trunk/docs/sdk/CustInstallLicenseFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/DoACacheWrite.html
incubator/trafficserver/site/trunk/docs/sdk/DuplicateMIMEFlds.html
incubator/trafficserver/site/trunk/docs/sdk/Errors_Cache.html
incubator/trafficserver/site/trunk/docs/sdk/HTTPFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/HTTPHooksAndTransactions.html
incubator/trafficserver/site/trunk/docs/sdk/HTTPSessionFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDigestSet.html
incubator/trafficserver/site/trunk/docs/sdk/INKCacheReady.html
incubator/trafficserver/site/trunk/docs/sdk/INKConfigRelease.html
incubator/trafficserver/site/trunk/docs/sdk/INKContCreate.html
incubator/trafficserver/site/trunk/docs/sdk/INKContDataGet.html
incubator/trafficserver/site/trunk/docs/sdk/INKContDataSet.html
incubator/trafficserver/site/trunk/docs/sdk/INKContMutexGet.html
incubator/trafficserver/site/trunk/docs/sdk/INKError.html
incubator/trafficserver/site/trunk/docs/sdk/INKHostLookupResultIPGet.html
incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockWriteAvail.html
incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockWriteStart.html
incubator/trafficserver/site/trunk/docs/sdk/INKVConnCacheObjectSizeGet.html
incubator/trafficserver/site/trunk/docs/sdk/INKfgets.html
incubator/trafficserver/site/trunk/docs/sdk/INKfopen.html
incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamily.html
incubator/trafficserver/site/trunk/docs/sdk/IOBufferInterfaceFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/PluginConfigurationFunctions.html
Modified: incubator/trafficserver/site/trunk/docs/sdk/ActivateContinuations.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/ActivateContinuations.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/ActivateContinuations.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/ActivateContinuations.html Tue Feb 9 22:00:39 2010
@@ -57,19 +57,19 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="ActivateContinuations"></a>How to Activate Continuations</h2></div></div></div>
-<p>Continuations are activated by
+<p>Continuations are activated when they receive an event or by
<code class="function">INKContSchedule</code> (which schedules a continuation to
- receive an event) or when they receive an event. Continuations might receive an event because:</p>
+ receive an event). Continuations might receive an event because:</p>
<div class="itemizedlist"><ul type="disc">
<li><p>Your plugin calls <code class="function">INKContCall</code></p></li>
<li><p>The Traffic Server HTTP state machine sends an event
corresponding to a particular HTTP hook</p></li>
-<li><p>A Traffic Server IO processor (such as cache processor or net
- processor) is letting a continuation know that there is (cache or
- network) data available to read or write. These callbacks are a
+<li>
+ <p>A Traffic Server IO processor (such as a cache processor or net
+ processor) is letting a continuation know there is data (cache or
+ network) available to read or write. These callbacks are a
result of using functions such
- <code class="function">INKVConnRead</code>/Write, or
- <code class="function">INKCacheRead/Write</code></p></li>
+ <code class="function">INKVConnRead</code>/<code class="function">Write</code> or <code class="function">INKCacheRead</code>/<code class="function">Write</code></p></li>
</ul></div>
</div>
</body>
Modified: incubator/trafficserver/site/trunk/docs/sdk/CustInstallLicenseFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/CustInstallLicenseFunctions.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/CustInstallLicenseFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/CustInstallLicenseFunctions.html Tue Feb 9 22:00:39 2010
@@ -64,15 +64,16 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="INKInstallDirGet"></a>INKInstallDirGet</h3></div></div></div>
-<p>Gets Traffic Serverâs install directory.</p>
+<p>Gets the Traffic Server install directory.</p>
<div class="variablelist"><dl>
<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">const char * INKInstallDirGet(void)</code></p></dd>
<dt><span class="term"><b>Description</b></span></dt>
-<dd><p>Get Traffic Serverâs installation directory.</p></dd>
+<dd>
+ <p>Gets the Traffic Server installation directory.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
-<dd><p>A pointer to a string containing the Traffic Serverâs
- installation directory.</p></dd>
+<dd><p>A pointer to a string containing Traffic Serverâs
+ installation directory.</p></dd>
</dl></div>
</div>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/DoACacheWrite.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/DoACacheWrite.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/DoACacheWrite.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/DoACacheWrite.html Tue Feb 9 22:00:39 2010
@@ -63,11 +63,10 @@
<div class="itemizedlist"><ul type="disc">
<li>
<p><code class="code">INK_EVENT_CACHE_WRITE_READ</code> - indicates the lookup was successful. The data passed back along with this
- event is a cache vconnection that can be used to initiate a write
- to the cache.</p></li>
+ event is a cache vconnection that can be used to initiate a cache write.</p></li>
<li>
<p><code class="code">INK_EVENT_CACHE_OPEN_WRITE_FAILED</code> - event
- that is returned when another continuation is currently writing to this
+ returned when another continuation is currently writing to this
location in the cache. Data payload for this event indicates the
possible reason for the write failing
(<code class="function">INKCacheError</code>).</p></li>
Modified: incubator/trafficserver/site/trunk/docs/sdk/DuplicateMIMEFlds.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/DuplicateMIMEFlds.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/DuplicateMIMEFlds.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/DuplicateMIMEFlds.html Tue Feb 9 22:00:39 2010
@@ -66,7 +66,7 @@
older clients and servers. Therefore, this version of Traffic Server does not
coalesce duplicate fields.</p>
<p>Properly-behaving plugins should check for the presence of
- duplicate fields and then iterate over the duplicate fields via <code class="function">INKMimeHdrFieldNextDup</code> (see <a href="MimeHeadersFunctions.html#INKMimeHdrFieldNextDup" title="INKMimeHdrFieldNextDup">INKMimeHdrFieldNextDup</a>).</p>
+ duplicate fields and then iterate over the duplicate fields via <a href="MimeHeadersFunctions.html#INKMimeHdrFieldNextDup" title="INKMimeHdrFieldNextDup"><code>INKMimeHdrFieldNextDup</code></a>.</p>
</div>
</body>
</html>
Modified: incubator/trafficserver/site/trunk/docs/sdk/Errors_Cache.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/Errors_Cache.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/Errors_Cache.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/Errors_Cache.html Tue Feb 9 22:00:39 2010
@@ -58,16 +58,17 @@
<div class="titlepage"><div><div><h3 class="title">
<a name="Errors_Cache"></a>Errors</h3></div></div></div>
<p>Errors pertaining to the failure of various cache operations are indicated
- by <code class="function">INKCacheError</code> (enumeration) as follows:</p>
+ by <code class="function">INKCacheError</code> (enumeration). They are as follows:</p>
<div class="itemizedlist"><ul type="disc">
<li>
<p><code class="code">INK_CACHE_ERROR_NO_DOC</code> - the key does not match a
- cached resource.</p></li>
+ cached resource</p></li>
<li>
<p><code class="code">INK_CACHE_ERROR_DOC_BUSY</code> - e.g, another
- continuation could be writing to the cache location.</p></li>
-<li><p><code class="code">INK_CACHE_ERROR_NOT_READY</code> - the cache is not
- ready.</p></li>
+ continuation could be writing to the cache location</p></li>
+<li>
+ <p><code class="code">INK_CACHE_ERROR_NOT_READY</code> - the cache is not
+ ready</p></li>
</ul></div>
</div>
</body>
Modified: incubator/trafficserver/site/trunk/docs/sdk/HTTPFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTPFunctions.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTPFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTPFunctions.html Tue Feb 9 22:00:39 2010
@@ -77,7 +77,7 @@
<p>Adds <code class="code"><em class="replaceable"><code>contp </code></em></code> to
the end of the list of global HTTP hooks specified by
<code class="code"><em class="replaceable"><code>id</code></em></code>. Since
- <code class="function">INKHttpHookAdd</code> is adding
+ <code class="function">INKHttpHookAdd</code> adds
<code class="code"><em class="replaceable"><code>contp </code></em></code> to a global list,
this function is only safe to call from the plugin
initialization routine.</p></dd>
Modified: incubator/trafficserver/site/trunk/docs/sdk/HTTPHooksAndTransactions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTPHooksAndTransactions.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTPHooksAndTransactions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTPHooksAndTransactions.html Tue Feb 9 22:00:39 2010
@@ -93,36 +93,37 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="SetOfHooks"></a>The Set of Hooks</h2></div></div></div>
-<p>you should be familiar with the following terminology:</p>
+<p>To understand hooks and transactions, you should be familiar with the following terminology:</p>
<div class="variablelist"><dl>
-<dt><span class="term"><b>HTTP Transaction</b></span></dt>
+<dt><span class="term"><b><u>HTTP Transaction</u></b></span></dt>
<dd>
-<p>A <i>transaction</i> consists of a single HTTP request from a
+<p>A <b>transaction</b> consists of a single HTTP request from a
client and the response Traffic Server sends to that client.
Thus, a transaction begins when Traffic Server receives a request and
ends when Traffic Server sends the response.</p>
-<p>Traffic Server uses <i>HTTP state machines</i> to process
+<p>Traffic Server uses <b>HTTP state machines</b> to process
transactions. The state machines follow a complex set of states
involved in sophisticated caching and document retrieval (taking
into account, for example, alternate selection, freshness
criteria, and hierarchical caching). The Traffic Server API
provides hooks to a subset of these states, as illustrated in the <a href="HTTPHooksAndTransactions.html#Fig_HHTTPTxStateDiag" title="Figure 8.1. HTTP Transaction State Diagram">HTTP Transaction State Diagram</a> below.</p>
</dd>
-<dt><span class="term"><b>Transform hooks</b></span></dt>
+<dt><span class="term"><b><u>Transform hooks</u></b></span></dt>
<dd>
- <p>The two <i>transform hooks</i>, <code class="code">INK_HTTP_REQUEST_TRANSFORM_HOOK</code> and
+ <p>The two <i>t</i><b>ransform hooks</b>, <code class="code">INK_HTTP_REQUEST_TRANSFORM_HOOK</code> and
<code class="code">INK_HTTP_RESPONSE_TRANSFORM_HOOK</code>, are called in the
course of an HTTP transform. To see where in the HTTP transaction
- they are called, look for the âset up transformâ ovals in the <a href="HTTPHooksAndTransactions.html#Fig_HHTTPTxStateDiag" title="Figure 8.1. HTTP Transaction State Diagram">HTTP Transaction State Diagram</a>.</p></dd>
-<dt><span class="term"><b>HTTP session</b></span></dt>
+ they are called, look for the âset up transformâ ovals in the <a href="HTTPHooksAndTransactions.html#Fig_HHTTPTxStateDiag" title="Figure 8.1. HTTP Transaction State Diagram">HTTP Transaction State Diagram</a> below.</p></dd>
+<dt><span class="term"><b><u>HTTP session</u></b></span></dt>
<dd>
- <p>A <i>session</i> consists of a single client connection to Traffic
+ <p>A <b>session</b> consists of a single client connection to Traffic
Server; it may consist of a single transaction or several transactions in
succession. The session starts when the client connection opens
and ends when the connection closes.</p></dd>
</dl></div>
<div class="figure">
-<a name="Fig_HHTTPTxStateDiag"></a><p class="title"><b>Figure 8.1. HTTP Transaction State Diagram</b></p>
+<a name="Fig_HHTTPTxStateDiag"></a>
+<p class="title"><b>Figure 8.1. HTTP Transaction State Diagram (**not yet updated**)</b></p>
<div class="mediaobject"><img src="images/http_state2.jpg" alt="HTTP Transaction State Diagram" /></div>
</div>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/HTTPSessionFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/HTTPSessionFunctions.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/HTTPSessionFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/HTTPSessionFunctions.html Tue Feb 9 22:00:39 2010
@@ -72,7 +72,7 @@
<em class="replaceable"><code>contp</code></em>)</code></p></dd>
<dt><span class="term"><b>Description</b></span></dt>
<dd>
- <p>Adds <code class="code"><em class="replaceable"><code>contp </code></em></code> to
+ <p>Adds <code class="code"><em class="replaceable"><code>contp </code></em></code> to
the end of the list of HTTP transaction hooks specified by
<code class="code"><em class="replaceable"><code>id</code></em></code>. This means that
<code class="code"><em class="replaceable"><code>contp </code></em></code> is called back
@@ -82,7 +82,7 @@
session, it is not possible to call
<code class="function">INKHttpSsnHookAdd</code> from the plugin
initialization routine. Therefore, the plugin needs a handle to an HTTP
- session. See the following example.</p></dd>
+ session (see the example below).</p></dd>
<dt><span class="term"><a name="INKEvent_1"></a><b>Example</b></span></dt>
<dd><pre class="programlisting">#include InkAPI.h
@@ -155,7 +155,7 @@
wants the session to continue. If
<code class="code">INK_EVENT_HTTP_ERROR</code> is specified for
<code class="code"><em class="replaceable"><code>event</code></em></code>, then the plugin
- wants the session to be terminated; an error is sent
+ wants the session to be terminated. An error is then sent
back to the client if no response has already been
sent.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDigestSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDigestSet.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDigestSet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheKeyDigestSet.html Tue Feb 9 22:00:39 2010
@@ -57,7 +57,7 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="INKCacheKeyDigestSet"></a>INKCacheKeyDigestSet</h3></div></div></div>
-<p>Generates and assigns a cache key to an object to be
+<p>Generates and assigns a cache key to an object that will be
cached.</p>
<div class="variablelist"><dl>
<dt><span class="term"><b>Prototype</b></span></dt>
@@ -68,30 +68,31 @@
<dt><span class="term"><b>Arguments</b></span></dt>
<dd>
<p><code class="function">INKCacheKey</code>
- <code class="code"><em class="replaceable"><code>key </code></em></code> is the key to be
- associated to the cached object. Before calling
+ <code class="code"><em class="replaceable"><code>key </code></em></code> is the key that will be
+ associated with the cached object. Before calling
<code class="function">INKCacheKeyDigestSet</code>, you must create the
key with <code class="function">INKCacheKeyCreate</code>. Note that in
order to generate unique keys, you must use unique input
- strings. In other words: if the input strings are identical, then
- <code class="function">INKCacheKeyCreate</code> will generate identical
+ strings. This means that if the input strings are identical, then
+ <code class="function">INKCacheKeyCreate</code> generates identical
keys.</p>
<p><code class="code">const unsigned char
*</code><code class="code"><em class="replaceable"><code>input </code></em></code> is a
character string that uniquely identifies the object. In most
- cases, it is the URL of the object.</p>
+ cases, it's the URL of the object.</p>
<p><code class="code">int
</code><code class="code"><em class="replaceable"><code>length </code></em></code> is the
- length of the string input.</p>
+ length of the input string.</p>
</dd>
<dt><span class="term"><b>Description</b></span></dt>
-<dd><p>Generates and assigns a cache key to an object to be
+<dd>
+ <p>Generates and assigns a cache key to the object to be
cached.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
-<p><code class="code">INK_SUCCESS</code> if the cache key was successfully
+<p><code class="code">INK_SUCCESS</code> if the cache key is successfully
generated.</p>
-<p><code class="code">INK_ERROR</code> if digest could not be set.</p>
+<p><code class="code">INK_ERROR</code> if <code class="function">INKCacheKeyDigestSet</code> cannot be set.</p>
</dd>
<dt><span class="term"><b>Example</b></span></dt>
<dd><pre class="programlisting">const char *digest_string = "mydigest"
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKCacheReady.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKCacheReady.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKCacheReady.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKCacheReady.html Tue Feb 9 22:00:39 2010
@@ -65,15 +65,15 @@
*<em class="replaceable"><code>is_ready</code></em>)</code></p></dd>
<dt><span class="term"><b>Arguments</b></span></dt>
<dd>
- <p>The <code class="code">int *<em class="replaceable"><code>is_ready </code></em></code>
- argument is set to a non-zero value if the cache is ready. It is set to 0 if the cache is not
- ready.</p></dd>
+ <p>If the cache is ready, then the <code class="code">int *<em class="replaceable"><code>is_ready </code></em></code>
+ argument is set to a non-zero value. It is set to 0 if the cache is not
+ ready.</p></dd>
<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Asks the Traffic Server cache if it is initialized and
ready to accept requests. If the cache is not initialized, then any
attempts to read, write, or remove documents will fail.</p>
-<p>When a plugin starts (its
+<p>When a plugin starts (i.e., when its
<code class="function">INKPluginInit</code> function is called), there is
no guarantee that the cache is already initialized. This API is
useful if a plugin needs to access the cache from the
@@ -84,7 +84,7 @@
<dd>
<p><code class="code">INK_SUCCESS</code> if the API is called
successfully.</p>
-<p><code class="code">INK_ERROR</code> if this function could not be set or
+<p><code class="code">INK_ERROR</code> if this function cannot be set or
if it is invalid.</p>
</dd>
</dl></div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKConfigRelease.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKConfigRelease.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKConfigRelease.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKConfigRelease.html Tue Feb 9 22:00:39 2010
@@ -68,10 +68,10 @@
<p>Releases the configuration pointer
<code class="code"><em class="replaceable"><code>configp </code></em></code> on the
configuration associated with the identifier
- <code class="code"><em class="replaceable"><code>id</code></em></code>. It is possible that
+ <code class="code"><em class="replaceable"><code>id</code></em></code>. If
<code class="code"><em class="replaceable"><code>configp </code></em></code> is no longer the
- current configuration, in which case
- <code class="function">INKConfigRelease</code> may end up calling the
+ current configuration, then
+ <code class="function">INKConfigRelease</code> may call the
configurationâs destroy function (see code snippet in the
previous section).</p></dd>
</dl></div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKContCreate.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKContCreate.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKContCreate.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKContCreate.html Tue Feb 9 22:00:39 2010
@@ -65,7 +65,7 @@
<em class="replaceable"><code>mutexp</code></em>)</code></p></dd>
<dt><span class="term"><b>Description</b></span></dt>
<dd>
-<p>Creates a new <code class="function">INKCont</code>. The
+<p>Creates a new <code class="function">INKCont </code>object. The
continuationâs handler function is
<code class="code"><em class="replaceable"><code>funcp </code></em></code> and its mutex is
<code class="code"><em class="replaceable"><code>mutexp</code></em></code>. As mentioned
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKContDataGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKContDataGet.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKContDataGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKContDataGet.html Tue Feb 9 22:00:39 2010
@@ -66,11 +66,11 @@
<dd>
<p>Retrieves the data pointer from
<code class="code"><em class="replaceable"><code>contp</code></em></code>. The data pointer
- can be set via a call to <code class="function">INKContDataSet</code>; it
+ can be set with a call to <code class="function">INKContDataSet</code>; it
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">contp</code>. </p>
<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
</dd>
</dl></div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKContDataSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKContDataSet.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKContDataSet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKContDataSet.html Tue Feb 9 22:00:39 2010
@@ -57,7 +57,7 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="INKContDataSet"></a>INKContDataSet</h3></div></div></div>
-<p>Sets a data pointer for a specified continuation.</p>
+<p>Sets a data pointer for the specified continuation.</p>
<div class="variablelist"><dl>
<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">INKReturnCode INKContDataSet (INKCont
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKContMutexGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKContMutexGet.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKContMutexGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKContMutexGet.html Tue Feb 9 22:00:39 2010
@@ -63,7 +63,8 @@
<dd><p><code class="code">INKMutex INKContMutexGet (INKCont
<em class="replaceable"><code>contp</code></em>)</code></p></dd>
<dt><span class="term"><b>Description</b></span></dt>
-<dd><p>Gets the mutex for
+<dd>
+ <p>Gets the mutex for the continuation
<code class="code"><em class="replaceable"><code>contp</code></em></code>.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKError.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKError.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKError.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKError.html Tue Feb 9 22:00:39 2010
@@ -61,18 +61,18 @@
<div class="variablelist"><dl>
<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">void INKError (const char
- *<em class="replaceable"><code>fmt</code></em>, ...)</code></p></dd>
+ *<em class="replaceable"><code>fmt</code></em>, <span class="replaceable">...</span>)</code></p></dd>
<dt><span class="term"><b>Arguments</b></span></dt>
<dd>
<p><code class="code"><em class="replaceable"><code>fmt </code></em></code> is the <code>printf</code> format description.</p>
-<p><code class="code">... </code>is the argument for the format
+<p><code class="replaceable">... </code>is the argument for the format
description.</p>
</dd>
-<dt><span class="term"><b>Description</b></span></dt>
+<dt><span class="term"><b>Description</b></span> </dt>
<dd>
<p>It is sometimes useful to log messages when errors occur.
Traffic Server has a global error log file to which it writes
- such messages - the function <code>INKError</code> is the API interface to
+ such messages, and the function <code>INKError</code> is the API interface to
this error log. <code class="function">INKError</code> is similar to
<code>printf</code> except that instead of writing the output to the C
standard output, <code class="function">INKError</code> writes output to
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKHostLookupResultIPGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKHostLookupResultIPGet.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKHostLookupResultIPGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKHostLookupResultIPGet.html Tue Feb 9 22:00:39 2010
@@ -57,7 +57,7 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="INKHostLookupResultIPGet"></a>INKHostLookupResultIPGet</h3></div></div></div>
-<p>Gets the IP address of a host name Traffic Server has
+<p>Gets the IP address of a hostname Traffic Server has
looked up.</p>
<div class="variablelist"><dl>
<dt><span class="term"><b>Prototype</b></span></dt>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockWriteAvail.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockWriteAvail.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockWriteAvail.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockWriteAvail.html Tue Feb 9 22:00:39 2010
@@ -69,7 +69,7 @@
<code class="code"><em class="replaceable"><code>blockp</code></em></code>.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
-<p>The number of bytes available for writing.</p>
+<p>The number of bytes available for writing (in the specified buffer block).</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
</dl></div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockWriteStart.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockWriteStart.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockWriteStart.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferBlockWriteStart.html Tue Feb 9 22:00:39 2010
@@ -57,7 +57,7 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="INKIOBufferBlockWriteStart"></a>INKIOBufferBlockWriteStart</h3></div></div></div>
-<p>Starts to write IO buffer block.</p>
+<p>Starts a write to the specified IO buffer block.</p>
<div class="variablelist"><dl>
<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">char* INKIOBufferBlockWriteStart (INKIOBufferBlock
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKVConnCacheObjectSizeGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKVConnCacheObjectSizeGet.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKVConnCacheObjectSizeGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKVConnCacheObjectSizeGet.html Tue Feb 9 22:00:39 2010
@@ -57,7 +57,7 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="INKVConnCacheObjectSizeGet"></a>INKVConnCacheObjectSizeGet</h3></div></div></div>
-<p>Gets the size of the object in the cache.</p>
+<p>Gets the size of an object in the cache.</p>
<div class="variablelist"><dl>
<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">INKReturnCode INKVConnCacheObjectSizeGet (INKVConn
@@ -75,7 +75,7 @@
<dd>
<p>When a cached object is requested from the cache (using
<code class="function">INKCacheRead</code>) and if the cache open was
- successful, this function can be called to get the size of the
+ successful, then this function can be called to get the size of the
object in the cache.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKfgets.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKfgets.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKfgets.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKfgets.html Tue Feb 9 22:00:39 2010
@@ -79,10 +79,9 @@
<code class="code"><em class="replaceable"><code>filep </code></em></code> into the buffer
<code class="code"><em class="replaceable"><code>buf</code></em></code>. Lines are
terminated by a line feed character, <code class="code">\n</code>. The line
- placed in the buffer includes the line feed character and is
+ placed in the buffer includes the line feed character; it is
terminated with a <code class="code">NULL</code>. If the line is longer than
- length bytes, then only the first length - 1 bytes are placed in
- <code class="code"><em class="replaceable"><code>buf</code></em></code>.</p></dd>
+ <span class="replaceable"><code>length</code></span> bytes, then only the first <span class="replaceable"><code>length</code></span> - 1 bytes are placed in <code class="code"><em class="replaceable"><code>buf</code></em></code>.</p></dd>
</dl></div>
</div>
</body>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKfopen.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKfopen.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKfopen.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKfopen.html Tue Feb 9 22:00:39 2010
@@ -68,8 +68,7 @@
<p><code class="code"><em class="replaceable"><code>filename </code></em></code> is the
name of the file to open.</p>
<p><code class="code"><em class="replaceable"><code>mode </code></em></code> specifies
- whether to open the file for reading or writing. If mode
- is:</p>
+ whether to open the file for reading or writing. If <code><span class="replaceable">mode </span></code> is:</p>
<ul>
<li><code class="code"><b>r</b></code>, then the file is opened for
reading.</li>
@@ -95,7 +94,7 @@
<dt><span class="term"><b>Example</b></span></dt>
<dd>
<p>The following example is taken from the append-transform
- plugin, whoch appends text to the end of
+ plugin, which appends text to the end of
HTTP response bodies. This subroutine loads the text to be added
from a file.</p>
<pre class="programlisting">static int
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamily.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamily.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamily.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamily.html Tue Feb 9 22:00:39 2010
@@ -59,12 +59,12 @@
<a name="INKfopenFamily"></a>The INKfopen Family</h2></div></div></div>
<p>The <code class="function">fopen</code> family of functions in C is
normally used for reading configuration files, since <code>fgets</code> is an easy
- way to parse files on a line-by-line basis. The <code class="function">INKfopen</code> family of functions is targeted at solving
+ way to parse files on a line-by-line basis. The <code class="function">INKfopen</code> family of functions aims at solving
the same problem of buffered IO and line at a time IO in a platform-independent manner. The
<code class="function">fopen</code> family of C library functions can only open a
file if a file descriptor less than 256 is available. Since Traffic Server
often has more than 2000 file descriptors open at once, however, the
- likelihood of an available file descriptor less than 256 very small. The
+ likelihood of an available file descriptor less than 256 very small. To solve this problem, the
<code class="function">INKfopen</code> family can open files with descriptors
greater than 256.</p>
<p>The <code class="function">INKfopen</code> family of routines is not
Modified: incubator/trafficserver/site/trunk/docs/sdk/IOBufferInterfaceFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/IOBufferInterfaceFunctions.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/IOBufferInterfaceFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/IOBufferInterfaceFunctions.html Tue Feb 9 22:00:39 2010
@@ -81,7 +81,7 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="INKIOBufferBlockNext"></a>INKIOBufferBlockNext</h3></div></div></div>
-<p>Gets next IO buffer block.</p>
+<p>Gets the next IO buffer block.</p>
<div class="variablelist"><dl>
<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">INKIOBufferBlock INKIOBufferBlockNext
Modified: incubator/trafficserver/site/trunk/docs/sdk/PluginConfigurationFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/PluginConfigurationFunctions.html?rev=908249&r1=908248&r2=908249&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/PluginConfigurationFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/PluginConfigurationFunctions.html Tue Feb 9 22:00:39 2010
@@ -74,13 +74,13 @@
<dd>
<p>Retrieves the data pointer from within the configuration
pointer <code class="code"><em class="replaceable"><code>configp</code></em></code>. Before
- you use <code class="function">INKConfigDataGet</code>, you must give the
+ using <code class="function">INKConfigDataGet</code>, you must give the
configuration data an identifier with
<code class="function">INKConfigSet</code> and then retrieve the
<code class="function">INKConfig</code> pointer
<code class="code"><em class="replaceable"><code>configp </code></em></code> with a call to
<code class="function">INKConfigGet</code> (see the code snippet in the
- previous section).</p></dd>
+ previous section).</p></dd>
</dl></div>
</div>
</div>