Author: igalic
Date: Mon Jan 31 00:09:10 2011
New Revision: 1065435
URL: http://svn.apache.org/viewvc?rev=1065435&view=rev
Log:
Done with Miscellaneous Interface Guide.
reverting the non existent macro %method Foo% to a link: [Foo](link/to/doxygen)
Modified:
trafficserver/site/branches/ats-cms/content/docs/trunk/STATUS
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/header-based-plugin-examples/index.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/adding-hooks.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/http-alternate-selection.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/http-sessions.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/http-transactions.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/initiate-http-connection.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/intercepting-http-transactions.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/index.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/memory-allocation.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/thread-functions.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/tsfopen-family.en.mdtext
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/STATUS
URL:
http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/STATUS?rev=1065435&r1=1065434&r2=1065435&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/STATUS (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/STATUS Mon Jan 31
00:09:10 2011
@@ -58,7 +58,7 @@ http-transformation-plugin -- igalic
new-protocol-plugins -- igalic
cache-plugin -- igalic
http-hooks-and-transactions -- igalic
-misc-interface-guide
+misc-interface-guide -- igalic
http-headers
mutex-guide
continuations
Modified:
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/header-based-plugin-examples/index.en.mdtext
URL:
http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/header-based-plugin-examples/index.en.mdtext?rev=1065435&r1=1065434&r2=1065435&view=diff
==============================================================================
---
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/header-based-plugin-examples/index.en.mdtext
(original)
+++
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/header-based-plugin-examples/index.en.mdtext
Mon Jan 31 00:09:10 2011
@@ -25,7 +25,7 @@ The Blacklist Plugin - [Next](blacklist-
**Table of Contents**
* [The Blacklist Plugin](blacklist-plugin)
-* [Creating the Parent
Continuation](blacklist-plugin#CreatingParentContinuation)
+ * [Creating the Parent
Continuation](blacklist-plugin#CreatingParentContinuation)
* [Setting a Global Hook](blacklist-plugin/setting-a-global-hook)
* [Setting Up UI Update
Callbacks](blacklist-plugin/setting-up-ui-update-callbacks)
* [Accessing the Transaction Being
Processed](blacklist-plugin/accessing-the-transaction-being-processed)
Modified:
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/adding-hooks.en.mdtext
URL:
http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/adding-hooks.en.mdtext?rev=1065435&r1=1065434&r2=1065435&view=diff
==============================================================================
---
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/adding-hooks.en.mdtext
(original)
+++
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/adding-hooks.en.mdtext
Mon Jan 31 00:09:10 2011
@@ -37,7 +37,7 @@ to a transaction. See [Accessing the Tra
* **Transformation hooks**
Transformation hooks are a special case of transaction hooks. See
-%method TSVConnCacheObjectSizeGet%
+[TSVConnCacheObjectSizeGet](link/to/doxygen)
for more information about transformation hooks. You add a transformation hook
using `TSHttpTxnHookAdd`, as described in [HTTP
Transactions](HTTP_Transactions.html).
@@ -139,5 +139,5 @@ for `TSHttpHookID` are:
or a previous client connection that was left open for keep alive has new
data
available.
-The function you use to add a global HTTP hook is %method TSHttpHookAdd%.
+The function you use to add a global HTTP hook is
[TSHttpHookAdd](link/to/doxygen).
Modified:
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/http-alternate-selection.en.mdtext
URL:
http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/http-alternate-selection.en.mdtext?rev=1065435&r1=1065434&r2=1065435&view=diff
==============================================================================
---
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/http-alternate-selection.en.mdtext
(original)
+++
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/http-alternate-selection.en.mdtext
Mon Jan 31 00:09:10 2011
@@ -180,12 +180,12 @@ for the alternate.
The HTTP alternate selection functions are:
-* %method TSHttpAltInfoCachedReqGet%
+* [TSHttpAltInfoCachedReqGet](link/to/doxygen)
-* %method TSHttpAltInfoCachedRespGet%
+* [TSHttpAltInfoCachedRespGet](link/to/doxygen)
-* %method TSHttpAltInfoClientReqGet%
+* [TSHttpAltInfoClientReqGet](link/to/doxygen)
-* %method TSHttpAltInfoQualitySet%
+* [TSHttpAltInfoQualitySet](link/to/doxygen)
Modified:
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/http-sessions.en.mdtext
URL:
http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/http-sessions.en.mdtext?rev=1065435&r1=1065434&r2=1065435&view=diff
==============================================================================
---
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/http-sessions.en.mdtext
(original)
+++
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/http-sessions.en.mdtext
Mon Jan 31 00:09:10 2011
@@ -50,6 +50,6 @@ a session hook.
The session hook functions are listed below:
-* %method TSHttpSsnHookAdd%
-* %method TSHttpSsnReenable%
+* [TSHttpSsnHookAdd](link/to/doxygen)
+* [TSHttpSsnReenable](link/to/doxygen)
Modified:
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/http-transactions.en.mdtext
URL:
http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/http-transactions.en.mdtext?rev=1065435&r1=1065434&r2=1065435&view=diff
==============================================================================
---
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/http-transactions.en.mdtext
(original)
+++
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/http-transactions.en.mdtext
Mon Jan 31 00:09:10 2011
@@ -161,46 +161,46 @@ for an illustration of the steps involve
The HTTP transaction functions are:
-* %method TSHttpTxnCacheLookupStatusGet%
+* [TSHttpTxnCacheLookupStatusGet](link/to/doxygen)
-* %method TSHttpTxnCachedReqGet% - Note that it is an error to modify cached
headers.
+* [TSHttpTxnCachedReqGet](link/to/doxygen) - Note that it is an error to
modify cached headers.
-* %method TSHttpTxnCachedRespGet% - Note that it is an error to modify cached
headers.
+* [TSHttpTxnCachedRespGet](link/to/doxygen) - Note that it is an error to
modify cached headers.
-* %method TSHttpTxnClientIncomingPortGet%
+* [TSHttpTxnClientIncomingPortGet](link/to/doxygen)
-* %method TSHttpTxnClientIPGet%
+* [TSHttpTxnClientIPGet](link/to/doxygen)
-* %method TSHttpTxnClientRemotePortGet%
+* [TSHttpTxnClientRemotePortGet](link/to/doxygen)
-* %method TSHttpTxnClientReqGet% - Plugins that must read client request
headers
+* [TSHttpTxnClientReqGet](link/to/doxygen) - Plugins that must read client
request headers
use this call to retrieve the HTTP header.
-* %method TSHttpTxnClientRespGet%
+* [TSHttpTxnClientRespGet](link/to/doxygen)
-* %method TSHttpTxnErrorBodySet%
+* [TSHttpTxnErrorBodySet](link/to/doxygen)
-* %method TSHttpTxnHookAdd%
+* [TSHttpTxnHookAdd](link/to/doxygen)
-* %method TSHttpTxnNextHopIPGet%
+* [TSHttpTxnNextHopIPGet](link/to/doxygen)
-* %method TSHttpTxnNextHopIPGet%
+* [TSHttpTxnNextHopIPGet](link/to/doxygen)
-* %method TSHttpTxnParentProxySet%
+* [TSHttpTxnParentProxySet](link/to/doxygen)
-* %method TSHttpTxnReenable%
+* [TSHttpTxnReenable](link/to/doxygen)
-* %method TSHttpTxnServerIPGet%
+* [TSHttpTxnServerIPGet](link/to/doxygen)
-* %method TSHttpTxnServerReqGet%
+* [TSHttpTxnServerReqGet](link/to/doxygen)
-* %method TSHttpTxnServerRespGet%
+* [TSHttpTxnServerRespGet](link/to/doxygen)
-* %method TSHttpTxnSsnGet%
+* [TSHttpTxnSsnGet](link/to/doxygen)
-* %method TSHttpTxnTransformedRespCache%
+* [TSHttpTxnTransformedRespCache](link/to/doxygen)
-* %method TSHttpTxnTransformRespGet%
+* [TSHttpTxnTransformRespGet](link/to/doxygen)
-* %method TSHttpTxnUntransformedRespCache%
+* [TSHttpTxnUntransformedRespCache](link/to/doxygen)
Modified:
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/initiate-http-connection.en.mdtext
URL:
http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/initiate-http-connection.en.mdtext?rev=1065435&r1=1065434&r2=1065435&view=diff
==============================================================================
---
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/initiate-http-connection.en.mdtext
(original)
+++
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/initiate-http-connection.en.mdtext
Mon Jan 31 00:09:10 2011
@@ -26,5 +26,5 @@ HTTP Alternate Selection - [Next](http-a
This function enables plugins to initiate HTTP transactions. The initiate HTTP
connection function is:
-* %method TSHttpConnect%
+* [TSHttpConnect](link/to/doxygen)
Modified:
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/intercepting-http-transactions.en.mdtext
URL:
http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/intercepting-http-transactions.en.mdtext?rev=1065435&r1=1065434&r2=1065435&view=diff
==============================================================================
---
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/intercepting-http-transactions.en.mdtext
(original)
+++
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/http-hooks-and-transactions/intercepting-http-transactions.en.mdtext
Mon Jan 31 00:09:10 2011
@@ -30,7 +30,7 @@ intercepting HTTP transaction function a
as well as using alternative transports to the origin server.The intercepting
HTTP transaction functions are:
-* %method TSHttpTxnIntercept%
+* [TSHttpTxnIntercept](link/to/doxygen)
Modified:
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/index.en.mdtext
URL:
http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/index.en.mdtext?rev=1065435&r1=1065434&r2=1065435&view=diff
==============================================================================
---
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/index.en.mdtext
(original)
+++
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/index.en.mdtext
Mon Jan 31 00:09:10 2011
@@ -0,0 +1,60 @@
+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.
+
+
+
+[Prev](HTTPAlternateSelection.html) - HTTP Alternate Selection
+
+The TSfopen Family - [Next](TSfopenFamily.html)
+
+## Miscellaneous Interface Guide ## {#MiscellaneousInterfaceGuide}
+
+Most of the functions in the Traffic Server API provide an interface to
specific
+code modules within Traffic Server. The miscellaneous functions described in
+this chapter provide some useful general capabilities. They are categorized
+as follows:
+
+* [Debugging Functions](#DebuggingFunctions)
+
+* [The TSfopen Family](tsfopen-family)
+
+* [Memory Allocation](memory-allocation)
+
+* [Thread Functions](thread-functions)
+
+The C library already provides functions such as `printf`, `malloc`, and
`fopen`
+to perform these tasks. The Traffic Server API versions, however, overcome
+various C library limitations (such as portability to all Traffic
Server-support
+platforms).
+
+## Debugging Functions ## {#DebuggingFunctions}
+
+* [TSDebug](link/to/doxygen) prints out a formatted statement
+if you are running Traffic Server in debug mode.
+
+* [TSIsDebugTagSet](link/to/doxygen) checks to see if a debug tag is set.
+If the debug tag is set, then Traffic Server prints out all debug statements
+associated with the tag.
+
+* [TSError](link/to/doxygen) prints error messages to Traffic Server's error
log
+
+* [TSAssert](link/to/doxygen) enables the use of assertion in a plugin.
+
+* [TSReleaseAssert](link/to/doxygen) enables the use of assertion in a
+plugin.
+
Modified:
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/memory-allocation.en.mdtext
URL:
http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/memory-allocation.en.mdtext?rev=1065435&r1=1065434&r2=1065435&view=diff
==============================================================================
---
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/memory-allocation.en.mdtext
(original)
+++
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/memory-allocation.en.mdtext
Mon Jan 31 00:09:10 2011
@@ -0,0 +1,51 @@
+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.
+
+
+[Prev](tsfopen-family) - The TSfopen Family
+
+Thread Functions - [Next](thread-functions)
+
+## Memory Allocation ## {#MemoryAllocation}
+
+Traffic Server provides five routines for allocating and freeing memory. These
+routines correspond to similar routines in the C library. For example,
`TSrealloc`
+behaves like the C library routine `realloc`.
+
+There are two main reasons for using 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 `NULL` 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, always turned on, and quite useful
+when tracking down memory leaks.
+
+The memory allocation functions are:
+
+* [TSfree](link/to/doxygen)
+
+* [TSmalloc](link/to/doxygen)
+
+* [TSrealloc](link/to/doxygen)
+
+* [TSstrdup](link/to/doxygen)
+
+* [TSstrndup](link/to/doxygen)
+
+
+
Modified:
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/thread-functions.en.mdtext
URL:
http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/thread-functions.en.mdtext?rev=1065435&r1=1065434&r2=1065435&view=diff
==============================================================================
---
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/thread-functions.en.mdtext
(original)
+++
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/thread-functions.en.mdtext
Mon Jan 31 00:09:10 2011
@@ -0,0 +1,37 @@
+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.
+
+[Prev](memory-allocation) - Memory Allocation
+
+Chapter 10. HTTP Headers - [Next](../http-headers)
+
+## Thread Functions ## {#ThreadFunctions}
+
+The Traffic Server API thread functions enable you to create, destroy, and
+identify threads within Traffic Server. Multithreading enables a single program
+to have more than one stream of execution and to process more than one
transaction
+at a time. Threads serialize their access to shared resources and data using
+the `TSMutex` type, as described in [Mutexes](../mutex-guide/#Mutexes).
+
+The thread functions are listed below:
+
+* [TSThreadCreate](link/to/doxygen)
+* [TSThreadDestroy](link/to/doxygen)
+* [TSThreadInit](link/to/doxygen)
+* [TSThreadSelf](link/to/doxygen)
+
Modified:
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/tsfopen-family.en.mdtext
URL:
http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/tsfopen-family.en.mdtext?rev=1065435&r1=1065434&r2=1065435&view=diff
==============================================================================
---
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/tsfopen-family.en.mdtext
(original)
+++
trafficserver/site/branches/ats-cms/content/docs/trunk/sdk/misc-interface-guide/tsfopen-family.en.mdtext
Mon Jan 31 00:09:10 2011
@@ -0,0 +1,55 @@
+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.
+
+[Prev](../misc-interface-guide) - iscellaneous Interface Guide
+
+Memory Allocation - [Next](memory-allocation)
+
+## The TSfopen Family ## {#TSfopenFamily}
+
+The `fopen` family of functions in C is normally used for reading configuration
+files, since `fgets` is an easy way to parse files on a line-by-line basis.
+The `TSfopen` family of functions aims at solving the same problem of buffered
+IO and line at a time IO in a platform-independent manner. The `fopen` family
+of C library functions can only open a file if a file descriptor less than
+256 is available. Since Traffic Server often has more than 2000 file
descriptors
+open at once, however, the likelihood of an available file descriptor less
+than 256 very small. To solve this problem, the `TSfopen` family can open
+files with descriptors greater than 256.
+
+The `TSfopen` family of routines is not intended for high speed IO or
flexibility -
+they are blocking APIs (not asynchronous). For performance reasons, you should
+not directly use these APIs on a Traffic Server thread (when being called back
+on an HTTP hook); it is better to use a separate thread for doing the blocking
+IO. The `TSfopen` family is intended for reading and writing configuration
+information when corresponding usage of the `fopen` family of functions is
+inappropriate due to file descriptor and portability limitations. The `TSfopen`
+family of functions consists of the following:
+
+* [TSfclose](link/to/doxygen)
+
+* [TSfflush](link/to/doxygen)
+
+* [TSfgets](link/to/doxygen)
+
+* [TSfopen](link/to/doxygen)
+
+* [TSfread](link/to/doxygen)
+
+* [TSfwrite](link/to/doxygen)
+
