trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From andrew...@apache.org
Subject svn commit: r831152 [27/37] - in /incubator/trafficserver/site/trunk/docs: ./ admin/ admin/images/ sdk/ sdk/css/ sdk/images/ sdk/images/docbook/ sdk/js/
Date Thu, 29 Oct 2009 23:23:36 GMT
Added: incubator/trafficserver/site/trunk/docs/sdk/MarshalBuffers.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/MarshalBuffers.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/MarshalBuffers.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/MarshalBuffers.html Thu Oct 29 23:23:25 2009
@@ -0,0 +1,98 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Marshal Buffers</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css"
type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css"
type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css"
type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="prev" href="DeprecatedMarshBufFuncs.html" title="Deprecated Functions">
+<link rel="next" href="HTTPHeaders2.html" title="HTTP Headers">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create
Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based
Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP
Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol
Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP
Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous
Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample
Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated
Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting
Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script
type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script
type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script
type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript"
src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software
Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="DeprecatedMarshBufFuncs.html">Prev</a> — Deprecated
Functions</div>
+<div class="navnext">HTTP Headers — <a accesskey="n" href="HTTPHeaders2.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="MarshalBuffers"></a>Marshal Buffers</h2></div></div></div>
+<p>The marshal buffer or <code class="function">INKMBuffer</code> is a
heap
+      data structure that stores parsed URLs, MIME headers and HTTP headers.
+      You can allocate new objects out of marshal buffers, and change the
+      values within the marshal buffer. Whenever you manipulate an object, you
+      require the handle to the object (<code class="function">INKMLoc</code>)
and the
+      marshal buffer containing the object
+      (<code class="function">INKMBuffer</code>).</p>
+<p>Routines exist for manipulating the object based on these two
+      pieces of information. See, for example:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><a href="HTTPHeaders2.html" title="HTTP Headers">“HTTP Headers”</a></p></li>
+<li><p><a href="URLs.html" title="URLs">“URLs”</a></p></li>
+<li><p><a href="MIMEHeaders.html" title="MIME Headers">“MIME Headers”</a></p></li>
+</ul></div>
+<p>The marshal buffer functions allow you to create and destroy
+      Traffic Server’s marshal buffers, which are the data structures that
+      hold parsed URLs, MIME headers, and HTTP headers.</p>
+<div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0"
summary="Caution">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/docbook/caution.png"></td>
+<th align="left">Caution</th>
+</tr>
+<tr><td align="left" valign="top">
+<p>Any marshal buffer fetched by
+        <code class="function">INKHttpTxn*Get</code> will be used by other parts
of the
+        system. Be careful not to destroy these shared, transaction marshal
+        buffers. In functions such as:</p>
+<p><code class="function">INKHttpTxnClientReqGet</code></p>
+<p><code class="function">INKHttpTxnClientRespGet</code></p>
+<p><code class="function">INKHttpTxnServerReqGet</code></p>
+<p><code class="function">INKHttpTxnServerRespGet</code></p>
+<p><code class="function">INKHttpTxnCachedReqGet</code></p>
+<p><code class="function">INKHttpTxnCachedRespGet</code></p>
+<p><code class="function">INKHttpTxnTransformRespGet</code></p>
+</td></tr>
+</table></div>
+</div>
+</body>
+</html>

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

