trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dia...@apache.org
Subject svn commit: r912015 - in /incubator/trafficserver/site/trunk/docs/sdk: MimeHeadersFunctions.html Preface.html URLFunctions.html
Date Fri, 19 Feb 2010 22:24:40 GMT
Author: dianes
Date: Fri Feb 19 22:24:40 2010
New Revision: 912015

URL: http://svn.apache.org/viewvc?rev=912015&view=rev
Log:
corrected errata previously overlooked in 2009

Modified:
    incubator/trafficserver/site/trunk/docs/sdk/MimeHeadersFunctions.html
    incubator/trafficserver/site/trunk/docs/sdk/Preface.html
    incubator/trafficserver/site/trunk/docs/sdk/URLFunctions.html

Modified: incubator/trafficserver/site/trunk/docs/sdk/MimeHeadersFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/MimeHeadersFunctions.html?rev=912015&r1=912014&r2=912015&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/MimeHeadersFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/MimeHeadersFunctions.html Fri Feb 19 22:24:40 2010
@@ -380,8 +380,8 @@
                 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>name </code></em></code> after calling
-                <code class="function">INKMimeHdrFieldNameSet</code>. For <code class="code"><em class="replaceable"><code>name</code></em></code>, use the <code class="code">INK_MIME_FIELD_XXX</code> tokens
-                when possible.</p>
+                <code class="function">INKMimeHdrFieldNameSet</code>. When possible, use the <code class="code">INK_MIME_FIELD_XXX</code> tokens
+                for <code class="code"><em class="replaceable"><code> name </code></em></code>.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
@@ -407,7 +407,7 @@
                 header (see <a href="GuideTSHTTPHdrSyst.html" title="Guide to Traffic Server HTTP Header System">Guide to Traffic Server HTTP Header System</a>).
                 <code class="function">INKMimeHdrFieldNext</code> returns the location
                 of the next <code class="code"><em class="replaceable"><code>field </code></em></code> in
-                the list after the field located at
+                the list, after the field located at
                 <code class="code"><em class="replaceable"><code>field </code></em></code> within the
                 marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.
                 If the next field is not found, then a <code class="code">NULL</code> pointer is
@@ -451,7 +451,7 @@
         INKMLoc <span class="replaceable">hdr</span>, INKMLoc <span class="replaceable">field</span>) </code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>MIME headers <b>can</b> contain more than one MIME field with
+<p>MIME headers <u>can</u> contain more than one MIME field with
                 the same 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
@@ -529,7 +529,7 @@
                 <code class="code"><em class="replaceable"><code>idx </code></em></code> is not between 0
                 and <code class="function">INKMimeHdrFieldValuesCount</code>
                 (<code class="code"><em class="replaceable"><code>bufp, hdr, field</code></em></code>) - 1,
-                then no operation will be performed.</p></dd>
+                then no operation is performed.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the string is successfully
@@ -654,7 +654,7 @@
                 <code class="code"><em class="replaceable"><code>idx </code></em></code> is not between 0
                 and <code class="function">INKMimeHdrFieldValuesCount</code>
                 (<code class="code"><em class="replaceable"><code>bufp, hdr, field</code></em></code>) - 1,
-                then no operation will be performed.</p></dd>
+                then no operation is performed.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if successful.</p>
@@ -766,7 +766,7 @@
                 specifies which value in the field to change. If
                 <code class="code"><em class="replaceable"><code>idx </code></em></code> is not between 0
                 and <code>INKMimeHdrFieldValuesCount </code>(<code class="code"><em class="replaceable"><code>bufp, hdr,
-                field</code></em></code>) - 1, then no operation will be
+                field</code></em></code>) - 1, then no operation is
                 performed. All values are stored as strings within the MIME
                 field. <code class="function">INKMimeHdrFieldValueIntSet</code> simply
                 formats the integer into a string and then calls
