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 [8/10] - /incubator/trafficserver/site/trunk/docs/sdk/
Modified: incubator/trafficserver/site/trunk/docs/sdk/URLFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/URLFunctions.html?rev=890975&r1=890974&r2=890975&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/URLFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/URLFunctions.html Tue Dec 15 20:36:40 2009
@@ -1,71 +1,71 @@
<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>URL 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="MarshallBuffersFunctions.html" title="Marshal Buffers">
-<link rel="prev" href="HTTPHeaderFunctions.html" title="HTTP Header Functions">
-<link rel="next" href="MimeHeadersFunctions.html" title="MIIME 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">
-<link rel="subsection" href="URLFunctions.html#INKUrlClone" title="INKUrlClone">
-<link rel="subsection" href="URLFunctions.html#INKUrlCopy" title="INKUrlCopy">
-<link rel="subsection" href="URLFunctions.html#INKUrlCreate" title="INKUrlCreate">
-<link rel="subsection" href="URLFunctions.html#INKUrlDestroy" title="INKUrlDestroy">
-<link rel="subsection" href="URLFunctions.html#INKUrlPrint" title="INKUrlPrint">
-<link rel="subsection" href="URLFunctions.html#INKUrlFtpTypeGet" title="INKUrlFtpTypeGet">
-<link rel="subsection" href="URLFunctions.html#INKUrlFtpTypeSet" title="INKUrlFtpTypeSet">
-<link rel="subsection" href="URLFunctions.html#INKUrlHostGet" title="INKUrlHostGet">
-<link rel="subsection" href="URLFunctions.html#INKUrlHostSet" title="INKUrlHostSet">
-<link rel="subsection" href="URLFunctions.html#INKUrlHttpFragmentGet" title="INKUrlHttpFragmentGet">
-<link rel="subsection" href="URLFunctions.html#INKUrlHttpFragmentSet" title="INKUrlHttpFragmentSet">
-<link rel="subsection" href="URLFunctions.html#INKUrlHttpParamsGet" title="INKUrlHttpParamsGet">
-<link rel="subsection" href="URLFunctions.html#INKUrlHttpParamsSet" title="INKUrlHttpParamsSet">
-<link rel="subsection" href="URLFunctions.html#INKUrlHttpQueryGet" title="INKUrlHttpQueryGet">
-<link rel="subsection" href="URLFunctions.html#INKUrlHttpQuerySet" title="INKUrlHttpQuerySet">
-<link rel="subsection" href="URLFunctions.html#INKUrlLengthGet" title="INKUrlLengthGet">
-<link rel="subsection" href="URLFunctions.html#INKUrlParse" title="INKUrlParse">
-<link rel="subsection" href="URLFunctions.html#INKUrlPasswordGet" title="INKUrlPasswordGet">
-<link rel="subsection" href="URLFunctions.html#INKUrlPasswordSet" title="INKUrlPasswordSet">
-<link rel="subsection" href="URLFunctions.html#INKUrlPathGet" title="INKUrlPathGet">
-<link rel="subsection" href="URLFunctions.html#INKUrlPathSet" title="INKUrlPathSet">
-<link rel="subsection" href="URLFunctions.html#INKUrlPortGet" title="INKUrlPortGet">
-<link rel="subsection" href="URLFunctions.html#INKUrlPortSet" title="INKUrlPortSet">
-<link rel="subsection" href="URLFunctions.html#INKUrlSchemeGet" title="INKUrlSchemeGet">
-<link rel="subsection" href="URLFunctions.html#INKUrlSchemeSet" title="INKUrlSchemeSet">
-<link rel="subsection" href="URLFunctions.html#INKUrlStringGet" title="INKUrlStringGet">
-<link rel="subsection" href="URLFunctions.html#INKUrlUserGet" title="INKUrlUserGet">
-<link rel="subsection" href="URLFunctions.html#INKUrlUserSet" title="INKUrlUserSet">
+<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="MarshallBuffersFunctions.html" title="Marshal Buffers" />
+<link rel="prev" href="HTTPHeaderFunctions.html" title="HTTP Header Functions" />
+<link rel="next" href="MimeHeadersFunctions.html" title="MIIME 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" />
+<link rel="subsection" href="URLFunctions.html#INKUrlClone" title="INKUrlClone" />
+<link rel="subsection" href="URLFunctions.html#INKUrlCopy" title="INKUrlCopy" />
+<link rel="subsection" href="URLFunctions.html#INKUrlCreate" title="INKUrlCreate" />
+<link rel="subsection" href="URLFunctions.html#INKUrlDestroy" title="INKUrlDestroy" />
+<link rel="subsection" href="URLFunctions.html#INKUrlPrint" title="INKUrlPrint" />
+<link rel="subsection" href="URLFunctions.html#INKUrlFtpTypeGet" title="INKUrlFtpTypeGet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlFtpTypeSet" title="INKUrlFtpTypeSet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlHostGet" title="INKUrlHostGet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlHostSet" title="INKUrlHostSet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlHttpFragmentGet" title="INKUrlHttpFragmentGet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlHttpFragmentSet" title="INKUrlHttpFragmentSet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlHttpParamsGet" title="INKUrlHttpParamsGet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlHttpParamsSet" title="INKUrlHttpParamsSet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlHttpQueryGet" title="INKUrlHttpQueryGet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlHttpQuerySet" title="INKUrlHttpQuerySet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlLengthGet" title="INKUrlLengthGet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlParse" title="INKUrlParse" />
+<link rel="subsection" href="URLFunctions.html#INKUrlPasswordGet" title="INKUrlPasswordGet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlPasswordSet" title="INKUrlPasswordSet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlPathGet" title="INKUrlPathGet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlPathSet" title="INKUrlPathSet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlPortGet" title="INKUrlPortGet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlPortSet" title="INKUrlPortSet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlSchemeGet" title="INKUrlSchemeGet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlSchemeSet" title="INKUrlSchemeSet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlStringGet" title="INKUrlStringGet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlUserGet" title="INKUrlUserGet" />
+<link rel="subsection" href="URLFunctions.html#INKUrlUserSet" title="INKUrlUserSet" />
<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>
@@ -73,7 +73,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">
@@ -85,49 +85,46 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="URLFunctions"></a>URL Functions</h3></div></div></div>
-<p>The URL functions are:</p>
+<p>The URL functions are listed below.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="INKUrlClone"></a>INKUrlClone</h4></div></div></div>
<p>Copies a URL from a specified location in a source marshal
buffer to a target 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">INKMLoc INKUrlClone (INKMBuffer
<em class="replaceable"><code>dest_bufp</code></em>, INKMBuffer
<em class="replaceable"><code>src_bufp</code></em>, INKMLoc
<em class="replaceable"><code>src_url_loc</code></em>)</code></p></dd>
-<dt><span class="term">Arguments</span></dt>
+<dt><span class="term"><b>Arguments</b></span></dt>
<dd>
-<p><code class="code"><em class="replaceable"><code>src_bufp</code></em></code> and
- <code class="code"><em class="replaceable"><code>dest_bufp</code></em></code> are the
+<p><code class="code"><em class="replaceable"><code>src_bufp </code></em></code> and
+ <code class="code"><em class="replaceable"><code>dest_bufp </code></em></code> are the
source and destination marshal buffers.</p>
-<p><code class="code"><em class="replaceable"><code>src_url_loc</code></em></code> is
+<p><code class="code"><em class="replaceable"><code>src_url_loc </code></em></code> is
the source URL location within the source marshal
buffer.</p>
</dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Copies the contents of the URL at location
- <code class="code"><em class="replaceable"><code>src_url_loc</code></em></code> within the
+ <code class="code"><em class="replaceable"><code>src_url_loc </code></em></code> within the
marshal buffer
- <code class="code"><em class="replaceable"><code>src_bufp</code></em></code> to a location
+ <code class="code"><em class="replaceable"><code>src_bufp </code></em></code> to a location
within the marshal buffer
<code class="code"><em class="replaceable"><code>dest_bufp</code></em></code>.
<code class="function">INKUrlClone</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
<p>Release the returned handle with a call to
<code class="function">INKHandleMLocRelease</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>Returns the <code class="function">INKMLoc</code> location of the
copied URL.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</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.5</p></dd>
</dl></div>
</div>
<div class="section" lang="en">
@@ -136,49 +133,45 @@
<p>Copies a URL at a specified location in a source marshal
buffer to a specified location in a target 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">INKReturnCode INKUrlCopy (INKMBuffer
<em class="replaceable"><code>dest_bufp</code></em>, INKMLoc
<em class="replaceable"><code>dest_url_loc</code></em>, INKMBuffer
<em class="replaceable"><code>src_bufp</code></em>, INKMLoc
<em class="replaceable"><code>src_url_loc</code></em>)</code></p></dd>
-<dt><span class="term">Arguments</span></dt>
+<dt><span class="term"><b>Arguments</b></span></dt>
<dd>
-<p><code class="code"><em class="replaceable"><code>src_bufp</code></em></code> and
- <code class="code"><em class="replaceable"><code>dest_bufp</code></em></code> are the
+<p><code class="code"><em class="replaceable"><code>src_bufp </code></em></code> and
+ <code class="code"><em class="replaceable"><code>dest_bufp </code></em></code> are the
source and destination marshal buffers.</p>
-<p><code class="code"><em class="replaceable"><code>src_url_loc</code></em></code> and
- <code class="code"><em class="replaceable"><code>dest_url_loc</code></em></code> are the
+<p><code class="code"><em class="replaceable"><code>src_url_loc </code></em></code> and
+ <code class="code"><em class="replaceable"><code>dest_url_loc </code></em></code> are the
source and destination URL locations within the source and
destination marshal buffers. The type
<code class="function">INKMLoc</code> is used for marshal buffer
locations.</p>
</dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Copies the contents of the URL at location
- <code class="code"><em class="replaceable"><code>src_url_loc</code></em></code> within the
+ <code class="code"><em class="replaceable"><code>src_url_loc </code></em></code> within the
marshal buffer
- <code class="code"><em class="replaceable"><code>src_bufp</code></em></code> to the
- location <code class="code"><em class="replaceable"><code>dest_url_loc</code></em></code>
+ <code class="code"><em class="replaceable"><code>src_bufp </code></em></code> to the
+ location <code class="code"><em class="replaceable"><code>dest_url_loc </code></em></code>
within the marshal buffer
<code class="code"><em class="replaceable"><code>dest_bufp</code></em></code>.
<code class="function">INKUrlCopy</code> works correctly even if
- <code class="code"><em class="replaceable"><code>src_bufp</code></em></code> and
- <code class="code"><em class="replaceable"><code>dest_bufp</code></em></code> point to
- different marshal buffers. It is important for the destination
- URL (its marshal buffer and <code class="function">INKMLoc</code>) to
- have been created before copying into it.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+ <code class="code"><em class="replaceable"><code>src_bufp </code></em></code> and
+ <code class="code"><em class="replaceable"><code>dest_bufp </code></em></code> point to
+ different marshal buffers. It is important to create the destination
+ URL (its marshal buffer and <code class="function">INKMLoc</code>) before you copy into it.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if successful.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
<div class="section" lang="en">
@@ -186,29 +179,26 @@
<a name="INKUrlCreate"></a>INKUrlCreate</h4></div></div></div>
<p>Creates a new URL in a 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">INKMLoc INKUrlCreate (INKMBuffer
<em class="replaceable"><code>bufp</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Creates a new URL within the marshal buffer
<code class="code"><em class="replaceable"><code>bufp</code></em></code>. Release the
resulting handle with a call to
- <code class="function">INKHandleMLocRelease</code>, and destroy the URL
- with a call to <code class="function">INKUrlDestroy</code> (note that
- if you destroy the URL, you must also release the
- handle).</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+ <code class="function">INKHandleMLocRelease</code> and destroy the URL
+ with a call to <code class="function">INKUrlDestroy</code>. Note that
+ if you destroy the URL, then you must also release the
+ handle.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>A location handle for the URL within the marshal
buffer.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</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 class="section" lang="en">
@@ -216,63 +206,57 @@
<a name="INKUrlDestroy"></a>INKUrlDestroy</h4></div></div></div>
<p>Destroys a specific URL within a 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">INKReturnCode INKUrlDestroy (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Destroys the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
marshal buffer
<code class="code"><em class="replaceable"><code>bufp</code></em></code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</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>Do not forget to release the handle
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> with a call
+<tr><td align="left" valign="top"><p>Do not forget to release the handle
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> with a call
to <code class="function">INKHandleMLocRelease</code>.</p></td></tr>
</table></div>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if successful.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="INKUrlPrint"></a>INKUrlPrint</h4></div></div></div>
<p>Formats a URL stored in a marshal buffer to an
- INKIOBuffer.</p>
+ <code>INKIOBuffer</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">INKReturnCode INKUrlPrint (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, INKIOBuffer
<em class="replaceable"><code>iobufp</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Formats a URL stored in an
<code class="function">INKMBuffer</code> to an
<code class="function">INKIOBuffer</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if successful.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.5</p></dd>
</dl></div>
</div>
<div class="section" lang="en">
@@ -280,27 +264,24 @@
<a name="INKUrlFtpTypeGet"></a>INKUrlFtpTypeGet</h4></div></div></div>
<p>Gets the FTP type of a specific URL.</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">int INKUrlFtpTypeGet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Retrieves the FTP type portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
marshal buffer
<code class="code"><em class="replaceable"><code>bufp</code></em></code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- within a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
-<p>Returns 65 if the FTP type is ASCII.</p>
-<p>Return 73 if the FTP type is binary.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</p>
+<p>Returns <code>65</code> if the FTP type is ASCII.</p>
+<p>Return <code>73</code> if the FTP type is binary.</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 class="section" lang="en">
@@ -308,32 +289,27 @@
<a name="INKUrlFtpTypeSet"></a>INKUrlFtpTypeSet</h4></div></div></div>
<p>Sets the FTP type of a specific URL.</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">INKReturnCode INKUrlFtpTypeSet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, int
<em class="replaceable"><code>type</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Sets the FTP type portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
- marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code> to
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to
the value <code class="code"><em class="replaceable"><code>type</code></em></code>. The
valid values for the
- <code class="code"><em class="replaceable"><code>type</code></em></code> argument are :
- <code class="code"><em class="replaceable"><code>0, 65('A'), 97('a'), 69('E'), 101('e'), 73
- ('I')</code></em></code> and
- <code class="code"><em class="replaceable"><code>105('i')</code></em></code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+ <code class="code"><em class="replaceable"><code>type </code></em></code> argument are:<code> 0</code>,<code> 65('A')</code>,<code> 97('a')</code>,<code> 69('E')</code>,<code> 101('e')</code>,<code> 73
+ ('I')</code>, and <code class="code">105('i')</code>.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if successful.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
<div class="section" lang="en">
@@ -341,39 +317,37 @@
<a name="INKUrlHostGet"></a>INKUrlHostGet</h4></div></div></div>
<p>Gets the host portion of a specific URL.</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">const char* INKUrlHostGet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, int
*<em class="replaceable"><code>length</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Retrieves the host portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.
The length of the returned string is placed in the
- <code class="code"><em class="replaceable"><code>length</code></em></code>
+ <code class="code"><em class="replaceable"><code>length </code></em></code>
argument.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>A pointer to the host portion of the specified URL.
Release with a call to
<code class="function">INKHandleStringRelease</code>.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</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>
+<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>The returned string is not guaranteed to be
null-terminated.</p></td></tr>
</table></div>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
+<dt> </dt>
</dl></div>
</div>
<div class="section" lang="en">
@@ -381,37 +355,32 @@
<a name="INKUrlHostSet"></a>INKUrlHostSet</h4></div></div></div>
<p>Sets the host portion of a URL to a specific value.</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">INKReturnCode INKUrlHostSet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, const char
*<em class="replaceable"><code>value</code></em>, int
<em class="replaceable"><code>length</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Sets the host portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
- marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code> to
- the string <code class="code"><em class="replaceable"><code>value</code></em></code>. If
- <code class="code"><em class="replaceable"><code>length</code></em></code>h is -1 then
- <code class="function">INKUrlHostSet</code> assumes that value is
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to
+ the string <code class="code"><em class="replaceable"><code>value</code></em></code>. If <code class="code"><em class="replaceable"><code>length</code></em></code><em><code> </code></em> is -1, then <code class="function">INKUrlHostSet</code> assumes that value is
null-terminated. Otherwise, the length of the string
- <code class="code"><em class="replaceable"><code>value</code></em></code> is taken to be
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is taken to be
<code class="code"><em class="replaceable"><code>length</code></em></code>. The string is
copied to within <code class="code"><em class="replaceable"><code>bufp</code></em></code>,
so it is okay to modify or delete
- <code class="code"><em class="replaceable"><code>value</code></em></code> after calling
+ <code class="code"><em class="replaceable"><code>value </code></em></code> after calling
<code class="function">INKUrlHostSet</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if successful.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
<div class="section" lang="en">
@@ -419,40 +388,38 @@
<a name="INKUrlHttpFragmentGet"></a>INKUrlHttpFragmentGet</h4></div></div></div>
<p>Gets a specified HTTP fragment of a URL.</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">const char* INKUrlHttpFragmentGet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, int
*<em class="replaceable"><code>length</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Retrieves the HTTP fragment portion of the URL located
- at <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
+ at <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.
<code class="function">INKUrlHttpFragmentGet</code> places the length
of the returned string in the
- <code class="code"><em class="replaceable"><code>length</code></em></code>
+ <code class="code"><em class="replaceable"><code>length </code></em></code>
argument.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>A pointer to the HTTP fragment portion of the specified
URL. Release with a call to
<code class="function">INKHandleStringRelease</code>.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</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>
+<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>The returned string is not guaranteed to be
null-terminated.</p></td></tr>
</table></div>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
+<dt> </dt>
</dl></div>
</div>
<div class="section" lang="en">
@@ -460,37 +427,34 @@
<a name="INKUrlHttpFragmentSet"></a>INKUrlHttpFragmentSet</h4></div></div></div>
<p>Sets a specified HTTP fragment within a URL.</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">INKReturnCode INKUrlHttpFragmentSet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, const char
*<em class="replaceable"><code>value</code></em>, int
<em class="replaceable"><code>length</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Sets the HTTP fragment portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
- marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code> to
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to
the string <code class="code"><em class="replaceable"><code>value</code></em></code>. If
- <code class="code"><em class="replaceable"><code>length</code></em></code> is -1 then
+ <code class="code"><em class="replaceable"><code>length </code></em></code> is -1, then
<code class="function">INKUrlHttpFragmentSet</code> assumes that value
is null-terminated. Otherwise, the length of the string
- <code class="code"><em class="replaceable"><code>value</code></em></code> is taken to be
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is taken to be
<code class="code"><em class="replaceable"><code>length</code></em></code>. The string is
copied to within <code class="code"><em class="replaceable"><code>bufp</code></em></code>,
so it is okay to modify or delete
- <code class="code"><em class="replaceable"><code>value</code></em></code> after calling
+ <code class="code"><em class="replaceable"><code>value </code></em></code> after calling
<code class="function">INKUrlHttpFragmentSet</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if successful.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
<div class="section" lang="en">
@@ -498,40 +462,38 @@
<a name="INKUrlHttpParamsGet"></a>INKUrlHttpParamsGet</h4></div></div></div>
<p>Gets the HTTP params portion of a specified URL.</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">const char* INKUrlHttpParamsGet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, int
*<em class="replaceable"><code>length</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Retrieves the HTTP params portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.
<code class="function">INKUrlHttpParamsGet</code> places the length of
the returned string in the
- <code class="code"><em class="replaceable"><code>length</code></em></code>
+ <code class="code"><em class="replaceable"><code>length </code></em></code>
argument.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>A pointer to the HTTP params portion of the specified
URL. Release with a call to
<code class="function">INKHandleStringRelease</code>.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</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>
+<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>The returned string is not guaranteed to be
null-terminated.</p></td></tr>
</table></div>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
+<dt> </dt>
</dl></div>
</div>
<div class="section" lang="en">
@@ -539,38 +501,35 @@
<a name="INKUrlHttpParamsSet"></a>INKUrlHttpParamsSet</h4></div></div></div>
<p>Sets the HTTP params portion of a specified URL.</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">INKReturnCode INKUrlHttpParamsSet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, const char
*<em class="replaceable"><code>value</code></em>, int
<em class="replaceable"><code>length</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Sets the HTTP params portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
- marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code> to
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to
the string <code class="code"><em class="replaceable"><code>value</code></em></code>. If
- <code class="code"><em class="replaceable"><code>length</code></em></code> is -1 then
+ <code class="code"><em class="replaceable"><code>length </code></em></code> is -1, then
<code class="function">INKUrlHttpParamsSet</code> assumes that value is
null-terminated. Otherwise, the length of the string
- <code class="code"><em class="replaceable"><code>value</code></em></code> is taken to be
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is taken to be
<code class="code"><em class="replaceable"><code>length</code></em></code>.
<code class="function">INKUrlHttpParamsSet</code> copies the string to
within <code class="code"><em class="replaceable"><code>bufp</code></em></code>, so it is
okay to modify or delete
- <code class="code"><em class="replaceable"><code>value</code></em></code> after calling
- INKUrlHttpParamsSet.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+ <code class="code"><em class="replaceable"><code>value </code></em></code> after calling
+ <code>INKUrlHttpParamsSet</code>.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if successful.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
<div class="section" lang="en">
@@ -578,40 +537,37 @@
<a name="INKUrlHttpQueryGet"></a>INKUrlHttpQueryGet</h4></div></div></div>
<p>Gets the HTTP query portion of a specified URL.</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">const char* INKUrlHttpQueryGet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, int
*<em class="replaceable"><code>length</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
-<p>Retrieves the HTTP query portion of the URL located at
- <code class="code"><em class="replaceable"><code>_loc</code></em></code> within the
+<p>Retrieves the HTTP query portion of the URL located at <code class="code"><em class="replaceable"><code>url_loc </code></em></code>within the
marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.
<code class="function">INKUrlHttpQueryGet</code> places the length of
the returned string in the
- <code class="code"><em class="replaceable"><code>length</code></em></code>
+ <code class="code"><em class="replaceable"><code>length </code></em></code>
argument.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>A pointer to the HTTP query portion of the specified
URL. Release with a call to
<code class="function">INKHandleStringRelease</code>.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</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>
+<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>The returned string is not guaranteed to be
null-terminated.</p></td></tr>
</table></div>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
+<dt> </dt>
</dl></div>
</div>
<div class="section" lang="en">
@@ -619,38 +575,35 @@
<a name="INKUrlHttpQuerySet"></a>INKUrlHttpQuerySet</h4></div></div></div>
<p>Sets the HTTP query portion of a specified URL.</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">INKReturnCode INKUrlHttpQuerySet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, const char
*<em class="replaceable"><code>value</code></em>, int
<em class="replaceable"><code>length</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Sets the HTTP query portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
- marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code> to
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to
the string <code class="code"><em class="replaceable"><code>value</code></em></code>. If
- <code class="code"><em class="replaceable"><code>length</code></em></code> is -1 then
+ <code class="code"><em class="replaceable"><code>length </code></em></code> is -1, then
<code class="function">INKUrlHttpQuerySet</code> assumes that value is
null-terminated. Otherwise, the length of the string
- <code class="code"><em class="replaceable"><code>value</code></em></code> is taken to be
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is taken to be
<code class="code"><em class="replaceable"><code>length</code></em></code>.
<code class="function">INKUrlHttpQuerySet</code> copies the string to
within <code class="code"><em class="replaceable"><code>bufp</code></em></code>, so it is
okay to modify or delete
- <code class="code"><em class="replaceable"><code>value</code></em></code> after calling
+ <code class="code"><em class="replaceable"><code>value </code></em></code> after calling
<code class="function">INKUrlHttpQuerySet</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if successful.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
<div class="section" lang="en">
@@ -659,27 +612,24 @@
<p>Calculates the length of the string representation of a
URL.</p>
<div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
-<dd><p><code class="code">int INKUrlLengthGet (INKMBuffer bufp, INKMLoc
- url_loc)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">int INKUrlLengthGet (INKMBuffer <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>url_loc</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Calculates the length of URL located at
- <code class="code"><em class="replaceable"><code>l_loc</code></em></code> within the
- marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code> if
- it were returned as a string. This length will be the same as
+ <code class="code"><em class="replaceable"><code>l_loc </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> if
+ it was returned as a string. This length will be the same as
the length returned by
<code class="function">INKUrlStringGet</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>Returns the calculated length.</p>
-<p><code class="code">INK_ERROR</code> if error.</p>
+<p><code class="code">INK_ERROR</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 class="section" lang="en">
@@ -687,78 +637,77 @@
<a name="INKUrlParse"></a>INKUrlParse</h4></div></div></div>
<p>Parses the specified URL.</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">int INKUrlParse (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, const char
**<em class="replaceable"><code>start</code></em>, const char
*<em class="replaceable"><code>end</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Parses a URL. The
- <code class="code"><em class="replaceable"><code>start</code></em></code> pointer is both
- an input and an output parameter and marks the start of the
+ <code class="code"><em class="replaceable"><code>start </code></em></code> pointer is both
+ an input and an output parameter, and marks the start of the
URL to be parsed. After a successful parse, the
- <code class="code"><em class="replaceable"><code>start</code></em></code> pointer equals
- the <code class="code"><em class="replaceable"><code>end</code></em></code> pointer. The
- <code class="code"><em class="replaceable"><code>end</code></em></code> pointer must be
+ <code class="code"><em class="replaceable"><code>start </code></em></code> pointer equals
+ the <code class="code"><em class="replaceable"><code>end </code></em></code> pointer. The
+ <code class="code"><em class="replaceable"><code>end </code></em></code> pointer must be
one byte after the last character you want to parse.The URL
parsing routine assumes that everything between
- <code class="code"><em class="replaceable"><code>start</code></em></code> and
- <code class="code"><em class="replaceable"><code>end</code></em></code> is part of the
- URL. It is up to higher level parsing routines, such as
+ <code class="code"><em class="replaceable"><code>start </code></em></code> and
+ <code class="code"><em class="replaceable"><code>end </code></em></code> is part of the
+ URL. It is up to higher-level parsing routines, such as
<code class="function">INKHttpHdrParseReq</code>, to determine the
actual end of the URL.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
-<dd><p>Returns <code class="code">INK_PARSE_ERROR</code> if an error occurs,
- otherwise <code class="code">INK_PARSE_DONE</code> is returned to indicate
- success.</p></dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
-</dl></div>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+ <p>Returns <code class="code">INK_PARSE_DONE</code> if
+ successful.</p></dd>
+<dd>
+ <p>Returns <code class="code">INK_PARSE_ERROR</code> if an error occurs.</p>
+</dd>
+</dl>
+</div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="INKUrlPasswordGet"></a>INKUrlPasswordGet</h4></div></div></div>
<p>Gets the password portion of a specified URL.</p>
<div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><b><span class="term">Prototype</span></b></dt>
<dd><p><code class="code">const char* INKUrlPasswordGet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, int
*<em class="replaceable"><code>length</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Retrieves the password portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.
<code class="function">INKUrlPasswordGet</code> places the length of
the returned string in the
- <code class="code"><em class="replaceable"><code>length</code></em></code>
+ <code class="code"><em class="replaceable"><code>length </code></em></code>
argument.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>A pointer to the password portion of the specified URL.
Release with a call to
<code class="function">INKHandleStringRelease</code>.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</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>
+<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>The returned string is not guaranteed to be
null-terminated.</p></td></tr>
</table></div>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
+<dt> </dt>
</dl></div>
</div>
<div class="section" lang="en">
@@ -766,38 +715,35 @@
<a name="INKUrlPasswordSet"></a>INKUrlPasswordSet</h4></div></div></div>
<p>Sets the password portion of a specified URL.</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">INKReturnCode INKUrlPasswordSet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, const char
*<em class="replaceable"><code>value</code></em>, int
<em class="replaceable"><code>length</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Sets the password portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code> to
the string <code class="code"><em class="replaceable"><code>value</code></em></code>. If
- <code class="code"><em class="replaceable"><code>length</code></em></code> is -1 then
+ <code class="code"><em class="replaceable"><code>length </code></em></code> is -1, then
<code class="function">INKUrlPasswordSet</code> assumes that value is
null-terminated. Otherwise, the length of the string
- <code class="code"><em class="replaceable"><code>value</code></em></code> is taken to be
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is taken to be
<code class="code"><em class="replaceable"><code>length</code></em></code>.
<code class="function">INKUrlPasswordSet</code> copies the string to
within <code class="code"><em class="replaceable"><code>bufp</code></em></code>, so it is
okay to modify or delete
- <code class="code"><em class="replaceable"><code>value</code></em></code> after calling
+ <code class="code"><em class="replaceable"><code>value </code></em></code> after calling
<code class="function">INKUrlPasswordSet</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if successful.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
<div class="section" lang="en">
@@ -805,40 +751,38 @@
<a name="INKUrlPathGet"></a>INKUrlPathGet</h4></div></div></div>
<p>Gets the path portion of a specified URL.</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">const char* INKUrlPathGet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, int
*<em class="replaceable"><code>length</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Retrieves the path portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.
<code class="function">INKUrlPathGet</code> places the length of the
returned string in the
- <code class="code"><em class="replaceable"><code>length</code></em></code>
+ <code class="code"><em class="replaceable"><code>length </code></em></code>
argument.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>A pointer to the path portion of the specified URL.
Release with a call to
<code class="function">INKHandleStringRelease</code>.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</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>
+<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>The returned string is not guaranteed to be
null-terminated.</p></td></tr>
</table></div>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
+<dt> </dt>
</dl></div>
</div>
<div class="section" lang="en">
@@ -846,37 +790,34 @@
<a name="INKUrlPathSet"></a>INKUrlPathSet</h4></div></div></div>
<p>Sets the path portion of a specified URL.</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">INKReturnCode INKUrlPathSet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, const char
*<em class="replaceable"><code>value</code></em>, int
<em class="replaceable"><code>length</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Sets the path portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
- marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code> to
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to
the string <code class="code"><em class="replaceable"><code>value</code></em></code>. If
- <code class="code"><em class="replaceable"><code>length</code></em></code> is -1 then
+ <code class="code"><em class="replaceable"><code>length </code></em></code> is -1, then
<code class="function">INKUrlPathSet</code> assumes that value is
null-terminated. Otherwise, the length of the string
- <code class="code"><em class="replaceable"><code>value</code></em></code> is taken to be
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is taken to be
<code class="code"><em class="replaceable"><code>length</code></em></code>.
<code class="function">INKUrlPathSet</code> copies the string to within
<code class="code"><em class="replaceable"><code>bufp</code></em></code>, so it is okay to
- modify or delete <code class="code"><em class="replaceable"><code>value</code></em></code>
+ modify or delete <code class="code"><em class="replaceable"><code>value </code></em></code>
after calling <code class="function">INKUrlPathSet</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if successful.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
<div class="section" lang="en">
@@ -884,26 +825,23 @@
<a name="INKUrlPortGet"></a>INKUrlPortGet</h4></div></div></div>
<p>Gets the port number portion of a specified URL.</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">int INKUrlPortGet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Retrieves the port number portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
marshal buffer
<code class="code"><em class="replaceable"><code>bufp</code></em></code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>The port number portion of the specified URL.</p>
-<p><code class="code">INK_ERROR</code> if error.</p>
+<p><code class="code">INK_ERROR</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 class="section" lang="en">
@@ -912,27 +850,24 @@
<p>Sets the port number portion of a URL to a specified
value.</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">INKReturnCode INKUrlPortSet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, int
<em class="replaceable"><code>port</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Sets the port number portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
- marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code> to
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to
the value <code class="code"><em class="replaceable"><code>port</code></em></code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if successful.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
<div class="section" lang="en">
@@ -940,40 +875,38 @@
<a name="INKUrlSchemeGet"></a>INKUrlSchemeGet</h4></div></div></div>
<p>Gets the scheme portion of a specified URL.</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">const char* INKUrlSchemeGet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, int
*<em class="replaceable"><code>length</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Retrieves the scheme portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.
<code class="function">INKUrlSchemeGet</code> places the length of the
returned string in the
- <code class="code"><em class="replaceable"><code>length</code></em></code>
+ <code class="code"><em class="replaceable"><code>length </code></em></code>
argument.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>A pointer to the scheme portion of the specified URL.
Release with a call to
<code class="function">INKHandleStringRelease</code>.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</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>
+<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>The returned string is not guaranteed to be
null-terminated.</p></td></tr>
</table></div>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
+<dt> </dt>
</dl></div>
</div>
<div class="section" lang="en">
@@ -981,77 +914,71 @@
<a name="INKUrlSchemeSet"></a>INKUrlSchemeSet</h4></div></div></div>
<p>Sets the scheme portion of a specified URL.</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">INKReturnCode INKUrlSchemeSet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, const char
*<em class="replaceable"><code>value</code></em>, int
<em class="replaceable"><code>length</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Sets the scheme portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
- marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code> to
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to
the string <code class="code"><em class="replaceable"><code>value</code></em></code>. If
- <code class="code"><em class="replaceable"><code>length</code></em></code> is -1 then
+ <code class="code"><em class="replaceable"><code>length </code></em></code> is -1, then
<code class="function">INKUrlSchemeSet</code> assumes that value is
null-terminated. Otherwise, the length of the string
- <code class="code"><em class="replaceable"><code>value</code></em></code> is taken to be
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is taken to be
<code class="code"><em class="replaceable"><code>length</code></em></code>.
<code class="function">INKUrlSchemeSet</code> copies the string to
within <code class="code"><em class="replaceable"><code>bufp</code></em></code>, so it is
okay to modify or delete
- <code class="code"><em class="replaceable"><code>value</code></em></code> after calling
+ <code class="code"><em class="replaceable"><code>value </code></em></code> after calling
<code class="function">INKUrlSchemeSet</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p><code class="code">INK_SUCCESS</code> if successful.</p>
<p><code class="code">INK_ERROR</code> if an error occurs.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="INKUrlStringGet"></a>INKUrlStringGet</h4></div></div></div>
<p>Constructs a string representation of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the marshal
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the marshal
buffer <code class="code"><em class="replaceable"><code>bufp</code></em></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">char* INKUrlStringGet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, int
*<em class="replaceable"><code>length</code></em>)</code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Constructs a string representation of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.
<code class="function">INKUrlStringGet</code> stores the length of the
allocated string in the parameter
- <code class="code"><em class="replaceable"><code>length</code></em></code>. This is the
- same length that <code class="function">INKUrlLengthGet</code> returns.
+ <code class="code"><em class="replaceable"><code>length </code></em></code> (this is the
+ same length that <code class="function">INKUrlLengthGet</code> returns).
The returned string is allocated by a call to
- <code class="function">INKmalloc</code>. It should be freed by a call
+ <code class="function">INKmalloc</code>; it should be freed by a call
to <code class="function">INKfree</code>. If
- <code class="code"><em class="replaceable"><code>length</code></em></code> is
- <code class="code">NULL</code> then no attempt is made to de-reference
+ <code class="code"><em class="replaceable"><code>length </code></em></code> is
+ <code class="code">NULL</code>, then no attempt is made to dereference
it.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>A null-terminated string.</p>
-<p><code class="code">INK_ERROR_PTR</code> in case of an error.</p>
+<p><code class="code">INK_ERROR_PTR</code> if there is an error.</p>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
</dl></div>
</div>
<div class="section" lang="en">
@@ -1059,40 +986,38 @@
<a name="INKUrlUserGet"></a>INKUrlUserGet</h4></div></div></div>
<p>Gets the user portion of a specified URL.</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">const char* INKUrlUserGet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, int
*<em class="replaceable"><code>length</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Retrieves the user portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.
<code class="function">INKUrlUserGet</code> places the length of the
returned string in the
- <code class="code"><em class="replaceable"><code>length</code></em></code>
+ <code class="code"><em class="replaceable"><code>length </code></em></code>
argument.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
<p>A pointer to the user portion of the specified URL.
Release with a call to
<code class="function">INKHandleStringRelease</code>.</p>
-<p><code class="code">INK_ERROR_PTR</code> if error.</p>
+<p><code class="code">INK_ERROR_PTR</code> if an error occurs.</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>
+<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>The returned string is not guaranteed to be
null-terminated.</p></td></tr>
</table></div>
</dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 3.0</p></dd>
+<dt> </dt>
</dl></div>
</div>
<div class="section" lang="en">
@@ -1100,37 +1025,34 @@
<a name="INKUrlUserSet"></a>INKUrlUserSet</h4></div></div></div>
<p>Sets the user portion of a specified URL.</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">INKReturnCode INKUrlUserSet (INKMBuffer
<em class="replaceable"><code>bufp</code></em>, INKMLoc
<em class="replaceable"><code>url_loc</code></em>, const char
*<em class="replaceable"><code>value</code></em>, int
<em class="replaceable"><code>length</code></em>) </code></p></dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
<dd>
<p>Sets the user portion of the URL located at
- <code class="code"><em class="replaceable"><code>url_loc</code></em></code> within the
- marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code> to
+ <code class="code"><em class="replaceable"><code>url_loc </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to
the string <code class="code"><em class="replaceable"><code>value</code></em></code>. If
- <code class="code"><em class="replaceable"><code>length</code></em></code> is -1 then
+ <code class="code"><em class="replaceable"><code>length </code></em></code> is -1, then
<code class="function">INKUrlUserSet</code> assumes that value is
null-terminated. Otherwise, the length of the string
- <code class="code"><em class="replaceable"><code>value</code></em></code> is taken to be
- length. <code class="function">INKUrlUserSet</code> copies the string
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is taken to be
+ <code class="code"><em class="replaceable"><code>length</code></em></code>. <code class="function">INKUrlUserSet</code> copies the string
to within <code class="code"><em class="replaceable"><code>bufp</code></em></code>, so it
is okay to modify or delete
<code class="code"><em class="replaceable"><code>value</code></em></code> after calling
<code class="function">INKUrlUserSet</code>.</p>
-<p>Call after <code class="code">READ_REQUEST_HDR_HOOK</code>, if it is
- in a transaction header.</p>
+<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
</dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
<dd>
[... 9 lines stripped ...]