Added: incubator/trafficserver/site/trunk/docs/sdk/MarshallBuffersFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/MarshallBuffersFunctions.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/MarshallBuffersFunctions.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/MarshallBuffersFunctions.html Thu Oct 29 23:23:25
2009
@@ -0,0 +1,111 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Marshal Buffers</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css"
type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css"
type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css"
type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="prev" href="ch18s09s04.html" title="Handle Release Functions">
+<link rel="next" href="INKMBufferDestroy.html" title="INKMBufferDestroy">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create
Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based
Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP
Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol
Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP
Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous
Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample
Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated
Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting
Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="subsection" href="MarshallBuffersFunctions.html#INKMBufferCreate" title="INKMBufferCreate">
+<link rel="subsection" href="INKMBufferDestroy.html" title="INKMBufferDestroy">
+<link rel="subsection" href="HTTPHeaderFunctions.html" title="HTTP Header Functions">
+<link rel="subsection" href="URLFunctions.html" title="URL Functions">
+<link rel="subsection" href="MimeHeadersFunctions.html" title="MIIME Headers">
+<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="ch18s09s04.html">Prev</a> — Handle Release Functions</div>
+<div class="navnext">INKMBufferDestroy — <a accesskey="n" href="INKMBufferDestroy.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="MarshallBuffersFunctions"></a>Marshal Buffers</h2></div></div></div>
+<p>The marshal buffer or <code class="function">INKMBuffer</code> is a
heap
+      data structure that stores parsed URLs, MIME headers and HTTP headers.
+      You can allocate new objects out of marshal buffers, and change the
+      values within the marshal buffer. Whenever you manipulate an object, you
+      require the handle to the object (<code class="function">INKMLoc</code>)
and the
+      marshal buffer containing the object
+      (<code class="function">INKMBuffer</code>).</p>
+<p>Routines exist for manipulating the object based on these two
+      pieces of information. See, for example:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><a href="HTTPHeaderFunctions.html" title="HTTP Header Functions">“HTTP
Header Functions”</a></p></li>
+<li><p><a href="URLFunctions.html" title="URL Functions">“URL Functions”</a></p></li>
+<li><p><a href="MimeHeadersFunctions.html" title="MIIME Headers">“MIIME
Headers”</a></p></li>
+</ul></div>
+<p>The marshal buffer functions allow you to create and destroy
+      Traffic Server’s marshal buffers, which are the data structures that
+      hold parsed URLs, MIME headers, and HTTP headers.</p>
+<div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0"
summary="Caution">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/docbook/caution.png"></td>
+<th align="left">Caution</th>
+</tr>
+<tr><td align="left" valign="top"><p>Any marshal buffer fetched by INKHttpTxn*Get
(for example,
+        <code class="function">INKHttpTxnClientReqGet</code> or
+        <code class="function">INKHttpTxnServerRespGet</code>) will be used by
other
+        parts of the system. Be careful not to destroy these shared,
+        transaction marshal buffers.</p></td></tr>
+</table></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMBufferCreate"></a>INKMBufferCreate</h3></div></div></div>
+<p>Creates a new marshal buffer.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">INKMBuffer INKMBufferCreate (void)</code></p></dd>
+<dt><span class="term">Description</span></dt>
+<dd><p>Creates a new marshal buffer and initializes the reference
+              count to 1.</p></dd>
+<dt><span class="term">Returns</span></dt>
+<dd><p>A pointer to the new marshal buffer.</p></dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+</div>
+</body>
+</html>

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

Added: incubator/trafficserver/site/trunk/docs/sdk/MemoryAllocation.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/MemoryAllocation.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/MemoryAllocation.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/MemoryAllocation.html Thu Oct 29 23:23:25
2009
@@ -0,0 +1,81 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Memory Allocation</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css"
type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css"
type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css"
type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous
Interface Guide">
+<link rel="prev" href="INKfopenFamily.html" title="The INKfopen Family">
+<link rel="next" href="Interface_ThreadFunctions.html" title="Thread Functions">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create
Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based
Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP
Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol
Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP
Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous
Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample
Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated
Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting
Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script
type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script
type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script
type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript"
src="js/toc.js"></script><script type="text/javascript">
+    document.write("<style> div.toc {display: none} </style>"); 
+  </script>
+</head>
+<body>
+<div class="doctitle">
+<a href="index.html">Home</a>
+<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software
Developers Kit</h1>
+</div>
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="INKfopenFamily.html">Prev</a> — The INKfopen Family</div>
+<div class="navnext">Thread Functions — <a accesskey="n" href="Interface_ThreadFunctions.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="MemoryAllocation"></a>Memory Allocation</h2></div></div></div>
+<p>Traffic Server provides five routines for allocating and freeing
+      memory. These routines correspond to similar routines in the C library.
+      For example, <code class="function">INKrealloc</code> behaves like the
C library
+      routine <code class="code">realloc</code>. There are two reasons to use
the routines
+      provided by Traffic Server. The first is portability. The Traffic Server
+      API routines behave the same on all of Traffic Server’s supported
+      platforms. For example, realloc does not accept an argument of
+      <code class="code">NULL</code> on some platforms. The second reason is
that the
+      Traffic Server routines actually track the memory allocations by file
+      and line number. This tracking is very efficient, is always turned on,
+      and is useful for tracking down memory leaks.</p>
+<p>The memory allocation functions are:</p>
+<div class="itemizedlist"><ul type="disc">
+<li><p><a href="MemoryAllocationFunctions.html#INKfree" title="INKfree">“INKfree”</a></p></li>
+<li><p><a href="INKmalloc.html" title="INKmalloc">“INKmalloc”</a></p></li>
+<li><p><a href="INKrealloc.html" title="INKrealloc">“INKrealloc”</a></p></li>
+<li><p><a href="INKstrdup.html" title="INKstrdup">“INKstrdup”</a></p></li>
+<li><p><a href="INKstrndup.html" title="INKstrndup">“INKstrndup”</a></p></li>
+</ul></div>
+</div>
+</body>
+</html>

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