@@ -804,7 +804,7 @@
                 from 0 to <code class="function">INKMimeHdrFieldValuesCount</code>
                 (<code class="code"><em class="replaceable"><code>bufp, hdr, field</code></em></code>) -
                 1. If <code class="code"><em class="replaceable"><code>idx </code></em></code> does not lie
-                within that range, then <code class="code">NULL</code> will be returned. The
+                within that range, then <code class="code">NULL</code> is returned. The
                 length of the returned string is placed in the
                 <code class="code"><em class="replaceable"><code>value_len </code></em></code> argument. If
                 <code class="code"><em class="replaceable"><code>value_len </code></em></code> is
@@ -862,7 +862,7 @@
                 <code class="code"><em class="replaceable"><code>idx </code></em></code> is 0, then
                 <code class="function">INKMimeHdrFieldValueStringInsert</code> prepends
                 the value to the list of values in the field. Increasing
-                values of <code class="code"><em class="replaceable"><code>idx </code></em></code> places
+                values of <code class="code"><em class="replaceable"><code>idx </code></em></code> place
                 the value farther down the list of values. If
                 <code class="code"><em class="replaceable"><code>idx </code></em></code> is -1,
                 then <code class="function">INKMimeHdrFieldValueStringInsert</code> appends
@@ -962,7 +962,7 @@
                 1. If <code class="code"><em class="replaceable"><code>idx </code></em></code> does not lie
                 within that range, then 
                 <code class="function">INKMimeHdrFieldValueGetUnit</code> returns
-                (unsigned int) 0. All values are stored as strings within the
+                <code>(unsigned int) 0</code>. All values are stored as strings within the
                 MIME field. <code class="function">INKMimeHdrFieldValueUintGet</code>
                 parses the string
                 <code class="code"><em class="replaceable"><code>value </code></em></code> to return an
@@ -984,7 +984,8 @@
 </dd>
 <dt><span class="term"><b>Example</b></span></dt>
 <dd> <p>The example below contains sample code that fetches MIME headers from marshal buffers into strings using <code>INKMimeHdrFieldValueGet</code> instead. The context of this example is that the plugin is processing an HTTP transaction and has access to a transaction.</p></dd>
-<dd><pre class="programlisting">static void
+<dd>
+  <pre class="programlisting">static void
 handle_string (INKHttpTxn txnp, INKCont contp) {
     INKMBuffer bufp;
     INKMLoc hdr_loc;
@@ -1022,9 +1023,9 @@
 
     /* Terminate the string */
     output_string[len] = '\0';
-/* Now that you have the MIME fields as a string, you can do 
-       whatever you want to do with it, for example, print it, or 
-       make sure it's an unsigned integer: either by using the
+/* Now that you have the MIME fields as a string, you can do whatever
+       you want to do with it. For example: you can print it or 
+       make sure it's an unsigned integer, either by using the
        atol C function or by scanning each ASCII character.  */ 
     INKDebug("my-plugin", "%s", output_string);
      
@@ -1053,19 +1054,17 @@
                 <code class="code"><em class="replaceable"><code>bufp</code></em></code>. The
                 <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter
                 specifies where the inserted value should be placed with respect
-                to the other values already in the MIME field. If
-                <code class="code">idx</code> is 0, then the value will be prepended to the
-                list of values in the field. Increasing values of
-                <code class="code"><em class="replaceable"><code>idx </code></em></code>  simply places the
+                to  other values already in the MIME field. If<code class="code"><em class="replaceable"><code> idx</code></em> </code>is 0, then the value is prepended to the
+                list of values in the field. Increasing values of <code class="code"><em class="replaceable"><code>idx </code></em></code>  simply places the
                 value farther down on the list of values. If
                 <code class="code"><em class="replaceable"><code>idx </code></em></code> is -1, then the
-                value will be appended to the list of values. Normal usage is
+                value is appended to the list of values. Normal usage is
                 to specify -1 for <code class="code"><em class="replaceable"><code>idx </code></em></code>
                 so that the value will be appended to the existing list of values. All
                 values are stored as strings within the MIME field.
                 <code class="function">INKMimeHdrFieldValueUIntInsert</code> simply
                 formats the unsigned integer into a string and then calls
-                <code class="function">INKMimeHdrFieldValueStringInsert</code>.</p></dd>
+        <code class="function">INKMimeHdrFieldValueStringInsert</code>.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the API is called
@@ -1092,7 +1091,7 @@
 <dd>
   <p>Sets a value in the MIME field located at
                 <code class="code"><em class="replaceable"><code>field </code></em></code> within the
-                marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code> to
+                marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to
                 the unsigned integer
                 <code class="code"><em class="replaceable"><code>value</code></em></code>. The
                 <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter
@@ -1100,7 +1099,7 @@
                 <code class="code"><em class="replaceable"><code>idx </code></em></code> is not between 0
                 and <code class="function">INKMimeHdrFieldValuesCount</code>
                 (<code class="code"><em class="replaceable"><code>bufp, hdr, field</code></em></code>) - 1,
-                then no operation will be performed. All values are stored as
+                then no operation is performed. All values are stored as
                 strings within the MIME field.
                 <code class="function">INKMimeHdrFieldValueUintSet</code> simply
                 formats the unsigned integer into a string and then calls
@@ -1126,7 +1125,7 @@
                 <em class="replaceable"><code>field</code></em>)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>Removes and destroys all of the values within the MIME
