| .. 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 |
| ======== |
| |
| .. code-block:: c |
| |
| #include <ts/ts.h> |
| |
| .. function:: int TSHttpTxnIsInternal(TSHttpTxn txnp) |
| .. function:: int 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 return a :code:`int`, indicating whether the |
| request was internal (:literal:`1`) or not (:literal:`0`). |
| |
| Examples |
| ======== |
| |
| The ESI plugin uses :func:`TSHttpTxnIsInternal` to ignore requests that is |
| had generated while fetching portions of an ESI document: |
| |
| .. literalinclude:: ../../../../plugins/esi/esi.cc |
| :language: c |
| :lines: 1395-1398 |
| |
| See also |
| ======== |
| |
| :manpage:`TSAPI(3ts)` |
