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 2010/11/06 07:31:10 UTC
svn commit: r778776 [12/21] - in
/websites/staging/trafficserver/trunk/content/docs/trunk: admin/ sdk/
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKNetConnect.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKNetConnect.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKNetConnect.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKNetConnect.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,72 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="NetvconnectionFunctions">Prev</a> - Netvconnection Functions:
+INKNetAccept
+INKNetVConnRemoteIPGet - <a href="INKNetVConnRemoteIPGet">Next</a></p>
+<h3 id="inknetconnect">INKNetConnect</h3>
+<p>Initiates a network connection to a server.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKAction INKNetConnect (INKCont <em class="replaceable"><code>contp</code>,
+ unsigned int <em><code>ip</code></em>, int <em><code>port</code></em>)</p>
+<p><strong>Arguments</strong>
+ ~ <code>INKCont</code> <code><em class="replaceable"><code>contp</code> is the
+ continuation to be associated with the connection.</p>
+<div class="codehilite"><pre><span class="sb">`int``<em class="replaceable"><code>ip`</span> <span class="n">is</span> <span class="n">the</span> <span class="n">IP</span> <span class="n">address</span><span class="p">,</span> <span class="n">in</span>
+<span class="n">network</span> <span class="n">byte</span> <span class="n">order</span><span class="p">,</span> <span class="n">of</span> <span class="n">the</span> <span class="n">host</span> <span class="n">to</span> <span class="nb">connect</span> <span class="n">with</span><span class="o">.</span>
+
+<span class="sb">`int`</span> <span class="sb">`<em class="replaceable"><code>port`</span> <span class="n">is</span> <span class="n">port</span> <span class="n">number</span> <span class="k">for</span> <span class="n">the</span>
+<span class="n">host</span><span class="p">,</span> <span class="n">specified</span> <span class="n">in</span> <span class="n">network</span> <span class="n">byte</span> <span class="n">order</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ Opens a network connection to the host specified by
+ <code><em class="replaceable"><code>ip</code> on the port specified by
+ <code><em class="replaceable"><code>port</code>. If the connection is
+ successfully opened, then <code><em class="replaceable"><code>contp</code> is
+ called back with the event <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><em class="replaceable"><code>contp</code> is called back with the event
+ <code>INK_EVENT_NET_CONNECT_FAILED</code>.</p>
+<div class="codehilite"><pre><span class="o">!</span><span class="p">[[</span><span class="n">Note</span><span class="p">]](</span><span class="n">images</span><span class="sr">/docbook/</span><span class="n">note</span><span class="o">.</span><span class="n">png</span><span class="p">)</span>
+<span class="n">Note</span>
+<span class="n">It</span><span class="err">'</span><span class="n">s</span> <span class="n">possible</span> <span class="n">to</span> <span class="n">receive</span> <span class="sb">`INK_EVENT_NET_CONNECT`</span> <span class="n">even</span> <span class="k">if</span> <span class="n">the</span>
+<span class="n">connection</span> <span class="n">failed</span> <span class="n">because</span> <span class="n">of</span> <span class="n">the</span> <span class="n">implementation</span> <span class="n">of</span> <span class="n">network</span> <span class="n">sockets</span>
+<span class="n">in</span> <span class="n">the</span> <span class="n">underlying</span> <span class="n">operating</span> <span class="nb">system</span><span class="o">.</span> <span class="n">There</span> <span class="n">is</span> <span class="n">an</span> <span class="n">exception:</span> <span class="k">if</span> <span class="n">a</span>
+<span class="n">plugin</span> <span class="n">tries</span> <span class="n">to</span> <span class="nb">open</span> <span class="n">a</span> <span class="n">connection</span> <span class="n">to</span> <span class="n">a</span> <span class="n">port</span> <span class="n">on</span> <span class="n">its</span> <span class="n">own</span> <span class="n">host</span>
+<span class="n">machine</span><span class="p">,</span> <span class="k">then</span> <span class="sb">`INK_EVENT_NET_CONNECT`</span> <span class="n">is</span> <span class="n">sent</span> <span class="n">only</span> <span class="k">if</span> <span class="n">the</span>
+<span class="n">connection</span> <span class="n">is</span> <span class="n">successful</span><span class="o">.</span> <span class="n">In</span> <span class="n">general</span><span class="p">,</span> <span class="n">however</span><span class="p">,</span> <span class="n">your</span> <span class="n">plugin</span> <span class="n">needs</span> <span class="n">to</span>
+<span class="n">look</span> <span class="k">for</span> <span class="sb">`INK_EVENT_VCONN_WRITE_READY`</span> <span class="ow">or</span>
+<span class="sb">`INK_EVENT_VCONN_READ_READY`</span> <span class="n">to</span> <span class="n">make</span> <span class="n">sure</span> <span class="n">the</span> <span class="n">connection</span> <span class="n">is</span>
+<span class="n">successfully</span> <span class="n">opened</span><span class="o">.</span>
+
+<span class="n">Reentrant</span> <span class="n">calls</span> <span class="n">are</span> <span class="n">possible</span><span class="p">;</span> <span class="n">i</span><span class="o">.</span><span class="n">e</span><span class="o">.</span><span class="p">,</span> <span class="n">the</span> <span class="n">net</span> <span class="n">processor</span> <span class="n">can</span> <span class="n">call</span> <span class="n">back</span>
+<span class="n">the</span> <span class="n">user</span> <span class="p">(</span><span class="sb">`<em class="replaceable"><code>contp`</span><span class="p">)</span> <span class="n">in</span> <span class="n">the</span> <span class="n">same</span> <span class="n">call</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Returns</strong>
+ ~ An <code>INKAction</code> object.</p>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKNetVConnRemoteIPGet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKNetVConnRemoteIPGet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKNetVConnRemoteIPGet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKNetVConnRemoteIPGet.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,47 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKNetConnect">Prev</a> - INKNetConnect
+INKNetVConnRemotePortGet - <a href="INKNetVConnRemotePortGet">Next</a></p>
+<h3 id="inknetvconnremoteipget">INKNetVConnRemoteIPGet</h3>
+<p>Retrieves the remote host's IP address.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKNetVConnRemoteIPGet (INKVConn <em class="replaceable"><code>vc</code>,
+ unsigned int *<em><code>ip</code></em>)</p>
+<p><strong>Arguments</strong>
+ ~ <code>INKVConn</code> <code><em class="replaceable"><code>vc</code> is the connection
+ between Traffic Server and the other end of the connection (can be
+ a remote client or server).</p>
+<div class="codehilite"><pre><span class="sb">`unsigned int *``<em class="replaceable"><code>ip`</span> <span class="n">is</span>
+<span class="n">set</span> <span class="n">to</span> <span class="n">the</span> <span class="n">remote</span> <span class="n">IP</span> <span class="n">address</span><span class="p">,</span> <span class="n">in</span> <span class="n">network</span> <span class="n">byte</span> <span class="n">order</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ Obtains the remote IP address in network byte order.</p>
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the API is called successfully.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span> <span class="k">while</span> <span class="n">calling</span> <span class="n">the</span> <span class="n">API</span> <span class="ow">or</span> <span class="k">if</span> <span class="n">an</span>
+<span class="n">argument</span> <span class="n">is</span> <span class="n">invalid</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKNetVConnRemotePortGet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKNetVConnRemotePortGet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKNetVConnRemotePortGet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKNetVConnRemotePortGet.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,48 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKNetVConnRemoteIPGet">Prev</a> - INKNetVConnRemoteIPGet
+Cache Interface Functions - <a href="CacheInterfaceFunctions">Next</a></p>
+<h3 id="inknetvconnremoteportget">INKNetVConnRemotePortGet</h3>
+<p>Retrieves the remote host's port number.</p>
+<p><strong>Prototype</strong>
+ ~ <code>InkReturnCode INKNetVConnRemotePortGet (INKVConn <em class="replaceable"><code>vc</code>,
+ int *<em><code>port</code></em>)</p>
+<p><strong>Arguments</strong>
+ ~ <code>INKVConn <em class="replaceable">vc </em>``<em class="replaceable"><code></code>
+ is the connection between Traffic Server and the other end of the
+ connection (can be remote client or server).</p>
+<div class="codehilite"><pre><span class="sb">`int *``<em class="replaceable"><code>port`</span> <span class="n">is</span> <span class="n">set</span> <span class="n">to</span>
+<span class="n">the</span> <span class="n">remote</span> <span class="n">port</span> <span class="n">value</span> <span class="n">in</span> <span class="n">host</span> <span class="n">byte</span> <span class="n">order</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ Obtains the port number of the remote host for the specified
+ connection. The port is returned in host byte order.</p>
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the API is called successfully.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span> <span class="k">while</span> <span class="n">calling</span> <span class="n">the</span> <span class="n">API</span> <span class="ow">or</span> <span class="k">if</span> <span class="n">an</span>
+<span class="n">argument</span> <span class="n">is</span> <span class="n">invalid</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKPluginDirGet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKPluginDirGet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKPluginDirGet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKPluginDirGet.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,46 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="CustInstallLicenseFunctions">Prev</a> - Customer Installation &
+Licensing Fxns: INKInstallDirGet
+INKPluginLicenseRequired - <a href="INKPluginLicenseRequired">Next</a></p>
+<h3 id="inkplugindirget">INKPluginDirGet</h3>
+<p>Gets the plugin directory.</p>
+<p><strong>Prototype</strong>
+ ~ <code>const char *INKPluginDirGet(void)</code></p>
+<p><strong>Description</strong>
+ ~ 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>records.config</code> variable
+ <code><i> proxy.config.plugin.plugin_dir</i></code>. The default value is
+ <code>config/plugin</code>.</p>
+<p><strong>Example</strong>
+ ~ To open the <code>Blacklist/ui/blacklist_config.txt</code> file, use the
+ following:</p>
+<div class="codehilite"><pre> <span class="n">INKfopen</span> <span class="p">(</span><span class="s">"INKInstallDirGet()/INKPluginDirGet()/Blacklist/ui/blacklist_config.txt"</span><span class="p">);</span>
+</pre></div>
+
+
+<p><strong>Returns</strong>
+ ~ A pointer to a string containing the plugin directory.</p>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKPluginLicenseRequired.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKPluginLicenseRequired.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKPluginLicenseRequired.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKPluginLicenseRequired.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,54 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢</p>
+<h1 id="apache_traffic_server+_software_developers_kit">Apache Traffic Server⢠Software Developers Kit</h1>
+<p>Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKPluginDirGet">Prev</a> - INKPluginDirGet
+Statistics Functions - <a href="StatisticsFunctions">Next</a></p>
+<h3 id="inkpluginlicenserequired">INKPluginLicenseRequired</h3>
+<p>Specifies to Traffic Server that a license key is required for a
+plugin.</p>
+<p><strong>Prototype</strong>
+ ~ <code>int INKPluginLicenseRequired(void)</code></p>
+<p><strong>Description</strong>
+ ~ 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>
+<p><strong>Example</strong>
+ ~ #include <stdio.h>
+ #include <ts/ts.h></p>
+<div class="codehilite"><pre> <span class="n">void</span> <span class="n">INKPluginInit</span> <span class="p">(</span><span class="nb">int</span> <span class="n">argc</span><span class="p">,</span> <span class="n">const</span> <span class="n">char</span> <span class="o">*</span><span class="n">argv</span><span class="o">[]</span><span class="p">)</span>
+ <span class="p">{</span>
+ <span class="nb">printf</span> <span class="p">(</span><span class="s">"hello world\n"</span><span class="p">);</span>
+ <span class="p">}</span>
+ <span class="nb">int</span> <span class="n">INKPluginLicenseRequired</span><span class="p">(</span><span class="n">void</span><span class="p">)</span>
+ <span class="p">{</span>
+ <span class="k">return</span> <span class="mi">1</span><span class="p">;</span>
+ <span class="p">}</span>
+</pre></div>
+
+
+<p><strong>Returns</strong>
+ ~ Returns <code>0</code> if a license is not required.</p>
+<div class="codehilite"><pre><span class="n">Returns</span> <span class="sb">`1`</span> <span class="k">if</span> <span class="n">a</span> <span class="n">license</span> <span class="n">is</span> <span class="n">required</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKPluginRegister.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKPluginRegister.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKPluginRegister.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKPluginRegister.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,56 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="InitializationFunctions">Prev</a> - Initialization Functions
+INKTrafficServerVersionGet -
+<a href="INKTrafficServerVersionGet">Next</a></p>
+<h3 id="inkpluginregister">INKPluginRegister</h3>
+<p>Registers the appropriate SDK version for your plugin.</p>
+<p><strong>Prototype</strong>
+ ~ <code>int INKPluginRegister (INKSDKVersion <em class="replaceable"><code>sdk_version</code>,
+ INKPluginRegistrationInfo <em><code>*plugin_info</code></em>)</p>
+<p><strong>Arguments</strong>
+ ~ <em><code>sdk_version</code></em> can have the following values:
+ - <code>INK_SDK_VERSION_1_0</code>
+ - <code>INK_SDK_VERSION_1_1</code>
+ - <code>INK_SDK_VERSION_2_0</code></p>
+<div class="codehilite"><pre><span class="o">></span> <span class="sb">`INKPluginRegistrationInfo`</span> <span class="n">is</span> <span class="n">the</span> <span class="n">following</span> <span class="n">struct:</span>
+<span class="o">></span>
+<span class="o">></span> <span class="n">typedef</span> <span class="n">struct</span>
+<span class="o">></span> <span class="p">{</span>
+<span class="o">></span> <span class="n">char</span> <span class="o">*</span><span class="n">plugin_name</span><span class="p">;</span>
+<span class="o">></span> <span class="n">char</span> <span class="o">*</span><span class="n">vendor_name</span><span class="p">;</span>
+<span class="o">></span> <span class="n">char</span> <span class="o">*</span><span class="n">support_email</span><span class="p">;</span>
+<span class="o">></span> <span class="p">}</span> <span class="n">INKPluginRegistrationInf</span>
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ 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" title="Plugin Registration and Version Checking">hello-world example</a>
+ that checks Traffic Server version for usage.</p>
+<p><strong>Returns</strong>
+ ~ If plugin registration fails, then <code>0</code> is returned.</p>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKReleaseAssert.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKReleaseAssert.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKReleaseAssert.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKReleaseAssert.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,39 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKAssert">Prev</a> - INKAssert
+The INKfopen Family - <a href="INKfopenFamilyFunctions">Next</a></p>
+<h3 id="inkreleaseassert">INKReleaseAssert</h3>
+<p>Allows the use of assertion in a plugin.</p>
+<p><strong>Prototype</strong>
+ ~ <code>void INKReleaseAssert(<em class="replaceable"><code>expression</code>);</p>
+<p><strong>Arguments</strong>
+ ~ A Boolean expression.</p>
+<p><strong>Description</strong>
+ ~ Allows the use of assertion in a plugin. If the expression is
+ false, then it causes Traffic Server in <code>debug</code> and <code>optim</code> mode to
+ print the file name, line number, and expression. Afterward, it
+ aborts.</p>
+<div class="codehilite"><pre>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectDestroy.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectDestroy.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectDestroy.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectDestroy.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,44 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="LoggingFunctions#INKTextLogObjectCreate">Prev</a> - Logging
+Functions: INKTextLogObjectCreate
+INKTextLogObjectFlush - <a href="INKTextLogObjectFlush">Next</a></p>
+<h3 id="inktextlogobjectdestroy">INKTextLogObjectDestroy</h3>
+<p>Destroys the custom log file created by <code>INKTextLogObjectCreate</code>.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKTextLogObjectDestroy (INKTextLogObject <em class="replaceable"><code>the_object</code>)</p>
+<p><strong>Arguments</strong>
+ ~ <code>INKTextLogObject</code> <code><em class="replaceable"><code>the_object</code>
+ is the custom log file you want to destroy. You must first create
+ this object with <code>INKTextLogObjectCreate</code>.</p>
+<p><strong>Description</strong>
+ ~ 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>
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the API is called successfully.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span> <span class="k">while</span> <span class="n">calling</span> <span class="n">the</span> <span class="n">API</span> <span class="ow">or</span> <span class="k">if</span> <span class="n">an</span>
+<span class="n">argument</span> <span class="n">is</span> <span class="n">invalid</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectFlush.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectFlush.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectFlush.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectFlush.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,46 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKTextLogObjectDestroy">Prev</a> - INKTextLogObjectDestroy
+INKTextLogObjectHeaderSet - <a href="INKTextLogObjectHeaderSet">Next</a></p>
+<h3 id="inktextlogobjectflush">INKTextLogObjectFlush</h3>
+<p>Flushes the contents of a specified log file's log write buffer.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKTextLogObjectFlush (INKTextLogObject <em class="replaceable"><code>the_object</code>)</p>
+<p><strong>Arguments</strong>
+ ~ <code>INKTextLogObject</code> <code><em class="replaceable"><code>the_object</code>
+ is the log file whose write buffer you want to flush. You have to
+ first create this object with <code>INKTextLogObjectCreate</code>.</p>
+<p><strong>Description</strong>
+ ~ This immediately flushes to disk the contents of the log write
+ buffer for <code><em class="replaceable"><code>the_object</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>
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the API is called successfully.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span> <span class="k">while</span> <span class="n">calling</span> <span class="n">the</span> <span class="n">API</span> <span class="ow">or</span> <span class="k">if</span> <span class="n">an</span>
+<span class="n">argument</span> <span class="n">is</span> <span class="n">invalid</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectHeaderSet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectHeaderSet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectHeaderSet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectHeaderSet.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,50 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKTextLogObjectFlush">Prev</a> - INKTextLogObjectFlush
+INKTextLogObjectRollingEnabledSet -
+<a href="INKTextLogObjectRollingEnabledSet">Next</a></p>
+<h3 id="inktextlogobjectheaderset">INKTextLogObjectHeaderSet</h3>
+<p>Sets a log file header.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKTextLogObjectHeaderSet (INKTextLogObject <i class="replaceable">the_object</i>, const char *<i class="replaceable">header</i>)</code></p>
+<p><strong>Arguments</strong>
+ ~ <code>INKTextLogObject</code> <code><i>the_object </i></code> is the log object for
+ which you want to set the header.</p>
+<div class="codehilite"><pre>`const char *<span class="nt"><i</span> <span class="na">class=</span><span class="s">"replaceable"</span><span class="nt">></span>header <span class="nt"></i></span>` is a log file
+header.
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ 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>INKTextLogObjectCreate</code>) and before
+ writing into logs (using <code>INKTextLogObjectWrite</code>). By default, a
+ null header (empty line) is used.</p>
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the API is called successfully.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span> <span class="k">while</span> <span class="n">calling</span> <span class="n">the</span> <span class="n">API</span> <span class="ow">or</span> <span class="k">if</span> <span class="n">an</span>
+<span class="n">argument</span> <span class="n">is</span> <span class="n">invalid</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectRollingEnabledSet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectRollingEnabledSet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectRollingEnabledSet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectRollingEnabledSet.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,73 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKTextLogObjectHeaderSet">Prev</a> - INKTextLogObjectHeaderSet
+INKTextLogObjectRollingIntervalSecSet -
+<a href="INKTextLogObjectRollingIntervalSecSet">Next</a></p>
+<h3 id="inktextlogobjectrollingenabledset">INKTextLogObjectRollingEnabledSet</h3>
+<p>Enables/disables rolling for a log object.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKTextLogObjectRollingEnabledSet (INKTextLogObject <i class="replaceable">the_object</i>, int *<i class="replaceable">rolling_enabled</i>)</code></p>
+<p><strong>Arguments</strong>
+ ~ <code>INKTextLogObject</code> <code><i>the_object </i></code> is the log object for
+ which you want to enable or disable rolling.</p>
+<div class="codehilite"><pre>To enable rolling, set
+`int <span class="nt"><i</span> <span class="na">class=</span><span class="s">"replaceable"</span><span class="nt">></span>rolling_enabled <span class="nt"></i></span>` to `1`; to
+disable rolling, set to `0`.
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ This API must be used once the object is created (using
+ <code>INKTextLogObjectCreate</code>) and before writing into logs (using
+ <code>INKTextLogObjectWrite</code>). If <code>INKTextLogObjectRollingEnabledSet</code> is
+ not called, then the default value (specified in <code>records.config</code>
+ by the parameter <code><i>proxy.config.log2.rolling_enabled </i></code>) is
+ used.</p>
+<div class="codehilite"><pre><span class="n">The</span> <span class="n">rolling</span> <span class="n">interval</span> <span class="ow">and</span> <span class="n">offset</span> <span class="n">can</span> <span class="n">be</span> <span class="n">specified</span> <span class="n">via</span> <span class="n">the</span> <span class="n">APIs</span>
+<span class="sb">`INKTextLogObjectRollingIntervalSecSet`</span> <span class="ow">and</span>
+<span class="sb">`INKTextLogObjectRollingOffsetHrSet`</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Example</strong>
+ ~ 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="codehilite"><pre>![[Note]](images/docbook/note.png)
+Note
+If the maximum amount of disk space reserved for logs is exhausted
+and if the parameter
+`<span class="nt"><i></span>proxy.config.log2.auto_delete_rolled_files <span class="nt"></i></span>` is enabled in
+`records.config`, then Traffic Server automatically deletes rolled
+files to free up disk space.
+</pre></div>
+
+
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the API is called successfully.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span> <span class="k">while</span> <span class="n">calling</span> <span class="n">the</span> <span class="n">API</span> <span class="ow">or</span> <span class="k">if</span> <span class="n">an</span>
+<span class="n">argument</span> <span class="n">is</span> <span class="n">invalid</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectRollingIntervalSecSet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectRollingIntervalSecSet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectRollingIntervalSecSet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectRollingIntervalSecSet.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,59 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKTextLogObjectRollingEnabledSet">Prev</a> -
+INKTextLogObjectRollingEnabledSet
+INKTextLogObjectRollingOffsetHrSet -
+<a href="INKTextLogObjectRollingOffsetHrSet">Next</a></p>
+<h3 id="inktextlogobjectrollingintervalsecset">INKTextLogObjectRollingIntervalSecSet</h3>
+<p>Sets the rolling interval for a log object.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKTextLogObjectRollingIntervalSecSet (INKTextLogObject <em class="replaceable"><code>the_object</code>,
+ int <em><code>rolling_interval_sec</code></em>)</p>
+<p><strong>Arguments</strong>
+ ~ <code>INKTextLogObject</code> <code><em class="replaceable"><code>the_object</code>
+ is the log object for which you want to set the rolling interval.</p>
+<div class="codehilite"><pre><span class="sb">`int <em class="replaceable"><code>rolling_interval_sec`</span>
+<span class="n">is</span> <span class="n">the</span> <span class="n">rolling</span> <span class="n">interval</span> <span class="p">(</span><span class="n">in</span> <span class="n">seconds</span><span class="p">)</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ This API must be used once the object is created (using
+ <code>INKTextLogObjectCreate</code>) and before writing into logs (using
+ <code>INKTextLogObjectWrite</code>). By default, a null header is used.</p>
+<div class="codehilite"><pre>If `INKTextLogObjectRollingIntervalSecSet` is not called, then the
+defaut value (specified in `records.config` by parameter
+`<span class="nt"><i></span>proxy.config.log2.rolling_interval_sec <span class="nt"></i></span>`) is used.
+
+The rolling offset can be specified using the API
+`INKTextLogObjectRollingOffsetHrSet`.
+</pre></div>
+
+
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the API is called successfully.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span> <span class="k">while</span> <span class="n">calling</span> <span class="n">the</span> <span class="n">API</span> <span class="ow">or</span> <span class="k">if</span> <span class="n">an</span>
+<span class="n">argument</span> <span class="n">is</span> <span class="n">invalid</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectRollingOffsetHrSet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectRollingOffsetHrSet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectRollingOffsetHrSet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectRollingOffsetHrSet.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,58 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKTextLogObjectRollingIntervalSecSet">Prev</a> -
+INKTextLogObjectRollingIntervalSecSet
+INKTextLogObjectWrite - <a href="INKTextLogObjectWrite">Next</a></p>
+<h3 id="inktextlogobjectrollingoffsethrset">INKTextLogObjectRollingOffsetHrSet</h3>
+<p>Sets the rolling offset for a log object.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKTextLogObjectRollingOffsetHrSet (INKTextLogObject <em class="replaceable"><code>the_object</code>,
+ int <em><code>rolling_offset_hr</code></em>)</p>
+<p><strong>Arguments</strong>
+ ~ <code>INKTextLogObject</code> <code><em class="replaceable"><code>the_object</code>
+ is the log object for which you want to set the rolling offset.</p>
+<div class="codehilite"><pre><span class="sb">`i``nt <em class="replaceable"><code>rolling_offset_hr`</span>
+<span class="n">is</span> <span class="n">the</span> <span class="n">rolling</span> <span class="n">interval</span> <span class="p">(</span><span class="n">in</span> <span class="n">seconds</span><span class="p">)</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ This API must be used once the object is created (using
+ <code>INKTextLogObjectCreate</code>) and before writing into logs (using
+ <code>INKTextLogObjectWrite</code>). By default, a null header is used.</p>
+<div class="codehilite"><pre>If `INKTextLogObjectRollingOffsetHrSet` is not called, then the
+defaut value (specified in `records.config` by parameter
+`<span class="nt"><i></span>proxy.config.log2.rolling_offset_hr <span class="nt"></i></span>`) is used.
+
+The rolling interval can be specified using the API
+`INKTextLogObjectRollingIntervalSecSet`.
+</pre></div>
+
+
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the API is called successfully.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span> <span class="k">while</span> <span class="n">calling</span> <span class="n">the</span> <span class="n">API</span> <span class="ow">or</span> <span class="k">if</span> <span class="n">an</span>
+<span class="n">argument</span> <span class="n">is</span> <span class="n">invalid</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectWrite.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectWrite.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectWrite.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTextLogObjectWrite.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,63 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKTextLogObjectRollingOffsetHrSet">Prev</a> -
+INKTextLogObjectRollingOffsetHrSet
+Appendix A. Sample Source Code - <a href="App_SampleSourceCode">Next</a></p>
+<h3 id="inktextlogobjectwrite">INKTextLogObjectWrite</h3>
+<p>Writes a text entry to a custom log file.</p>
+<p><strong>Prototype</strong>
+ ~ <code>InkReturnCode INKTextLogObjectWrite (INKTextLogObject <em class="replaceable"><code>the_object</code>,
+ char *<em><code>format</code></em>, ...)</p>
+<p><strong>Arguments</strong>
+ ~ <code><em class="replaceable"><code>the_object</code> is the log object to
+ write to. You must first create this log file with
+ <code>INKTextLogObjectCreate</code>.</p>
+<div class="codehilite"><pre><span class="sb">`char *<em class="replaceable"><code>format`</span> <span class="n">is</span> <span class="n">a</span> <span class="nb">printf</span><span class="o">-</span><span class="n">style</span>
+<span class="n">formatted</span> <span class="n">statement</span> <span class="n">to</span> <span class="n">be</span> <span class="n">printed</span><span class="o">.</span>
+
+<span class="sb">`...`</span><span class="n">corresponds</span> <span class="n">to</span> <span class="n">the</span> <span class="n">parameters</span> <span class="n">in</span> <span class="n">the</span> <span class="n">formatted</span> <span class="n">statement</span><span class="o">.</span> <span class="n">A</span>
+<span class="k">new</span> <span class="n">line</span> <span class="n">is</span> <span class="n">automatically</span> <span class="n">added</span> <span class="n">to</span> <span class="n">the</span> <span class="n">end</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ Writes a text entry to a custom log file.</p>
+<p><strong>Example</strong>
+ ~ Suppose you call the following:</p>
+<div class="codehilite"><pre> int my_value = 2001;
+ INKTextLogObjectWrite (log, "my value: %d", my_value);
+
+If `<span class="nt"><i></span>mode <span class="nt"></i></span>` is set to `ADD_TIMESTAMP`, then the log should
+look like:
+
+ <span class="nt"><timestamp></span> my value: 2001
+</pre></div>
+
+
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the API is called successfully.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span> <span class="k">while</span> <span class="n">calling</span> <span class="n">the</span> <span class="n">API</span> <span class="ow">or</span> <span class="k">if</span> <span class="n">an</span>
+<span class="n">argument</span> <span class="n">is</span> <span class="n">invalid</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKThreadDestroy.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKThreadDestroy.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKThreadDestroy.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKThreadDestroy.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,38 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="ThreadFunctions">Prev</a> - Thread Functions
+INKThreadInit - <a href="INKThreadInit">Next</a></p>
+<h3 id="inkthreaddestroy">INKThreadDestroy</h3>
+<p>Destroys a thread.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKThreadDestroy (INKThread <em class="replaceable"><code>thread</code>)</p>
+<p><strong>Description</strong>
+ ~ Destroys a thread and frees all memory & associated data
+ structures. This should only be called on threads that have been
+ initialized using <code>INKThreadInit</code>.</p>
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if successful.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKThreadInit.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKThreadInit.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKThreadInit.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKThreadInit.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,39 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKThreadDestroy">Prev</a> - INKThreadDestroy
+INKThreadSelf - <a href="INKThreadSelf">Next</a></p>
+<h3 id="inkthreadinit">INKThreadInit</h3>
+<p>Initializes a thread.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKThread INKThreadInit (void)</code></p>
+<p><strong>Description</strong>
+ ~ Initializes a thread for use by Traffic Server. This function
+ should only be used if you create your own thread using something
+ other than the <code>INKThreadCreate</code> function. It should not be called
+ more than once for any given thread.</p>
+<p><strong>Returns</strong>
+ ~ A valid pointer to an <code>INKThread</code> object if successful.</p>
+<div class="codehilite"><pre><span class="n">A</span> <span class="sb">`NULL`</span> <span class="n">pointer</span> <span class="k">if</span> <span class="n">there</span> <span class="n">is</span> <span class="n">an</span> <span class="n">error</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKThreadSelf.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKThreadSelf.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKThreadSelf.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKThreadSelf.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,37 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKThreadInit">Prev</a> - INKThreadInit
+HTTP Functions - <a href="HTTPFunctions">Next</a></p>
+<h3 id="inkthreadself">INKThreadSelf</h3>
+<p>Obtains a thread identifier.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKThread INKThreadSelf (void)</code></p>
+<p><strong>Description</strong>
+ ~ Returns the thread identifier for the thread that's currently
+ being executed.</p>
+<p><strong>Returns</strong>
+ ~ A valid pointer to an <code>INKThread</code> object if successful.</p>
+<div class="codehilite"><pre><span class="n">A</span> <span class="sb">`NULL`</span> <span class="n">pointer</span> <span class="k">if</span> <span class="n">there</span> <span class="n">is</span> <span class="n">an</span> <span class="n">error</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTrafficServerVersionGet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTrafficServerVersionGet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTrafficServerVersionGet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTrafficServerVersionGet.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,38 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKPluginRegister">Prev</a> - INKPluginRegister
+Debugging Functions - <a href="DebuggingFunctions">Next</a></p>
+<h3 id="inktrafficserverversionget">INKTrafficServerVersionGet</h3>
+<p>Returns the version of Traffic Server that's running the plugin.</p>
+<p><strong>Prototype</strong>
+ ~ <code>const char* INKTrafficServerVersionGet (void)</code></p>
+<p><strong>Description</strong>
+ ~ Returns the string that indicates the release version of
+ Traffic Server running the plugin. See the modified
+ <a href="PlusingRegisAndVersionCkg" title="Plugin Registration and Version Checking"><code>hello-world</code></a>
+ example that checks the Traffic Server version for usage.</p>
+<p><strong>Returns</strong>
+ ~ A pointer to a string of characters that indicates the Traffic
+ Server release version.</p>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTransformOutputVConnGet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTransformOutputVConnGet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTransformOutputVConnGet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKTransformOutputVConnGet.en.html Sat Nov 6 06:31:06 2010
@@ -4,17 +4,37 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <title></title>
-
+ <title>Apache Traffic Server⢠Software Developers Kit</title>
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at . http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->
</head>
<body>
- <h1></h1>
+ <h1>Apache Traffic Server⢠Software Developers Kit</h1>
<div id="content">
-
+ <p><a href="TransformationFunctions">Prev</a> - Transformation Functions:
+INKTransformCreate
+VIO Functions - <a href="VIOFunctions">Next</a></p>
+<h3 id="inktransformoutputvconnget">INKTransformOutputVConnGet</h3>
+<p>Retrieves the downstream (output) vconnection for a
+transformation.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKVConn INKTransformOutputVConnGet (INKVConn <em class="replaceable"><code>connp</code>)</p>
+<p><strong>Description</strong>
+ ~ Retrieves the output vconnection for the transformation
+ <code><em class="replaceable"><code>connp</code>. The output vconnection may
+ be <code>NULL</code> if <code>INKTransformOutputVConnGet</code> is called before the
+ write operation is initiated on
+ <code><em class="replaceable"><code>connp</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>
+<p><strong>Returns</strong>
+ ~ The downstream vconnection for the transformation.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR_PTR`</span> <span class="k">if</span> <span class="n">there</span> <span class="n">is</span> <span class="n">an</span> <span class="n">error</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnCacheObjectSizeGet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnCacheObjectSizeGet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnCacheObjectSizeGet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnCacheObjectSizeGet.en.html Sat Nov 6 06:31:06 2010
@@ -4,17 +4,41 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <title></title>
-
+ <title>Apache Traffic Server⢠Software Developers Kit</title>
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at . http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->
</head>
<body>
- <h1></h1>
+ <h1>Apache Traffic Server⢠Software Developers Kit</h1>
<div id="content">
-
+ <p><a href="INKCacheKeyPinnedSet">Prev</a> - INKCacheKeyPinnedSet
+Transformation Functions - <a href="TransformationFunctions">Next</a></p>
+<h3 id="inkvconncacheobjectsizeget">INKVConnCacheObjectSizeGet</h3>
+<p>Gets the size of an object in the cache.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKVConnCacheObjectSizeGet (INKVConn <em class="replaceable"><code>connp</code>,
+ int *<em><code>obj_size</code></em>)</p>
+<p><strong>Arguments</strong>
+ ~ <code>INKConn</code> <code><em class="replaceable"><code>connp</code> is the
+ vconnection to the cache.</p>
+<div class="codehilite"><pre><span class="sb">`int *<em class="replaceable"><code>obj_size`</span> <span class="n">is</span> <span class="n">set</span> <span class="n">to</span> <span class="n">the</span> <span class="n">object</span>
+<span class="n">size</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ When a cached object is requested from the cache (using
+ <code>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>
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the API is called successfully.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span> <span class="k">while</span> <span class="n">calling</span> <span class="n">the</span> <span class="n">API</span> <span class="ow">or</span> <span class="k">if</span> <span class="n">an</span>
+<span class="n">argument</span> <span class="n">is</span> <span class="n">invalid</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnClose.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnClose.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnClose.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnClose.en.html Sat Nov 6 06:31:06 2010
@@ -4,17 +4,34 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <title></title>
-
+ <title>Apache Traffic Server⢠Software Developers Kit</title>
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at . http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->
</head>
<body>
- <h1></h1>
+ <h1>Apache Traffic Server⢠Software Developers Kit</h1>
<div id="content">
-
+ <p><a href="VconnectionFunctions">Prev</a> - Vconnection Functions:
+INKVConnAbort
+INKVConnClosedGet - <a href="INKVConnClosedGet">Next</a></p>
+<h3 id="inkvconnclose">INKVConnClose</h3>
+<p>Closes a vconnection.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKVConnClose (INKVConn <em class="replaceable"><code>connp</code>)</p>
+<p><strong>Description</strong>
+ ~ Closes the vconnection <code><em class="replaceable"><code> connp</code>.
+ The vconnection will be deallocated at some point in the near
+ future, after <code>INKVConnClose</code> is called. After calling
+ <code>INKVConnClose</code>, a user will not receive any more events from
+ <code><em class="replaceable"><code>connp</code>.</p>
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the connection is successfully closed.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnClosedGet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnClosedGet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnClosedGet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnClosedGet.en.html Sat Nov 6 06:31:06 2010
@@ -4,17 +4,43 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <title></title>
-
+ <title>Apache Traffic Server⢠Software Developers Kit</title>
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at . http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->
</head>
<body>
- <h1></h1>
+ <h1>Apache Traffic Server⢠Software Developers Kit</h1>
<div id="content">
-
+ <p><a href="INKVConnClose">Prev</a> - INKVConnClose
+INKVConnRead - <a href="INKVConnRead">Next</a></p>
+<h3 id="inkvconnclosedget">INKVConnClosedGet</h3>
+<p>Gets a closed vconnection.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKVConnClosedGet (INKVConn <em class="replaceable"><code>connp</code>)</p>
+<p><strong>Description</strong>
+ ~ Retrieves the closed status for a vconnection.</p>
+<div class="codehilite"><pre><span class="sb">`INKVConnClosedGet`</span> <span class="n">is</span> <span class="n">intended</span> <span class="n">to</span> <span class="n">be</span> <span class="n">used</span> <span class="n">by</span> <span class="n">vconnection</span>
+<span class="n">implementors</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">by</span> <span class="n">vconnection</span> <span class="n">users</span><span class="o">.</span> <span class="n">It</span> <span class="n">is</span> <span class="ow">not</span> <span class="n">safe</span> <span class="k">for</span> <span class="n">a</span>
+<span class="n">vconnection</span> <span class="n">user</span> <span class="n">to</span> <span class="n">call</span> <span class="sb">`INKVConnClosedGet`</span> <span class="n">because</span> <span class="k">if</span> <span class="n">the</span>
+<span class="n">vconnection</span> <span class="n">actually</span> <span class="n">is</span> <span class="n">closed</span><span class="p">,</span> <span class="k">then</span> <span class="n">it</span> <span class="n">is</span> <span class="n">possible</span> <span class="p">(</span><span class="ow">and</span> <span class="n">likely</span><span class="p">)</span> <span class="n">it</span>
+<span class="n">will</span><span class="o">/</span><span class="n">can</span> <span class="n">be</span> <span class="n">deallocated</span> <span class="n">at</span> <span class="n">any</span> <span class="nb">time</span><span class="o">.</span>
+
+<span class="o">!</span><span class="p">[[</span><span class="n">Note</span><span class="p">]](</span><span class="n">images</span><span class="sr">/docbook/</span><span class="n">note</span><span class="o">.</span><span class="n">png</span><span class="p">)</span>
+<span class="n">Note</span>
+<span class="n">This</span> <span class="n">API</span> <span class="n">can</span> <span class="n">be</span> <span class="n">used</span> <span class="o">**</span><span class="n">ONLY</span><span class="o">**</span> <span class="n">on</span> <span class="n">transformation</span> <span class="n">VConnections</span><span class="o">.</span>
+<span class="o">**</span><span class="n">NEVER</span><span class="o">**</span> <span class="k">use</span> <span class="n">it</span> <span class="n">on</span> <span class="n">Cache</span> <span class="n">VConnections</span><span class="p">,</span> <span class="n">Net</span> <span class="n">VConnections</span> <span class="ow">or</span> <span class="n">any</span>
+<span class="n">other</span> <span class="n">type</span> <span class="n">of</span> <span class="n">VConnection</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if successful.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnRead.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnRead.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnRead.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKVConnRead.en.html Sat Nov 6 06:31:06 2010
@@ -4,17 +4,40 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <title></title>
-
+ <title>Apache Traffic Server⢠Software Developers Kit</title>
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at . http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->
</head>
<body>
- <h1></h1>
+ <h1>Apache Traffic Server⢠Software Developers Kit</h1>
<div id="content">
-
+ <p><a href="INKVConnClosedGet">Prev</a> - INKVConnClosedGet
+INKVConnReadVIOGet - <a href="INKVConnReadVIOGet">Next</a></p>
+<h3 id="inkvconnread">INKVConnRead</h3>
+<p>Reads a vconnection.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKVIO INKVConnRead (INKVConn <em class="replaceable"><code>connp</code>,
+ INKCont <em><code>contp</code></em>, INKIOBuffer <em><code>bufp</code></em>, int <em><code>nbytes</code></em>)</p>
+<p><strong>Description</strong>
+ ~ Initiates a read operation on the vconnection
+ <code><em class="replaceable"><code>connp</code>. The read operation writes
+ into the buffer <code><em class="replaceable"><code> bufp</code>. The
+ continuation <code><em class="replaceable"><code> contp</code> is called back
+ with either <code>INK_EVENT_ERROR</code>, <code>INK_EVENT_VCONN_READ_READY</code>,
+ <code>INK_EVENT_VCONN_READ_COMPLETE</code>, or <code>INK_EVENT_VCONN_EOS</code> (refer to
+ the
+ <a href="IOGuide#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><em class="replaceable"><code> nbytes</code>
+ parameter.</p>
+<p><strong>Returns</strong>
+ ~ A handle to the vconnection.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR_PTR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">