trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From andrew...@apache.org
Subject svn commit: r831152 [25/37] - in /incubator/trafficserver/site/trunk/docs: ./ admin/ admin/images/ sdk/ sdk/css/ sdk/images/ sdk/images/docbook/ sdk/js/
Date Thu, 29 Oct 2009 23:23:36 GMT
Added: incubator/trafficserver/site/trunk/docs/sdk/INKrealloc.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKrealloc.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKrealloc.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKrealloc.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,92 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>INKrealloc</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="MemoryAllocationFunctions.html" title="Memory Allocation">
+<link rel="prev" href="INKmalloc.html" title="INKmalloc">
+<link rel="next" href="INKstrdup.html" title="INKstrdup">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKmalloc.html">Prev</a> — INKmalloc</div>
+<div class="navnext">INKstrdup — <a accesskey="n" href="INKstrdup.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKrealloc"></a>INKrealloc</h3></div></div></div>
+<p>Changes the size of an allocated block of memory.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">void* INKrealloc (void
+              <em class="replaceable"><code>*ptr</code></em>, unsigned int
+              <em class="replaceable"><code>size</code></em>)</code></p></dd>
+<dt><span class="term">Arguments</span></dt>
+<dd>
+<p><code class="code"><em class="replaceable"><code>ptr</code></em></code> is the pointer
+              to the memory to reallocate.</p>
+<p><code class="code"><em class="replaceable"><code>size</code></em></code> is the number
+              of bytes to allocate.</p>
+</dd>
+<dt><span class="term">Description</span></dt>
+<dd><p>Changes the size of the memory block pointed to by
+              <code class="code"><em class="replaceable"><code>ptr</code></em></code> to
+              <code class="code"><em class="replaceable"><code>size</code></em></code> bytes and returns a
+              pointer to the new block. It may not be possible to simply
+              extend <code class="code"><em class="replaceable"><code>ptr</code></em></code> to satisfy a
+              request to increase the allocated block, so the returned pointer
+              might point to a new block of memory. If
+              <code class="code"><em class="replaceable"><code>ptr</code></em></code> is
+              <code class="code">NULL</code>, <code class="function">INKrealloc</code> behaves like
+              <code class="function">INKmalloc</code> and returns a pointer to the
+              newly allocated memory.</p></dd>
+<dt><span class="term">Returns</span></dt>
+<dd><p>A pointer to the reallocated memory.</p></dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/INKrealloc.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/INKstrdup.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKstrdup.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKstrdup.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKstrdup.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,95 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>INKstrdup</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="MemoryAllocationFunctions.html" title="Memory Allocation">
+<link rel="prev" href="INKrealloc.html" title="INKrealloc">
+<link rel="next" href="INKstrndup.html" title="INKstrndup">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKrealloc.html">Prev</a> — INKrealloc</div>
+<div class="navnext">INKstrndup — <a accesskey="n" href="INKstrndup.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKstrdup"></a>INKstrdup</h3></div></div></div>
+<p>Returns a pointer to a duplicate string.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">char* INKstrdup (const char
+              *<em class="replaceable"><code>str</code></em>)</code></p></dd>
+<dt><span class="term">Arguments</span></dt>
+<dd><p><code class="code"><em class="replaceable"><code>str</code></em></code> is a pointer
+              to the null-terminated string to duplicate.</p></dd>
+<dt><span class="term">Description</span></dt>
+<dd><p>Returns a pointer to a new string that is a duplicate of
+              the string pointed to by
+              <code class="code"><em class="replaceable"><code>str</code></em></code>. The memory for the
+              new string is allocated using <code class="function">INKmalloc</code> and
+              should be freed by a call to
+              <code class="function">INKfree</code>.</p></dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p>Pointer to the duplicated string.</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>A valid null-terminated string may not be returned if
+                the input <code class="code"><em class="replaceable"><code>str</code></em></code> argument
+                is not a valid pointer (i.e. a <code class="code">NULL</code> argument
+                would simply cause <code class="function">INKstrdup</code> to return
+                <code class="code">NULL</code>).</p></td></tr>
+</table></div>
+</dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/INKstrdup.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/INKstrndup.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKstrndup.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKstrndup.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKstrndup.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,105 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>INKstrndup</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="MemoryAllocationFunctions.html" title="Memory Allocation">
+<link rel="prev" href="INKstrdup.html" title="INKstrdup">
+<link rel="next" href="ThreadFunctions.html" title="Thread Functions">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKstrdup.html">Prev</a> — INKstrdup</div>
+<div class="navnext">Thread Functions — <a accesskey="n" href="ThreadFunctions.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKstrndup"></a>INKstrndup</h3></div></div></div>
+<p>Returns a pointer to a duplicate string of specified
+        length.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">char* INKstrndup (const char
+              *<em class="replaceable"><code>str</code></em>, int
+              <em class="replaceable"><code>length</code></em>)</code></p></dd>
+<dt><span class="term">Arguments</span></dt>
+<dd>
+<p><code class="code"><em class="replaceable"><code>str</code></em></code> is a pointer
+              to the string to duplicate.</p>
+<p><code class="code"><em class="replaceable"><code>length</code></em></code> is the
+              length of the string to duplicate.</p>
+</dd>
+<dt><span class="term">Description</span></dt>
+<dd><p>Returns a pointer to a new string that is a duplicate of
+              the string pointed to by
+              <code class="code"><em class="replaceable"><code>str</code></em></code> and
+              <code class="code"><em class="replaceable"><code>length</code></em></code> bytes long. The
+              new string will be null-terminated. This API is very useful for
+              transforming non-null terminated string values returned by APIs
+              such as <code class="function">INKMimeHdrFieldStringValueGet</code> into
+              null-terminated string values. The memory for the new string is
+              allocated using <code class="function">INKmalloc</code> and should be
+              freed by a call to <code class="function">INKfree</code>.</p></dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p>Pointer to the duplicated string.</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>A valid null-terminated string may not be returned if
+                the input <code class="code"><em class="replaceable"><code>str</code></em></code> argument
+                is not a valid pointer (i.e. a <code class="code">NULL</code> argument
+                would simply cause <code class="function">INKstrndup</code> to return
+                <code class="code">NULL</code>).</p></td></tr>
+</table></div>
+</dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/INKstrndup.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/IOBufferInterfaceFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/IOBufferInterfaceFunctions.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/IOBufferInterfaceFunctions.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/IOBufferInterfaceFunctions.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,103 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>IO Buffer Interface</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="prev" href="INKVIOReenable.html" title="INKVIOReenable">
+<link rel="next" href="INKIOBufferBlockReadAvail.html" title="INKIOBufferBlockReadAvail">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="subsection" href="IOBufferInterfaceFunctions.html#INKIOBufferBlockNext" title="INKIOBufferBlockNext">
+<link rel="subsection" href="INKIOBufferBlockReadAvail.html" title="INKIOBufferBlockReadAvail">
+<link rel="subsection" href="INKIOBufferBlockReadStart.html" title="INKIOBufferBlockReadStart">
+<link rel="subsection" href="INKIOBufferBlockWriteAvail.html" title="INKIOBufferBlockWriteAvail">
+<link rel="subsection" href="INKIOBufferBlockWriteStart.html" title="INKIOBufferBlockWriteStart">
+<link rel="subsection" href="INKIOBufferCopy.html" title="INKIOBufferCopy">
+<link rel="subsection" href="INKIOBufferCreate.html" title="INKIOBufferCreate">
+<link rel="subsection" href="INKIOBufferDestroy.html" title="INKIOBufferDestroy">
+<link rel="subsection" href="INKIOBufferProduce.html" title="INKIOBufferProduce">
+<link rel="subsection" href="INKIOBufferReaderAlloc.html" title="INKIOBufferReaderAlloc">
+<link rel="subsection" href="INKIOBufferReaderAvail.html" title="INKIOBufferReaderAvail">
+<link rel="subsection" href="INKIOBufferReaderClone.html" title="INKIOBufferReaderClone">
+<link rel="subsection" href="INKIOBufferReaderConsume.html" title="INKIOBufferReaderConsume">
+<link rel="subsection" href="INKIOBufferReaderFree.html" title="INKIOBufferReaderFree">
+<link rel="subsection" href="INKIOBufferReaderStart.html" title="INKIOBufferReaderStart">
+<link rel="subsection" href="INKIOBufferSizedCreate.html" title="INKIOBufferSizedCreate">
+<link rel="subsection" href="INKIOBufferStart.html" title="INKIOBufferStart">
+<link rel="subsection" href="INKIOBufferWaterMarkGet.html" title="INKIOBufferWaterMarkGet">
+<link rel="subsection" href="INKIOBufferWaterMarkSet.html" title="INKIOBufferWaterMarkSet">
+<link rel="subsection" href="INKIOBufferWrite.html" title="INKIOBufferWrite">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKVIOReenable.html">Prev</a> — INKVIOReenable</div>
+<div class="navnext">INKIOBufferBlockReadAvail — <a accesskey="n" href="INKIOBufferBlockReadAvail.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="IOBufferInterfaceFunctions"></a>IO Buffer Interface</h2></div></div></div>
+<p></p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKIOBufferBlockNext"></a>INKIOBufferBlockNext</h3></div></div></div>
+<p>Gets next IO buffer block.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">INKIOBufferBlock INKIOBufferBlockNext
+              (INKIOBufferBlock
+              <em class="replaceable"><code>blockp</code></em>)</code></p></dd>
+<dt><span class="term">Description</span></dt>
+<dd><p>Gets the next block in the buffer block chain.</p></dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p>The next IO buffer block.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
+</dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/IOBufferInterfaceFunctions.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/IOBuffers_IO.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/IOBuffers_IO.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/IOBuffers_IO.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/IOBuffers_IO.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,94 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>IO Buffers</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="prev" href="VIOs_IO.html" title="VIOs">
+<link rel="next" href="CacheAPI.html" title="Guide to the Cache API">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="VIOs_IO.html">Prev</a> — VIOs</div>
+<div class="navnext">Guide to the Cache API — <a accesskey="n" href="CacheAPI.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="IOBuffers_IO"></a>IO Buffers</h2></div></div></div>
+<p>The IO buffer data structure is the building block of the
+      vconnection abstraction. An IO buffer (<code class="function">INKIOBuffer</code>)
+      is composed of a list of buffer blocks which in turn point to buffer
+      data. Both the buffer block (<code class="function">INKIOBufferBlock</code>) and
+      buffer data (<code class="function">INKIOBufferData</code>) data structures are
+      reference counted so that they can reside in multiple buffers at the
+      same time. This makes it extremely efficient to copy data from one IO
+      buffer to another using <code class="function">INKIOBufferCopy</code> since
+      Traffic Server only needs to copy pointers and adjust reference counts
+      appropriately and not actually copy any data.</p>
+<p>The IO buffer abstraction provides for a single writer and
+      multiple readers. In order for the readers to have no knowledge of each
+      other, they manipulate IO buffers through the
+      <code class="function">INKIOBufferReader</code> data structure. Since only a
+      single writer is allowed, there is no corresponding
+      <code class="function">INKIOBufferWriter</code> data structure. The writer simply
+      modifies the IO buffer directly.</p>
+<p>Refer to the sample code in the description of <a href="INKIOBufferBlockReadStart.html" title="INKIOBufferBlockReadStart">“INKIOBufferBlockReadStart”</a> for a sample that illustrates how
+      to use IOBuffers.</p>
+<p>The IO buffer functions are:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p>The <code class="function">INKIOBufferReader</code> data structure
+          keeps track of how much data in the <code class="function">INKIOBuffer</code>
+          has been read. It has an offset number of bytes which is the current
+          start point of a particular buffer reader. (For every read operation
+          on an INKIOBuffer, you must allocate an
+          <code class="function">INKIOBufferReader</code>).</p></li>
+<li><p>Note that the bytes that already have been read may or may not
+          be freed within the <code class="code">INKIOBuffer</code>. You have to call
+          <code class="function">INKIOBufferConsume</code> to consume bytes that have
+          been read.</p></li>
+</ul></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/IOBuffers_IO.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/IOGuide.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/IOGuide.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/IOGuide.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/IOGuide.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,283 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Chapter 15. IO Guide</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="prev" href="HostsLookupAPI.html" title="Hosts Lookup API">
+<link rel="next" href="NetVconnections.html" title="Net Vconnections">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="section" href="IOGuide.html#Vconnections" title="Vconnections">
+<link rel="section" href="NetVconnections.html" title="Net Vconnections">
+<link rel="section" href="Transformations_IO.html" title="Transformations">
+<link rel="section" href="VIOs_IO.html" title="VIOs">
+<link rel="section" href="IOBuffers_IO.html" title="IO Buffers">
+<link rel="section" href="CacheAPI.html" title="Guide to the Cache API">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="HostsLookupAPI.html">Prev</a> — Hosts Lookup API</div>
+<div class="navnext">Net Vconnections — <a accesskey="n" href="NetVconnections.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="chapter" lang="en">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="IOGuide"></a>Chapter 15. IO Guide</h2></div></div></div>
+<div class="toc">
+<p><b>Table of Contents</b></p>
+<dl>
+<dt><span class="section"><a href="IOGuide.html#Vconnections">Vconnections</a></span></dt>
+<dd><dl><dt><span class="section"><a href="IOGuide.html#VconnectionUsersView">The vconnection user’s view</a></span></dt></dl></dd>
+<dt><span class="section"><a href="NetVconnections.html">Net Vconnections</a></span></dt>
+<dt><span class="section"><a href="Transformations_IO.html">Transformations</a></span></dt>
+<dd><dl>
+<dt><span class="section"><a href="Transformations_IO.html#VconnImplementersView">The Vconnection Implementor’s View</a></span></dt>
+<dd><dl><dt><span class="section"><a href="Transformations_IO.html#TransformVconnection">Transformation VConnection</a></span></dt></dl></dd>
+</dl></dd>
+<dt><span class="section"><a href="VIOs_IO.html">VIOs</a></span></dt>
+<dt><span class="section"><a href="IOBuffers_IO.html">IO Buffers</a></span></dt>
+<dt><span class="section"><a href="CacheAPI.html">Guide to the Cache API</a></span></dt>
+<dd><dl>
+<dt><span class="section"><a href="CacheAPI.html#DoACacheRead">How to Do a Cache Read</a></span></dt>
+<dt><span class="section"><a href="DoACacheWrite.html">How to Do a Cache Write</a></span></dt>
+<dt><span class="section"><a href="DoACacheRemove.html">How to Do a Cache Remove</a></span></dt>
+<dt><span class="section"><a href="Errors_Cache.html">Errors</a></span></dt>
+<dt><span class="section"><a href="CacheAPI_Example.html">Example</a></span></dt>
+</dl></dd>
+</dl>
+</div>
+<p>This chapter contains:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><a href="IOGuide.html#Vconnections" title="Vconnections">“Vconnections”</a></p></li>
+<li><p><a href="NetVconnections.html" title="Net Vconnections">“Net Vconnections”</a></p></li>
+<li><p><a href="Transformations_IO.html" title="Transformations">“Transformations”</a></p></li>
+<li><p><a href="HTTPTransformationPlugins.html#VIOs" title="VIOs">“VIOs”</a></p></li>
+<li><p><a href="HTTPTransformationPlugins.html#IOBuffers" title="IO Buffers">“IO Buffers”</a></p></li>
+<li><p><a href="CacheAPI.html" title="Guide to the Cache API">“Guide to the Cache API”</a></p></li>
+</ul></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="Vconnections"></a>Vconnections</h2></div></div></div>
+<p></p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="VconnectionUsersView"></a>The vconnection user’s view</h3></div></div></div>
+<p>To use a vconnection, a user first needs to get a handle to one.
+        This is usually accomplished by having it handed to the user or the
+        user issuing a call which creates a vconnection such as
+        <code class="function">INKNetConnect</code>. In the case of transform plugins,
+        plugin creates a transformation vconnection using
+        <code class="function">INKTransformCreate</code>, and accesses the output
+        vconnection using
+        <code class="function">INKTransformOutputVConnGet</code>.</p>
+<p>Once the user has a handle to a vconnection he can then issue a
+        read or write call. It’s important to note that not all vconnections
+        support both reading and writing. As of yet, there has not been a need
+        to query a vconnection ask to whether it can perform a read or write
+        operation. That ability is obvious from context.</p>
+<p>To issue a read or write operation a user calls
+        <code class="function">INKVConnRead</code> or
+        <code class="function">INKVConnWrite</code>. These two operations both return
+        VIO (INKVIO). The VIO describes the operation being performed and how
+        much progress has been made.</p>
+<p>Transform plugins initiate output to the downstream vconnection
+        by calling <code class="function">INKVConnWrite</code>.</p>
+<p>A vconnection read or write operation is different from a normal
+        Unix read(2) or write(2) operation in that the operation can specify
+        more data to be read or written than exists in the buffer handed to
+        the operation. For example, it is typical to issue a read for
+        <code class="code">INT_MAX</code> <a class="indexterm" name="id387878"></a>(4 billion) bytes from a network vconnection in order to
+        read all the data from the network connection until we reach the end
+        of stream. Contrast this to the usual Unix fashion of issuing repeated
+        calls to read(2) until one of them finally returns 0 indicating the
+        end of stream was reached. (Yes, the underlying implementation of
+        vconnections on Unix still issues those calls to read(2), but the
+        interface does not expose that detail).</p>
+<p>A given vconnection can have at most one read operation and one
+        write operation being performed on it. This is restricted both by
+        design and common sense. If two write operations were to be performed
+        on a single vconnection the user would not be able to specify which
+        one should occur first and the output would occur in an intermingled
+        fashion. Note that both a read operation and a write operation can
+        happen on a single vconnection at the same time. The restriction is on
+        more than one operation of a given type.</p>
+<p>One issue that should be obvious is that the buffer passed to
+        <code class="function">INKVConnRead</code> and
+        <code class="function">INKVConnWrite</code> won’t be large enough. There is no
+        reasonable way to make a buffer that can hold <code class="code">INT_MAX</code> (4
+        billion) bytes. The secret is that vconnections engage in a protocol
+        whereby they signal their user (the continuation passed to
+        <code class="function">INKVConnRead</code> and
+        <code class="function">INKVConnWrite</code>) that they have emptied out the
+        buffers passed to them and are ready for more data. When this occurs
+        it is up to the user to add more data to the buffers (or wait for more
+        data to be added) and then wake up the vconnection by calling
+        <code class="function">INKVIOReenable</code> on the VIO describing the
+        operation. <code class="function">INKVIOReenable</code> specifies that the
+        buffer for the operation has been modified and that the vconnection
+        should reexamine it to see if it can make further progress.</p>
+<p>The null transform plugin gives an example of how this is done.
+        First, here is the prototype of
+        <code class="function">INKVConnWrite</code>:</p>
+<pre class="programlisting">INKVIO INKVConnWrite (INKVConn connp, INKCont contp, INKIOBufferReader readerp, int nbytes)</pre>
+<p>Where the <code class="varname">connp</code> is the vconnection that the
+        user is writing to, and <code class="varname">contp</code> is the “user” – it is
+        the continuation that connp calls back when it has emptied out its
+        buffer and is ready for more data.</p>
+<p>The call made in the null transform plugin is:</p>
+<pre class="programlisting">INKVConnWrite (output_conn, contp, data-&gt;output_reader, INKVIONBytesGet (input_vio));</pre>
+<p>In this example, <code class="code">contp</code> is the transformation
+        vconnection, which is writing to the output vconnection. The number of
+        bytes to be written is obtained from the <code class="code">input_vio</code> by
+        <code class="function">INKVIONBytesGet</code>.</p>
+<p>When a vconnection calls back its user to indicate that it wants
+        more data or when some other condition has occurred, it issues a call
+        to <code class="function">INKContCall</code> and passes one of the following
+        values as the event parameter and the <code class="code">INKVIO</code> describing
+        the operation as the data parameter.</p>
+<div class="informaltable"><table border="1">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td align="center"><span class="bold"><strong>Event Parameter
+                Value</strong></span></td>
+<td align="center"><span class="bold"><strong>Description</strong></span></td>
+</tr>
+<tr>
+<td>INK_EVENT_ERROR</td>
+<td>Indicates that an error has occurred on the
+                vconnection. This will happen for network IO if the underlying
+                read(2) or write(2) call return an error.</td>
+</tr>
+<tr>
+<td>INK_EVENT_VCONN_READ_READY</td>
+<td>The vconnection has placed data in the buffer passed to
+                an <code class="function">INKVConnRead</code> operation and it would
+                like to do more IO but the buffer is now full. When the user
+                consumes the data from the buffer it should re-enable the VIO
+                to indicate to the vconnection that the buffer has been
+                modified.</td>
+</tr>
+<tr>
+<td>INK_EVENT_VCONN_WRITE_READY</td>
+<td>The vconnection has removed data from the buffer passed
+                to an <code class="function">INKVConnWrite</code> operation and it
+                would like to do more IO but the buffer does not have enough
+                data in it. When the user places more data in the buffer he
+                should re-enable the VIO to indicate to the vconnection that
+                the buffer has been modified.</td>
+</tr>
+<tr>
+<td>INK_EVENT_VCONN_READ_COMPLETE</td>
+<td>The vconnection has read all the bytes specified by an
+                <code class="function">INKVConnRead</code> operation. The vconnection
+                can now be used to initiate a new IO operation.</td>
+</tr>
+<tr>
+<td>INK_EVENT_VCONN_WRITE_COMPLETE</td>
+<td>The vconnection has written all the bytes specified by
+                an <code class="function">INKVConnWrite</code> operation. The
+                vconnection can now be used to initiate a new IO
+                operation.</td>
+</tr>
+<tr>
+<td>INK_EVENT_VCONN_EOS</td>
+<td>An attempt was made to read past the end of the stream
+                of bytes during the handling of an
+                <code class="function">INKVConnRead</code> operation. This event occurs
+                when the number of bytes available for reading from a
+                vconnection is less than the number of bytes the user
+                specifies should be read from the vconnection in a call to
+                <code class="function">INKVConnRead</code>. A common case where this
+                occurs is when the user specifies that <code class="code">INT_MAX</code>
+                bytes are to be read from network connection.</td>
+</tr>
+</tbody>
+</table></div>
+<p>The null transform plugin’s transformation, for example,
+        receives <code class="code">INK_EVENT_VCONN_WRITE_READY</code> and
+        <code class="code">INK_EVENT_VCONN_WRITE_COMPLETE</code> events from the downstream
+        vconnection as a result of the call to
+        <code class="function">INKVConnWrite</code>.</p>
+<p>When the user is finished using a vconnection he needs to call
+        <code class="function">INKVConnClose</code> or
+        <code class="function">INKVConnAbort</code>. Both calls indicate that the
+        vconnection can destroy itself but <code class="function">INKVConnAbort</code>
+        should be used when the connection is being closed abnormally. After a
+        call to <code class="function">INKVConnClose</code> or
+        <code class="function">INKVConnAbort</code> the user will not be called back by
+        the vconnection again.</p>
+<p>Sometimes it’s desirable to simply close down the write portion
+        of a connection while keeping the read portion open. This can be
+        accomplished using the <code class="function">INKVConnShutdown</code> function
+        which will shutdown either the read or write portion of a vconnection.
+        Shutdown means that the vconnection will no longer call back the user
+        with events for the portion of the connection shutdown. For example,
+        if the user shuts down the write portion of a connection he will no
+        longer get <code class="code">INK_EVENT_VCONN_WRITE_READY</code> or
+        <code class="code">INK_EVENT_VCONN_WRITE_COMPLETE</code> events.</p>
+<p>In the null transform plugin, the write operation is shut down
+        with a call to <code class="function">INKVConnShutdown</code>.</p>
+<p>For a description of how vconnections are used in transformation
+        plugins, see<a href="HTTPTransformationPlugins.html#WritingContentTransformPlugins" title="Writing Content Transform Plugins">“Writing Content Transform Plugins”</a>.</p>
+<p>The vconnection functions are:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><code class="function">INKVConnAbort</code></p></li>
+<li><p><code class="function">INKVConnClose</code></p></li>
+<li><p><code class="function">INKVConnClosedGet</code> (used for
+            Transformations only)</p></li>
+<li><p><code class="function">INKVConnCreate</code></p></li>
+<li><p><code class="function">INKVConnRead</code></p></li>
+<li><p><code class="function">INKVConnReadVIOGet</code></p></li>
+<li><p><code class="function">INKVConnShutdown</code></p></li>
+<li><p><code class="function">INKVConnWrite</code></p></li>
+<li><p><code class="function">INKVConnWriteVIOGet</code></p></li>
+</ul></div>
+</div>
+</div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/IOGuide.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/ImplementHandler_GetTransHandle.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/ImplementHandler_GetTransHandle.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/ImplementHandler_GetTransHandle.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/ImplementHandler_GetTransHandle.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,84 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Implementing the Handler and Getting a Handle to the
+        Transaction</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="BasicAuthorizatonPlugin.html" title="The Basic Authorization Plugin">
+<link rel="prev" href="BasicAuthorizatonPlugin.html" title="The Basic Authorization Plugin">
+<link rel="next" href="WorkWithHTTPHeaders.html" title="Working With HTTP Headers">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="BasicAuthorizatonPlugin.html">Prev</a> — The Basic Authorization Plugin</div>
+<div class="navnext">Working With HTTP Headers — <a accesskey="n" href="WorkWithHTTPHeaders.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="ImplementHandler_GetTransHandle"></a>Implementing the Handler and Getting a Handle to the
+        Transaction</h3></div></div></div>
+<p>The handler function for the plugin’s parent continuation is
+        implemented as follows:</p>
+<pre class="programlisting">static int
+auth_plugin (INKCont contp, INKEvent event, void *edata)
+{
+
+     INKHttpTxn txnp = (INKHttpTxn) edata;
+     switch (event) {
+     case INK_EVENT_HTTP_OS_DNS:
+          handle_dns (txnp, contp);
+          return 0;
+     case INK_EVENT_HTTP_SEND_RESPONSE_HDR:
+          handle_response (txnp);
+          return 0;
+     default:
+          break;
+     }
+
+     return 0;
+}</pre>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/ImplementHandler_GetTransHandle.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/InitializationFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/InitializationFunctions.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/InitializationFunctions.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/InitializationFunctions.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,94 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Initialization Functions</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="prev" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="next" href="INKPluginRegister.html" title="INKPluginRegister">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="subsection" href="InitializationFunctions.html#INKPluginInit" title="INKPluginInit">
+<link rel="subsection" href="INKPluginRegister.html" title="INKPluginRegister">
+<link rel="subsection" href="INKTrafficServerVersionGet.html" title="INKTrafficServerVersionGet">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="FunctionReference.html">Prev</a> — Chapter 18. Function Reference</div>
+<div class="navnext">INKPluginRegister — <a accesskey="n" href="INKPluginRegister.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="InitializationFunctions"></a>Initialization Functions</h2></div></div></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKPluginInit"></a>INKPluginInit</h3></div></div></div>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">void INKPluginInit (int <code class="varname">argc</code>,
+              const char <code class="varname">*argv[]</code>)</code></p></dd>
+<dt><span class="term">Arguments</span></dt>
+<dd>
+<p><code class="varname">argc</code> is a count of the number of
+              arguments in the argument vector, <code class="varname">argv</code>. The
+              count is at least one because the first argument in the argument
+              vector is the plugin’s name, which must exist in order for the
+              plugin to be loaded.</p>
+<p><code class="varname">argv</code> is the vector of arguments. The
+              number of arguments in the vector is <code class="varname">argc</code>,
+              and <code class="varname">argv[0]</code> always contains the name of the
+              plugin shared library.</p>
+</dd>
+<dt><span class="term">Description</span></dt>
+<dd><p>This function must be defined by all plugins. Traffic
+              Server calls this initialization routine when it loads the
+              plugin and sets <code class="varname">argc</code> and
+              <code class="varname">argv</code> appropriately based on the values in
+              <code class="filename">plugin.config</code>.</p></dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/InitializationFunctions.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/InitiateConnectionFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/InitiateConnectionFunctions.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/InitiateConnectionFunctions.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/InitiateConnectionFunctions.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,126 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Initiate Connection</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="prev" href="HTTPTransactionFunctions.html" title="HTTP Transaction Functions">
+<link rel="next" href="InterceptingHTTPTransactionFuncs.html" title="Intercepting HTTP Transaction Functions">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="subsection" href="InitiateConnectionFunctions.html#INKHttpConnect" title="INKHttpConnect">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="HTTPTransactionFunctions.html">Prev</a> — HTTP Transaction Functions</div>
+<div class="navnext">Intercepting HTTP Transaction Functions — <a accesskey="n" href="InterceptingHTTPTransactionFuncs.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="InitiateConnectionFunctions"></a>Initiate Connection</h2></div></div></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKHttpConnect"></a>INKHttpConnect</h3></div></div></div>
+<p>Sends an HTTP request through the Traffic Server HTTP SM.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">InkReturnCode INKHttpConnect (unsigned int
+              <em class="replaceable"><code>ip</code></em>, int
+              <em class="replaceable"><code>port</code></em>, INKVConn
+              *<em class="replaceable"><code>vc</code></em>) </code></p></dd>
+<dt><span class="term">Arguments</span></dt>
+<dd>
+<p><code class="code">unsigned int
+              </code><code class="code"><em class="replaceable"><code>ip</code></em></code> is the IP
+              address used to set the value of the VC remote IP address. This
+              is equivalent to a client IP address: IP from which the
+              connection is originated. Value is in host byte order.</p>
+<p><code class="code">int
+              </code><code class="code"><em class="replaceable"><code>port</code></em></code> is the port
+              used to set the value of the VC remote port. This is equivalent
+              to a client port: port from which the connection is originated.
+              Value is in host byte order.</p>
+<p><code class="code">INKVConn
+              *</code><code class="code"><em class="replaceable"><code>vc</code></em></code> is the
+              VConnection returned.</p>
+<p>Once VConnection is established, you can use regular
+              VConnection operations (<code class="function">INKVConnRead</code>,
+              <code class="function">INKVConnWrite</code>, etc).</p>
+</dd>
+<dt><span class="term">Description</span></dt>
+<dd>
+<p>Sends an HTTP request through the Traffic Server HTTP SM.
+              The HTTP request goes through the Traffic Server the same way a
+              request from a client (for instance a browser) does.</p>
+<p>A typical scenario when using is:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p>Call <code class="function">INKHttpConnect</code>.</p></li>
+<li><p>Use <code class="function">INKVConnWrite</code> to send an HTTP
+                  request.</p></li>
+<li><p>Use <code class="function">INKVConnRead</code> to get the HTTP
+                  response.</p></li>
+<li><p>If needed, use <code class="function">INKHttpParser</code> to
+                  parse the response.</p></li>
+</ul></div>
+<p>Note that the request and response go through the Traffic
+              Server HTTP SM. The request and the response can be cached and
+              the transaction will be logged in
+              <code class="filename">squid.log</code>.</p>
+<p>Also note that the ip address passed to
+              <code class="function">INKHttpConnect</code> will be used as the client
+              IP address in <code class="filename">squid.log</code>.</p>
+</dd>
+<dt><span class="term">Returns</span></dt>
+<dd>
+<p><code class="code">INK_SUCCESS</code> if 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>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 5.2</p></dd>
+</dl></div>
+</div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/InitiateConnectionFunctions.html
------------------------------------------------------------------------------
    svn:keywords = Id