+<p>Removes and destroys all  values within the MIME
                 field located at <code class="code"><em class="replaceable"><code>field </code></em></code>
                 within the marshal buffer
                 <code class="code"><em class="replaceable"><code>bufp</code></em></code>.</p>
@@ -1177,7 +1176,7 @@
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
   <p>Copies the contents of the MIME header located at
-                <code class="code"><em class="replaceable"><code>src_hdr_loc </code></em></code> within the
+                <code class="code"><em class="replaceable"><code> src_hdr_loc </code></em></code> within the
                 marshal buffer
                 <code class="code"><em class="replaceable"><code>src_bufp </code></em></code> to the
                 marshal buffer
@@ -1206,14 +1205,14 @@
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Copies the contents of the MIME header located at
-                <code class="code"><em class="replaceable"><code>src_hdr_loc </code></em></code> within the
+                <code class="code"><em class="replaceable"><code> src_hdr_loc </code></em></code> within the
                 marshal buffer
                 <code class="code"><em class="replaceable"><code>src_bufp </code></em></code> to the MIME
                 header located at
                 <code class="code"><em class="replaceable"><code>dest_hdr_loc </code></em></code> within
                 the marshal buffer
                 <code class="code"><em class="replaceable"><code>dest_bufp</code></em></code>.
-                <code class="function">INKMimeHdrCopy</code> works correctly, even if
+                <code class="function">INKMimeHdrCopy</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.</p>
@@ -1222,7 +1221,7 @@
 <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>Make sure that the destination marshal buffer and
+<tr><td align="left" valign="top"><p>Make sure  the destination marshal buffer and
                   destination MIME header location have been created before
                   copying (see the example below).</p></td></tr>
 </table></div>
@@ -1363,7 +1362,7 @@
                 from 0 to <code class="function">INKMimeHdrFieldsCount</code>
                 (<code class="code"><em class="replaceable"><code>bufp, hdr_loc</code></em></code>) - 1.
                 If <code class="code"><em class="replaceable"><code>idx </code></em></code> does not lie
-                within that range, then 0 will be returned.</p></dd>
+                within that range, then 0 is returned.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>The location of the MIME field from within the MIME
@@ -1426,7 +1425,7 @@
                 <em class="replaceable"><code>hdr_loc</code></em>)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>Removes and destroys all the MIME fields within the MIME
+<p>Removes and destroys all  MIME fields in the MIME
                 header located at
                 <code class="code"><em class="replaceable"><code>hdr_loc </code></em></code> within the
                 marshal buffer
@@ -1505,7 +1504,7 @@
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
   <p>Parses a MIME header. The MIME header must have already
