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/19 19:33:47 UTC
svn commit: r911895 - /incubator/trafficserver/site/trunk/docs/sdk/
Author: dianes
Date: Fri Feb 19 18:33:47 2010
New Revision: 911895
URL: http://svn.apache.org/viewvc?rev=911895&view=rev
Log: (empty)
Modified:
incubator/trafficserver/site/trunk/docs/sdk/INKVConnClose.html
incubator/trafficserver/site/trunk/docs/sdk/INKVConnClosedGet.html
incubator/trafficserver/site/trunk/docs/sdk/INKVConnRead.html
incubator/trafficserver/site/trunk/docs/sdk/INKVConnReadVIOGet.html
incubator/trafficserver/site/trunk/docs/sdk/INKVConnShutdown.html
incubator/trafficserver/site/trunk/docs/sdk/INKVConnWriteVIOGet.html
incubator/trafficserver/site/trunk/docs/sdk/INKVIOReaderGet.html
incubator/trafficserver/site/trunk/docs/sdk/INKVIOReenable.html
incubator/trafficserver/site/trunk/docs/sdk/TransformationFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/VconnectionFunctions.html
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKVConnClose.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKVConnClose.html?rev=911895&r1=911894&r2=911895&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKVConnClose.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKVConnClose.html Fri Feb 19 18:33:47 2010
@@ -63,13 +63,13 @@
<dd><p><code class="code">INKReturnCode INKVConnClose (INKVConn
<em class="replaceable"><code>connp</code></em>)</code></p></dd>
<dt><span class="term"><b>Description</b></span></dt>
-<dd><p>Closes the vconnection
- <code class="code"><em class="replaceable"><code>connp</code></em></code>. The vconnection
- will be de-allocated at some point in the near future after
- having <code class="function">INKVConnClose</code> called upon it. After
+<dd>
+ <p>Closes the vconnection
+ <code class="code"><em class="replaceable"><code> connp</code></em></code>. The vconnection
+ will be deallocated at some point in the near future, after <code class="function">INKVConnClose</code> is called. After
calling <code class="function">INKVConnClose</code>, a user will not
receive any more events from
- <code class="code"><em class="replaceable"><code>connp</code></em></code>.</p></dd>
+ <code class="code"><em class="replaceable"><code>connp</code></em></code>.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if the connection is successfully
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKVConnClosedGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKVConnClosedGet.html?rev=911895&r1=911894&r2=911895&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKVConnClosedGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKVConnClosedGet.html Fri Feb 19 18:33:47 2010
@@ -68,8 +68,8 @@
<p><code class="function">INKVConnClosedGet</code> is intended to be
used by vconnection implementors and not by vconnection users.
It is not safe for a vconnection user to call
- <code class="function">INKVConnClosedGet</code> - this is because if the vconnection
- actually is closed, then it is possible (and likely) for it to be
+ <code class="function">INKVConnClosedGet</code> because if the vconnection
+ actually is closed, then it is possible (and likely) it will/can be
deallocated at any time.</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
@@ -79,7 +79,7 @@
<tr><td align="left" valign="top"><p>This API can be used <span class="bold"><strong>ONLY</strong></span> on transformation VConnections.
<span class="bold"><strong>NEVER</strong></span> use it on Cache
VConnections, Net VConnections or any other type of
- VConnections.</p></td></tr>
+ VConnection.</p></td></tr>
</table></div>
</dd>
<dt><span class="term"><b>Returns</b></span></dt>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKVConnRead.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKVConnRead.html?rev=911895&r1=911894&r2=911895&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKVConnRead.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKVConnRead.html Fri Feb 19 18:33:47 2010
@@ -70,13 +70,13 @@
<p>Initiates a read operation on the vconnection
<code class="code"><em class="replaceable"><code>connp</code></em></code>. The read
operation writes into the buffer
- <code class="code"><em class="replaceable"><code>bufp</code></em></code>. The continuation
- <code class="code"><em class="replaceable"><code>contp </code></em></code> is called
+ <code class="code"><em class="replaceable"><code> bufp</code></em></code>. The continuation
+ <code class="code"><em class="replaceable"><code> contp </code></em></code> is called
back with either <code class="code">INK_EVENT_ERROR</code>,
<code class="code">INK_EVENT_VCONN_READ_READY</code>,
<code class="code">INK_EVENT_VCONN_READ_COMPLETE</code>, or
<code class="code">INK_EVENT_VCONN_EOS</code> (refer to the <a href="IOGuide.html#VconnectionUsersView" title="The vconnection userâs view">vconnection userâs view</a> for more information about
- these events). The number of bytes to read is specified by the <code class="code"><em class="replaceable"><code>nbytes </code></em></code> parameter.</p></dd>
+ these events). The number of bytes to read is specified by the <code class="code"><em class="replaceable"><code> nbytes </code></em></code> parameter.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>A handle to the vconnection.</p>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKVConnReadVIOGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKVConnReadVIOGet.html?rev=911895&r1=911894&r2=911895&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKVConnReadVIOGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKVConnReadVIOGet.html Fri Feb 19 18:33:47 2010
@@ -65,7 +65,7 @@
<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Retrieves the read VIO for a vconnection.
- <code class="function">INKVConnReadVIOGet</code> is intended to be used
+ <code class="function">INKVConnReadVIOGet</code> should be used
by vconnection implementors and not by vconnection users.</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/INKVConnShutdown.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKVConnShutdown.html?rev=911895&r1=911894&r2=911895&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKVConnShutdown.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKVConnShutdown.html Fri Feb 19 18:33:47 2010
@@ -70,17 +70,16 @@
<code class="code"><em class="replaceable"><code>connp</code></em></code>. If
<code class="code"><em class="replaceable"><code>read </code></em></code> is non-zero, then
the read portion of
- <code class="code"><em class="replaceable"><code>connp </code></em></code> is shut down. This ndicates that the user does not want to be called back
+ <code class="code"><em class="replaceable"><code>connp </code></em></code> is also shut down. This indicates that the user does not want to be called back
regarding any more read events on this vconnection. If
<code class="code"><em class="replaceable"><code>write </code></em></code> is non-zero, then
the write portion of
- <code class="code"><em class="replaceable"><code>connp </code></em></code> is shutdown
- indicating that the user does not want to be called back
+ <code class="code"><em class="replaceable"><code>connp </code></em></code> is shut down, indicating that the user does not want to be called back
regarding any more write events on this vconnection.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if the connection is successfully
- shutdown.</p>
+ shut down.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
</dl></div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKVConnWriteVIOGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKVConnWriteVIOGet.html?rev=911895&r1=911894&r2=911895&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKVConnWriteVIOGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKVConnWriteVIOGet.html Fri Feb 19 18:33:47 2010
@@ -43,6 +43,7 @@
</script>
</head>
<body>
+\
<div class="doctitle">
<a href="index.html">Home</a>
<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
@@ -65,7 +66,7 @@
<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Retrieves the write VIO for a vconnection.
- <code class="function">INKVConnWriteVIOGet</code> is intended to be used
+ <code class="function">INKVConnWriteVIOGet</code> should be used
by vconnection implementors and not by vconnection users.</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
@@ -77,8 +78,8 @@
</dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
-<p>A handle to the vconnection if successful.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</p>
+<p>If successful, then a handle to the vconnection is returned.</p>
+<p><code class="code">INK_ERROR_PTR</code> if there is an error.</p>
</dd>
</dl></div>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKVIOReaderGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKVIOReaderGet.html?rev=911895&r1=911894&r2=911895&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKVIOReaderGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKVIOReaderGet.html Fri Feb 19 18:33:47 2010
@@ -67,7 +67,7 @@
<p>Gets a buffer reader for the IO operation described by
<code class="code"><em class="replaceable"><code>viop</code></em></code>.
<code class="function">INKVIOReaderGet</code> is used by vconnections
- performing write operations (write operations read from their
+ performing write operations (since write operations read from their
buffers).</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
Modified: incubator/trafficserver/site/trunk/docs/sdk/INKVIOReenable.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKVIOReenable.html?rev=911895&r1=911894&r2=911895&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKVIOReenable.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKVIOReenable.html Fri Feb 19 18:33:47 2010
@@ -64,8 +64,8 @@
<em class="replaceable"><code>viop</code></em>)</code></p></dd>
<dt><span class="term"><b>Description</b></span></dt>
<dd>
- <p>Re-enables the vconnection associated with
- <code class="code"><em class="replaceable"><code>viop</code></em></code>. Re-enabling a vconnection means that it will wake up and be able
+ <p>Reenables the vconnection associated with
+ <code class="code"><em class="replaceable"><code>viop</code></em></code>. Reenabling a vconnection means that it will wake up and therefore be able
to determine that the buffer being used in its IO operation has
changed.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
Modified: incubator/trafficserver/site/trunk/docs/sdk/TransformationFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/TransformationFunctions.html?rev=911895&r1=911894&r2=911895&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/TransformationFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/TransformationFunctions.html Fri Feb 19 18:33:47 2010
@@ -73,8 +73,8 @@
<dd>
<p>Creates a new transformation, <code class="code">INKVConn</code>. The
vconnectionâs handler function is
- <code class="code"><em class="replaceable"><code>funcp </code></em></code> and its mutex is
- taken from <code class="code"><em class="replaceable"><code>txnp</code></em></code>.</p></dd>
+ <code class="code"><em class="replaceable"><code> funcp </code></em></code> and its mutex is
+ taken from <code class="code"><em class="replaceable"><code> txnp</code></em></code>.</p></dd>
<dt><span class="term"><b>Example</b></span></dt>
<dd>
<p>See the <a href="SampleNullTransformPlugin.html" title="The Sample Null Transform Plugin"> Sample Null Transform Plugin</a> example.</p></dd>
Modified: incubator/trafficserver/site/trunk/docs/sdk/VconnectionFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/VconnectionFunctions.html?rev=911895&r1=911894&r2=911895&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/VconnectionFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/VconnectionFunctions.html Fri Feb 19 18:33:47 2010
@@ -69,8 +69,7 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="INKVConnAbort"></a>INKVConnAbort</h3></div></div></div>
-<p>Closes a vconnection and specifies that the operations it was
- performing were aborted.</p>
+<p>Closes a vconnection and specifies that operations being performing were aborted.</p>
<div class="variablelist"><dl>
<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">INKReturnCode INKVConnAbort (INKVConn
@@ -81,8 +80,7 @@
<p>Closes the vconnection
<code class="code"><em class="replaceable"><code>connp </code></em></code> and specifies that
the operations it was performing were aborted. The vconnection
- will be deallocated at some point in the near future, after
- having <code class="function">INKVConnAbort</code> called upon it. After
+ will be deallocated at some point in the near future, after <code class="function">INKVConnAbort</code> is called. After
calling <code class="function">INKVConnClose</code>, a user will not
receive any more events from
<code class="code"><em class="replaceable"><code>connp</code></em></code>. For most
@@ -90,7 +88,7 @@
<code class="function">INKVConnAbort</code> perform identical operations; a potential difference is that when a vconnection is aborted, the
vconnection implementor can decide to do something special. For
example, a vconnection writing a file to disk might decide to
- delete the file.</p></dd>
+ delete the file.</p></dd>
<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if the connection is successfully