Added: incubator/trafficserver/site/trunk/docs/sdk/InitiateHTTPConnection.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/InitiateHTTPConnection.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/InitiateHTTPConnection.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/InitiateHTTPConnection.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,65 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Initiate HTTP Connection</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="prev" href="InterceptingHTTPTx.html" title="Intercepting HTTP Transactions">
+<link rel="next" href="HTTPAlternateSelection.html" title="HTTP Alternate Selection">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="InterceptingHTTPTx.html">Prev</a> — Intercepting HTTP Transactions</div>
+<div class="navnext">HTTP Alternate Selection — <a accesskey="n" href="HTTPAlternateSelection.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="InitiateHTTPConnection"></a>Initiate HTTP Connection</h2></div></div></div>
+<p>The initiate HTTP connection function allows plugins to initiate
+      HTTP transactions. The initiate HTTP connection function is:</p>
+<div class="itemizedlist"><ul type="disc"><li><p><a href="InitiateConnectionFunctions.html#INKHttpConnect" title="INKHttpConnect">“INKHttpConnect”</a></p></li></ul></div>
+</div>
+</body>
+</html>

Propchange: incubator/trafficserver/site/trunk/docs/sdk/InitiateHTTPConnection.html
------------------------------------------------------------------------------
    svn:keywords = Id



Mime
View raw message