You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by bu...@apache.org on 2013/12/24 19:32:22 UTC
svn commit: r891679 [16/24] - in /websites/staging/trafficserver/trunk:
cgi-bin/ content/ content/docs/ content/docs/trunk/
content/docs/trunk/admin/ content/docs/trunk/admin/cluster-howto/
content/docs/trunk/admin/configuration-files/ content/docs/tru...
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKMutexUnlock.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKMutexUnlock.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKMutexUnlock.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,38 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKMutexUnlock</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKMutexLockTry.html">Prev</a> - INKMutexLockTry</div>
+<div class="navnext">Continuation Functions - <a accesskey="n" href="ContinuationFunctions.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMutexUnlock"></a>INKMutexUnlock</h3></div></div></div>
+<p>Unlocks an <code class="code">INKMutex</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKReturnCode INKMutexUnlock (INKMutex
+ <em class="replaceable"><code>mutexp</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Unlocks the <code class="function">INKMutex </code>
+ <code class="code"><em class="replaceable"><code> mutexp</code></em></code>. If
+ <code class="code"><em class="replaceable"><code> mutexp </code></em></code> was recursively
+ locked, then <code class="function">INKMutexUnlock</code> does not
+ actually unlock the mutex - it simply decrements the recursion
+ count.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the mutex is successfully
+ unlocked.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKMutexUnlock.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKNetConnect.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKNetConnect.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKNetConnect.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,78 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKNetConnect</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="NetvconnectionFunctions.html">Prev</a> - Netvconnection Functions: INKNetAccept</div>
+<div class="navnext">INKNetVConnRemoteIPGet - <a accesskey="n" href="INKNetVConnRemoteIPGet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKNetConnect"></a>INKNetConnect</h3></div></div></div>
+<p>Initiates a network connection to a server.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKAction INKNetConnect (INKCont
+ <em class="replaceable"><code>contp</code></em>, unsigned int
+ <em class="replaceable"><code>ip</code></em>, int
+ <em class="replaceable"><code>port</code></em>)</code></p></dd>
+<dt><span class="term"><b>Arguments</b></span></dt>
+<dd>
+<p><code class="function">INKCont</code>
+ <code class="code"><em class="replaceable"><code>contp </code></em></code> is the
+ continuation to be associated with the connection.</p>
+<p><code class="code">int
+ </code><code class="code"><em class="replaceable"><code>ip </code></em></code> is the IP
+ address, in network byte order, of the host to connect
+ with.</p>
+<p><code class="code">int</code>
+ <code class="code"><em class="replaceable"><code>port </code></em></code> is port number for
+ the host, specified in network byte order.</p>
+</dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Opens a network connection to the host specified by
+ <code class="code"><em class="replaceable"><code>ip </code></em></code> on the port specified
+ by <code class="code"><em class="replaceable"><code>port</code></em></code>. If the
+ connection is successfully opened, then
+ <code class="code"><em class="replaceable"><code>contp </code></em></code> is called
+ back with the event <code class="code">INK_EVENT_NET_CONNECT</code> and the
+ new network vconnection is passed in the event data
+ parameter. If the connection is not successful, then
+ <code class="code"><em class="replaceable"><code>contp </code></em></code> is called
+ back with the event
+ <code class="code">INK_EVENT_NET_CONNECT_FAILED</code>.</p>
+<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+<p>It's possible to receive
+ <code class="code">INK_EVENT_NET_CONNECT</code> even if the connection
+ failed because of the implementation of network sockets in
+ the underlying operating system. There is an exception: if a
+ plugin tries to open a connection to a port on its own host
+ machine, then <code class="code">INK_EVENT_NET_CONNECT</code> is sent only
+ if the connection is successful. In general, however, your
+ plugin needs to look for
+ <code class="code">INK_EVENT_VCONN_WRITE_READY</code> or
+ <code class="code">INK_EVENT_VCONN_READ_READY</code> to make sure the
+ connection is successfully opened.</p>
+<p>Reentrant calls are possible; i.e., the net processor 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>
+</dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd><p>An <code class="function">INKAction</code> object.</p></dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKNetConnect.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKNetVConnRemoteIPGet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKNetVConnRemoteIPGet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKNetVConnRemoteIPGet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,44 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKNetVConnRemoteIPGet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKNetConnect.html">Prev</a> - INKNetConnect</div>
+<div class="navnext">INKNetVConnRemotePortGet - <a accesskey="n" href="INKNetVConnRemotePortGet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKNetVConnRemoteIPGet"></a>INKNetVConnRemoteIPGet</h3></div></div></div>
+<p>Retrieves the remote host's IP address.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKReturnCode INKNetVConnRemoteIPGet (INKVConn
+ <em class="replaceable"><code>vc</code></em>, unsigned int
+ *<em class="replaceable"><code>ip</code></em>)</code></p></dd>
+<dt><span class="term"><b>Arguments</b></span></dt>
+<dd>
+<p><code>INKVConn </code> <code class="code"><em class="replaceable"><code>vc </code></em></code> is the
+ connection between Traffic Server and the other end of the
+ connection (can be a remote client or server).</p>
+<p><code class="code">unsigned int
+ *</code><code class="code"><em class="replaceable"><code>ip </code></em></code> is set to the
+ remote IP address, in network byte order.</p>
+</dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd><p>Obtains the remote IP address in network byte
+ order.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the API is called
+ successfully.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs while calling
+ the API or if an argument is invalid.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKNetVConnRemoteIPGet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKNetVConnRemotePortGet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKNetVConnRemotePortGet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKNetVConnRemotePortGet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,45 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKNetVConnRemotePortGet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKNetVConnRemoteIPGet.html">Prev</a> - INKNetVConnRemoteIPGet</div>
+<div class="navnext">Cache Interface Functions - <a accesskey="n" href="CacheInterfaceFunctions.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKNetVConnRemotePortGet"></a>INKNetVConnRemotePortGet</h3></div></div></div>
+<p>Retrieves the remote host's port number.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">InkReturnCode INKNetVConnRemotePortGet (INKVConn
+ <em class="replaceable"><code>vc</code></em>, int
+ *<em class="replaceable"><code>port</code></em>)</code></p></dd>
+<dt><span class="term"><b>Arguments</b></span></dt>
+<dd>
+<p><code>INKVConn <em class="replaceable">vc </em></code><code class="code"><em class="replaceable"><code> </code></em></code> is the
+ connection between Traffic Server and the other end of the
+ connection (can be remote client or server).</p>
+<p><code class="code">int
+ *</code><code class="code"><em class="replaceable"><code>port </code></em></code> is set to
+ the remote port value in host byte order.</p>
+</dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd><p>Obtains the port number of the remote host for the
+ specified connection. The port is returned in host byte
+ order.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the API is called
+ successfully.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs while calling
+ the API or if an argument is invalid.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKNetVConnRemotePortGet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKPluginDirGet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKPluginDirGet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKPluginDirGet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,44 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKPluginDirGet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="CustInstallLicenseFunctions.html">Prev</a> - Customer Installation & Licensing Fxns: INKInstallDirGet</div>
+<div class="navnext">INKPluginLicenseRequired - <a accesskey="n" href="INKPluginLicenseRequired.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKPluginDirGet"></a>INKPluginDirGet</h3></div></div></div>
+<p>Gets the plugin directory.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd>
+ <p><code class="code">const char *INKPluginDirGet(void)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Gets the plugin directory relative to Traffic Server's
+ install directory. This path (relative to the Traffic Server
+ install directory) is stored in the
+ <code class="filename">records.config</code> variable
+ <code class="varname"><i> proxy.config.plugin.plugin_dir</i></code>. The default value is <code>config/plugin</code>.</p>
+</dd>
+<dt><span class="term"><b>Example</b></span></dt>
+<dd>
+<p>To open the
+ <code class="filename">Blacklist/ui/blacklist_config.txt</code> file,
+ use the following:</p>
+<pre class="programlisting">INKfopen ("INKInstallDirGet()/INKPluginDirGet()/Blacklist/ui/blacklist_config.txt");</pre>
+</dd>
+<dt> </dt>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd><p>A pointer to a string containing the plugin
+ directory.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKPluginDirGet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKPluginLicenseRequired.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKPluginLicenseRequired.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKPluginLicenseRequired.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,49 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKPluginLicenseRequired</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKPluginDirGet.html">Prev</a> - INKPluginDirGet</div>
+<div class="navnext">Statistics Functions - <a accesskey="n" href="StatisticsFunctions.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKPluginLicenseRequired"></a>INKPluginLicenseRequired</h3></div></div></div>
+<p>Specifies to Traffic Server that a license key is required for a
+ plugin.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code>int INKPluginLicenseRequired(void)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Determines if a license is required. If a license is required, then Traffic
+ Server looks in the <code>plugin.db</code> file for the license key. If this
+ function is simply not defined, then the plugin does not require a license.</p></dd>
+<dt><span class="term"><b>Example</b></span></dt>
+<dd>
+ <pre class="programlisting">#include <stdio.h>
+#include <ts/ts.h>
+
+void INKPluginInit (int argc, const char *argv[])
+{
+ printf ("hello world\n");
+}
+int INKPluginLicenseRequired(void)
+{
+ return 1;
+}</pre></dd>
+<dt> </dt>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+ <p>Returns <code>0</code> if a license is not required.</p>
+ <p>Returns <code>1</code> if a license is required.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
+
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKPluginLicenseRequired.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKPluginRegister.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKPluginRegister.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKPluginRegister.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,56 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKPluginRegister</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="InitializationFunctions.html">Prev</a> - Initialization Functions</div>
+<div class="navnext">INKTrafficServerVersionGet - <a accesskey="n" href="INKTrafficServerVersionGet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKPluginRegister"></a>INKPluginRegister</h3></div></div></div>
+<p>Registers the appropriate SDK version for your plugin.</p>
+<div class="variablelist"><dl>
+ <dt><span class="term"><b>Prototype</b></span></dt>
+ <dd><p><code class="code">int INKPluginRegister (INKSDKVersion
+ <em class="replaceable"><code>sdk_version</code></em>,
+ INKPluginRegistrationInfo
+ <em class="replaceable"><code>*plugin_info</code></em>)</code></p></dd>
+ <dt><span class="term"><b>Arguments</b></span></dt>
+ <dd> <em class="replaceable"><code>sdk_version </code></em> can have the
+ following values:
+ <ul>
+ <li><code class="code">INK_SDK_VERSION_1_0</code></li>
+ <li><code class="code">INK_SDK_VERSION_1_1</code></li>
+ <li><code class="code">INK_SDK_VERSION_2_0</code></li>
+ </ul> <br/>
+ <blockquote>
+ <p><code class="function">INKPluginRegistrationInfo</code> is the
+ following struct:</p>
+ <pre class="programlisting">typedef struct
+ {
+ char *plugin_name;
+ char *vendor_name;
+ char *support_email;
+ } INKPluginRegistrationInf</pre></blockquote>
+ </dd>
+
+ <dt><span class="term"><b>Description</b></span></dt>
+ <dd>
+ <p>Registers the appropriate SDK version for your plugin. Use
+ this function to ensure that your plugin is supported by the version of Traffic Server it's running on. See the modified <a href="PlusingRegisAndVersionCkg.html" title="Plugin Registration and Version Checking">hello-world example</a> that checks Traffic Server version for
+ usage.</p>
+ </dd>
+ <dt><span class="term"><b>Returns</b></span></dt>
+ <dd>
+ <p>If plugin registration fails, then <code>0</code> is returned.</p></dd>
+</dl>
+ </div>
+</div>
+</body>
+</html>
+
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKPluginRegister.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKReleaseAssert.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKReleaseAssert.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKReleaseAssert.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,33 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKReleaseAssert</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKAssert.html">Prev</a> - INKAssert</div>
+<div class="navnext">The INKfopen Family - <a accesskey="n" href="INKfopenFamilyFunctions.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKReleaseAssert"></a>INKReleaseAssert</h3></div></div></div>
+<p>Allows the use of assertion in a plugin.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">void
+ INKReleaseAssert(<em class="replaceable"><code>expression</code></em>);</code></p></dd>
+<dt><span class="term"><b>Arguments</b></span></dt>
+<dd>
+ <p>A Boolean expression.</p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Allows the use of assertion in a plugin. If the expression is false, then it causes Traffic Server in <code>debug</code> <u>and</u> <code>optim</code> mode to print the file name, line number, and
+ expression. Afterward, it aborts.</p>
+<p> </p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKReleaseAssert.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectDestroy.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectDestroy.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectDestroy.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,44 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKTextLogObjectDestroy</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="LoggingFunctions.html#INKTextLogObjectCreate">Prev</a> - Logging Functions: INKTextLogObjectCreate</div>
+<div class="navnext">INKTextLogObjectFlush - <a accesskey="n" href="INKTextLogObjectFlush.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKTextLogObjectDestroy"></a>INKTextLogObjectDestroy</h3></div></div></div>
+<p>Destroys the custom log file created by
+ <code>INKTextLogObjectCreate</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKReturnCode INKTextLogObjectDestroy
+ (INKTextLogObject
+ <em class="replaceable"><code>the_object</code></em>)</code></p></dd>
+<dt><span class="term"><b>Arguments</b></span></dt>
+<dd>
+ <p><code class="function">INKTextLogObject</code>
+ <code class="code"><em class="replaceable"><code>the_object </code></em></code> is the custom
+ log file you want to destroy. You must first create this
+ object with <code class="function">INKTextLogObjectCreate</code>.</p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Destroys a log object (a plugin's custom log file) and
+ releases the memory allocated to it. Use this call if you're finished with
+ the log.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the API is called
+ successfully.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs while calling
+ the API or if an argument is invalid.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectDestroy.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectFlush.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectFlush.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectFlush.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,46 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKTextLogObjectFlush</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKTextLogObjectDestroy.html">Prev</a> - INKTextLogObjectDestroy</div>
+<div class="navnext">INKTextLogObjectHeaderSet - <a accesskey="n" href="INKTextLogObjectHeaderSet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKTextLogObjectFlush"></a>INKTextLogObjectFlush</h3></div></div></div>
+<p>Flushes the contents of a specified log file's log write buffer.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKReturnCode INKTextLogObjectFlush
+ (INKTextLogObject
+ <em class="replaceable"><code>the_object</code></em>)</code></p></dd>
+<dt><span class="term"><b>Arguments</b></span></dt>
+<dd>
+ <p><code class="function">INKTextLogObject</code>
+ <code class="code"><em class="replaceable"><code>the_object </code></em></code> is the log
+ file whose write buffer you want to flush. You have to first
+ create this object with
+ <code class="function">INKTextLogObjectCreate</code>.</p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>This immediately flushes to disk the contents of the log write
+ buffer for <code class="code"><em class="replaceable"><code>the_object</code></em></code>. Use this call only if you want to make sure that log
+ entries are flushed immediately. Also be aware that this call has a performance
+ cost, as Traffic Server automatically flushes the log buffer about
+ every second.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the API is called
+ successfully.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs while calling
+ the API or if an argument is invalid.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectFlush.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectHeaderSet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectHeaderSet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectHeaderSet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,47 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKTextLogObjectHeaderSet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKTextLogObjectFlush.html">Prev</a> - INKTextLogObjectFlush</div>
+<div class="navnext">INKTextLogObjectRollingEnabledSet - <a accesskey="n" href="INKTextLogObjectRollingEnabledSet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKTextLogObjectHeaderSet"></a>INKTextLogObjectHeaderSet</h3></div></div></div>
+<p>Sets a log file header.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd>
+ <p><code class="code">INKReturnCode INKTextLogObjectHeaderSet (INKTextLogObject <i class="replaceable">the_object</i>, const char *<i class="replaceable">header</i>)</code></p></dd>
+<dt><span class="term"><b>Arguments</b></span></dt>
+<dd>
+<p><code class="function">INKTextLogObject</code>
+ <code class="replaceable"><i>the_object </i></code> is the log object for which you want to set the
+ header.</p>
+<p><code class="code">const char *<i class="replaceable">header </i></code> is a log file
+ header.</p>
+</dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>A header for a log object is the banner (i.e., a text line)
+ printed at the top of the log file. This API must be
+ used once the object is created (using
+ <code class="function">INKTextLogObjectCreate</code>) and before writing
+ into logs (using <code class="function">INKTextLogObjectWrite</code>). By
+ default, a null header (empty line) is used.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the API is called
+ successfully.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs while calling
+ the API or if an argument is invalid.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectHeaderSet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectRollingEnabledSet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectRollingEnabledSet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectRollingEnabledSet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,71 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKTextLogObjectRollingEnabledSet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKTextLogObjectHeaderSet.html">Prev</a> - INKTextLogObjectHeaderSet</div>
+<div class="navnext">INKTextLogObjectRollingIntervalSecSet - <a accesskey="n" href="INKTextLogObjectRollingIntervalSecSet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKTextLogObjectRollingEnabledSet"></a>INKTextLogObjectRollingEnabledSet</h3></div></div></div>
+<p>Enables/disables rolling for a log object.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd>
+ <p><code class="code">INKReturnCode INKTextLogObjectRollingEnabledSet (INKTextLogObject <i class="replaceable">the_object</i>, int *<i class="replaceable">rolling_enabled</i>)</code></p></dd>
+<dt><span class="term"><b>Arguments</b></span></dt>
+<dd>
+<p><code class="function">INKTextLogObject</code>
+ <code class="replaceable"><i>the_object </i></code> is the log object for which you want to
+ enable or disable rolling.</p>
+<p>To enable rolling, set <code class="code">int <i class="replaceable">rolling_enabled </i></code> to <code>1</code>; to disable rolling, set to <code>0</code>.</p>
+</dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>This API must be used once the object is created (using
+ <code class="function">INKTextLogObjectCreate</code>) and before writing
+ into logs (using <code class="function">INKTextLogObjectWrite</code>). If
+ <code class="function">INKTextLogObjectRollingEnabledSet</code> is not
+ called, then the default value (specified in
+ <code class="filename">records.config</code> by the parameter
+ <code><i>proxy.config.log.rolling_enabled </i></code>) is used.</p>
+<p>The rolling interval and offset can be specified via the
+ APIs <code class="function">INKTextLogObjectRollingIntervalSecSet</code>
+ and
+ <code class="function">INKTextLogObjectRollingOffsetHrSet</code>.</p>
+</dd>
+<dt><span class="term"><b>Example</b></span></dt>
+<dd>
+ <p>If rolling is enabled, then the rolling interval is set to 21600
+ sec (6 hours) and the offset hour is set to 0 (midnight). This means the
+ logs will be rolled at 0:00am (midnight), 06:00am, 12:00pm, and 18:00pm each
+ day.</p>
+<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top"><p>If the maximum amount of disk space reserved for logs is
+ exhausted and if the parameter
+ <code class="varname"><i>proxy.config.log.auto_delete_rolled_files </i></code>
+ is enabled in <code class="filename">records.config</code>, then Traffic Server automatically deletes rolled
+ files to free up
+ disk space.</p></td></tr>
+</table></div>
+</dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the API is called
+ successfully.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs while calling
+ the API or if an argument is invalid.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectRollingEnabledSet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectRollingIntervalSecSet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectRollingIntervalSecSet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectRollingIntervalSecSet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,57 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKTextLogObjectRollingIntervalSecSet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKTextLogObjectRollingEnabledSet.html">Prev</a> - INKTextLogObjectRollingEnabledSet</div>
+<div class="navnext">INKTextLogObjectRollingOffsetHrSet - <a accesskey="n" href="INKTextLogObjectRollingOffsetHrSet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKTextLogObjectRollingIntervalSecSet"></a>INKTextLogObjectRollingIntervalSecSet</h3></div></div></div>
+<p>Sets the rolling interval for a log object.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd>
+ <p><code class="code">INKReturnCode INKTextLogObjectRollingIntervalSecSet
+ (INKTextLogObject <em class="replaceable"><code>the_object</code></em>, int
+ <em class="replaceable"><code>rolling_interval_sec</code></em>)</code></p></dd>
+<dt><span class="term"><b>Arguments</b></span></dt>
+<dd>
+<p><code class="function">INKTextLogObject</code>
+ <code class="code"><em class="replaceable"><code>the_object </code></em></code> is the log
+ object for which you want to set the rolling interval.</p>
+<p><code class="code">int
+ <em class="replaceable"><code>rolling_interval_sec </code></em></code> is the
+ rolling interval (in seconds).</p>
+</dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>This API must be used once the object is created (using
+ <code class="function">INKTextLogObjectCreate</code>) and before writing
+ into logs (using <code class="function">INKTextLogObjectWrite</code>). By
+ default, a null header is used.</p>
+<p>If
+ <code class="function">INKTextLogObjectRollingIntervalSecSet</code> is
+ not called, then the defaut value (specified in
+ <code class="filename">records.config</code> by parameter
+ <code class="varname"><i>proxy.config.log.rolling_interval_sec </i></code>) is
+ used.</p>
+<p>The rolling offset can be specified using the API
+ <code class="function">INKTextLogObjectRollingOffsetHrSet</code>.</p>
+</dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the API is called
+ successfully.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs while calling
+ the API or if an argument is invalid.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectRollingIntervalSecSet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectRollingOffsetHrSet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectRollingOffsetHrSet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectRollingOffsetHrSet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,55 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKTextLogObjectRollingOffsetHrSet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKTextLogObjectRollingIntervalSecSet.html">Prev</a> - INKTextLogObjectRollingIntervalSecSet</div>
+<div class="navnext">INKTextLogObjectWrite - <a accesskey="n" href="INKTextLogObjectWrite.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKTextLogObjectRollingOffsetHrSet"></a>INKTextLogObjectRollingOffsetHrSet</h3></div></div></div>
+<p>Sets the rolling offset for a log object.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd>
+ <p><code class="code">INKReturnCode INKTextLogObjectRollingOffsetHrSet (INKTextLogObject <em class="replaceable"><code>the_object</code></em>, int
+ <em class="replaceable"><code>rolling_offset_hr</code></em>)</code></p></dd>
+<dt><span class="term"><b>Arguments</b></span></dt>
+<dd>
+<p><code class="function">INKTextLogObject</code>
+ <code class="code"><em class="replaceable"><code>the_object </code></em></code> is the log
+ object for which you want to set the rolling offset.</p>
+<p><code>i</code><code class="code">nt
+ <em class="replaceable"><code>rolling_offset_hr </code></em></code> is the
+ rolling interval (in seconds).</p>
+</dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>This API must be used once the object is created (using
+ <code class="function">INKTextLogObjectCreate</code>) and before writing
+ into logs (using <code class="function">INKTextLogObjectWrite</code>). By
+ default, a null header is used.</p>
+<p>If <code class="function">INKTextLogObjectRollingOffsetHrSet</code>
+ is not called, then the defaut value (specified in
+ <code class="filename">records.config</code> by parameter
+ <code class="varname"><i>proxy.config.log.rolling_offset_hr </i></code>) is
+ used.</p>
+<p>The rolling interval can be specified using the API
+ <code class="function">INKTextLogObjectRollingIntervalSecSet</code>.</p>
+</dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the API is called
+ successfully.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs while calling
+ the API or if an argument is invalid.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectRollingOffsetHrSet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectWrite.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectWrite.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectWrite.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,54 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKTextLogObjectWrite</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKTextLogObjectRollingOffsetHrSet.html">Prev</a> - INKTextLogObjectRollingOffsetHrSet</div>
+<div class="navnext">Appendix A. Sample Source Code - <a accesskey="n" href="App_SampleSourceCode.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKTextLogObjectWrite"></a>INKTextLogObjectWrite</h3></div></div></div>
+<p>Writes a text entry to a custom log file.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">InkReturnCode INKTextLogObjectWrite
+ (INKTextLogObject <em class="replaceable"><code>the_object</code></em>, char
+ *<em class="replaceable"><code>format</code></em>, ...)</code></p></dd>
+<dt><span class="term"><b>Arguments</b></span></dt>
+<dd>
+<p><code class="code"><em class="replaceable"><code>the_object </code></em></code> is the
+ log object to write to. You must first create this log file with
+ <code class="function">INKTextLogObjectCreate</code>.</p>
+<p><code class="code">char *<em class="replaceable"><code>format </code></em></code> is a
+ printf-style formatted statement to be printed.</p>
+<p><code class="replaceable">... </code>corresponds to the parameters in the formatted
+ statement. A new line is automatically added to the end.</p>
+</dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd><p>Writes a text entry to a custom log file.</p></dd>
+<dt><span class="term"><b>Example</b></span></dt>
+<dd>
+<p>Suppose you call the following:</p>
+<pre class="programlisting">int my_value = 2001;
+INKTextLogObjectWrite (log, "my value: %d", my_value);</pre>
+<p>If <code class="replaceable"><i>mode </i></code> is set to <code class="code">ADD_TIMESTAMP</code>, then the log
+ should look like:</p>
+<pre class="programlisting"><timestamp> my value: 2001 </pre>
+</dd>
+<dt> </dt>
+<dt><span class="term"> <b>Returns</b></span> </dt>
+<dd>
+ <p><code class="code">INK_SUCCESS</code> if the API is called
+ successfully.</p>
+ <p><code class="code">INK_ERROR</code> if an error occurs while calling
+ the API or if an argument is invalid.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTextLogObjectWrite.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKThreadDestroy.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKThreadDestroy.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKThreadDestroy.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,34 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKThreadDestroy</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="ThreadFunctions.html">Prev</a> - Thread Functions</div>
+<div class="navnext">INKThreadInit - <a accesskey="n" href="INKThreadInit.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKThreadDestroy"></a>INKThreadDestroy</h3></div></div></div>
+<p>Destroys a thread.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKReturnCode INKThreadDestroy (INKThread
+ <em class="replaceable"><code>thread</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Destroys a thread and frees all memory & associated data structures. This should
+ only be called on threads that have been initialized using
+ <code class="function">INKThreadInit</code>.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if successful.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKThreadDestroy.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKThreadInit.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKThreadInit.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKThreadInit.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,36 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKThreadInit</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKThreadDestroy.html">Prev</a> - INKThreadDestroy</div>
+<div class="navnext">INKThreadSelf - <a accesskey="n" href="INKThreadSelf.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKThreadInit"></a>INKThreadInit</h3></div></div></div>
+<p>Initializes a thread.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKThread INKThreadInit (void)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Initializes a thread for use by Traffic Server. This
+ function should only be used if you create your own thread using
+ something <u>other than</u> the <code class="function">INKThreadCreate</code>
+ function. It should not be called more than once for any given
+ thread.</p></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>A <code class="code">NULL</code> pointer if there is an error.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKThreadInit.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKThreadSelf.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKThreadSelf.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKThreadSelf.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,32 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKThreadSelf</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKThreadInit.html">Prev</a> - INKThreadInit</div>
+<div class="navnext">HTTP Functions - <a accesskey="n" href="HTTPFunctions.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKThreadSelf"></a>INKThreadSelf</h3></div></div></div>
+<p>Obtains a thread identifier.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKThread INKThreadSelf (void)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Returns the thread identifier for the thread that's currently being executed.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p>A valid pointer to an <code class="code">INKThread</code> object if
+ successful.</p>
+<p>A <code class="code">NULL</code> pointer if there is an error.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKThreadSelf.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTrafficServerVersionGet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTrafficServerVersionGet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTrafficServerVersionGet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,35 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKTrafficServerVersionGet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKPluginRegister.html">Prev</a> - INKPluginRegister</div>
+<div class="navnext">Debugging Functions - <a accesskey="n" href="DebuggingFunctions.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKTrafficServerVersionGet"></a>INKTrafficServerVersionGet</h3></div></div></div>
+<p>Returns the version of Traffic Server that's running the plugin.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">const char* INKTrafficServerVersionGet
+ (void)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Returns the string that indicates the release version of Traffic Server running the
+ plugin. See the modified <a href="PlusingRegisAndVersionCkg.html" title="Plugin Registration and Version Checking">
+ <code>hello-world</code></a> example that checks the Traffic Server version for
+ usage.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p>A pointer to a string of characters that indicates the
+ Traffic Server release version.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTrafficServerVersionGet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTransformOutputVConnGet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTransformOutputVConnGet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTransformOutputVConnGet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,40 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKTransformOutputVConnGet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="TransformationFunctions.html">Prev</a> - Transformation Functions: INKTransformCreate</div>
+<div class="navnext">VIO Functions - <a accesskey="n" href="VIOFunctions.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKTransformOutputVConnGet"></a>INKTransformOutputVConnGet</h3></div></div></div>
+<p>Retrieves the downstream (output) vconnection for a
+ transformation.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKVConn INKTransformOutputVConnGet (INKVConn
+ <em class="replaceable"><code>connp</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Retrieves the output vconnection for the transformation
+ <code class="code"><em class="replaceable"><code>connp</code></em></code>. The output
+ vconnection may be <code class="code">NULL</code> if
+ <code class="function">INKTransformOutputVConnGet</code> is called before
+ the write operation is initiated on
+ <code class="code"><em class="replaceable"><code>connp</code></em></code>. This is normally
+ not an issue, however, since a transformation would not want to output
+ data until it has data input into it.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p>The downstream vconnection for the transformation.</p>
+<p><code class="code">INK_ERROR_PTR</code> if there is an error.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKTransformOutputVConnGet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnCacheObjectSizeGet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnCacheObjectSizeGet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnCacheObjectSizeGet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,46 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKVConnCacheObjectSizeGet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKCacheKeyPinnedSet.html">Prev</a> - INKCacheKeyPinnedSet</div>
+<div class="navnext">Transformation Functions - <a accesskey="n" href="TransformationFunctions.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<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 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
+ <em class="replaceable"><code>connp</code></em>, int
+ *<em class="replaceable"><code>obj_size</code></em>)</code></p></dd>
+<dt><span class="term"><b>Arguments</b></span></dt>
+<dd>
+<p><code class="function">INKConn</code>
+ <code class="code"><em class="replaceable"><code>connp </code></em></code> is the vconnection
+ to the cache.</p>
+<p><code class="code">int *<em class="replaceable"><code>obj_size </code></em></code> is
+ set to the object size.</p>
+</dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>When a cached object is requested from the cache (using
+ <code class="function">INKCacheRead</code>) and if the cache open was
+ 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>
+<p><code class="code">INK_SUCCESS</code> if the API is called
+ successfully.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs while calling
+ the API or if an argument is invalid.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnCacheObjectSizeGet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnClose.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnClose.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnClose.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,38 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKVConnClose</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="VconnectionFunctions.html">Prev</a> - Vconnection Functions: INKVConnAbort</div>
+<div class="navnext">INKVConnClosedGet - <a accesskey="n" href="INKVConnClosedGet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKVConnClose"></a>INKVConnClose</h3></div></div></div>
+<p>Closes a vconnection.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<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 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>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the connection is successfully
+ closed.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnClose.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnClosedGet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnClosedGet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnClosedGet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,49 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKVConnClosedGet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKVConnClose.html">Prev</a> - INKVConnClose</div>
+<div class="navnext">INKVConnRead - <a accesskey="n" href="INKVConnRead.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKVConnClosedGet"></a>INKVConnClosedGet</h3></div></div></div>
+<p>Gets a closed vconnection.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKReturnCode INKVConnClosedGet (INKVConn
+ <em class="replaceable"><code>connp</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Retrieves the closed status for a vconnection.</p>
+<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> 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>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
+<th align="left">Note</th>
+</tr>
+<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
+ VConnection.</p></td></tr>
+</table></div>
+</dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if successful.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnClosedGet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnRead.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnRead.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnRead.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,44 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKVConnRead</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKVConnClosedGet.html">Prev</a> - INKVConnClosedGet</div>
+<div class="navnext">INKVConnReadVIOGet - <a accesskey="n" href="INKVConnReadVIOGet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKVConnRead"></a>INKVConnRead</h3></div></div></div>
+<p>Reads a vconnection.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKVIO INKVConnRead (INKVConn
+ <em class="replaceable"><code>connp</code></em>, INKCont
+ <em class="replaceable"><code>contp</code></em>, INKIOBuffer
+ <em class="replaceable"><code>bufp</code></em>, int
+ <em class="replaceable"><code>nbytes</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <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
+ 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>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p>A handle to the vconnection.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnRead.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnReadVIOGet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnReadVIOGet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnReadVIOGet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,43 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKVConnReadVIOGet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKVConnRead.html">Prev</a> - INKVConnRead</div>
+<div class="navnext">INKVConnShutdown - <a accesskey="n" href="INKVConnShutdown.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKVConnReadVIOGet"></a>INKVConnReadVIOGet</h3></div></div></div>
+<p>Obtains the output VIO for a vconnection.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKVIO INKVConnReadVIOGet (INKVConn
+ <em class="replaceable"><code>connp</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Retrieves the read VIO for a vconnection.
+ <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>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top"><p>This API can only be used for transformations; it is not
+ used for <code>NetVConn</code> or <code>CacheVConn</code>.</p></td></tr>
+</table></div>
+</dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p>A handle to the vconnection.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnReadVIOGet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnShutdown.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnShutdown.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnShutdown.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,44 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKVConnShutdown</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKVConnReadVIOGet.html">Prev</a> - INKVConnReadVIOGet</div>
+<div class="navnext">INKVConnWrite - <a accesskey="n" href="INKVConnWrite.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKVConnShutdown"></a>INKVConnShutdown</h3></div></div></div>
+<p>Shuts down a vconnection.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKReturnCode INKVConnShutdown (INKVConn
+ <em class="replaceable"><code>connp</code></em>, int
+ <em class="replaceable"><code>read</code></em>, int
+ <em class="replaceable"><code>write</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Shuts down a portion of the vconnection
+ <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 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 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
+ shut down.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnShutdown.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnWrite.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnWrite.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnWrite.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,44 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKVConnWrite</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKVConnShutdown.html">Prev</a> - INKVConnShutdown</div>
+<div class="navnext">INKVConnWriteVIOGet - <a accesskey="n" href="INKVConnWriteVIOGet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKVConnWrite"></a>INKVConnWrite</h3></div></div></div>
+<p>Writes a vconnection.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKVIO INKVConnWrite (INKVConn
+ <em class="replaceable"><code>connp</code></em>, INKCont
+ <em class="replaceable"><code>contp</code></em>, INKIOBufferReader
+ <em class="replaceable"><code>readerp</code></em>, int
+ <em class="replaceable"><code>nbytes</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Initiates a write operation on the vconnection
+ <code class="code"><em class="replaceable"><code>connp</code></em></code>. The write
+ operation reads from the buffer reader
+ <code class="code"><em class="replaceable"><code>readerp</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_WRITE_READY</code> or
+ <code class="code">INK_EVENT_VCONN_WRITE_COMPLETE</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 write 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>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnWrite.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnWriteVIOGet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnWriteVIOGet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnWriteVIOGet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,42 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKVConnWriteVIOGet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKVConnWrite.html">Prev</a> - INKVConnWrite</div>
+<div class="navnext">Netvconnection Functions - <a accesskey="n" href="NetvconnectionFunctions.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKVConnWriteVIOGet"></a>INKVConnWriteVIOGet</h3></div></div></div>
+<p>Obtains the input VIO for a vconnection.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKVIO INKVConnWriteVIOGet (INKVConn
+ <em class="replaceable"><code>connp</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Retrieves the write VIO for a vconnection.
+ <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>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top"><p>This API can only be used for transformations.</p></td></tr>
+</table></div>
+</dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<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>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVConnWriteVIOGet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIOContGet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIOContGet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIOContGet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,35 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKVIOContGet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="VIOFunctions.html">Prev</a> - VIO Functions: INKVIOBufferGet</div>
+<div class="navnext">INKVIOMutexGet - <a accesskey="n" href="INKVIOMutexGet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKVIOContGet"></a>INKVIOContGet</h3></div></div></div>
+<p>Gets an <code class="function">INKVIOCont</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKCont INKVIOContGet (INKVIO
+ <em class="replaceable"><code>viop</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Gets the continuation (user) for the IO operation
+ described by <code class="code"><em class="replaceable"><code>viop</code></em></code>. This
+ is the continuation the vconnection calls back when
+ progress is made on the IO operation.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p>The continuation for the specified IO operation.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIOContGet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIOMutexGet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIOMutexGet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIOMutexGet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,40 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKVIOMutexGet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKVIOContGet.html">Prev</a> - INKVIOContGet</div>
+<div class="navnext">INKVIONBytesGet - <a accesskey="n" href="INKVIONBytesGet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKVIOMutexGet"></a>INKVIOMutexGet</h3></div></div></div>
+<p>Returns the mutex for the specified IO operation.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKMutex INKVIOMutexGet (INKVIO
+ <em class="replaceable"><code>viop</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Gets the mutex for the IO operation described by
+ <code class="code"><em class="replaceable"><code>viop</code></em></code>. The mutex for the
+ IO operation protects the buffer, continuation, and other VIO
+ members from simultaneous access. The vconnection implementor
+ must obtain the mutex for a VIO before accessing any of its
+ members. Since the VIO mutex is the same as the continuation's
+ mutex, the vconnection user already holds the mutex whenever he
+ is running and doesn't need to worry about grabbing it. To learn more about why vconnection transformations do not need to grab the VIO mutex before accessing their write
+ VIO, see <a href="Transformations_IO.html" title="Transformations">Transformations</a>.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p>The mutex for the specified IO operation.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIOMutexGet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONBytesGet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONBytesGet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONBytesGet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,38 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKVIONBytesGet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKVIOMutexGet.html">Prev</a> - INKVIOMutexGet</div>
+<div class="navnext">INKVIONBytesSet - <a accesskey="n" href="INKVIONBytesSet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKVIONBytesGet"></a>INKVIONBytesGet</h3></div></div></div>
+<p>Returns the number of bytes associated with a specified IO
+ operation.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">int INKVIONBytesGet (INKVIO
+ <em class="replaceable"><code>viop</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Gets the number of bytes to be performed by the IO
+ operation described by
+ <code class="code"><em class="replaceable"><code>viop</code></em></code>. This is the <code><i>nbytes </i></code> parameter that's passed to <code class="function">INKVConnRead</code> or
+ <code class="function">INKVConnWrite</code>.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p>The number of bytes associated with the specified IO
+ operation.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs.</p>
+</dd>
+</dl>
+</div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONBytesGet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONBytesSet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONBytesSet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONBytesSet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,48 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKVIONBytesSet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKVIONBytesGet.html">Prev</a> - INKVIONBytesGet</div>
+<div class="navnext">INKVIONDoneGet - <a accesskey="n" href="INKVIONDoneGet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKVIONBytesSet"></a>INKVIONBytesSet</h3></div></div></div>
+<p>Sets the number of bytes for the specified IO operation.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKReturnCode INKVIONBytesSet (INKVIO
+ <em class="replaceable"><code>viop</code></em>, int
+ <em class="replaceable"><code>nbytes</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Sets the number of bytes to be performed by the IO
+ operation described by
+ <code class="code"><em class="replaceable"><code>viop</code></em></code>. Only the user of a
+ vconnection should call <code class="function">INKVIONBytesSet</code> and
+ 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>. </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
+ with the IO operation is successfully set.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONBytesSet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONDoneGet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONDoneGet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONDoneGet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,38 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKVIONDoneGet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKVIONBytesSet.html">Prev</a> - INKVIONBytesSet</div>
+<div class="navnext">INKVIONDoneSet - <a accesskey="n" href="INKVIONDoneSet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKVIONDoneGet"></a>INKVIONDoneGet</h3></div></div></div>
+<p>Returns the number of bytes completed for the specified IO
+ operation.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">int INKVIONDoneGet (INKVIO
+ <em class="replaceable"><code>viop</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Gets the number of bytes completed on the
+ IO operation described by
+ <code class="code"><em class="replaceable"><code>viop</code></em></code>. The number of
+ completed bytes is also the number of bytes consumed out of (or
+ produced into) the buffer passed to the IO operation.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p>The number of bytes that have been completed for the
+ specified IO operation.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONDoneGet.html
------------------------------------------------------------------------------
svn:executable = *
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONDoneSet.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONDoneSet.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONDoneSet.html Tue Dec 24 18:32:14 2013
@@ -0,0 +1,40 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>INKVIONDoneSet</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKVIONDoneGet.html">Prev</a> - INKVIONDoneGet</div>
+<div class="navnext">INKVIONTodoGet - <a accesskey="n" href="INKVIONTodoGet.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKVIONDoneSet"></a>INKVIONDoneSet</h3></div></div></div>
+<p>Sets the number of bytes completed for the specified IO
+ operation.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKReturnCode INKVIONDoneSet (INKVIO
+ <em class="replaceable"><code>viop</code></em>, int
+ <em class="replaceable"><code>ndone</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Sets the number of bytes that have been completed on the
+ IO operation described by
+ <code class="code"><em class="replaceable"><code>viop </code></em></code> to
+ <code class="code"><em class="replaceable"><code>ndone</code></em></code>. Only vconnection
+ implementors should call
+ <code class="function">INKVIONDoneSet</code>.</p></dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if the number of completed bytes
+ associated with the IO operation is successfully set.</p>
+<p><code class="code">INK_ERROR</code> if an error occurs.</p>
+</dd>
+</dl></div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/INKVIONDoneSet.html
------------------------------------------------------------------------------
svn:executable = *