-                been allocated and both
+                been allocated, and both
                 <code class="code"><em class="replaceable"><code>bufp </code></em></code> and
                 <code class="code"><em class="replaceable"><code>hdr_loc </code></em></code> must point
                 within that header. The
@@ -1517,17 +1516,17 @@
                 point past the last character parsed. It is possible to parse
                 a MIME header a single byte at a time using repeated calls to
                 <code class="function">INKMimeHdrParse</code>. As long as an error does
-                not occur, the <code>INKMimeHdrParse</code> function will consume that
-        single byte and ask for more.</p></dd>
+                not occur, the <code>INKMimeHdrParse</code> function  consumes that
+        single byte and asks for more.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p><code class="code">INK_PARSE_ERROR</code> is returned if an error occurs.</p>
-<p><code class="code">INK_PARSE_DONE</code> is returned when a
+<p><code class="code">INK_PARSE_ERROR</code>  if an error occurs.</p>
+<p><code class="code">INK_PARSE_DONE</code>  when a
                 <code class="code">\r\n\r\n</code> pattern is encountered, indicating the
                 end of the header. </p>
 </dd>
 <dd>
-  <p><code class="code">INK_PARSE_CONT</code> is returned if
+  <p><code class="code">INK_PARSE_CONT</code>  if
     parsing of the header stopped because the end of the buffer
     was reached.</p>
 </dd>
@@ -1537,7 +1536,7 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKMimeParserClear"></a>INKMimeParserClear</h4></div></div></div>
-<p>Clears a MIME header parser so that it can be reused.</p>
+<p>Clears a MIME header parser so  it can be reused.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">INKReturnCode INKMimeParserClear (INKMimeParser
@@ -1613,7 +1612,7 @@
                 <code class="code"><em class="replaceable"><code>hdr_loc </code></em></code> within the
                 marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code>
                 into the IO buffer
-                <code class="code"><em class="replaceable"><code>iobufp</code></em></code>. See <a href="HTTPTransformationPlugins.html#IOBuffers" title="IO Buffers">IO Buffers</a> for information about allocating an IO
+                <code class="code"><em class="replaceable"><code>iobufp </code></em></code>. See <a href="HTTPTransformationPlugins.html#IOBuffers" title="IO Buffers">IO Buffers</a> for information about allocating an IO
         buffer and retrieving data from within one.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>