Added: incubator/trafficserver/site/trunk/docs/sdk/MemoryAllocationFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/MemoryAllocationFunctions.html?rev=831152&view=auto
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/MemoryAllocationFunctions.html (added)
+++ incubator/trafficserver/site/trunk/docs/sdk/MemoryAllocationFunctions.html Thu Oct 29
23:23:25 2009
@@ -0,0 +1,102 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Memory Allocation</title>
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css"
type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css"
type="text/css">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css"
type="text/css">
+<link rel="stylesheet" href="css/ydoc.css" type="text/css">
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
+<link rel="up" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="prev" href="INKfwrite.html" title="INKfwrite">
+<link rel="next" href="INKmalloc.html" title="INKmalloc">
+<link rel="preface" href="Preface.html" title="Preface">
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create
Traffic Server Plugins">
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based
Plugin Examples">
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP
Transformation Plugins">
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol
Plugins">
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP
Hooks and Transactions">
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous
Interface Guide">
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample
Source Code">
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated
Functions">
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting
Tips">
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
+<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="subsection" href="MemoryAllocationFunctions.html#INKfree" title="INKfree">
+<link rel="subsection" href="INKmalloc.html" title="INKmalloc">
+<link rel="subsection" href="INKrealloc.html" title="INKrealloc">
+<link rel="subsection" href="INKstrdup.html" title="INKstrdup">
+<link rel="subsection" href="INKstrndup.html" title="INKstrndup">
+<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="INKfwrite.html">Prev</a> — INKfwrite</div>
+<div class="navnext">INKmalloc — <a accesskey="n" href="INKmalloc.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="MemoryAllocationFunctions"></a>Memory Allocation</h2></div></div></div>
+<p>Traffic Server provides five routines for allocating and freeing
+      memory. These routines correspond to similar routines in the C library.
+      For example, <code class="function">INKrealloc</code> behaves like the
C library
+      routine <code class="function">realloc</code>. There are two reasons to
use the
+      routines provided by Traffic Server. The first is portability. The
+      Traffic Server API routines behave the same on all of Traffic Server’s
+      supported platforms. For example, realloc does not accept an argument of
+      <code class="code">NULL</code> on some platforms. The second reason is
that the
+      Traffic Server routines actually track the memory allocations by file
+      and line number. This tracking is very efficient, is always turned on,
+      and is useful for tracking down memory leaks.</p>
+<p>The memory allocation functions are:</p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKfree"></a>INKfree</h3></div></div></div>
+<p>Frees memory allocated by <code class="function">INKmalloc</code> or
+        <code class="function">INKrealloc</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term">Prototype</span></dt>
+<dd><p><code class="code">void INKfree (void
+              <em class="replaceable"><code>*ptr</code></em>)</code></p></dd>
+<dt><span class="term">Arguments</span></dt>
+<dd><p><code class="code"><em class="replaceable"><code>ptr</code></em></code>
is a pointer
+              to the memory to deallocate.</p></dd>
+<dt><span class="term">Description</span></dt>
+<dd><p>Releases the memory allocated by
+              <code class="function">INKmalloc</code> or
+              <code class="function">INKrealloc</code>. If
+              <code class="code"><em class="replaceable"><code>ptr</code></em></code>
is
+              <code class="code">NULL</code>, <code class="function">INKfree</code>
does no
+              operation.</p></dd>
+<dt><span class="term">First release</span></dt>
+<dd><p>Traffic Server 3.0</p></dd>
+</dl></div>
+</div>
+</div>
+</body>
+</html>

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



Mime
View raw message