You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by bu...@apache.org on 2010/11/06 07:31:10 UTC
svn commit: r778776 [11/21] - in
/websites/staging/trafficserver/trunk/content/docs/trunk: admin/ sdk/
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferCopy.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferCopy.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferCopy.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferCopy.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,45 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKIOBufferBlockWriteStart">Prev</a> -
+INKIOBufferBlockWriteStart
+INKIOBufferCreate - <a href="INKIOBufferCreate">Next</a></p>
+<h3 id="inkiobuffercopy">INKIOBufferCopy</h3>
+<p>Copies an IO buffer.</p>
+<p><strong>Prototype</strong>
+ ~ <code>int INKIOBufferCopy (INKIOBuffer <em class="replaceable"><code>bufp</code>,
+ INKIOBufferReader <em><code>readerp</code></em>, int <em><code>length</code></em>, int <em><code>offset</code></em>)</p>
+<p><strong>Description</strong>
+ ~ Copies <code><em class="replaceable"><code>length</code> bytes of data
+ from the IO buffer reader <code><em class="replaceable"><code>readerp</code>
+ to the IO buffer <code><em class="replaceable"><code>bufp</code>. As
+ previously described, <code>INKIOBufferCopy</code> does not actually copy the
+ data - it simply copies pointers and adjusts reference counts
+ appropriately. The parameter <code><em class="replaceable"><code>offset</code>
+ specifies the offset from <code><em class="replaceable"><code>readerp</code>'s
+ current position to start copying from.</p>
+<p><strong>Returns</strong>
+ ~ The number of bytes actually copied.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferCreate.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferCreate.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferCreate.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferCreate.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,37 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKIOBufferCopy">Prev</a> - INKIOBufferCopy
+INKIOBufferDestroy - <a href="INKIOBufferDestroy">Next</a></p>
+<h3 id="inkiobuffercreate">INKIOBufferCreate</h3>
+<p>Creates an IO buffer.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKIOBuffer INKIOBufferCreate (void)</code></p>
+<p><strong>Description</strong>
+ ~ Creates a new IO Buffer. The IO buffer that's created is
+ initially empty.</p>
+<p><strong>Returns</strong>
+ ~ A handle to the newly-created IO buffer.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR_PTR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferDestroy.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferDestroy.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferDestroy.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferDestroy.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,39 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKIOBufferCreate">Prev</a> - INKIOBufferCreate
+INKIOBufferProduce - <a href="INKIOBufferProduce">Next</a></p>
+<h3 id="inkiobufferdestroy">INKIOBufferDestroy</h3>
+<p>Destroys an IO buffer.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKIOBufferDestroy (INKIOBuffer <em class="replaceable"><code>bufp</code>)</p>
+<p><strong>Description</strong>
+ ~ Destroys the IO buffer <code><em class="replaceable"><code>bufp</code>.
+ Since two IO buffers can share data, this does not necessarily free
+ all of the data associated with the IO buffer - it simply
+ decrements the appropriate reference counts.</p>
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the IO buffer is successfully destroyed.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferProduce.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferProduce.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferProduce.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferProduce.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,41 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKIOBufferDestroy">Prev</a> - INKIOBufferDestroy
+INKIOBufferReaderAlloc - <a href="INKIOBufferReaderAlloc">Next</a></p>
+<h3 id="inkiobufferproduce">INKIOBufferProduce</h3>
+<p>Makes a specified number of bytes of data available for reading.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKIOBufferProduce (INKIObuffer <em class="replaceable"><code>bufp</code>,
+ int <em><code>nbytes</code></em>)</p>
+<p><strong>Description</strong>
+ ~ Makes <code><em class="replaceable"><code>nbytes</code> of data available
+ for reading in the buffer <code><em class="replaceable"><code>bufp</code>. A
+ common paradigm for writing to a buffer is to copy data into a
+ buffer block and then call <code>INKIOBufferProduce</code> to make the new
+ data visible to readers.</p>
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the operation completes successfully.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderAlloc.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderAlloc.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderAlloc.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderAlloc.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,37 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKIOBufferProduce">Prev</a> - INKIOBufferProduce
+INKIOBufferReaderAvail - <a href="INKIOBufferReaderAvail">Next</a></p>
+<h3 id="inkiobufferreaderalloc">INKIOBufferReaderAlloc</h3>
+<p>Allocates an IO buffer reader.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKIOBufferReader INKIOBufferReaderAlloc (INKIOBuffer <em class="replaceable"><code>bufp</code>)</p>
+<p><strong>Description</strong>
+ ~ Allocates an IO buffer reader for the IO buffer
+ <code><em class="replaceable"><code>bufp</code>.</p>
+<p><strong>Returns</strong>
+ ~ A handle to the newly-allocated IO buffer.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR_PTR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderAvail.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderAvail.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderAvail.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderAvail.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,37 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKIOBufferReaderAlloc">Prev</a> - INKIOBufferReaderAlloc
+INKIOBufferReaderClone - <a href="INKIOBufferReaderClone">Next</a></p>
+<h3 id="inkiobufferreaderavail">INKIOBufferReaderAvail</h3>
+<p>Gets the number of bytes available for reading.</p>
+<p><strong>Prototype</strong>
+ ~ <code>int INKIOBufferReaderAvail (INKIOBufferReader <em class="replaceable"><code>readerp</code>)</p>
+<p><strong>Description</strong>
+ ~ Gets the total number of bytes available for reading by the IO
+ buffer reader, <code><em class="replaceable"><code>readerp</code>.</p>
+<p><strong>Returns</strong>
+ ~ The number of bytes available for reading.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderClone.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderClone.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderClone.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderClone.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,39 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKIOBufferReaderAvail">Prev</a> - INKIOBufferReaderAvail
+INKIOBufferReaderConsume - <a href="INKIOBufferReaderConsume">Next</a></p>
+<h3 id="inkiobufferreaderclone">INKIOBufferReaderClone</h3>
+<p>Clones an IO buffer reader.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKIOBufferReader INKIOBufferReaderClone (INKIOBufferReader <em class="replaceable"><code>readerp</code>)</p>
+<p><strong>Description</strong>
+ ~ Makes a clone of the IO buffer reader
+ <code><em class="replaceable"><code>readerp</code>. The cloned reader points
+ to the same IO buffer and initially has the same read offset as
+ <code><em class="replaceable"><code>readerp</code>.</p>
+<p><strong>Returns</strong>
+ ~ A handle to the cloned IO buffer.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR_PTR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderConsume.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderConsume.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderConsume.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderConsume.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,47 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKIOBufferReaderClone">Prev</a> - INKIOBufferReaderClone
+INKIOBufferReaderFree - <a href="INKIOBufferReaderFree">Next</a></p>
+<h3 id="inkiobufferreaderconsume">INKIOBufferReaderConsume</h3>
+<p>Consumes an IO buffer reader.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKIOBufferReaderConsume (INKIOBufferReader <em class="replaceable"><code>readerp</code>,
+ int <em><code>nbytes</code></em>)</p>
+<p><strong>Description</strong>
+ ~ Moves the read offset for the IO buffer reader
+ <code><em class="replaceable"><code>readerp</code> ahead by the amount
+ <code><em class="replaceable"><code> nbytes</code>.</p>
+<div class="codehilite"><pre><span class="o">!</span><span class="p">[[</span><span class="n">Caution</span><span class="p">]](</span><span class="n">images</span><span class="sr">/docbook/c</span><span class="n">aution</span><span class="o">.</span><span class="n">png</span><span class="p">)</span>
+<span class="n">Caution</span>
+<span class="n">Once</span> <span class="n">a</span> <span class="n">reader</span> <span class="n">moves</span> <span class="n">its</span> <span class="n">offset</span> <span class="n">ahead</span><span class="p">,</span> <span class="n">it</span> <span class="n">can</span> <span class="n">never</span> <span class="n">move</span> <span class="n">it</span> <span class="n">back</span><span class="o">.</span>
+<span class="n">When</span> <span class="n">a</span> <span class="n">reader</span> <span class="n">moves</span> <span class="n">its</span> <span class="n">offset</span><span class="p">,</span> <span class="n">the</span> <span class="n">data</span> <span class="n">it</span> <span class="n">has</span> <span class="n">moved</span> <span class="n">is</span>
+<span class="n">potentially</span> <span class="n">freed</span> <span class="n">at</span> <span class="n">that</span> <span class="n">moment</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the operation completes successfully.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderFree.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderFree.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderFree.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderFree.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,42 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKIOBufferReaderConsume">Prev</a> - INKIOBufferReaderConsume
+INKIOBufferReaderStart - <a href="INKIOBufferReaderStart">Next</a></p>
+<h3 id="inkiobufferreaderfree">INKIOBufferReaderFree</h3>
+<p>Frees an IO buffer reader.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKIOBufferReaderFree (INKIOBufferReader <em class="replaceable"><code>readerp</code>)</p>
+<p><strong>Description</strong>
+ ~ Frees an IO buffer reader. The IO buffer maintains a reference
+ to each reader that accesses it and then frees those references
+ when the buffer gets destroyed (which makes it unnecessary to call
+ <code>INKIOBufferReaderFree</code>). It is sometimes useful to free an IO
+ buffer reader if the reader is no longer being used to allow the
+ buffer data to automatically be deallocated when other readers have
+ consumed it.</p>
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the IO buffer is successfully freed.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderStart.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderStart.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderStart.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferReaderStart.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,40 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKIOBufferReaderFree">Prev</a> - INKIOBufferReaderFree
+INKIOBufferSizedCreate - <a href="INKIOBufferSizedCreate">Next</a></p>
+<h3 id="inkiobufferreaderstart">INKIOBufferReaderStart</h3>
+<p>Starts an IO buffer reader.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKIOBufferBlock INKIOBufferReaderStart (INKIOBufferReader <em class="replaceable"><code>readerp</code>)</p>
+<p><strong>Description</strong>
+ ~ Gets the read start block for the IO buffer reader.
+ <code>INKIOBufferReaderStart</code> may return <code>NULL</code> if there is no data
+ available for reading; it may also return an IO buffer block with
+ no data available for reading. You should check for both
+ conditions.</p>
+<p><strong>Returns</strong>
+ ~ The read start block for the IO buffer reader.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR_PTR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferSizedCreate.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferSizedCreate.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferSizedCreate.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferSizedCreate.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,50 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKIOBufferReaderStart">Prev</a> - INKIOBufferReaderStart
+INKIOBufferStart - <a href="INKIOBufferStart">Next</a></p>
+<h3 id="inkiobuffersizedcreate">INKIOBufferSizedCreate</h3>
+<p>Creates an <code>INKIOBuffer</code> with the specified size index.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKIOBuffer INKIOBufferSizedCreate (INKIOBufferSizeIndex <em class="replaceable"><code>index</code>)</p>
+<p><strong>Arguments</strong>
+ ~ <code>INKIOBufferSizeIndex``<em class="replaceable"><code> index</code> is
+ the size of the new <code>IOBuffer</code> to create. It should be one of the
+ following values:
+ - <code>INK_IOBUFFER_SIZE_INDEX_128</code>
+ - <code>INK_IOBUFFER_SIZE_INDEX_256</code>
+ - <code>INK_IOBUFFER_SIZE_INDEX_512</code>
+ - <code>INK_IOBUFFER_SIZE_INDEX_1K</code>
+ - <code>INK_IOBUFFER_SIZE_INDEX_2K</code>
+ - <code>INK_IOBUFFER_SIZE_INDEX_4K</code>
+ - <code>INK_IOBUFFER_SIZE_INDEX_8K</code>
+ - <code>INK_IOBUFFER_SIZE_INDEX_16K</code>
+ - <code>INK_IOBUFFER_SIZE_INDEX_32K</code></p>
+<p><strong>Description</strong>
+ ~ Creates an <code>INKIOBuffer</code> of the specifed size.</p>
+<p><strong>Returns</strong>
+ ~ An <code>IOBuffer</code> object if the API call is successful.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR_PTR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span> <span class="k">while</span> <span class="n">calling</span> <span class="n">the</span> <span class="n">API</span> <span class="ow">or</span> <span class="k">if</span> <span class="n">an</span>
+<span class="n">argument</span> <span class="n">is</span> <span class="n">invalid</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferStart.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferStart.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferStart.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferStart.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,39 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKIOBufferSizedCreate">Prev</a> - INKIOBufferSizedCreate
+INKIOBufferWaterMarkGet - <a href="INKIOBufferWaterMarkGet">Next</a></p>
+<h3 id="inkiobufferstart">INKIOBufferStart</h3>
+<p>Starts an IO buffer.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKIOBufferBlock INKIOBufferStart (INKIOBuffer <em class="replaceable"><code>bufp</code>)</p>
+<p><strong>Description</strong>
+ ~ Gets the write start block for the IO buffer
+ <code><em class="replaceable"><code>bufp</code>. <code>INKIOBufferStart</code> always
+ returns a block with a non-zero amount of space available for
+ writing. If necessary, a new block is added to accomplish this.</p>
+<p><strong>Returns</strong>
+ ~ The write start block for the IO buffer writer.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR_PTR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferWaterMarkGet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferWaterMarkGet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferWaterMarkGet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferWaterMarkGet.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,55 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKIOBufferStart">Prev</a> - INKIOBufferStart
+INKIOBufferWaterMarkSet - <a href="INKIOBufferWaterMarkSet">Next</a></p>
+<h3 id="inkiobufferwatermarkget">INKIOBufferWaterMarkGet</h3>
+<p>Gets the current watermark for the specified buffer.</p>
+<p><strong>Prototype</strong>
+ ~ <code>InkReturnCode INKIOBufferWaterMarkGet (INKIOBuffer <em class="replaceable"><code>bufp</code>,
+ int *<em><code>watermark</code></em>)</p>
+<p><strong>Arguments</strong>
+ ~ <code>INKIOBuffer</code> <code><em class="replaceable"><code>bufp</code> is the
+ <strong><code>IOBuffer</code></strong> whose <code>water_mark</code> is to be obtained.</p>
+<div class="codehilite"><pre><span class="sb">`int *<em class="replaceable"><code>watermark`</span> <span class="n">is</span> <span class="n">set</span> <span class="n">to</span> <span class="n">the</span>
+<span class="n">watermark</span> <span class="n">value</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ Gets the current watermark for the specified buffer. A water
+ mark applies only to a <code><b>NetVConnection</b></code> and should therefore
+ only be used when reading data from one.</p>
+<div class="codehilite"><pre><span class="n">When</span> <span class="n">the</span> <span class="n">watermark</span> <span class="n">is</span> <span class="n">set</span> <span class="n">to</span> <span class="sb">`N`</span> <span class="ow">and</span> <span class="n">after</span> <span class="sb">`INKVConnRead`</span> <span class="n">is</span>
+<span class="n">called</span><span class="p">,</span> <span class="n">the</span> <span class="n">net</span> <span class="n">processor</span> <span class="n">calls</span> <span class="n">back</span> <span class="n">the</span> <span class="n">reader</span> <span class="p">(</span><span class="n">with</span> <span class="n">an</span> <span class="n">event</span>
+<span class="sb">`INK_VCONN_READ_READY`</span><span class="p">)</span> <span class="n">only</span> <span class="n">when</span> <span class="n">at</span> <span class="n">least</span> <span class="sb">`N`</span> <span class="n">bytes</span> <span class="n">of</span> <span class="n">data</span> <span class="n">are</span>
+<span class="n">available</span> <span class="k">for</span> <span class="n">reading</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the API call is successful.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span> <span class="k">while</span> <span class="n">calling</span> <span class="n">the</span> <span class="n">API</span> <span class="ow">or</span> <span class="k">if</span> <span class="n">an</span>
+<span class="n">argument</span> <span class="n">is</span> <span class="n">invalid</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferWaterMarkSet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferWaterMarkSet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferWaterMarkSet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferWaterMarkSet.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,55 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKIOBufferWaterMarkGet">Prev</a> - INKIOBufferWaterMarkGet
+INKIOBufferWrite - <a href="INKIOBufferWrite">Next</a></p>
+<h3 id="inkiobufferwatermarkset">INKIOBufferWaterMarkSet</h3>
+<p>Sets the current watermark for the specified buffer.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKIOBufferWaterMarkSet (INKIOBuffer <em class="replaceable"><code>bufp</code>,int
+ <em><code>water_mark</code></em>)</p>
+<p><strong>Arguments</strong>
+ ~ <code>INKIOBuffer</code> <code><em class="replaceable"><code>bufp</code> is the
+ <strong><code>IOBuffer</code></strong> whose watermark is to be set.</p>
+<div class="codehilite"><pre><span class="sb">`int <em class="replaceable"><code>water_mark`</span> <span class="n">is</span> <span class="n">the</span> <span class="n">watermark</span>
+<span class="n">value</span> <span class="n">to</span> <span class="n">set</span> <span class="k">for</span> <span class="sb">`<em class="replaceable"><code>bufp`</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ Sets the current watermark of the specified buffer.</p>
+<div class="codehilite"><pre>A water mark applies only to a `<span class="nt"><b></span>NetVConnection<span class="nt"></b></span>` and should
+therefore be used only when reading data from one. When the
+watermark is set to N and after `INKVConnRead` is called, the net
+processor calls back the reader (with an event
+`INK_VCONN_READ_READY`) only when at least N bytes of data are
+available for reading.
+</pre></div>
+
+
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the operation completes successfully.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span> <span class="k">while</span> <span class="n">calling</span> <span class="n">the</span> <span class="n">API</span> <span class="ow">or</span> <span class="k">if</span> <span class="n">an</span>
+<span class="n">argument</span> <span class="n">is</span> <span class="n">invalid</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferWrite.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferWrite.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferWrite.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIOBufferWrite.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,85 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKIOBufferWaterMarkSet">Prev</a> - INKIOBufferWaterMarkSet
+Management Interface Functions -
+<a href="ManagementInterfaceFunctions">Next</a></p>
+<h3 id="inkiobufferwrite">INKIOBufferWrite</h3>
+<p>Appends the specified number of bytes from a particular buffer to
+the IO buffer.</p>
+<p><strong>Prototype</strong>
+ ~ <code>int INKIOBufferWrite (INKIOBuffer <em class="replaceable"><code>bufp</code>,
+ const char <em><code>*buf</code></em>, int <em><code>len</code></em>)</p>
+<p><strong>Arguments</strong>
+ ~ <code>INKIOBuffer</code> <code><em class="replaceable"><code>bufp</code> is the
+ target IOBuffer that receives the data.</p>
+<div class="codehilite"><pre><span class="sb">`const char <em class="replaceable"><code>*buf`</span> <span class="n">is</span> <span class="n">the</span> <span class="n">buffer</span> <span class="n">that</span>
+<span class="n">contains</span> <span class="n">the</span> <span class="n">data</span><span class="o">.</span>
+
+<span class="sb">`int <em class="replaceable"><code>len`</span> <span class="n">is</span> <span class="n">the</span> <span class="nb">length</span> <span class="n">of</span> <span class="n">the</span> <span class="n">data</span>
+<span class="n">to</span> <span class="nb">write</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ This function appends data from
+ <code><em class="replaceable"><code>*buf</code> to IOBuffer
+ <code><em class="replaceable"><code>bufp</code>; the length of data being
+ appended is specified in <code><em class="replaceable"><code>len</code>. The
+ returned value is the actual length of data being appended.</p>
+<p><strong>Example</strong>
+ ~ <code>INKIOBufferWrite</code> offers the same functionality as the
+ deprecated functions <code>INKIOBufferAppend</code>, <code>INKIOBufferDataCreate</code>,
+ and <code>INKIOBufferBlockCreate</code>. To append the content of a buffer
+ <code><em class="replaceable"><code>buf</code> of size
+ <code><em class="replaceable"><code>len</code> into an <code>IOBuffer</code>, we
+ recommend using <code>INKIOBufferWrite</code>. It has the following
+ prototype:</p>
+<div class="codehilite"><pre> <span class="nb">int</span> <span class="n">INKIOBufferWrite</span> <span class="p">(</span><span class="n">INKIOBuffer</span> <span class="n">bufp</span><span class="p">,</span> <span class="n">const</span> <span class="n">char</span> <span class="o">*</span><span class="n">buf</span><span class="p">,</span> <span class="nb">int</span> <span class="n">len</span><span class="p">);</span>
+
+ <span class="n">The</span> <span class="n">equivalent</span> <span class="n">of</span> <span class="n">this</span> <span class="n">API</span> <span class="n">in</span> <span class="n">SDK2</span><span class="o">.</span><span class="mi">0</span> <span class="n">is</span> <span class="n">the</span> <span class="n">following</span> <span class="n">snippet</span> <span class="n">of</span> <span class="n">code:</span>
+ <span class="n">INKIOBufferBlock</span> <span class="n">block</span><span class="p">;</span>
+ <span class="nb">int</span> <span class="n">avail</span><span class="p">,</span> <span class="n">ndone</span><span class="p">,</span> <span class="n">ntodo</span><span class="p">,</span> <span class="n">towrite</span><span class="p">;</span>
+ <span class="n">char</span> <span class="o">*</span><span class="n">ptr_block</span><span class="p">;</span>
+
+ <span class="n">ndone</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
+ <span class="n">ntodo</span> <span class="o">=</span> <span class="n">len</span><span class="p">;</span>
+ <span class="k">while</span> <span class="p">(</span><span class="n">ntodo</span> <span class="o">></span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span>
+ <span class="sr">/* INKIOBufferStart allocates more blocks if required */</span>
+ <span class="n">block</span> <span class="o">=</span> <span class="n">INKIOBufferStart</span><span class="p">(</span><span class="n">bufp</span><span class="p">);</span>
+ <span class="n">ptr_block</span> <span class="o">=</span> <span class="n">INKIOBufferBlockWriteStart</span> <span class="p">(</span><span class="n">block</span><span class="p">,</span> <span class="o">&</span><span class="n">avail</span><span class="p">);</span>
+ <span class="n">towrite</span> <span class="o">=</span> <span class="n">min</span><span class="p">(</span><span class="n">ntodo</span><span class="p">,</span> <span class="n">avail</span><span class="p">);</span>
+ <span class="n">memcpy</span> <span class="p">(</span><span class="n">ptr_block</span><span class="p">,</span> <span class="n">buf</span><span class="o">+</span><span class="n">ndone</span><span class="p">,</span> <span class="n">towrite</span><span class="p">);</span>
+ <span class="n">INKIOBufferProduce</span><span class="p">(</span><span class="n">bufp</span><span class="p">,</span> <span class="n">towrite</span><span class="p">);</span>
+ <span class="n">ntodo</span> <span class="o">-=</span> <span class="n">towrite</span><span class="p">;</span>
+ <span class="n">ndone</span> <span class="o">+=</span> <span class="n">towrite</span><span class="p">;</span>
+ <span class="p">}</span>
+</pre></div>
+
+
+<p><strong>Returns</strong>
+ ~ The length of data copied if the API call is successful.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span> <span class="k">while</span> <span class="n">calling</span> <span class="n">the</span> <span class="n">API</span> <span class="ow">or</span> <span class="k">if</span> <span class="n">an</span>
+<span class="n">argument</span> <span class="n">is</span> <span class="n">invalid</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIsDebugTagSet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIsDebugTagSet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIsDebugTagSet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKIsDebugTagSet.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,50 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="DebuggingFunctions">Prev</a> - Debugging Functions
+INKError - <a href="INKError">Next</a></p>
+<h3 id="inkisdebugtagset">INKIsDebugTagSet</h3>
+<p>Indicates if a particular debug tag is set.</p>
+<p><strong>Prototype</strong>
+ ~ <code>void INKError (const char <em class="replaceable"><code>*fmt, ...</code>)</p>
+<p><strong>Arguments</strong>
+ ~ <code><em class="replaceable"><code>fmt</code> is the <code>printf</code> format
+ description.</p>
+<div class="codehilite"><pre><span class="sb">`...`</span> <span class="n">is</span> <span class="n">the</span> <span class="n">argument</span> <span class="k">for</span> <span class="n">the</span> <span class="nb">format</span> <span class="n">description</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ Since it is sometimes useful to log messages when errors occur,
+ Traffic Server provides a global error log file for this purpose.
+ The function <code>INKError</code> is the API interface to this error log.
+ <code>INKError</code> is similar to <code>printf</code>, except that <code>INKError</code> writes
+ output to the Traffic Server error log instead of writing the
+ output to the C standard output. One advantage of <code>INKError</code> over
+ <code>printf</code> is that each call is atomically placed into the error log
+ and not garbled with other error entries (this is not an issue in
+ single-threaded programs, but is a definite nuisance in
+ multi-threaded programs).</p>
+<p><strong>Example</strong>
+ ~ INKError ("couldn't retrieve client request headern");</p>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMBufferDestroy.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMBufferDestroy.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMBufferDestroy.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMBufferDestroy.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,39 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="MarshallBuffersFunctions">Prev</a> - Marshal Buffers:
+INKMBufferCreate
+HTTP Header Functions - <a href="HTTPHeaderFunctions">Next</a></p>
+<h3 id="inkmbufferdestroy">INKMBufferDestroy</h3>
+<p>Destroys a marshal buffer.</p>
+<p><strong>Prototype</strong>
+ ~ <code>void INKMBufferDestroy (INKMBuffer <em class="replaceable"><code>bufp</code>)</p>
+<p><strong>Arguments</strong>
+ ~ <code><em class="replaceable"><code>bufp</code> is the marshal buffer to
+ be destroyed.</p>
+<p><strong>Description</strong>
+ ~ Ignores the reference count and destroys the marshal buffer
+ <code><em class="replaceable"><code>bufp</code>. The internal data buffer
+ associated with the marshal buffer is also destroyed (if the
+ marshal buffer allocated it).</p>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMgmtFloatGet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMgmtFloatGet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMgmtFloatGet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMgmtFloatGet.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,47 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="TEConfigReadFunctions">Prev</a> - Configuration Read Functions:
+INKMgmtCounterGet
+INKMgmtIntGet - <a href="INKMgmtIntGet">Next</a></p>
+<h3 id="inkmgmtfloatget">INKMgmtFloatGet</h3>
+<p>Gets a <code>records.config</code> variable of type <code>float</code>.</p>
+<p><strong>Prototype</strong>
+ ~ <code>int INKMgmtFloatGet (const char *<i class="replaceable">var_name</i>, INKMgmtFloat *<i class="replaceable">result</i>)</code></p>
+<p><strong>Arguments</strong>
+ ~ <code><i>var_name </i></code> is the name of the variable you want from
+ the <code>records.config</code> file.</p>
+<div class="codehilite"><pre>`<span class="nt"><i></span>result <span class="nt"></i></span>` is a pointer to the value of the variable, which
+is of type `INKMgmtFloat`.
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ <code>INKMgmtFloatGet</code> obtains the value of the specified
+ <code>records.config</code> variable of type <code>float</code>, and then stores the
+ value in <code>result</code>.</p>
+<p><strong>Returns</strong>
+ ~ If <code>INKMgmtFloatGet</code> cannot get the variable, then it returns
+ zero.</p>
+<p>~ If it is successful, then a nonzero value is returned.</p>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMgmtIntGet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMgmtIntGet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMgmtIntGet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMgmtIntGet.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,59 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKMgmtFloatGet">Prev</a> - INKMgmtFloatGet
+INKMgmtStringGet - <a href="INKMgmtStringGet">Next</a></p>
+<h3 id="inkmgmtintget">INKMgmtIntGet</h3>
+<p>Get a <code>records.config</code> variable of type <code>int</code>.</p>
+<p><strong>Prototype</strong>
+ ~ <code>int INKMgmtIntGet (const char *<i class="replaceable">var_name</i>, INKMgmtInt *<i class="replaceable">result</i>)</code></p>
+<p><strong>Arguments</strong>
+ ~ <code><i>var_name </i></code> is the name of the variable you want from
+ the <code>records.config</code> file.</p>
+<div class="codehilite"><pre>`<span class="nt"><i></span>result <span class="nt"></i></span>` is a pointer to the variable's value, which is of
+type `INKMgmtInt`.
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ <code>INKMgmtIntGet</code> obtains the value of the specified
+ <code>records.config</code> variable of type <code>int</code>, and then stores the value
+ in <code>result</code>.</p>
+<p><strong>Example</strong>
+ ~ The following code fragment does something if keepalive is
+ enabled on Traffic Server:</p>
+<div class="codehilite"><pre> <span class="n">INKMgmtInt</span> <span class="n">result</span><span class="p">;</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">INKMgmtIntGet</span><span class="p">(</span><span class="s">"proxy.config.http.keep_alive_enabled"</span><span class="p">,</span> <span class="o">&</span><span class="n">result</span><span class="p">))</span> <span class="p">{</span>
+ <span class="k">if</span> <span class="p">(</span><span class="n">result</span><span class="p">){</span>
+ <span class="sr">//</span> <span class="n">keepalive</span> <span class="n">is</span> <span class="n">enabled</span><span class="p">,</span> <span class="k">do</span> <span class="n">something</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="k">else</span> <span class="n">INKError</span> <span class="p">(</span><span class="s">"could not retrieve value\n"</span><span class="p">);</span>
+</pre></div>
+
+
+<p><strong>Returns</strong>
+ ~ If <code>INKMgmtIntGet</code> cannot get the variable, then zero is
+ returned.</p>
+<p>~ If it is successful, then it returns a nonzero value.</p>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMgmtStringGet.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMgmtStringGet.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMgmtStringGet.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMgmtStringGet.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,52 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKMgmtIntGet">Prev</a> - INKMgmtIntGet
+Coupled Statistics Functions -
+<a href="StatisticsFunctions">Next</a></p>
+<h3 id="inkmgmtstringget">INKMgmtStringGet</h3>
+<p>Get a <code>records.config</code> variable of type <code>String</code>.</p>
+<p><strong>Prototype</strong>
+ ~ <code>int INKMgmtStringGet (const char *<i>var_name</i>, INKMgmtString *<i>result</i>)</code></p>
+<p><strong>Arguments</strong>
+ ~ <code><i>var_name </i></code> is the name of the variable you want from
+ the <code>records.config</code> file.</p>
+<div class="codehilite"><pre>`<span class="nt"><i></span>result <span class="nt"></i></span>` is a pointer to the value of the variable. This
+value is of type `INKMgmtString`.
+</pre></div>
+
+
+<p><strong>Description</strong>
+ ~ <code>INKMgmtStringGet</code> obtains the value of the specified
+ <code>records.config</code> variable of type <code>String</code>, and then stores the
+ value in <code>result</code>.</p>
+<div class="codehilite"><pre><span class="n">When</span> <span class="n">it</span><span class="err">'</span><span class="n">s</span> <span class="n">finished</span> <span class="n">with</span> <span class="n">the</span> <span class="n">result</span><span class="p">,</span> <span class="n">your</span> <span class="n">plugin</span> <span class="n">must</span> <span class="n">deallocate</span> <span class="n">the</span>
+<span class="n">result</span> <span class="n">string</span> <span class="n">with</span> <span class="n">a</span> <span class="n">call</span> <span class="n">to</span> <span class="sb">`INKfree`</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Returns</strong>
+ ~ If <code>INKMgmtStringGet</code> cannot get the variable, then it returns
+ zero.</p>
+<p>~ If it is successful, then a nonzero value is returned.</p>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMutexLock.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMutexLock.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMutexLock.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMutexLock.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,49 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="MutexFunctions">Prev</a> - Mutex Functions
+INKMutexLockTry - <a href="INKMutexLockTry">Next</a></p>
+<h3 id="inkmutexlock">INKMutexLock</h3>
+<p>Locks an <code>INKMutex</code>.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKMutexLock (INKMutex <em class="replaceable"><code>mutexp</code>)</p>
+<p><strong>Description</strong>
+ ~ Locks the <code>INKMutex</code> <code><em class="replaceable"><code>mutexp</code>. If
+ <code><em class="replaceable"><code>mutexp</code> is already locked, then
+ <code>INKMutexLock</code> blocks until the mutex is unlocked.</p>
+<p>~ An <code>INKMutex</code> will be recursively locked if <code>INKMutexLock</code> is
+ called on the same mutex twice from the same thread. Thus, the
+ following example will succeed and not block on the second call to
+ <code>INKMutexLock</code>.</p>
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the mutex is successfully locked.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Example</strong>
+ ~ INKMutexLock (some_mutex);
+ INKMutexLock (some_mutex);
+ INKMutexUnlock (some_mutex);
+ INKMutexUnlock (some_mutex);</p>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMutexLockTry.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMutexLockTry.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMutexLockTry.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMutexLockTry.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,66 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKMutexLock">Prev</a> - INKMutexLock
+INKMutexUnlock - <a href="INKMutexUnlock">Next</a></p>
+<h3 id="inkmutexlocktry">INKMutexLockTry</h3>
+<p>Tries to lock an <code>INKMutex</code>.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode InkMutexLockTry (INKMutex <em class="replaceable"><code>mutex</code>,
+ int *<em><code>lock</code></em>)</p>
+<p><strong>Description</strong>
+ ~ Tries to lock the <code>INKMutex</code>
+ <code><em class="replaceable"><code>mutex</code>. Information about whether
+ the lock was grabbed is set in
+ <code>int *``<em class="replaceable"><code>lock</code>.
+ <code>INKReturnCode</code> tells you if the call was successful or not, but
+ does not indicate if the lock was grabbed.</p>
+<div class="codehilite"><pre><span class="n">In</span> <span class="n">general</span><span class="p">,</span> <span class="k">use</span> <span class="sb">`InkMutexLockTry`</span> <span class="n">to</span> <span class="n">obtain</span> <span class="n">a</span> <span class="n">mutex</span> <span class="p">(</span><span class="n">see</span> <span class="n">the</span>
+<span class="n">example</span> <span class="n">below</span><span class="p">)</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Returns</strong>
+ ~ <code>1</code> if the mutex is successfully locked.</p>
+<div class="codehilite"><pre><span class="sb">`0`</span> <span class="k">if</span> <span class="n">the</span> <span class="n">mutex</span> <span class="n">is</span> <span class="n">already</span> <span class="n">locked</span><span class="o">.</span>
+</pre></div>
+
+
+<p><strong>Example</strong>
+ ~ int handler (INKCont contp, INKEvent event, void <em>edata)
+ {
+ //This continuation tries to grab a mutex
+ int retval, lock = 0;
+ retvak = InkMutexLockTry (mutex, &lock);
+ if (!lock)
+ {
+ /</em> Schedule a retry; RETRY_TIME should be 10 ms or longer. */
+ INKContSchedule (contp, RETRY_TIME);
+ return INK_EVENT_IMMEDIATE;
+ }</p>
+<div class="codehilite"><pre> <span class="sr">//</span> <span class="n">Now</span> <span class="n">the</span> <span class="n">mutex</span> <span class="n">has</span> <span class="n">been</span> <span class="n">grabbed</span>
+ <span class="n">do_some_job</span> <span class="o">...</span>
+ <span class="n">INKMutexUnlock</span> <span class="p">(</span><span class="n">mutexp</span><span class="p">);</span>
+ <span class="p">}</span>
+</pre></div>
</div>
<div id="footer">
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMutexUnlock.en.html
URL: http://svn.apache.org/viewvc/websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMutexUnlock.en.html?rev=778776&r1=778775&r2=778776&view=diff
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMutexUnlock.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/sdk/INKMutexUnlock.en.html Sat Nov 6 06:31:06 2010
@@ -4,6 +4,7 @@
<html>
<!-- This template is for the bulk of the site! -->
<head>
+ <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title></title>
@@ -14,7 +15,39 @@
<h1></h1>
<div id="content">
-
+ <p><a href="/index"><img alt="image" src="images/docbook/ts75.png" /></a>â¢
+Title: Apache Traffic Server⢠Software Developers Kit
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.</p>
+<p><a href="INKMutexLockTry">Prev</a> - INKMutexLockTry
+Continuation Functions - <a href="ContinuationFunctions">Next</a></p>
+<h3 id="inkmutexunlock">INKMutexUnlock</h3>
+<p>Unlocks an <code>INKMutex</code>.</p>
+<p><strong>Prototype</strong>
+ ~ <code>INKReturnCode INKMutexUnlock (INKMutex <em class="replaceable"><code>mutexp</code>)</p>
+<p><strong>Description</strong>
+ ~ Unlocks the <code>INKMutex</code> <code><em class="replaceable"><code> mutexp</code>.
+ If <code><em class="replaceable"><code> mutexp</code> was recursively locked,
+ then <code>INKMutexUnlock</code> does not actually unlock the mutex - it
+ simply decrements the recursion count.</p>
+<p><strong>Returns</strong>
+ ~ <code>INK_SUCCESS</code> if the mutex is successfully unlocked.</p>
+<div class="codehilite"><pre><span class="sb">`INK_ERROR`</span> <span class="k">if</span> <span class="n">an</span> <span class="n">error</span> <span class="n">occurs</span><span class="o">.</span>
+</pre></div>
</div>
<div id="footer">