Modified: incubator/trafficserver/site/trunk/docs/sdk/Preface.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/Preface.html?rev=912015&r1=912014&r2=912015&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/Preface.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/Preface.html Fri Feb 19 22:24:40 2010
@@ -1,92 +1,93 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>Preface</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
-<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
-<link rel="up" href="index.html" title="Traffic Server Software Developers Kit" />
-<link rel="prev" href="index.html" title="Traffic Server Software Developers Kit" />
-<link rel="next" href="pr01s02.html" title="How to Use This Book" />
-<link rel="preface" href="Preface.html" title="Preface" />
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
-<link rel="index" href="ConceptIndex.html" title="Index" />
-<link rel="section" href="Preface.html#Audience" title="Audience" />
-<link rel="section" href="pr01s02.html" title="How to Use This Book" />
-<link rel="section" href="Conventions.html" title="Typographical Conventions" />
-<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
-    document.write("<style> div.toc {display: none} </style>"); 
-  </script>
-</head>
-<body>
-<div class="doctitle">
-<a href="index.html">Home</a>
-<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software Developers Kit</h1>
-</div>
-<div class="navheader">
-<div class="navprev">
-<a accesskey="p" href="index.html">Prev</a> — Traffic Server Software Developers Kit</div>
-<div class="navnext">How to Use This Book — <a accesskey="n" href="pr01s02.html">Next</a>
-</div>
-</div>
-<div id="toc"></div>
-<div class="preface" lang="en">
-<div class="titlepage"><div><div><h2 class="title">
-<a name="Preface"></a>Preface</h2></div></div></div>
-<div class="toc">
-<p><b>Table of Contents</b></p>
-<dl>
-<dt><span class="section"><a href="Preface.html#Audience">Audience</a></span></dt>
-<dt><span class="section"><a href="pr01s02.html">How to Use This Book</a></span></dt>
-<dt><span class="section"><a href="Conventions.html">Typographical Conventions</a></span></dt>
-</dl>
-</div>
-<p>The <span class="emphasis"><em>Traffic Server Software Developers Kit</em></span> is a
-    reference for creating plugins. <b>Plugins</b> are programs that add services
-    (such as filtering or content transformation) or entire features (such as
-    new protocol support) to Traffic Server. If you are new to writing Traffic
-    Server plugins, then read the first two chapters, <a href="GetingStarted.html#GettingStarted"><i>Getting Started</i></a> and <a href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins"><i>Creating Traffic Server Plugins</i></a>, and
-    use the remaining chapters as needed. <a href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples"><i>Header-Based Plugin Examples</i></a> provides
-    details about plugins that work on HTTP headers, while <a href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins"><i>HTTP Transformation Plugins</i></a>
-    explains how to write a plugin that transforms or scans the body of an
-    HTTP response. If you want to support your own protocol on Traffic Server,
-    then reference <a href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins"><i>New Protocol Plugins</i></a>.</p>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="Audience"></a>Audience</h2></div></div></div>
-<p>This manual is intended for programmers who want to write plugin
-      programs that add services or features to Traffic Server. It assumes a
-      cursory knowledge of the C programming language, Hyper-Text Transfer
-      Protocol (HTTP), and Multipurpose Internet Mail Extensions
-      (MIME).</p>
-</div>
-</div>
-</body>
-</html>
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>Preface</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css" type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="prev" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="next" href="pr01s02.html" title="How to Use This Book" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started" />
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations" />
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations" />
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management" />
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics" />
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference" />
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index" />
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
+<link rel="section" href="Preface.html#Audience" title="Audience" />
+<link rel="section" href="pr01s02.html" title="How to Use This Book" />
+<link rel="section" href="Conventions.html" title="Typographical Conventions" />
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript" src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png" />
+<h1 class="doctitle">Traffic Server Software Developer's Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="index.html">Prev</a> — Traffic Server Software Developers Kit</div>
+<div class="navnext">How to Use This Book — <a accesskey="n" href="pr01s02.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="preface" lang="en">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="Preface"></a>Preface</h2></div></div></div>
+<div class="toc">
+<p><b>Table of Contents</b></p>
+<dl>
+<dt><span class="section"><a href="Preface.html#Audience">Audience</a></span></dt>
+<dt><span class="section"><a href="pr01s02.html">How to Use This Book</a></span></dt>
+<dt><span class="section"><a href="Conventions.html">Typographical Conventions</a></span></dt>
+</dl>
+</div>
+<p>The <span class="emphasis"><em>Traffic Server Software Developer's Kit</em></span> is a
+    reference for creating plugins. <b>Plugins</b> are programs that add services
+    (such as filtering or content transformation) or entire features (such as
+    new protocol support) to Traffic Server. If you are new to writing Traffic
+    Server plugins, then read the first two chapters, <a href="GetingStarted.html#GettingStarted">Getting Started</a>  and <a href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server Plugins">Creating Traffic Server Plugins</a>, and
+    use the remaining chapters as needed. <a href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based Plugin Examples">Header-Based Plugin Examples</a> provides
+    details about plugins that work on HTTP headers, while <a href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP Transformation Plugins">HTTP Transformation Plugins</a>
+    explains how to write a plugin that transforms or scans the body of an
+    HTTP response. If you want to support your own protocol on Traffic Server,
+    then reference <a href="NewProtocolPlugins.html" title="Chapter 6. New Protocol Plugins">New Protocol Plugins</a>.</p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="Audience"></a>Audience</h2></div></div></div>
+<p>This manual is intended for programmers who want to write plugin
+      programs that add services or features to Traffic Server. It assumes a
+      cursory knowledge of the C programming language, Hyper-Text Transfer
+      Protocol (HTTP), and Multipurpose Internet Mail Extensions
+      (MIME).</p>
+</div>
+</div>
+</body>
+</html>

