doc/developer-guide/api/types/TSOverridableConfigKey.en.rst

.. 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.

.. include:: ../../../common.defs

TSOverridableConfigKey
**********************

Synopsis
========

.. code-block:: cpp

    #include <ts/apidefs.h>

.. c:enum:: TSOverridableConfigKey

Enumeration Members
===================

.. c:enumerator:: TS_CONFIG_URL_REMAP_PRISTINE_HOST_HDR
.. c:enumerator:: TS_CONFIG_HTTP_CHUNKING_ENABLED
.. c:enumerator:: TS_CONFIG_HTTP_NEGATIVE_CACHING_ENABLED
.. c:enumerator:: TS_CONFIG_HTTP_NEGATIVE_CACHING_LIFETIME
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_WHEN_TO_REVALIDATE
.. c:enumerator:: TS_CONFIG_HTTP_KEEP_ALIVE_ENABLED_IN
.. c:enumerator:: TS_CONFIG_HTTP_KEEP_ALIVE_ENABLED_OUT
.. c:enumerator:: TS_CONFIG_HTTP_KEEP_ALIVE_POST_OUT
.. c:enumerator:: TS_CONFIG_HTTP_SERVER_SESSION_SHARING_MATCH
.. c:enumerator:: TS_CONFIG_NET_SOCK_RECV_BUFFER_SIZE_OUT
.. c:enumerator:: TS_CONFIG_NET_SOCK_SEND_BUFFER_SIZE_OUT
.. c:enumerator:: TS_CONFIG_NET_SOCK_OPTION_FLAG_OUT
.. c:enumerator:: TS_CONFIG_HTTP_FORWARD_PROXY_AUTH_TO_PARENT
.. c:enumerator:: TS_CONFIG_HTTP_ANONYMIZE_REMOVE_FROM
.. c:enumerator:: TS_CONFIG_HTTP_ANONYMIZE_REMOVE_REFERER
.. c:enumerator:: TS_CONFIG_HTTP_ANONYMIZE_REMOVE_USER_AGENT
.. c:enumerator:: TS_CONFIG_HTTP_ANONYMIZE_REMOVE_COOKIE
.. c:enumerator:: TS_CONFIG_HTTP_ANONYMIZE_REMOVE_CLIENT_IP
.. c:enumerator:: TS_CONFIG_HTTP_ANONYMIZE_INSERT_CLIENT_IP
.. c:enumerator:: TS_CONFIG_HTTP_RESPONSE_SERVER_ENABLED
.. c:enumerator:: TS_CONFIG_HTTP_INSERT_SQUID_X_FORWARDED_FOR
.. c:enumerator:: TS_CONFIG_HTTP_SEND_HTTP11_REQUESTS
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_HTTP
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_IGNORE_CLIENT_NO_CACHE
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_IGNORE_CLIENT_CC_MAX_AGE
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_IMS_ON_CLIENT_NO_CACHE
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_IGNORE_SERVER_NO_CACHE
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_CACHE_RESPONSES_TO_COOKIES
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_IGNORE_AUTHENTICATION
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_CACHE_URLS_THAT_LOOK_DYNAMIC
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_REQUIRED_HEADERS
.. c:enumerator:: TS_CONFIG_HTTP_INSERT_REQUEST_VIA_STR
.. c:enumerator:: TS_CONFIG_HTTP_INSERT_RESPONSE_VIA_STR
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_HEURISTIC_MIN_LIFETIME
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_HEURISTIC_MAX_LIFETIME
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_GUARANTEED_MIN_LIFETIME
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_GUARANTEED_MAX_LIFETIME
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_MAX_STALE_AGE
.. c:enumerator:: TS_CONFIG_HTTP_KEEP_ALIVE_NO_ACTIVITY_TIMEOUT_IN
.. c:enumerator:: TS_CONFIG_HTTP_KEEP_ALIVE_NO_ACTIVITY_TIMEOUT_OUT
.. c:enumerator:: TS_CONFIG_HTTP_TRANSACTION_NO_ACTIVITY_TIMEOUT_IN
.. c:enumerator:: TS_CONFIG_HTTP_TRANSACTION_NO_ACTIVITY_TIMEOUT_OUT
.. c:enumerator:: TS_CONFIG_HTTP_TRANSACTION_ACTIVE_TIMEOUT_OUT
.. c:enumerator:: TS_CONFIG_HTTP_ORIGIN_MAX_CONNECTIONS
.. c:enumerator:: TS_CONFIG_HTTP_CONNECT_ATTEMPTS_MAX_RETRIES
.. c:enumerator:: TS_CONFIG_HTTP_CONNECT_ATTEMPTS_MAX_RETRIES_DOWN_SERVER
.. c:enumerator:: TS_CONFIG_HTTP_CONNECT_ATTEMPTS_RR_RETRIES
.. c:enumerator:: TS_CONFIG_HTTP_CONNECT_ATTEMPTS_TIMEOUT
.. c:enumerator:: TS_CONFIG_HTTP_POST_CONNECT_ATTEMPTS_TIMEOUT
.. c:enumerator:: TS_CONFIG_HTTP_DOWN_SERVER_CACHE_TIME
.. c:enumerator:: TS_CONFIG_HTTP_DOC_IN_CACHE_SKIP_DNS
.. c:enumerator:: TS_CONFIG_HTTP_BACKGROUND_FILL_ACTIVE_TIMEOUT
.. c:enumerator:: TS_CONFIG_HTTP_RESPONSE_SERVER_STR
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_HEURISTIC_LM_FACTOR
.. c:enumerator:: TS_CONFIG_HTTP_BACKGROUND_FILL_COMPLETED_THRESHOLD
.. c:enumerator:: TS_CONFIG_NET_SOCK_PACKET_MARK_OUT
.. c:enumerator:: TS_CONFIG_NET_SOCK_PACKET_TOS_OUT
.. c:enumerator:: TS_CONFIG_HTTP_INSERT_AGE_IN_RESPONSE
.. c:enumerator:: TS_CONFIG_HTTP_CHUNKING_SIZE
.. c:enumerator:: TS_CONFIG_HTTP_FLOW_CONTROL_ENABLED
.. c:enumerator:: TS_CONFIG_HTTP_FLOW_CONTROL_LOW_WATER_MARK
.. c:enumerator:: TS_CONFIG_HTTP_FLOW_CONTROL_HIGH_WATER_MARK
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_RANGE_LOOKUP
.. c:enumerator:: TS_CONFIG_HTTP_DEFAULT_BUFFER_SIZE
.. c:enumerator:: TS_CONFIG_HTTP_DEFAULT_BUFFER_WATER_MARK
.. c:enumerator:: TS_CONFIG_HTTP_REQUEST_HEADER_MAX_SIZE
.. c:enumerator:: TS_CONFIG_HTTP_RESPONSE_HEADER_MAX_SIZE
.. c:enumerator:: TS_CONFIG_HTTP_NEGATIVE_REVALIDATING_ENABLED
.. c:enumerator:: TS_CONFIG_HTTP_NEGATIVE_REVALIDATING_LIFETIME
.. c:enumerator:: TS_CONFIG_SSL_HSTS_MAX_AGE
.. c:enumerator:: TS_CONFIG_SSL_HSTS_INCLUDE_SUBDOMAINS
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_OPEN_READ_RETRY_TIME
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_MAX_OPEN_READ_RETRIES
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_RANGE_WRITE
.. c:enumerator:: TS_CONFIG_HTTP_POST_CHECK_CONTENT_LENGTH_ENABLED
.. c:enumerator:: TS_CONFIG_HTTP_GLOBAL_USER_AGENT_HEADER
.. c:enumerator:: TS_CONFIG_HTTP_AUTH_SERVER_SESSION_PRIVATE
.. c:enumerator:: TS_CONFIG_HTTP_SLOW_LOG_THRESHOLD
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_GENERATION
.. c:enumerator:: TS_CONFIG_BODY_FACTORY_TEMPLATE_BASE
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_OPEN_WRITE_FAIL_ACTION
.. c:enumerator:: TS_CONFIG_HTTP_NUMBER_OF_REDIRECTIONS
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_MAX_OPEN_WRITE_RETRIES
.. c:enumerator:: TS_CONFIG_HTTP_REDIRECT_USE_ORIG_CACHE_KEY
.. c:enumerator:: TS_CONFIG_HTTP_REQUEST_BUFFER_ENABLED
.. c:enumerator:: TS_CONFIG_HTTP_ATTACH_SERVER_SESSION_TO_CLIENT
.. c:enumerator:: TS_CONFIG_HTTP_MAX_PROXY_CYCLES
.. c:enumerator:: TS_CONFIG_HTTP_ORIGIN_MAX_CONNECTIONS_QUEUE
.. c:enumerator:: TS_CONFIG_WEBSOCKET_NO_ACTIVITY_TIMEOUT
.. c:enumerator:: TS_CONFIG_WEBSOCKET_ACTIVE_TIMEOUT
.. c:enumerator:: TS_CONFIG_HTTP_UNCACHEABLE_REQUESTS_BYPASS_PARENT
.. c:enumerator:: TS_CONFIG_HTTP_PARENT_PROXY_TOTAL_CONNECT_ATTEMPTS
.. c:enumerator:: TS_CONFIG_HTTP_TRANSACTION_ACTIVE_TIMEOUT_IN
.. c:enumerator:: TS_CONFIG_SRV_ENABLED
.. c:enumerator:: TS_CONFIG_HTTP_FORWARD_CONNECT_METHOD
.. c:enumerator:: TS_CONFIG_SSL_CLIENT_CERT_FILENAME
.. c:enumerator:: TS_CONFIG_SSL_CERT_FILEPATH
.. c:enumerator:: TS_CONFIG_PARENT_FAILURES_UPDATE_HOSTDB
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_MISMATCH
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_LANGUAGE_MISMATCH
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_ENCODING_MISMATCH
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_CHARSET_MISMATCH
.. c:enumerator:: TS_CONFIG_HTTP_PARENT_PROXY_FAIL_THRESHOLD
.. c:enumerator:: TS_CONFIG_HTTP_PARENT_PROXY_RETRY_TIME
.. c:enumerator:: TS_CONFIG_HTTP_PER_PARENT_CONNECT_ATTEMPTS
.. c:enumerator:: TS_CONFIG_HTTP_PARENT_CONNECT_ATTEMPT_TIMEOUT
.. c:enumerator:: TS_CONFIG_HTTP_NORMALIZE_AE
.. c:enumerator:: TS_CONFIG_HTTP_INSERT_FORWARDED
.. c:enumerator:: TS_CONFIG_HTTP_ALLOW_MULTI_RANGE
.. c:enumerator:: TS_CONFIG_HTTP_ALLOW_HALF_OPEN
.. c:enumerator:: TS_CONFIG_HTTP_PER_SERVER_CONNECTION_MAX
.. c:enumerator:: TS_CONFIG_HTTP_PER_SERVER_CONNECTION_MATCH
.. c:enumerator:: TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_POLICY
.. c:enumerator:: TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_PROPERTIES
.. c:enumerator:: TS_CONFIG_SSL_CLIENT_SNI_POLICY
.. c:enumerator:: TS_CONFIG_SSL_CLIENT_PRIVATE_KEY_FILENAME
.. c:enumerator:: TS_CONFIG_SSL_CLIENT_CA_CERT_FILENAME
.. c:enumerator:: TS_CONFIG_HTTP_HOST_RESOLUTION_PREFERENCE
.. c:enumerator:: TS_CONFIG_PLUGIN_VC_DEFAULT_BUFFER_INDEX
.. c:enumerator:: TS_CONFIG_PLUGIN_VC_DEFAULT_BUFFER_WATER_MARK
.. c:enumerator:: TS_CONFIG_NET_SOCK_NOTSENT_LOWAT
.. c:enumerator:: TS_CONFIG_BODY_FACTORY_RESPONSE_SUPPRESSION_MODE
.. c:enumerator:: TS_CONFIG_NET_DEFAULT_INACTIVITY_TIMEOUT
.. c:enumerator:: TS_CONFIG_HTTP_NO_DNS_JUST_FORWARD_TO_PARENT
.. c:enumerator:: TS_CONFIG_HTTP_CACHE_IGNORE_QUERY


Description
===========

This is an enumeration for all of the configuration values that are overridable per transaction. See
:ref:`ts-overridable-config` for the relationship between these values and configuration values.