You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by jp...@apache.org on 2015/11/03 07:10:24 UTC
[48/51] trafficserver git commit: doc: move straggling API reference
doc: move straggling API reference
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/04cdbc61
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/04cdbc61
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/04cdbc61
Branch: refs/heads/master
Commit: 04cdbc61b1c5877e1da44816b9580a1d9dce3e2b
Parents: 018b4ab
Author: James Peach <jp...@apache.org>
Authored: Mon Nov 2 21:56:42 2015 -0800
Committer: James Peach <jp...@apache.org>
Committed: Mon Nov 2 22:09:16 2015 -0800
----------------------------------------------------------------------
.../api/functions/TSHttpSsnClientFdGet.en.rst | 31 +++++++++
.../api/functions/TSHttpTxnClientFdGet.en.rst | 31 +++++++++
.../functions/TSHttpTxnIncomingAddrGet.en.rst | 39 +++++++++++
.../api/functions/TSHttpTxnInfoIntGet.en.rst | 71 ++++++++++++++++++++
.../api/functions/TSHttpTxnIsInternal.en.rst | 59 ++++++++++++++++
.../functions/TSHttpTxnOutgoingAddrGet.en.rst | 39 +++++++++++
.../api/functions/TSHttpTxnServerFdGet.en.rst | 31 +++++++++
doc/reference/api/TSHttpSsnClientFdGet.en.rst | 31 ---------
doc/reference/api/TSHttpTxnClientFdGet.en.rst | 31 ---------
.../api/TSHttpTxnIncomingAddrGet.en.rst | 39 -----------
doc/reference/api/TSHttpTxnInfoIntGet.en.rst | 71 --------------------
doc/reference/api/TSHttpTxnIsInternal.en.rst | 59 ----------------
.../api/TSHttpTxnOutgoingAddrGet.en.rst | 39 -----------
doc/reference/api/TSHttpTxnServerFdGet.en.rst | 31 ---------
14 files changed, 301 insertions(+), 301 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/04cdbc61/doc/developer-guide/api/functions/TSHttpSsnClientFdGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpSsnClientFdGet.en.rst b/doc/developer-guide/api/functions/TSHttpSsnClientFdGet.en.rst
new file mode 100644
index 0000000..8ecf094
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpSsnClientFdGet.en.rst
@@ -0,0 +1,31 @@
+.. 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.
+
+
+TSHttpSsnClientFdGet
+=====================
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSReturnCode TSHttpSsnClientFdGet(TSHttpTxn txnp, int *fdp)
+
+
+Description
+-----------
+Get the socket descriptor for the client socket in :arg:`fdp` for the transaction :arg:`ssn`.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/04cdbc61/doc/developer-guide/api/functions/TSHttpTxnClientFdGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnClientFdGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnClientFdGet.en.rst
new file mode 100644
index 0000000..4c61160
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnClientFdGet.en.rst
@@ -0,0 +1,31 @@
+.. 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.
+
+
+TSHttpTxnClientFdGet
+=====================
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSReturnCode TSHttpTxnClientFdGet(TSHttpTxn txnp, int *fdp)
+
+
+Description
+-----------
+Get the socket descriptor for the client socket in :arg:`fdp` for the transaction :arg:`txnp`.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/04cdbc61/doc/developer-guide/api/functions/TSHttpTxnIncomingAddrGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnIncomingAddrGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnIncomingAddrGet.en.rst
new file mode 100644
index 0000000..cd691c1
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnIncomingAddrGet.en.rst
@@ -0,0 +1,39 @@
+.. 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.
+
+
+TSHttpTxnIncomingAddrGet
+========================
+
+Get the incoming proxy address on which a client's connection is accepted.
+
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: sockaddr const* TSHttpTxnIncomingAddrGet(TSHttpTxn txnp)
+
+
+Description
+-----------
+
+.. note::
+
+ The pointer is valid only for the current callback. Clients that
+ need to keep the value across callbacks must maintain their own
+ storage.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/04cdbc61/doc/developer-guide/api/functions/TSHttpTxnInfoIntGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnInfoIntGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnInfoIntGet.en.rst
new file mode 100644
index 0000000..4fa9c9e
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnInfoIntGet.en.rst
@@ -0,0 +1,71 @@
+.. 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.
+
+
+TSHttpTxnInfoIntGet
+===================
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSReturnCode TSHttpTxnInfoIntGet(TSHttpTxn txnp, TSHttpTxnInfoKey key, TSMgmtInt *value)
+
+
+Description
+-----------
+:c:func:`TSHttpTxnInfoIntGet` returns arbitrary integer-typed info about a transaction as defined in
+:c:type:`TSHttpTxnInfoKey`. The API will be part of a generic API umbrella that can support returning
+arbitrary info about a transaction using custom log tags. It works on multiple hooks depending on the
+requested info. For example, cache related info may be available only at or after :c:data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook.
+
+The :c:type:`TSHttpTxnInfoKey` currently supports the below integer-based info about a transaction
+
+ :c:data:`TS_TXN_INFO_CACHE_HIT_RAM`
+
+ This info is available at or after :c:data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook. A value of 1 indicates that the response
+ is returned from RAM cache. A value of 0 indicates otherwise.
+
+ :c:data:`TS_TXN_INFO_CACHE_COMPRESSED_IN_RAM`
+
+ This info is available at or after :c:data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook. A value of 1 indicates that the response
+ is returned from RAM cache and is compressed. A value of 0 indicates otherwise.
+
+ :c:data:`TS_TXN_INFO_CACHE_HIT_RWW`
+
+ This info is available at or after :c:data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook. A value of 1 indicates that the response
+ is returned via Read-While-Writer functionality. A value of 0 indicates otherwise.
+
+ :c:data:`TS_TXN_INFO_CACHE_OPEN_READ_TRIES`
+
+ This info is available at or after :c:data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook. The value indicates the number of cache open
+ read reattempts made by the transaction on cache open read failure.
+
+ :c:data:`TS_TXN_INFO_CACHE_OPEN_WRITE_TRIES`
+
+ This info is available at or after :c:data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook. The value indicates the number of cache open
+ write reattempts made by the transaction on cache open write failure.
+
+ :c:data:`TS_TXN_INFO_CACHE_VOLUME`
+
+ This info is available at or after :c:data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook. The value indicates the cache volume ID used
+ for the cache object associated with the transaction.
+
+Return values
+-------------
+
+The API returns :c:data:`TS_SUCCESS`, if the requested info is supported, :c:data:`TS_ERROR` otherwise.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/04cdbc61/doc/developer-guide/api/functions/TSHttpTxnIsInternal.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnIsInternal.en.rst b/doc/developer-guide/api/functions/TSHttpTxnIsInternal.en.rst
new file mode 100644
index 0000000..662d167
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnIsInternal.en.rst
@@ -0,0 +1,59 @@
+.. 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.
+
+.. default-domain:: c
+
+=======================
+TSHttpTxnIsInternal
+=======================
+
+Test whether a request is internally-generated.
+
+Synopsis
+========
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpTxnIsInternal(TSHttpTxn txnp)
+.. function:: TSReturnCode TSHttpSsnIsInternal(TSHttpSsn ssnp)
+
+Description
+===========
+
+:func:`TSHttpTxnIsInternal` tests whether a HTTP transaction
+was originated within Traffic Server.
+
+:func:`TSHttpSsnIsInternal` tests whether a HTTP session
+was originated within Traffic Server.
+
+Return Values
+=============
+
+Both these APIs returns a :type:`TSReturnCode`, indicating whether the
+object was internal (:data:`TS_SUCCESS`) or not (:data:`TS_ERROR`).
+
+Examples
+========
+
+The ESI plugin uses :func:`TSHttpTxnIsInternal` to ignore requests that is
+had generated while fetching portions of an ESI document:
+
+.. literalinclude:: ../../../plugins/experimental/esi/esi.cc
+ :language: c
+ :lines: 1395-1398
+
+See also
+========
+:manpage:`TSAPI(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/04cdbc61/doc/developer-guide/api/functions/TSHttpTxnOutgoingAddrGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnOutgoingAddrGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnOutgoingAddrGet.en.rst
new file mode 100644
index 0000000..1a604af
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnOutgoingAddrGet.en.rst
@@ -0,0 +1,39 @@
+.. 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.
+
+
+TSHttpTxnOutgoingAddrGet
+========================
+
+Get the outgoing address used in origin connection.
+
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: sockaddr const* TSHttpTxnOutgoingAddrGet(TSHttpTxn txnp)
+
+
+Description
+-----------
+
+.. note::
+
+ The pointer is valid only for the current callback. Clients that
+ need to keep the value across callbacks must maintain their own
+ storage.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/04cdbc61/doc/developer-guide/api/functions/TSHttpTxnServerFdGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnServerFdGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnServerFdGet.en.rst
new file mode 100644
index 0000000..1b0f6e0
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnServerFdGet.en.rst
@@ -0,0 +1,31 @@
+.. 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.
+
+
+TSHttpTxnServerFdGet
+=====================
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSReturnCode TSHttpTxnServerFdGet(TSHttpTxn txnp, int *fdp)
+
+
+Description
+-----------
+Get the socket descriptor for the server socket in :arg:`fdp` for the transaction :arg:`txnp`.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/04cdbc61/doc/reference/api/TSHttpSsnClientFdGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpSsnClientFdGet.en.rst b/doc/reference/api/TSHttpSsnClientFdGet.en.rst
deleted file mode 100644
index 8ecf094..0000000
--- a/doc/reference/api/TSHttpSsnClientFdGet.en.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-.. 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.
-
-
-TSHttpSsnClientFdGet
-=====================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSHttpSsnClientFdGet(TSHttpTxn txnp, int *fdp)
-
-
-Description
------------
-Get the socket descriptor for the client socket in :arg:`fdp` for the transaction :arg:`ssn`.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/04cdbc61/doc/reference/api/TSHttpTxnClientFdGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpTxnClientFdGet.en.rst b/doc/reference/api/TSHttpTxnClientFdGet.en.rst
deleted file mode 100644
index 4c61160..0000000
--- a/doc/reference/api/TSHttpTxnClientFdGet.en.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-.. 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.
-
-
-TSHttpTxnClientFdGet
-=====================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSHttpTxnClientFdGet(TSHttpTxn txnp, int *fdp)
-
-
-Description
------------
-Get the socket descriptor for the client socket in :arg:`fdp` for the transaction :arg:`txnp`.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/04cdbc61/doc/reference/api/TSHttpTxnIncomingAddrGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpTxnIncomingAddrGet.en.rst b/doc/reference/api/TSHttpTxnIncomingAddrGet.en.rst
deleted file mode 100644
index cd691c1..0000000
--- a/doc/reference/api/TSHttpTxnIncomingAddrGet.en.rst
+++ /dev/null
@@ -1,39 +0,0 @@
-.. 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.
-
-
-TSHttpTxnIncomingAddrGet
-========================
-
-Get the incoming proxy address on which a client's connection is accepted.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: sockaddr const* TSHttpTxnIncomingAddrGet(TSHttpTxn txnp)
-
-
-Description
------------
-
-.. note::
-
- The pointer is valid only for the current callback. Clients that
- need to keep the value across callbacks must maintain their own
- storage.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/04cdbc61/doc/reference/api/TSHttpTxnInfoIntGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpTxnInfoIntGet.en.rst b/doc/reference/api/TSHttpTxnInfoIntGet.en.rst
deleted file mode 100644
index 4fa9c9e..0000000
--- a/doc/reference/api/TSHttpTxnInfoIntGet.en.rst
+++ /dev/null
@@ -1,71 +0,0 @@
-.. 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.
-
-
-TSHttpTxnInfoIntGet
-===================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSHttpTxnInfoIntGet(TSHttpTxn txnp, TSHttpTxnInfoKey key, TSMgmtInt *value)
-
-
-Description
------------
-:c:func:`TSHttpTxnInfoIntGet` returns arbitrary integer-typed info about a transaction as defined in
-:c:type:`TSHttpTxnInfoKey`. The API will be part of a generic API umbrella that can support returning
-arbitrary info about a transaction using custom log tags. It works on multiple hooks depending on the
-requested info. For example, cache related info may be available only at or after :c:data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook.
-
-The :c:type:`TSHttpTxnInfoKey` currently supports the below integer-based info about a transaction
-
- :c:data:`TS_TXN_INFO_CACHE_HIT_RAM`
-
- This info is available at or after :c:data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook. A value of 1 indicates that the response
- is returned from RAM cache. A value of 0 indicates otherwise.
-
- :c:data:`TS_TXN_INFO_CACHE_COMPRESSED_IN_RAM`
-
- This info is available at or after :c:data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook. A value of 1 indicates that the response
- is returned from RAM cache and is compressed. A value of 0 indicates otherwise.
-
- :c:data:`TS_TXN_INFO_CACHE_HIT_RWW`
-
- This info is available at or after :c:data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook. A value of 1 indicates that the response
- is returned via Read-While-Writer functionality. A value of 0 indicates otherwise.
-
- :c:data:`TS_TXN_INFO_CACHE_OPEN_READ_TRIES`
-
- This info is available at or after :c:data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook. The value indicates the number of cache open
- read reattempts made by the transaction on cache open read failure.
-
- :c:data:`TS_TXN_INFO_CACHE_OPEN_WRITE_TRIES`
-
- This info is available at or after :c:data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook. The value indicates the number of cache open
- write reattempts made by the transaction on cache open write failure.
-
- :c:data:`TS_TXN_INFO_CACHE_VOLUME`
-
- This info is available at or after :c:data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook. The value indicates the cache volume ID used
- for the cache object associated with the transaction.
-
-Return values
--------------
-
-The API returns :c:data:`TS_SUCCESS`, if the requested info is supported, :c:data:`TS_ERROR` otherwise.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/04cdbc61/doc/reference/api/TSHttpTxnIsInternal.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpTxnIsInternal.en.rst b/doc/reference/api/TSHttpTxnIsInternal.en.rst
deleted file mode 100644
index 662d167..0000000
--- a/doc/reference/api/TSHttpTxnIsInternal.en.rst
+++ /dev/null
@@ -1,59 +0,0 @@
-.. 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.
-
-.. default-domain:: c
-
-=======================
-TSHttpTxnIsInternal
-=======================
-
-Test whether a request is internally-generated.
-
-Synopsis
-========
-`#include <ts/ts.h>`
-
-.. function:: TSReturnCode TSHttpTxnIsInternal(TSHttpTxn txnp)
-.. function:: TSReturnCode TSHttpSsnIsInternal(TSHttpSsn ssnp)
-
-Description
-===========
-
-:func:`TSHttpTxnIsInternal` tests whether a HTTP transaction
-was originated within Traffic Server.
-
-:func:`TSHttpSsnIsInternal` tests whether a HTTP session
-was originated within Traffic Server.
-
-Return Values
-=============
-
-Both these APIs returns a :type:`TSReturnCode`, indicating whether the
-object was internal (:data:`TS_SUCCESS`) or not (:data:`TS_ERROR`).
-
-Examples
-========
-
-The ESI plugin uses :func:`TSHttpTxnIsInternal` to ignore requests that is
-had generated while fetching portions of an ESI document:
-
-.. literalinclude:: ../../../plugins/experimental/esi/esi.cc
- :language: c
- :lines: 1395-1398
-
-See also
-========
-:manpage:`TSAPI(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/04cdbc61/doc/reference/api/TSHttpTxnOutgoingAddrGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpTxnOutgoingAddrGet.en.rst b/doc/reference/api/TSHttpTxnOutgoingAddrGet.en.rst
deleted file mode 100644
index 1a604af..0000000
--- a/doc/reference/api/TSHttpTxnOutgoingAddrGet.en.rst
+++ /dev/null
@@ -1,39 +0,0 @@
-.. 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.
-
-
-TSHttpTxnOutgoingAddrGet
-========================
-
-Get the outgoing address used in origin connection.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: sockaddr const* TSHttpTxnOutgoingAddrGet(TSHttpTxn txnp)
-
-
-Description
------------
-
-.. note::
-
- The pointer is valid only for the current callback. Clients that
- need to keep the value across callbacks must maintain their own
- storage.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/04cdbc61/doc/reference/api/TSHttpTxnServerFdGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpTxnServerFdGet.en.rst b/doc/reference/api/TSHttpTxnServerFdGet.en.rst
deleted file mode 100644
index 1b0f6e0..0000000
--- a/doc/reference/api/TSHttpTxnServerFdGet.en.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-.. 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.
-
-
-TSHttpTxnServerFdGet
-=====================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSHttpTxnServerFdGet(TSHttpTxn txnp, int *fdp)
-
-
-Description
------------
-Get the socket descriptor for the server socket in :arg:`fdp` for the transaction :arg:`txnp`.