trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dia...@apache.org
Subject svn commit: r934143 - /incubator/trafficserver/site/trunk/docs/v2/sdk/MIMEHeaders.html
Date Wed, 14 Apr 2010 19:40:56 GMT
Author: dianes
Date: Wed Apr 14 19:40:56 2010
New Revision: 934143

URL: http://svn.apache.org/viewvc?rev=934143&view=rev
Log:
ts-294

Modified:
    incubator/trafficserver/site/trunk/docs/v2/sdk/MIMEHeaders.html

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/MIMEHeaders.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/MIMEHeaders.html?rev=934143&r1=934142&r2=934143&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/MIMEHeaders.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/MIMEHeaders.html Wed Apr 14 19:40:56 2010
@@ -13,19 +13,19 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="MIMEHeaders"></a>MIME Headers</h2></div></div></div>
-<p>The Traffic Server API <b class="index">MIME header functions </b> enable
you to
+<p>The Traffic Server <b class="index">MIME header functions </b> enable
you to
       retrieve and modify information about HTTP MIME fields.</p>
 <p>An HTTP request or response consists of a header, body, and
-      trailer. The <b>HTTP</b> <b>header</b><a class="indexterm"
name="id383429"></a> consists of a request (or response) line and a MIME header<a
class="indexterm" name="id383437"></a>. A <b>MIME</b> <b>header</b>
is composed of zero or more <a class="indexterm" name="id383447"></a>MIME fields.
A <b>MIME</b> <b>field</b> is composed of a field name, a
-      colon, and zero or more field values (the values in a field are separated
+      trailer. The <b>HTTP</b> <b>header</b><a class="indexterm"
name="id383429"></a> contains  a request (or response) line and a MIME header<a
class="indexterm" name="id383437"></a>. A <b>MIME</b> <b>header</b>
is composed of zero or more <a class="indexterm" name="id383447"></a>MIME fields.
A <b>MIME</b> <b>field</b> is composed of a field name, a
+      colon, and zero or more field values (values in a field are separated
       by commas). </p>
 <p>In the  example below: <code>Foo</code> is the <a class="indexterm"
name="id383456"></a>MIME field name, <code>bar</code> is the first <a
class="indexterm" name="id383465"></a>MIME field value, and <code>car</code>
is the second MIME field
   value.</p>
 <pre class="programlisting">Foo: bar, car</pre>
 <p>The following example is an augmented <b>Backus-Naur Form</b> (BNF)
for the form
       of a <a class="indexterm" name="id383483"></a>MIME header - it specifies
exactly what was described
-      above. A <b>header</b> consists of zero or more <b>fields</b>
that consist of a name,
-      a separating colon, and zero or more values. A name or <b>value</b> is
simply a
+      above. A <b>header</b> consists of zero or more <b>fields</b>
that contain  a name,
+       separating colon, and zero or more values. A <b>name</b> or <b>value</b>
is simply a
       string of tokens that is potentially zero length; a <b>token</b> is any
       character except certain control characters and separators (such as
       colons). For the purpose of retrieving a field, field names are not case-sensitive;
therefore, the field names <code class="code">Foo</code>, <code class="code">foo</code>
and <code class="code">fOO</code> are all equivalent.</p>
@@ -59,7 +59,7 @@ field-value = *token
       name. Previous versions of Traffic Server joined multiple fields with the same name
into one field
       with composite values, but this behavior came at a performance cost and
       caused compatability issues with  older clients and servers.
-      Future versions of Traffic Server have ceased coalescing duplicate
+      Hence, the current version of Traffic Server does not coalesce duplicate
       fields. Correctly-behaving plugins should check for the presence of
       duplicate fields and iterate over the duplicate fields by using <code class="function">INKMimeHdrFieldNextDup</code>.</p>
 <p>To facilitate fast comparisons and  reduce storage size, Traffic
@@ -433,15 +433,15 @@ field-value = *token
 </tbody>
 </table></div>
 <p>The header field names above are defined in
-      <code class="filename">InkAPI.h</code> as <code class="code">const
char*</code> strings. When
+      <code class="filename">InkAPI.h</code> as <code class="code"> const
char* </code> strings. When
       Traffic Server sets the name portion of a header field (or any portion
       for that matter), it quickly checks to see if the new value is one
-      of the known values. If it is, then  it stores a pointer into a global table instead
of storing the known value in the
+      of the known values. If it is, then  Traffic Server stores a pointer into a global
table instead of storing the known value in the
       marshal buffer. The header field
       names listed above are also pointers into this table, which enables simple
       pointer comparison of the value returned from
       <code class="function">INKMimeHdrFieldNameGet</code> with one of the values
-      listed above. It is also recommended that you use the above values when
+      listed above. It is  recommended that you use the above values when
       referring to one of the known header field names to avoid  the
       possibility of a spelling error.</p>
 <p>Traffic Server adds one important feature to MIME fields that
@@ -449,41 +449,56 @@ field-value = *token
       begins with the '<code class="code">@</code>' symbol. For example: a plugin
can add
       the field "<code class="code">@My-Field</code>" to a header. Even though
Traffic
       Server never sends that field out in a request to an origin server or in
-      a response to a client, it can be printed in Traffic Server logs by defining a
+      a response to a client, it can be printed to Traffic Server logs by defining a
       custom log configuration file that explicitly logs such fields. This provides
       a useful mechanism for plugins to store information about an object in
       one of the MIME headers associated with the object.</p>
 <p><a name="MimeHeaderFxns"></a>The MIME header functions are listed below:</p>
 <div class="itemizedlist"><ul type="disc">
-<li><code class="function">INKMimeHdrFieldClone</code></li>
-<li><code class="function">INKMimeHdrFieldCopy</code></li>
-<li><code class="function">INKMimeHdrFieldCopyValues</code></li>
-<li><code class="function">INKMimeHdrFieldCreate</code></li>
-<li><code class="function">INKMimeHdrFieldDestroy</code></li>
-<li><code class="function">INKMimeHdrFieldLengthGet</code>></li>
-<li><code class="function">INKMimeHdrFieldNameGet</code></li>
-<li><code class="function">INKMimeHdrFieldNameSet</code></li>
-<li><code class="function">INKMimeHdrFieldNext</code></li>
-<li><code class="function">INKMimeHdrFieldNextDup</code></li>
-<li><code class="function">INKMimeHdrFieldValueAppend</code></li>
-<li><code class="function">INKMimeHdrFieldValueDelete</code>></li>
-<li><code class="function">INKMimeHdrFieldValuesClear</code></li>
-<li><code class="function">INKMimeHdrFieldValuesCount</code></li>
-<li><code class="function">INKMimeHdrClone</code></li>
-<li><code class="function">INKMimeHdrCopy</code></li>
-<li><code class="function">INKMimeHdrCreate</code></li>
-<li><code class="function">INKMimeHdrDestroy</code></li>
-<li><code class="function">INKMimeHdrFieldFind</code></li>
-<li><code class="function">INKMimeHdrFieldGet</code></li>
-<li><code class="function">INKMimeHdrFieldRemove</code></li>
-<li><code class="function">INKMimeHdrFieldsClear</code></li>
-<li><code class="function">INKMimeHdrFieldsCount</code></li>
-<li><code class="function">INKMimeHdrLengthGet</code></li>
-<li><code class="function">INKMimeHdrParse</code></li>
-<li><code class="function">INKMimeParserClear</code></li>
-<li><code class="function">INKMimeParserCreate</code></li>
-<li><code class="function">INKMimeParserDestroy</code></li>
-<li><code class="function">INKMimeHdrPrint</code></li>
+<li><a href="MimeHeadersFunctions.html#INKMimeHdrFieldAppend"><code>INKMimeHdrFieldAppend</code></a></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldClone">INKMimeHdrFieldClone</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldCopy">INKMimeHdrFieldCopy</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldCopyValues">INKMimeHdrFieldCopyValues</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldCreate">INKMimeHdrFieldCreate</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldDestroy">INKMimeHdrFieldDestroy</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldLengthGet">INKMimeHdrFieldLengthGet</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldNameGet">INKMimeHdrFieldNameGet</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldNameSet">INKMimeHdrFieldNameSet</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldNext">INKMimeHdrFieldNext</a></code></li>
+
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldNextDup">INKMimeHdrFieldNextDup</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValueAppend">INKMimeHdrFieldValueAppend</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValueAppend">INKMimeHdrFieldValueAppend</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValueDateGet">INKMimeHdrFieldValueDateGet</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValueDateInsert">INKMimeHdrFieldValueDateInsert</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValueDateSet">INKMimeHdrFieldValueDateSet</a></code></li>
+
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValueInsert">INKMimeHdrFieldValueInsert</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValueIntGet">INKMimeHdrFieldValueIntGet</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValueIntSet">INKMimeHdrFieldValueIntSet</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValueStringGet">INKMimeHdrFieldValueStringGet</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValueStringInsert">INKMimeHdrFieldValueStringInsert</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValueStringSet">INKMimeHdrFieldValueStringSet</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValueUintGet">INKMimeHdrFieldValueUintGet</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValueUintInsert">INKMimeHdrFieldValueUintInsert</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValueUintSet">INKMimeHdrFieldValueUintSet</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValuesClear">INKMimeHdrFieldValuesClear</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldValuesCount">INKMimeHdrFieldValuesCount</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrClone">INKMimeHdrClone</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrCopy">INKMimeHdrCopy</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrCreate">INKMimeHdrCreate</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrDestroy">INKMimeHdrDestroy</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldFind">INKMimeHdrFieldFind</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldGet">INKMimeHdrFieldGet</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldRemove">INKMimeHdrFieldRemove</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldsClear">INKMimeHdrFieldsClear</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrFieldsCount">INKMimeHdrFieldsCount</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrLengthGet">INKMimeHdrLengthGet</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrParse">INKMimeHdrParse</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeParserClear">INKMimeParserClear</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeParserCreate">INKMimeParserCreate</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeParserDestroy">INKMimeParserDestroy</a></code></li>
+<li><code><a href="MimeHeadersFunctions.html#INKMimeHdrPrint">INKMimeHdrPrint</a></code></li>
 </ul></div>
 </div>
 </body>



Mime
View raw message