You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by di...@apache.org on 2009/12/15 21:36:41 UTC
svn commit: r890975 [1/10] - /incubator/trafficserver/site/trunk/docs/sdk/
Author: dianes
Date: Tue Dec 15 20:36:40 2009
New Revision: 890975
URL: http://svn.apache.org/viewvc?rev=890975&view=rev
Log:
basic edits & mods since last ckin
Modified:
incubator/trafficserver/site/trunk/docs/sdk/MIMEFldsBelongAssocMIMEHdr.html
incubator/trafficserver/site/trunk/docs/sdk/MIMEHeaders.html
incubator/trafficserver/site/trunk/docs/sdk/MarshallBuffersFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/MemoryAllocationFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/MimeHeadersFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/MiscellaneousInterfaceGuide.html
incubator/trafficserver/site/trunk/docs/sdk/MutexFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/MutexGuide.html
incubator/trafficserver/site/trunk/docs/sdk/NamingConventions.html
incubator/trafficserver/site/trunk/docs/sdk/NetVconnections.html
incubator/trafficserver/site/trunk/docs/sdk/NetvconnectionFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/OtherDeprecatedFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/PluginConfigurations.html
incubator/trafficserver/site/trunk/docs/sdk/PluginManagement.html
incubator/trafficserver/site/trunk/docs/sdk/PlusingRegisAndVersionCkg.html
incubator/trafficserver/site/trunk/docs/sdk/Preface.html
incubator/trafficserver/site/trunk/docs/sdk/ReadTESettingStats.html
incubator/trafficserver/site/trunk/docs/sdk/RestartingTS.html
incubator/trafficserver/site/trunk/docs/sdk/RlsMarshalBufHandles.html
incubator/trafficserver/site/trunk/docs/sdk/Roadmap_CreatingPlugins.html
incubator/trafficserver/site/trunk/docs/sdk/SampleBufferedNullTransformPlugin.html
incubator/trafficserver/site/trunk/docs/sdk/SampleNullTransformPlugin.html
incubator/trafficserver/site/trunk/docs/sdk/SetTransactionHook.html
incubator/trafficserver/site/trunk/docs/sdk/SetUpLicensing.html
incubator/trafficserver/site/trunk/docs/sdk/SettingGlobalHook.html
incubator/trafficserver/site/trunk/docs/sdk/SettingUpTransacHook.html
incubator/trafficserver/site/trunk/docs/sdk/SettingUpUIUpdateCallbacks.html
incubator/trafficserver/site/trunk/docs/sdk/SpecifyingPluginLocation.html
incubator/trafficserver/site/trunk/docs/sdk/StatisticsFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/TEConfigReadFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/ThreadFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/Transformations_IO.html
incubator/trafficserver/site/trunk/docs/sdk/Trouble_DebugMemLeaks.html
incubator/trafficserver/site/trunk/docs/sdk/Trouble_DebugTags.html
incubator/trafficserver/site/trunk/docs/sdk/Trouble_LoadPlugins.html
incubator/trafficserver/site/trunk/docs/sdk/Trouble_UsingDebugger.html
incubator/trafficserver/site/trunk/docs/sdk/TypeIndex.html
incubator/trafficserver/site/trunk/docs/sdk/URLFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/URLs.html
incubator/trafficserver/site/trunk/docs/sdk/Updatingplugin.configFile.html
incubator/trafficserver/site/trunk/docs/sdk/VIOs_IO.html
incubator/trafficserver/site/trunk/docs/sdk/ViewStatsUsingTrafLine.html
incubator/trafficserver/site/trunk/docs/sdk/WorkWHTTPHeaderFunc.html
incubator/trafficserver/site/trunk/docs/sdk/WorkWithHTTPHeaders.html
incubator/trafficserver/site/trunk/docs/sdk/WritingHandlerFunctions.html
incubator/trafficserver/site/trunk/docs/sdk/pr01s02.html
Modified: incubator/trafficserver/site/trunk/docs/sdk/MIMEFldsBelongAssocMIMEHdr.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/MIMEFldsBelongAssocMIMEHdr.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/MIMEFldsBelongAssocMIMEHdr.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/MIMEFldsBelongAssocMIMEHdr.html Tue Dec 15 20:36:40 2009
@@ -1,44 +1,44 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>MIME Fields Always Belong to an Associated MIME
Header</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="GuideTSHTTPHdrSyst.html" title="Guide to Traffic Server HTTP Header System">
-<link rel="prev" href="DuplicateMIMEFlds.html" title="Duplicate MIME Fields Are Not Coalesced">
-<link rel="next" href="RlsMarshalBufHandles.html" title="Release Marshal Buffer Handles">
-<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="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="GuideTSHTTPHdrSyst.html" title="Guide to Traffic Server HTTP Header System" />
+<link rel="prev" href="DuplicateMIMEFlds.html" title="Duplicate MIME Fields Are Not Coalesced" />
+<link rel="next" href="RlsMarshalBufHandles.html" title="Release Marshal Buffer Handles" />
+<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>
@@ -46,7 +46,7 @@
<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>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
<div class="navprev">
@@ -59,38 +59,37 @@
<div class="titlepage"><div><div><h3 class="title">
<a name="MIMEFldsBelongAssocMIMEHdr"></a>MIME Fields Always Belong to an Associated MIME
Header<a class="indexterm" name="id381034"></a></h3></div></div></div>
-<p>In Traffic Server versions 4.0 and newer, you cannot create a
+<p>When using Traffic Server, you cannot create a
new MIME field without an associated MIME header or HTTP header; MIME
fields are always seen as part of a MIME header or HTTP
header.<a class="indexterm" name="id381045"></a></p>
<p>To use a MIME field, you must specify the MIME header or HTTP
- header to which it belongs. This header is called the fieldâs parent
- header. The <code class="function">INKMimeField*</code> functions in pre-2.0
- versions of the SDK, which do not require the parent header<a class="indexterm" name="id381061"></a> as inputs, have been deprecated. SDK 2.0 has new
- functions, the <code class="function">INKMimeHdrField</code>* series, that
+ header to which it belongs - this is called the fieldâs <b>parent
+ header</b>. The <code class="function">INKMimeField*</code> functions in older
+ versions of the SDK have been deprecated, as they do not require the parent header<a class="indexterm" name="id381061"></a> as inputs. The current version of Traffic Server uses new
+ functions, the <code class="function"><b>INKMimeHdrField*</b></code> series, which
require you to specify the location of the parent header along with
the location of the MIME field. For every deprecated
- <code class="function">INKMimeField</code>* function, there is a new preferred
- <code class="function">INKMimeHdrField</code>* function. Use the
- <code class="function">INKMimeHdrField*</code> functions instead of the
- deprecated <code class="function">INKMimeField*</code> series. Here are some
- examples:</p>
+ <code class="function">INKMimeField*</code> function, there is a new, preferred
+ <code class="function">INKMimeHdrField*</code> function. Therefore, you should use the
+ <code class="function"><b>INKMimeHdrField*</b></code> functions instead of the
+ deprecated <code class="function">INKMimeField*</code> series. Examples are provided below.</p>
<p>Instead of:</p>
<pre class="programlisting">INKMLoc INKMimeFieldCreate (INKMBuffer bufp)</pre>
-<p>Use:</p>
+<p>You should use:</p>
<pre class="programlisting">INKMLoc INKMimeHdrFieldCreate (INKMBuffer bufp, INKMLoc hdr)</pre>
<p>Instead of:</p>
<pre class="programlisting">void INKMimeFieldCopyValues (INKMBuffer dest_bufp, INKMLoc dest_offset,
INKMBuffer src_bufp, INKMLoc src_offset)</pre>
-<p>Use:</p>
+<p>You should use:</p>
<pre class="programlisting">void INKMimeHdrFieldCopyValues (INKMBuffer dest_bufp, INKMLoc dest_hdr,
INKMLoc dest_field, INKMBuffer src_bufp, INKMLoc src_hdr, INKMLoc
src_field)</pre>
<p>In the <code class="function">INKMimeHdrField*</code> function
prototypes, the <code class="code">INKMLoc</code> field corresponds to the
- <code class="code">INKMLoc</code> offset used the
- <code class="function">INKMimeField*</code> functions. See the discussion of
- parent <code class="code">INKMLoc</code> in the following section.</p>
+ <code class="code">INKMLoc</code> offset used the deprecated
+ <code class="function">INKMimeField*</code> functions (see the discussion of
+ parent <code class="code">INKMLoc</code> in the following section).</p>
</div>
</body>
</html>
Modified: incubator/trafficserver/site/trunk/docs/sdk/MIMEHeaders.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/MIMEHeaders.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/MIMEHeaders.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/MIMEHeaders.html Tue Dec 15 20:36:40 2009
@@ -1,43 +1,43 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>MIME Headers</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="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="prev" href="URLs.html" title="URLs">
-<link rel="next" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<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="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="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="prev" href="URLs.html" title="URLs" />
+<link rel="next" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<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>
@@ -45,7 +45,7 @@
<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>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
<div class="navprev">
@@ -60,56 +60,52 @@
<p>The Traffic Server API MIME header functions enable you to
retrieve and modify information about HTTP MIME fields.</p>
<p>An HTTP request or response consists of a header, body, and
- trailer. The HTTP header<a class="indexterm" name="id383429"></a> consists of a request or response line, and a MIME
- header<a class="indexterm" name="id383437"></a>. A MIME header is composed of zero or more <a class="indexterm" name="id383447"></a>MIME fields. A MIME field is composed of a field name, a
- colon and zero or more field values. The values in a field are separated
- by commas. In the following example, Foo is the <a class="indexterm" name="id383456"></a>MIME field name and bar is the first <a class="indexterm" name="id383465"></a>MIME field value and car is the second MIME field
- value:</p>
+ trailer. The <b>HTTP</b> <b>header</b><a class="indexterm" name="id383429"></a> consists of a request (or response) line and a MIME header<a class="indexterm" name="id383437"></a>. A <b>MIME</b> <b>header</b> is composed of zero or more <a class="indexterm" name="id383447"></a>MIME fields. A <b>MIME</b> <b>field</b> is composed of a field name, a
+ colon, and zero or more field values (the values in a field are separated
+ by commas). In the example below: <code>Foo</code> is the <a class="indexterm" name="id383456"></a>MIME field name, <code>bar</code> is the first <a class="indexterm" name="id383465"></a>MIME field value, and <code>car</code> is the second MIME field
+ value.</p>
<pre class="programlisting">Foo: bar, car</pre>
<p>The following is an augmented Backus-Naur Form (BNF) for the form
- of a <a class="indexterm" name="id383483"></a>MIME header. It specifies exactly what was described
- above. A header consists of zero or more fields which consist of a name,
- a separating colon and zero or more values. A name or value is simply a
- string of tokens which is potentially zero length. And a token is any
- character except certain control characters and separators such as
- colons.</p>
+ of a <a class="indexterm" name="id383483"></a>MIME header - it specifies exactly what was described
+ above. A <b>header</b> consists of zero or more <b>fields</b> that consist of a name,
+ a separating colon, and zero or more values. A name or <b>value</b> is simply a
+ string of tokens that is potentially zero length; a <b>token</b> is any
+ character except certain control characters and separators (such as
+ colons).</p>
<pre class="programlisting">MIME-header = *MIME-field
MIME-field = field-name ":" #field-value
field-name = *token
field-value = *token</pre>
-<p>For the purposes of retrieving a field, field names are not case
- sensitive: the field names <code class="code">Foo</code>, <code class="code">foo</code> and
+<p>For the purposes of retrieving a field, field names are not case-sensitive; ergo, the field names <code class="code">Foo</code>, <code class="code">foo</code> and
<code class="code">fOO</code> are all equivalent.</p>
<p>The MIME header data structure is a parsed version of a standard
Internet MIME header. The MIME header data structure is similar to the
- URL data structure (see <a href="URLs.html" title="URLs">âURLsâ</a>). The actual data is
+ URL data structure (see <a href="URLs.html" title="URLs">URLs</a>). The actual data is
stored in a marshal buffer and the MIME header functions operate on a
- marshal buffer and a location (INKMLoc) within the buffer.</p>
+ marshal buffer and a location (<code>INKMLoc</code>) within the buffer.</p>
<p>After a call to <code class="function">INKMimeHdrFieldDestroy</code>,
- <code class="function">INKMimeHdrFieldRemove</code> or
+ <code class="function">INKMimeHdrFieldRemove</code>, or
<code class="function">INKUrlDestroy</code> is made, you must deallocate the
- <code class="function">INKMLoc</code> handle by a call to
+ <code class="function">INKMLoc</code> handle with a call to
<code class="function">INKHandleMLocRelease</code>. You do not need to deallocate
- a <code class="code">NULL</code> handles. For instance, if you called
+ a <code class="code">NULL</code> handles. For example: if you called
<code class="function">INKMimeHdrFieldValueStringGet</code> to get the value of
- the content type field and the field does not exist, it returns
- <code class="code">INK_NULL_MLOC</code>. In this case, you would not have to
- deallocate the handle by a call to
+ the content type field and the field does not exist, then it returns
+ <code class="code">INK_NULL_MLOC</code>. In such a case, you wouldn't need to
+ deallocate the handle with a call to
<code class="function">INKHandleMLocRelease</code>.</p>
<p>The location (<code class="function">INKMLoc</code>) in the following MIME
header functions can be either a HTTP header location or a MIME header
- location. If an HTTP header location is passed to these function, the
- system locates the MIME header associated with this HTTP header, and
- executes the corresponding MIME header operations specified by the
- functions. See the example in the description of <a href="MimeHeadersFunctions.html#INKMimeHdrCopy" title="INKMimeHdrCopy"><code class="code">INKMimeHdrCopy</code></a>.</p>
+ location. If an HTTP header location is passed to these function, then the
+ system locates the MIME header associated with this HTTP header and
+ then executes the corresponding MIME header operations specified by the
+ functions (see the example in the description of <a href="MimeHeadersFunctions.html#INKMimeHdrCopy" title="INKMimeHdrCopy"><code class="code">INKMimeHdrCopy</code></a>).</p>
<p>MIME headers may contain more than one MIME field with the same
- name. Previous versions of Traffic Server (Traffic Server versions
- before 4.0) joined multiple fields with the same name into one field
- with composite values. This behavior comes at a performance cost, and
- causes interoperability problems with some older clients and servers.
+ name. While previous versions of Traffic Server joined multiple fields with the same name into one field
+ with composite values, this behavior comes at a performance cost and
+ causes compatability issues with older clients and servers.
Future versions of Traffic Server will cease coalescing duplicate
- fields.</p>
-<p>Correctly behaving plugins should check for the presence of
+ fields. Correctly-behaving plugins should check for the presence of
duplicate fields, and iterate over the duplicate fields, by using
<code class="function">INKMimeHdrFieldNextDup</code>.</p>
<p>To facilitate fast comparisons and to reduce storage size, Traffic
@@ -117,9 +113,9 @@
correspond to field names found in HTTP and NNTP headers.</p>
<div class="informaltable"><table border="1">
<colgroup>
-<col>
-<col>
-<col>
+<col />
+<col />
+<col />
</colgroup>
<tbody>
<tr>
@@ -131,380 +127,379 @@
lengths</strong></span></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_ACCEPT</td>
+<td><code>INK_MIME_FIELD_ACCEPT</code></td>
<td>"Accept"</td>
-<td>INK_MIME_LEN_ACCEPT</td>
+<td><code>INK_MIME_LEN_ACCEPT</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_ACCEPT_CHARSET</td>
+<td><code>INK_MIME_FIELD_ACCEPT_CHARSET</code></td>
<td>âAccept-Charset"</td>
-<td>INK_MIME_LEN_ACCEPT_CHARSET</td>
+<td><code>INK_MIME_LEN_ACCEPT_CHARSET</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_ACCEPT_ENCODING</td>
+<td><code>INK_MIME_FIELD_ACCEPT_ENCODING</code></td>
<td>"Accept-Encoding"</td>
-<td>INK_MIME_LEN_ACCEPT_ENCODING</td>
+<td><code>INK_MIME_LEN_ACCEPT_ENCODING</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_ACCEPT_LANGUAGE</td>
+<td><code>INK_MIME_FIELD_ACCEPT_LANGUAGE</code></td>
<td>"Accept-Language"</td>
-<td>INK_MIME_LEN_ACCEPT_LANGUAGE</td>
+<td><code>INK_MIME_LEN_ACCEPT_LANGUAGE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_ACCEPT_RANGES</td>
+<td><code>INK_MIME_FIELD_ACCEPT_RANGES</code></td>
<td>"Accept-Ranges"</td>
-<td>INK_MIME_LEN_ACCEPT_RANGES</td>
+<td><code>INK_MIME_LEN_ACCEPT_RANGES</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_AGE</td>
+<td><code>INK_MIME_FIELD_AGE</code></td>
<td>"Age"</td>
-<td>INK_MIME_LEN_AGE</td>
+<td><code>INK_MIME_LEN_AGE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_ALLOW</td>
+<td><code>INK_MIME_FIELD_ALLOW</code></td>
<td>"Allow"</td>
-<td>INK_MIME_LEN_ALLOW</td>
+<td><code>INK_MIME_LEN_ALLOW</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_APPROVED</td>
+<td><code>INK_MIME_FIELD_APPROVED</code></td>
<td>âApproved"</td>
-<td>INK_MIME_LEN_APPROVED</td>
+<td><code>INK_MIME_LEN_APPROVED</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_AUTHORIZATION</td>
+<td><code>INK_MIME_FIELD_AUTHORIZATION</code></td>
<td>"Authorization"</td>
-<td>INK_MIME_LEN_AUTHORIZATION</td>
+<td><code>INK_MIME_LEN_AUTHORIZATION</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_BYTES</td>
+<td><code>INK_MIME_FIELD_BYTES</code></td>
<td>"Bytes"</td>
-<td>INK_MIME_LEN_BYTES</td>
+<td><code>INK_MIME_LEN_BYTES</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_CACHE_CONTROL</td>
+<td><code>INK_MIME_FIELD_CACHE_CONTROL</code></td>
<td>"Cache-Control"</td>
-<td>INK_MIME_LEN_CACHE_CONTROL</td>
+<td><code>INK_MIME_LEN_CACHE_CONTROL</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_CLIENT_IP</td>
+<td><code>INK_MIME_FIELD_CLIENT_IP</code></td>
<td>"Client-ip"</td>
-<td>INK_MIME_LEN_CLIENT_IP</td>
+<td><code>INK_MIME_LEN_CLIENT_IP</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_CONNECTION</td>
+<td><code>INK_MIME_FIELD_CONNECTION</code></td>
<td>"Connection"</td>
-<td>INK_MIME_LEN_CONNECTION</td>
+<td><code>INK_MIME_LEN_CONNECTION</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_CONTENT_BASE</td>
+<td><code>INK_MIME_FIELD_CONTENT_BASE</code></td>
<td>"Content-Base"</td>
-<td>INK_MIME_LEN_CONTENT_BASE</td>
+<td><code>INK_MIME_LEN_CONTENT_BASE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_CONTENT_ENCODING</td>
+<td><code>INK_MIME_FIELD_CONTENT_ENCODING</code></td>
<td>"Content-Encoding"</td>
-<td>INK_MIME_LEN_CONTENT_ENCODING</td>
+<td><code>INK_MIME_LEN_CONTENT_ENCODING</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_CONTENT_LANGUAGE</td>
+<td><code>INK_MIME_FIELD_CONTENT_LANGUAGE</code></td>
<td>"Content-Language"</td>
-<td>INK_MIME_LEN_CONTENT_LANGUAGE</td>
+<td><code>INK_MIME_LEN_CONTENT_LANGUAGE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_CONTENT_LENGTH</td>
+<td><code>INK_MIME_FIELD_CONTENT_LENGTH</code></td>
<td>"Content-Length"</td>
-<td>INK_MIME_LEN_CONTENT_LENGTH</td>
+<td><code>INK_MIME_LEN_CONTENT_LENGTH</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_CONTENT_LOCATION</td>
+<td><code>INK_MIME_FIELD_CONTENT_LOCATION</code></td>
<td>"Content-Location"</td>
-<td>INK_MIME_LEN_CONTENT_LOCATION</td>
+<td><code>INK_MIME_LEN_CONTENT_LOCATION</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_CONTENT_MD5</td>
+<td><code>INK_MIME_FIELD_CONTENT_MD5</code></td>
<td>"Content-MD5"</td>
-<td>INK_MIME_LEN_CONTENT_MD5</td>
+<td><code>INK_MIME_LEN_CONTENT_MD5</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_CONTENT_RANGE</td>
+<td><code>INK_MIME_FIELD_CONTENT_RANGE</code></td>
<td>"Content-Range"</td>
-<td>INK_MIME_LEN_CONTENT_RANGE</td>
+<td><code>INK_MIME_LEN_CONTENT_RANGE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_CONTENT_TYPE</td>
+<td><code>INK_MIME_FIELD_CONTENT_TYPE</code></td>
<td>"Content-Type"</td>
-<td>INK_MIME_LEN_CONTENT_TYPE</td>
+<td><code>INK_MIME_LEN_CONTENT_TYPE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_CONTROL</td>
+<td><code>INK_MIME_FIELD_CONTROL</code></td>
<td>"Control"</td>
-<td>INK_MIME_LEN_CONTROL</td>
+<td><code>INK_MIME_LEN_CONTROL</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_COOKIE</td>
+<td><code>INK_MIME_FIELD_COOKIE</code></td>
<td>"Cookie"</td>
-<td>INK_MIME_LEN_COOKIE</td>
+<td><code>INK_MIME_LEN_COOKIE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_DATE</td>
+<td><code>INK_MIME_FIELD_DATE</code></td>
<td>"Date"</td>
-<td>INK_MIME_LEN_DATE</td>
+<td><code>INK_MIME_LEN_DATE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_DISTRIBUTION</td>
+<td><code>INK_MIME_FIELD_DISTRIBUTION</code></td>
<td>"Distribution"</td>
-<td>INK_MIME_LEN_DISTRIBUTION</td>
+<td><code>INK_MIME_LEN_DISTRIBUTION</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_ETAG</td>
+<td><code>INK_MIME_FIELD_ETAG</code></td>
<td>"Etag"</td>
-<td>INK_MIME_LEN_ETAG</td>
+<td><code>INK_MIME_LEN_ETAG</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_EXPECT</td>
+<td><code>INK_MIME_FIELD_EXPECT</code></td>
<td>"Expect"</td>
-<td>INK_MIME_LEN_EXPECT</td>
+<td><code>INK_MIME_LEN_EXPECT</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_EXPIRES</td>
+<td><code>INK_MIME_FIELD_EXPIRES</code></td>
<td>"Expires"</td>
-<td>INK_MIME_LEN_EXPIRES</td>
+<td><code>INK_MIME_LEN_EXPIRES</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_FOLLOWUP_TO</td>
+<td><code>INK_MIME_FIELD_FOLLOWUP_TO</code></td>
<td>"Followup-To"</td>
-<td>INK_MIME_LEN_FOLLOWUP_TO</td>
+<td><code>INK_MIME_LEN_FOLLOWUP_TO</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_FROM</td>
+<td><code>INK_MIME_FIELD_FROM</code></td>
<td>"From"</td>
-<td>INK_MIME_LEN_FROM</td>
+<td><code>INK_MIME_LEN_FROM</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_HOST</td>
+<td><code>INK_MIME_FIELD_HOST</code></td>
<td>"Host"</td>
-<td>INK_MIME_LEN_HOST</td>
+<td><code>INK_MIME_LEN_HOST</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_IF_MATCH</td>
+<td><code>INK_MIME_FIELD_IF_MATCH</code></td>
<td>"If-Match"</td>
-<td>INK_MIME_LEN_IF_MATCH</td>
+<td><code>INK_MIME_LEN_IF_MATCH</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_IF_MODIFIED_SINCE</td>
+<td><code>INK_MIME_FIELD_IF_MODIFIED_SINCE</code></td>
<td>"If-Modified-Since''</td>
-<td>INK_MIME_LEN_IF_MODIFIED_SINCE</td>
+<td><code>INK_MIME_LEN_IF_MODIFIED_SINCE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_IF_NONE_MATCH</td>
+<td><code>INK_MIME_FIELD_IF_NONE_MATCH</code></td>
<td>"If-None-Match''</td>
-<td>INK_MIME_LEN_IF_NONE_MATCH</td>
+<td><code>INK_MIME_LEN_IF_NONE_MATCH</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_IF_RANGE</td>
+<td><code>INK_MIME_FIELD_IF_RANGE</code></td>
<td>"If-Range''</td>
-<td>INK_MIME_LEN_IF_RANGE</td>
+<td><code>INK_MIME_LEN_IF_RANGE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_IF_UNMODIFIED_SINCE</td>
+<td><code>INK_MIME_FIELD_IF_UNMODIFIED_SINCE</code></td>
<td>"If-Unmodified-Since''</td>
-<td>INK_MIME_LEN_IF_UNMODIFIED_SINCE</td>
+<td><code>INK_MIME_LEN_IF_UNMODIFIED_SINCE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_KEEP_ALIVE</td>
+<td><code>INK_MIME_FIELD_KEEP_ALIVE</code></td>
<td>"Keep-Alive''</td>
-<td>INK_MIME_LEN_KEEP_ALIVE</td>
+<td><code>INK_MIME_LEN_KEEP_ALIVE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_KEYWORDS</td>
+<td><code>INK_MIME_FIELD_KEYWORDS</code></td>
<td>"Keywords''</td>
-<td>INK_MIME_LEN_KEYWORDS</td>
+<td><code>INK_MIME_LEN_KEYWORDS</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_LAST_MODIFIED</td>
+<td><code>INK_MIME_FIELD_LAST_MODIFIED</code></td>
<td>"Last-Modified''</td>
-<td>INK_MIME_LEN_LAST_MODIFIED</td>
+<td><code>INK_MIME_LEN_LAST_MODIFIED</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_LINES</td>
+<td><code>INK_MIME_FIELD_LINES</code></td>
<td>"Lines''</td>
-<td>INK_MIME_LEN_LINES</td>
+<td><code>INK_MIME_LEN_LINES</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_LOCATION</td>
+<td><code>INK_MIME_FIELD_LOCATION</code></td>
<td>"Location''</td>
-<td>INK_MIME_LEN_LOCATION</td>
+<td><code>INK_MIME_LEN_LOCATION</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_MAX_FORWARDS</td>
+<td><code>INK_MIME_FIELD_MAX_FORWARDS</code></td>
<td>"Max-Forwards''</td>
-<td>INK_MIME_LEN_MAX_FORWARDS</td>
+<td><code>INK_MIME_LEN_MAX_FORWARDS</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_MESSAGE_ID</td>
+<td><code>INK_MIME_FIELD_MESSAGE_ID</code></td>
<td>"Message-ID''</td>
-<td>INK_MIME_LEN_MESSAGE_ID</td>
+<td><code>INK_MIME_LEN_MESSAGE_ID</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_NEWSGROUPS</td>
+<td><code>INK_MIME_FIELD_NEWSGROUPS</code></td>
<td>"Newsgroups''</td>
-<td>INK_MIME_LEN_NEWSGROUPS</td>
+<td><code>INK_MIME_LEN_NEWSGROUPS</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_ORGANIZATION</td>
+<td><code>INK_MIME_FIELD_ORGANIZATION</code></td>
<td>"Organization''</td>
-<td>INK_MIME_LEN_ORGANIZATION</td>
+<td><code>INK_MIME_LEN_ORGANIZATION</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_PATH</td>
+<td><code>INK_MIME_FIELD_PATH</code></td>
<td>"Path''</td>
-<td>INK_MIME_LEN_PATH</td>
+<td><code>INK_MIME_LEN_PATH</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_PRAGMA</td>
+<td><code>INK_MIME_FIELD_PRAGMA</code></td>
<td>"Pragma''</td>
-<td>INK_MIME_LEN_PRAGMA</td>
+<td><code>INK_MIME_LEN_PRAGMA</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_PROXY_AUTHENTICATE</td>
+<td><code>INK_MIME_FIELD_PROXY_AUTHENTICATE</code></td>
<td>"Proxy-Authenticate''</td>
-<td>INK_MIME_LEN_PROXY_AUTHENTICATE</td>
+<td><code>INK_MIME_LEN_PROXY_AUTHENTICATE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_PROXY_AUTHORIZATION</td>
+<td><code>INK_MIME_FIELD_PROXY_AUTHORIZATION</code></td>
<td>"Proxy-Authorization''</td>
-<td>INK_MIME_LEN_PROXY_AUTHORIZATION</td>
+<td><code>INK_MIME_LEN_PROXY_AUTHORIZATION</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_PROXY_CONNECTION</td>
+<td><code>INK_MIME_FIELD_PROXY_CONNECTION</code></td>
<td>"Proxy-Connection''</td>
-<td>INK_MIME_LEN_PROXY_CONNECTION</td>
+<td><code>INK_MIME_LEN_PROXY_CONNECTION</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_PUBLIC</td>
+<td><code>INK_MIME_FIELD_PUBLIC</code></td>
<td>"Public''</td>
-<td>INK_MIME_LEN_PUBLIC</td>
+<td><code>INK_MIME_LEN_PUBLIC</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_RANGE</td>
+<td><code>INK_MIME_FIELD_RANGE</code></td>
<td>"Range''</td>
-<td>INK_MIME_LEN_RANGE</td>
+<td><code>INK_MIME_LEN_RANGE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_REFERENCES</td>
+<td><code>INK_MIME_FIELD_REFERENCES</code></td>
<td>"References''</td>
-<td>INK_MIME_LEN_REFERENCES</td>
+<td><code>INK_MIME_LEN_REFERENCES</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_REFERER</td>
+<td><code>INK_MIME_FIELD_REFERER</code></td>
<td>"Referer''</td>
-<td>INK_MIME_LEN_REFERER</td>
+<td><code>INK_MIME_LEN_REFERER</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_REPLY_TO</td>
+<td><code>INK_MIME_FIELD_REPLY_TO</code></td>
<td>"Reply-To''</td>
-<td>INK_MIME_LEN_REPLY_TO</td>
+<td><code>INK_MIME_LEN_REPLY_TO</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_RETRY_AFTER</td>
+<td><code>INK_MIME_FIELD_RETRY_AFTER</code></td>
<td>"Retry-After''</td>
-<td>INK_MIME_LEN_RETRY_AFTER</td>
+<td><code>INK_MIME_LEN_RETRY_AFTER</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_SENDER</td>
+<td><code>INK_MIME_FIELD_SENDER</code></td>
<td>"Sender''</td>
-<td>INK_MIME_LEN_SENDER</td>
+<td><code>INK_MIME_LEN_SENDER</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_SERVER</td>
+<td><code>INK_MIME_FIELD_SERVER</code></td>
<td>"Server''</td>
-<td>INK_MIME_LEN_SERVER</td>
+<td><code>INK_MIME_LEN_SERVER</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_SET_COOKIE</td>
+<td><code>INK_MIME_FIELD_SET_COOKIE</code></td>
<td>"Set-Cookie''</td>
-<td>INK_MIME_LEN_SET_COOKIE</td>
+<td><code>INK_MIME_LEN_SET_COOKIE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_SUBJECT</td>
+<td><code>INK_MIME_FIELD_SUBJECT</code></td>
<td>"Subject''</td>
-<td>INK_MIME_LEN_SUBJECTINK_MIME_LEN_SUBJECT</td>
+<td><code>INK_MIME_LEN_SUBJECTINK_MIME_LEN_SUBJECT</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_SUMMARY</td>
+<td><code>INK_MIME_FIELD_SUMMARY</code></td>
<td>"Summary''</td>
-<td>INK_MIME_LEN_SUMMARY</td>
+<td><code>INK_MIME_LEN_SUMMARY</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_TE</td>
+<td><code>INK_MIME_FIELD_TE</code></td>
<td>"TE''</td>
-<td>INK_MIME_LEN_TE</td>
+<td><code>INK_MIME_LEN_TE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_TRANSFER_ENCODING</td>
+<td><code>INK_MIME_FIELD_TRANSFER_ENCODING</code></td>
<td>"Transfer-Encoding''</td>
-<td>INK_MIME_LEN_TRANSFER_ENCODING</td>
+<td><code>INK_MIME_LEN_TRANSFER_ENCODING</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_UPGRADE</td>
+<td><code>INK_MIME_FIELD_UPGRADE</code></td>
<td>"Upgrade''</td>
-<td>INK_MIME_LEN_UPGRADE</td>
+<td><code>INK_MIME_LEN_UPGRADE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_USER_AGENT</td>
+<td><code>INK_MIME_FIELD_USER_AGENT</code></td>
<td>"User-Agent''</td>
-<td>INK_MIME_LEN_USER_AGENT</td>
+<td><code>INK_MIME_LEN_USER_AGENT</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_VARY</td>
+<td><code>INK_MIME_FIELD_VARY</code></td>
<td>"Vary''</td>
-<td>INK_MIME_LEN_VARY</td>
+<td><code>INK_MIME_LEN_VARY</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_VIA</td>
+<td><code>INK_MIME_FIELD_VIA</code></td>
<td>"Via''</td>
-<td>INK_MIME_LEN_VIA</td>
+<td><code>INK_MIME_LEN_VIA</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_WARNING</td>
+<td><code>INK_MIME_FIELD_WARNING</code></td>
<td>"Warning''</td>
-<td>INK_MIME_LEN_WARNING</td>
+<td><code>INK_MIME_LEN_WARNING</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_WWW_AUTHENTICATE</td>
+<td><code>INK_MIME_FIELD_WWW_AUTHENTICATE</code></td>
<td>"Www-Authenticate''</td>
-<td>INK_MIME_LEN_WWW_AUTHENTICATE</td>
+<td><code>INK_MIME_LEN_WWW_AUTHENTICATE</code></td>
</tr>
<tr>
-<td>INK_MIME_FIELD_XREF</td>
+<td><code>INK_MIME_FIELD_XREF</code></td>
<td>"Xref''</td>
-<td>INK_MIME_LEN_XREF</td>
+<td><code>INK_MIME_LEN_XREF</code></td>
</tr>
</tbody>
</table></div>
<p>The header field names above are defined in
<code class="filename">InkAPI.h</code> as <code class="code">const char*</code> strings. When
Traffic Server sets the name portion of a header field (or any portion
- for that matter) it makes a quick check to see if the new value is one
- of the known values. If it is, instead of storing the known value in the
- marshal buffer it stores a pointer into a global table. The header field
- names listed above are also pointers into this table. This allows simple
+ for that matter), it makes a quick check to see if the new value is one
+ of the known values. If it is, then it stores a pointer into a global table instead of storing the known value in the
+ marshal buffer. The header field
+ names listed above are also pointers into this table, which allows simple
pointer comparison of the value returned from
<code class="function">INKMimeHdrFieldNameGet</code> with one of the values
listed above. It is also recommended that you use the above values when
- referring to one of the known header field names as doing so removes the
+ referring to one of the known header field names to avoid the
possibility of a spelling error.</p>
<p>Traffic Server adds one important feature to MIME fields that
- those people already familiar with MIME headers will not know about.
- Namely, Traffic Server does not print a MIME field if the field name
- begins with the '<code class="code">@</code>' symbol. For example, a plugin can add
+ you may not know about: Traffic Server does not print a MIME field if the field name
+ begins with the '<code class="code">@</code>' symbol. For example: a plugin can add
the field "<code class="code">@My-Field</code>" to a header. Even though Traffic
Server never sends that field out in a request to an origin server or in
- a response to a client, they can be printed in TS logs by defining a
- custom log config file that explicitly logs these fields. This provides
+ a response to a client, it can be printed in Traffic Server logs by defining a
+ custom log config file that explicitly logs such fields. This provides
a useful mechanism for plugins to store information about an object in
one of the MIME headers associated with the object.</p>
-<p>The MIME header functions are:</p>
+<p>The MIME header functions are listed below:</p>
<div class="itemizedlist"><ul type="disc">
<li><p><code class="function">INKMimeHdrFieldClone</code></p></li>
<li><p><code class="function">INKMimeHdrFieldCopy</code></p></li>
Modified: incubator/trafficserver/site/trunk/docs/sdk/MarshallBuffersFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/MarshallBuffersFunctions.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/MarshallBuffersFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/MarshallBuffersFunctions.html Tue Dec 15 20:36:40 2009
@@ -1,48 +1,48 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Marshal 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="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="prev" href="ch18s09s04.html" title="Handle Release Functions">
-<link rel="next" href="INKMBufferDestroy.html" title="INKMBufferDestroy">
-<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="MarshallBuffersFunctions.html#INKMBufferCreate" title="INKMBufferCreate">
-<link rel="subsection" href="INKMBufferDestroy.html" title="INKMBufferDestroy">
-<link rel="subsection" href="HTTPHeaderFunctions.html" title="HTTP Header Functions">
-<link rel="subsection" href="URLFunctions.html" title="URL Functions">
-<link rel="subsection" href="MimeHeadersFunctions.html" title="MIIME Headers">
+<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="ch18s09s04.html" title="Handle Release Functions" />
+<link rel="next" href="INKMBufferDestroy.html" title="INKMBufferDestroy" />
+<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="MarshallBuffersFunctions.html#INKMBufferCreate" title="INKMBufferCreate" />
+<link rel="subsection" href="INKMBufferDestroy.html" title="INKMBufferDestroy" />
+<link rel="subsection" href="HTTPHeaderFunctions.html" title="HTTP Header Functions" />
+<link rel="subsection" href="URLFunctions.html" title="URL Functions" />
+<link rel="subsection" href="MimeHeadersFunctions.html" title="MIIME Headers" />
<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>
@@ -50,7 +50,7 @@
<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>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
<div class="navprev">
@@ -62,30 +62,31 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="MarshallBuffersFunctions"></a>Marshal Buffers</h2></div></div></div>
-<p>The marshal buffer or <code class="function">INKMBuffer</code> is a heap
- data structure that stores parsed URLs, MIME headers and HTTP headers.
- You can allocate new objects out of marshal buffers, and change the
- values within the marshal buffer. Whenever you manipulate an object, you
+<p>The marshal buffer, or <code class="function">INKMBuffer</code>, is a heap
+ data structure that stores parsed URLs, MIME headers, and HTTP headers.
+ You can allocate new objects out of marshal buffers as well as change the
+ values within a marshal buffer. Whenever you manipulate an object, you
require the handle to the object (<code class="function">INKMLoc</code>) and the
marshal buffer containing the object
(<code class="function">INKMBuffer</code>).</p>
<p>Routines exist for manipulating the object based on these two
- pieces of information. See, for example:</p>
+ pieces of information. For example, see the following:</p>
<div class="itemizedlist"><ul type="disc">
-<li><p><a href="HTTPHeaderFunctions.html" title="HTTP Header Functions">âHTTP Header Functionsâ</a></p></li>
-<li><p><a href="URLFunctions.html" title="URL Functions">âURL Functionsâ</a></p></li>
-<li><p><a href="MimeHeadersFunctions.html" title="MIIME Headers">âMIIME Headersâ</a></p></li>
+<li>
+ <p><a href="HTTPHeaderFunctions.html" title="HTTP Header Functions">HTTP Header Functions</a></p></li>
+<li><p><a href="URLFunctions.html" title="URL Functions">URL Functions</a></p></li>
+<li>
+ <p><a href="MimeHeadersFunctions.html" title="MIIME Headers">MIIME Headers</a></p></li>
</ul></div>
-<p>The marshal buffer functions allow you to create and destroy
+<p>The marshal buffer functions enable you to create and destroy
Traffic Serverâs marshal buffers, which are the data structures that
hold parsed URLs, MIME headers, and HTTP headers.</p>
<div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Caution">
<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/docbook/caution.png"></td>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/docbook/caution.png" /></td>
<th align="left">Caution</th>
</tr>
-<tr><td align="left" valign="top"><p>Any marshal buffer fetched by INKHttpTxn*Get (for example,
- <code class="function">INKHttpTxnClientReqGet</code> or
+<tr><td align="left" valign="top"><p>Any marshal buffer fetched by <code>INKHttpTxn*Get</code> (for example, <code class="function">INKHttpTxnClientReqGet</code> or
<code class="function">INKHttpTxnServerRespGet</code>) will be used by other
parts of the system. Be careful not to destroy these shared,
transaction marshal buffers.</p></td></tr>
@@ -95,15 +96,13 @@
<a name="INKMBufferCreate"></a>INKMBufferCreate</h3></div></div></div>
<p>Creates a new marshal buffer.</p>
<div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">INKMBuffer INKMBufferCreate (void)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd><p>Creates a new marshal buffer and initializes the reference
count to 1.</p></dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd><p>A pointer to the new marshal buffer.</p></dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
</div>
Modified: incubator/trafficserver/site/trunk/docs/sdk/MemoryAllocationFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/MemoryAllocationFunctions.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/MemoryAllocationFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/MemoryAllocationFunctions.html Tue Dec 15 20:36:40 2009
@@ -1,48 +1,48 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Memory Allocation</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="INKfwrite.html" title="INKfwrite">
-<link rel="next" href="INKmalloc.html" title="INKmalloc">
-<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="MemoryAllocationFunctions.html#INKfree" title="INKfree">
-<link rel="subsection" href="INKmalloc.html" title="INKmalloc">
-<link rel="subsection" href="INKrealloc.html" title="INKrealloc">
-<link rel="subsection" href="INKstrdup.html" title="INKstrdup">
-<link rel="subsection" href="INKstrndup.html" title="INKstrndup">
+<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="INKfwrite.html" title="INKfwrite" />
+<link rel="next" href="INKmalloc.html" title="INKmalloc" />
+<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="MemoryAllocationFunctions.html#INKfree" title="INKfree" />
+<link rel="subsection" href="INKmalloc.html" title="INKmalloc" />
+<link rel="subsection" href="INKrealloc.html" title="INKrealloc" />
+<link rel="subsection" href="INKstrdup.html" title="INKstrdup" />
+<link rel="subsection" href="INKstrndup.html" title="INKstrndup" />
<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>
@@ -50,7 +50,7 @@
<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>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
</div>
<div class="navheader">
<div class="navprev">
@@ -65,36 +65,36 @@
<p>Traffic Server provides five routines for allocating and freeing
memory. These routines correspond to similar routines in the C library.
For example, <code class="function">INKrealloc</code> behaves like the C library
- routine <code class="function">realloc</code>. There are two reasons to use the
- routines provided by Traffic Server. The first is portability. The
- Traffic Server API routines behave the same on all of Traffic Serverâs
- supported platforms. For example, realloc does not accept an argument of
- <code class="code">NULL</code> on some platforms. The second reason is that the
- Traffic Server routines actually track the memory allocations by file
- and line number. This tracking is very efficient, is always turned on,
- and is useful for tracking down memory leaks.</p>
-<p>The memory allocation functions are:</p>
+ routine <code class="function">realloc</code>. </p>
+<p>There are two main reasons to use the routines
+ provided by Traffic Server. The first is portability: the Traffic Server
+ API routines behave the same on all of Traffic Serverâs supported
+ platforms. For example, <code>realloc</code> does not accept an argument of <code class="code">NULL</code> on some platforms. The second reason is that the
+ Traffic Server routines actually track the memory allocations by file
+ and line number. This tracking is very efficient, is always turned on,
+ and is useful for tracking down memory leaks.</p>
+<p>The memory allocation functions are described below.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="INKfree"></a>INKfree</h3></div></div></div>
<p>Frees memory allocated by <code class="function">INKmalloc</code> or
<code class="function">INKrealloc</code>.</p>
<div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
<dd><p><code class="code">void INKfree (void
<em class="replaceable"><code>*ptr</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 a pointer
+<dt><span class="term"><b>Arguments</b></span></dt>
+<dd>
+ <p><code class="code"><em class="replaceable"><code>ptr </code></em></code> is a pointer
to the memory to deallocate.</p></dd>
-<dt><span class="term">Description</span></dt>
-<dd><p>Releases the memory allocated by
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Releases the memory allocated by
<code class="function">INKmalloc</code> or
<code class="function">INKrealloc</code>. If
- <code class="code"><em class="replaceable"><code>ptr</code></em></code> is
- <code class="code">NULL</code>, <code class="function">INKfree</code> does no
+ <code class="code"><em class="replaceable"><code>ptr </code></em></code> is
+ <code class="code">NULL</code>, then <code class="function">INKfree</code> does not perform an
operation.</p></dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
</div>