Modified: incubator/trafficserver/site/trunk/docs/sdk/URLFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/URLFunctions.html?rev=912015&r1=912014&r2=912015&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/URLFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/URLFunctions.html Fri Feb 19 22:24:40 2010
@@ -113,8 +113,7 @@
                 marshal buffer
                 <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>
+                <code class="code"><em class="replaceable"><code>dest_bufp</code></em></code>.</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>
@@ -130,7 +129,7 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKUrlCopy"></a>INKUrlCopy</h4></div></div></div>
-<p>Copies a URL at a specified location in a source marshal
+<p>Copies a URL from 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"><b>Prototype</b></span></dt>
@@ -154,7 +153,7 @@
 <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>
@@ -223,7 +222,7 @@
 <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
+                  <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>
@@ -299,8 +298,7 @@
 <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
-                the value <code class="code"><em class="replaceable"><code>type</code></em></code>. The
-                valid values for the
+                the value <code class="code"><em class="replaceable"><code>type</code></em></code>. Valid values for the
                 <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>
@@ -396,7 +394,7 @@
 <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
@@ -593,7 +591,7 @@
                 <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
+                within <code class="code"><em class="replaceable"><code>bufp</code></em></code>, so it's
                 okay to modify or delete
                 <code class="code"><em class="replaceable"><code>value </code></em></code> after calling
                 <code class="function">INKUrlHttpQuerySet</code>.</p>
@@ -609,18 +607,16 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKUrlLengthGet"></a>INKUrlLengthGet</h4></div></div></div>
-<p>Calculates the length of the string representation of a
-          URL.</p>
+<p>Calculates the length of a URL's string representation.</p>
 <div class="variablelist"><dl>
 <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
+<p>Calculates the length of 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> if
-                it was returned as a string. This length will be the same as
+                it was returned as a string. This length is the same as
                 the length returned by
                 <code class="function">INKUrlStringGet</code>.</p>
 <p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
@@ -650,7 +646,7 @@
                 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
+                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
@@ -725,7 +721,7 @@
 <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
-                marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code> to
+                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="function">INKUrlPasswordSet</code> assumes that value is
@@ -779,7 +775,7 @@
 <th align="left">Note</th>
 </tr>
 <tr><td align="left" valign="top"><p>The returned string is not guaranteed to be
-                  null-terminated. If the URL contains a query portion, it is not included in the response (see <a href="#INKUrlHttpQueryGet">INKUrlHttpQueryGet)</a>.</p></td></tr>
+                  null-terminated. If the URL contains a query portion, then it is not included in the response (see <a href="#INKUrlHttpQueryGet">INKUrlHttpQueryGet)</a>.</p></td></tr>
 </table></div>
 </dd>
 <dt>&nbsp;</dt>
@@ -860,7 +856,7 @@
 <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
-                the value <code class="code"><em class="replaceable"><code>port</code></em></code>.</p>
+                the value <code class="code"><em class="replaceable"><code> port</code></em></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"><b>Returns</b></span></dt>
@@ -932,7 +928,7 @@
                 <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
+                within <code class="code"><em class="replaceable"><code>bufp</code></em></code>, so it's
                 okay to modify or delete
                 <code class="code"><em class="replaceable"><code>value </code></em></code> after calling
                 <code class="function">INKUrlSchemeSet</code>.</p>
@@ -965,7 +961,7 @@
                 <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).
+                same <code>length</code> 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
                 to <code class="function">INKfree</code>. If
@@ -1000,7 +996,7 @@
                 returned string in the
                 <code class="code"><em class="replaceable"><code>length </code></em></code>
                 argument.</p>
-<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
+<p>If  in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
@@ -1044,7 +1040,7 @@
                 <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="code"><em class="replaceable"><code>value </code></em></code> after calling
                 <code class="function">INKUrlUserSet</code>.</p>
 <p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
 </dd>



Mime
View raw message