diff --git a/doc/admin-guide/logging/cache-results.en.rst b/doc/admin-guide/logging/cache-results.en.rst index 18210c26905..5521d74a78b 100644 --- a/doc/admin-guide/logging/cache-results.en.rst +++ b/doc/admin-guide/logging/cache-results.en.rst @@ -105,7 +105,7 @@ the object to the client. .. _crc-tcp-cf-hit: TCP_CF_HIT -------- +---------- A valid copy of the requested object is being updated in the cache and Traffic Server sent the object to the client. diff --git a/doc/admin-guide/plugins/cookie_remap.en.rst b/doc/admin-guide/plugins/cookie_remap.en.rst index 7b9dd542ba9..de92e60afbe 100644 --- a/doc/admin-guide/plugins/cookie_remap.en.rst +++ b/doc/admin-guide/plugins/cookie_remap.en.rst @@ -32,7 +32,7 @@ Cookie Based Routing Inside TrafficServer Using cookie_remap * `Comments <#comments>`_ * `cookie: X|X.Y <#cookie-xxy>`_ - * `target: purl <#purl>`_ + * `target: puri <#purl>`_ * `operation: exists|not exists|string|regex|bucket <#operation-existsnot-existsstringregexbucket>`_ * `match: str <#match-str>`_ * `regex: str <#regex-str>`_ @@ -126,15 +126,15 @@ cookie: X|X.Y This sub-operation is testing against the X cookie or X.Y cookie where X.Y denotes the X cookie, sub cookie Y e.g +.. code-block:: text -.. raw:: html - - 
    A=ACOOKIE;B=data&f=fsub&z=zsub;
-   A will operate on ACOOKIE
-   B will operate on data&f=fsub&z=zsub
-   B.f will operate on fsub
-
+ +A will operate on ``ACOOKIE`` + +B will operate on ``data&f=fsub&z=zsub`` + +B.f will operate on ``fsub`` target: puri ^^^^^^^^^^^^ diff --git a/doc/conf.py b/doc/conf.py index 4bc2b91d9ae..89de61cd34a 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -65,10 +65,9 @@ with open(LOCAL_CONFIG) as f: exec(compile(f.read(), LOCAL_CONFIG, 'exec')) -if version_info >= (1, 4): - extensions.append('sphinx.ext.imgmath') -else: - extensions.append('sphinx.ext.pngmath') +if version_info < (3, 0): + print("Documentation requires Sphinx 3.0 or later.") + exit(1) # XXX Disabling docxygen for now, since it make RTD documentation builds time # out, eg. https://readthedocs.org/projects/trafficserver/builds/3525976/ @@ -172,16 +171,18 @@ #modindex_common_prefix = [] nitpicky = True -nitpick_ignore = [('c:type', 'int64_t'), - ('c:type', 'bool'), - ('c:type', 'sockaddr'), +nitpick_ignore = [('c:identifier', 'int64_t'), + ('c:identifier', 'uint64_t'), + ('c:identifier', 'uint8_t'), + ('c:identifier', 'int32_t'), + ('c:identifier', 'size_t'), + ('c:identifier', 'ssize_t'), + ('c:identifier', 'sockaddr'), + ('c:identifier', 'time_t'), ('cpp:identifier', 'T'), # template arg ('cpp:identifier', 'F'), # template arg ('cpp:identifier', 'Args'), # variadic template arg ('cpp:identifier', 'Rest'), # variadic template arg - ('c:type', 'uint64_t'), - ('c:type', 'uint8_t'), - ('c:type', 'int32_t') ] # Autolink issue references. diff --git a/doc/developer-guide/api/functions/TSDebug.en.rst b/doc/developer-guide/api/functions/TSDebug.en.rst index d788bba380f..f9cafdfc55e 100644 --- a/doc/developer-guide/api/functions/TSDebug.en.rst +++ b/doc/developer-guide/api/functions/TSDebug.en.rst @@ -26,7 +26,7 @@ Traffic Server Debugging APIs. Synopsis ======== -.. code-block:: cpp +.. code-block:: c #include @@ -47,8 +47,8 @@ Synopsis .. function:: const char* TSHttpServerStateNameLookup(TSServerState state) .. function:: const char* TSHttpHookNameLookup(TSHttpHookID hook) .. function:: const char* TSHttpEventNameLookup(TSEvent event) -.. macro:: void TSAssert( ... ) -.. macro:: void TSReleaseAssert( ... ) +.. macro:: TSAssert( ... ) +.. macro:: TSReleaseAssert( ... ) diags.log ========= diff --git a/doc/developer-guide/api/functions/TSHttpConnectWithPluginId.en.rst b/doc/developer-guide/api/functions/TSHttpConnectWithPluginId.en.rst index fd3b7cc1d96..c291c3859cf 100644 --- a/doc/developer-guide/api/functions/TSHttpConnectWithPluginId.en.rst +++ b/doc/developer-guide/api/functions/TSHttpConnectWithPluginId.en.rst @@ -45,7 +45,7 @@ stack via the loopback interface. :arg:`addr` This is the network address of the target of the connection. - This includes the port which should be stored in the :c:type:`sockaddr` + This includes the port which should be stored in the :code:`sockaddr` structure pointed at by :arg:`addr`. :arg:`tag` diff --git a/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst b/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst index 5e564da9803..9b7c7b13290 100644 --- a/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst +++ b/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst @@ -22,16 +22,15 @@ .. _ts-overridable-config: TSHttpOverridableConfig -*********************** +*************************** Synopsis ======== -.. code-block:: cpp +.. code-block:: c #include - .. function:: TSReturnCode TSHttpTxnConfigIntSet(TSHttpTxn txnp, TSOverridableConfigKey key, TSMgmtInt value) .. function:: TSReturnCode TSHttpTxnConfigIntGet(TSHttpTxn txnp, TSOverridableConfigKey key, TSMgmtInt* value) .. function:: TSReturnCode TSHttpTxnConfigFloatSet(TSHttpTxn txnp, TSOverridableConfigKey key, TSMgmtFloat value) @@ -54,7 +53,7 @@ All of the ``...Get`` functions store the internal value in the storage indicated by the :arg:`value` argument. For strings :arg:`length*` will receive the length of the string. -The values are identified by the enumeration :type:`TSOverridableConfigKey`. +The values are identified by the enumeration :enum:`TSOverridableConfigKey`. String values can be used indirectly by first passing them to :func:`TSHttpTxnConfigFind` which, if the string matches an overridable value, return the key and data type. @@ -62,127 +61,129 @@ return the key and data type. Configurations ============== +Testing :enumerator:`TS_CONFIG_BODY_FACTORY_TEMPLATE_BASE`. + The following configurations (from ``records.config``) are overridable: -================================================================== ==================================================================== -TSOverridableConfigKey Value Configuration Value -================================================================== ==================================================================== -:c:macro:`TS_CONFIG_BODY_FACTORY_TEMPLATE_BASE` :ts:cv:`proxy.config.body_factory.template_base` -:c:macro:`TS_CONFIG_HTTP_ALLOW_HALF_OPEN` :ts:cv:`proxy.config.http.allow_half_open` -:c:macro:`TS_CONFIG_HTTP_ALLOW_MULTI_RANGE` :ts:cv:`proxy.config.http.allow_multi_range` -:c:macro:`TS_CONFIG_HTTP_ANONYMIZE_INSERT_CLIENT_IP` :ts:cv:`proxy.config.http.insert_client_ip` -:c:macro:`TS_CONFIG_HTTP_ANONYMIZE_REMOVE_CLIENT_IP` :ts:cv:`proxy.config.http.anonymize_remove_client_ip` -:c:macro:`TS_CONFIG_HTTP_ANONYMIZE_REMOVE_COOKIE` :ts:cv:`proxy.config.http.anonymize_remove_cookie` -:c:macro:`TS_CONFIG_HTTP_ANONYMIZE_REMOVE_FROM` :ts:cv:`proxy.config.http.anonymize_remove_from` -:c:macro:`TS_CONFIG_HTTP_ANONYMIZE_REMOVE_REFERER` :ts:cv:`proxy.config.http.anonymize_remove_referer` -:c:macro:`TS_CONFIG_HTTP_ANONYMIZE_REMOVE_USER_AGENT` :ts:cv:`proxy.config.http.anonymize_remove_user_agent` -:c:macro:`TS_CONFIG_HTTP_ATTACH_SERVER_SESSION_TO_CLIENT` :ts:cv:`proxy.config.http.attach_server_session_to_client` -:c:macro:`TS_CONFIG_HTTP_MAX_PROXY_CYCLES` :ts:cv:`proxy.config.http.max_proxy_cycles` -:c:macro:`TS_CONFIG_HTTP_AUTH_SERVER_SESSION_PRIVATE` :ts:cv:`proxy.config.http.auth_server_session_private` -:c:macro:`TS_CONFIG_HTTP_BACKGROUND_FILL_ACTIVE_TIMEOUT` :ts:cv:`proxy.config.http.background_fill_active_timeout` -:c:macro:`TS_CONFIG_HTTP_BACKGROUND_FILL_COMPLETED_THRESHOLD` :ts:cv:`proxy.config.http.background_fill_completed_threshold` -:c:macro:`TS_CONFIG_HTTP_CACHE_CACHE_RESPONSES_TO_COOKIES` :ts:cv:`proxy.config.http.cache.cache_responses_to_cookies` -:c:macro:`TS_CONFIG_HTTP_CACHE_CACHE_URLS_THAT_LOOK_DYNAMIC` :ts:cv:`proxy.config.http.cache.cache_urls_that_look_dynamic` -:c:macro:`TS_CONFIG_HTTP_CACHE_GENERATION` :ts:cv:`proxy.config.http.cache.generation` -:c:macro:`TS_CONFIG_HTTP_CACHE_GUARANTEED_MAX_LIFETIME` :ts:cv:`proxy.config.http.cache.guaranteed_max_lifetime` -:c:macro:`TS_CONFIG_HTTP_CACHE_GUARANTEED_MIN_LIFETIME` :ts:cv:`proxy.config.http.cache.guaranteed_min_lifetime` -:c:macro:`TS_CONFIG_HTTP_CACHE_HEURISTIC_LM_FACTOR` :ts:cv:`proxy.config.http.cache.heuristic_lm_factor` -:c:macro:`TS_CONFIG_HTTP_CACHE_HEURISTIC_MAX_LIFETIME` :ts:cv:`proxy.config.http.cache.heuristic_max_lifetime` -:c:macro:`TS_CONFIG_HTTP_CACHE_HEURISTIC_MIN_LIFETIME` :ts:cv:`proxy.config.http.cache.heuristic_min_lifetime` -:c:macro:`TS_CONFIG_HTTP_CACHE_HTTP` :ts:cv:`proxy.config.http.cache.http` -:c:macro:`TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_CHARSET_MISMATCH` :ts:cv:`proxy.config.http.cache.ignore_accept_charset_mismatch` -:c:macro:`TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_ENCODING_MISMATCH` :ts:cv:`proxy.config.http.cache.ignore_accept_encoding_mismatch` -:c:macro:`TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_LANGUAGE_MISMATCH` :ts:cv:`proxy.config.http.cache.ignore_accept_language_mismatch` -:c:macro:`TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_MISMATCH` :ts:cv:`proxy.config.http.cache.ignore_accept_mismatch` -:c:macro:`TS_CONFIG_HTTP_CACHE_IGNORE_AUTHENTICATION` :ts:cv:`proxy.config.http.cache.ignore_authentication` -:c:macro:`TS_CONFIG_HTTP_CACHE_IGNORE_CLIENT_CC_MAX_AGE` :ts:cv:`proxy.config.http.cache.ignore_client_cc_max_age` -:c:macro:`TS_CONFIG_HTTP_CACHE_IGNORE_CLIENT_NO_CACHE` :ts:cv:`proxy.config.http.cache.ignore_client_no_cache` -:c:macro:`TS_CONFIG_HTTP_CACHE_IGNORE_SERVER_NO_CACHE` :ts:cv:`proxy.config.http.cache.ignore_server_no_cache` -:c:macro:`TS_CONFIG_HTTP_CACHE_IMS_ON_CLIENT_NO_CACHE` :ts:cv:`proxy.config.http.cache.ims_on_client_no_cache` -:c:macro:`TS_CONFIG_HTTP_CACHE_MAX_OPEN_READ_RETRIES` :ts:cv:`proxy.config.http.cache.max_open_read_retries` -:c:macro:`TS_CONFIG_HTTP_CACHE_MAX_OPEN_WRITE_RETRIES` :ts:cv:`proxy.config.http.cache.max_open_write_retries` -:c:macro:`TS_CONFIG_HTTP_CACHE_MAX_STALE_AGE` :ts:cv:`proxy.config.http.cache.max_stale_age` -:c:macro:`TS_CONFIG_HTTP_CACHE_OPEN_READ_RETRY_TIME` :ts:cv:`proxy.config.http.cache.open_read_retry_time` -:c:macro:`TS_CONFIG_HTTP_CACHE_OPEN_WRITE_FAIL_ACTION` :ts:cv:`proxy.config.http.cache.open_write_fail_action` -:c:macro:`TS_CONFIG_HTTP_CACHE_RANGE_LOOKUP` :ts:cv:`proxy.config.http.cache.range.lookup` -:c:macro:`TS_CONFIG_HTTP_CACHE_RANGE_WRITE` :ts:cv:`proxy.config.http.cache.range.write` -:c:macro:`TS_CONFIG_HTTP_CACHE_REQUIRED_HEADERS` :ts:cv:`proxy.config.http.cache.required_headers` -:c:macro:`TS_CONFIG_HTTP_CACHE_WHEN_TO_REVALIDATE` :ts:cv:`proxy.config.http.cache.when_to_revalidate` -:c:macro:`TS_CONFIG_HTTP_CHUNKING_ENABLED` :ts:cv:`proxy.config.http.chunking_enabled` -:c:macro:`TS_CONFIG_HTTP_CHUNKING_SIZE` :ts:cv:`proxy.config.http.chunking.size` -:c:macro:`TS_CONFIG_HTTP_CONNECT_ATTEMPTS_MAX_RETRIES_DEAD_SERVER` :ts:cv:`proxy.config.http.connect_attempts_max_retries_dead_server` -:c:macro:`TS_CONFIG_HTTP_CONNECT_ATTEMPTS_MAX_RETRIES` :ts:cv:`proxy.config.http.connect_attempts_max_retries` -:c:macro:`TS_CONFIG_HTTP_CONNECT_ATTEMPTS_RR_RETRIES` :ts:cv:`proxy.config.http.connect_attempts_rr_retries` -:c:macro:`TS_CONFIG_HTTP_CONNECT_ATTEMPTS_TIMEOUT` :ts:cv:`proxy.config.http.connect_attempts_timeout` -:c:macro:`TS_CONFIG_HTTP_DEFAULT_BUFFER_SIZE` :ts:cv:`proxy.config.http.default_buffer_size` -:c:macro:`TS_CONFIG_HTTP_DEFAULT_BUFFER_WATER_MARK` :ts:cv:`proxy.config.http.default_buffer_water_mark` -:c:macro:`TS_CONFIG_HTTP_DOC_IN_CACHE_SKIP_DNS` :ts:cv:`proxy.config.http.doc_in_cache_skip_dns` -:c:macro:`TS_CONFIG_HTTP_DOWN_SERVER_CACHE_TIME` :ts:cv:`proxy.config.http.down_server.cache_time` -:c:macro:`TS_CONFIG_HTTP_FLOW_CONTROL_ENABLED` :ts:cv:`proxy.config.http.flow_control.enabled` -:c:macro:`TS_CONFIG_HTTP_FLOW_CONTROL_HIGH_WATER_MARK` :ts:cv:`proxy.config.http.flow_control.high_water` -:c:macro:`TS_CONFIG_HTTP_FLOW_CONTROL_LOW_WATER_MARK` :ts:cv:`proxy.config.http.flow_control.low_water` -:c:macro:`TS_CONFIG_HTTP_FORWARD_CONNECT_METHOD` :ts:cv:`proxy.config.http.forward_connect_method` -:c:macro:`TS_CONFIG_HTTP_FORWARD_PROXY_AUTH_TO_PARENT` :ts:cv:`proxy.config.http.forward.proxy_auth_to_parent` -:c:macro:`TS_CONFIG_HTTP_GLOBAL_USER_AGENT_HEADER` :ts:cv:`proxy.config.http.global_user_agent_header` -:c:macro:`TS_CONFIG_HTTP_INSERT_AGE_IN_RESPONSE` :ts:cv:`proxy.config.http.insert_age_in_response` -:c:macro:`TS_CONFIG_HTTP_INSERT_FORWARDED` :ts:cv:`proxy.config.http.insert_forwarded` -:c:macro:`TS_CONFIG_HTTP_INSERT_REQUEST_VIA_STR` :ts:cv:`proxy.config.http.insert_request_via_str` -:c:macro:`TS_CONFIG_HTTP_INSERT_RESPONSE_VIA_STR` :ts:cv:`proxy.config.http.insert_response_via_str` -:c:macro:`TS_CONFIG_HTTP_INSERT_SQUID_X_FORWARDED_FOR` :ts:cv:`proxy.config.http.insert_squid_x_forwarded_for` -:c:macro:`TS_CONFIG_HTTP_KEEP_ALIVE_ENABLED_IN` :ts:cv:`proxy.config.http.keep_alive_enabled_in` -:c:macro:`TS_CONFIG_HTTP_KEEP_ALIVE_ENABLED_OUT` :ts:cv:`proxy.config.http.keep_alive_enabled_out` -:c:macro:`TS_CONFIG_HTTP_KEEP_ALIVE_NO_ACTIVITY_TIMEOUT_IN` :ts:cv:`proxy.config.http.keep_alive_no_activity_timeout_in` -:c:macro:`TS_CONFIG_HTTP_KEEP_ALIVE_NO_ACTIVITY_TIMEOUT_OUT` :ts:cv:`proxy.config.http.keep_alive_no_activity_timeout_out` -:c:macro:`TS_CONFIG_HTTP_KEEP_ALIVE_POST_OUT` :ts:cv:`proxy.config.http.keep_alive_post_out` -:c:macro:`TS_CONFIG_HTTP_NEGATIVE_CACHING_ENABLED` :ts:cv:`proxy.config.http.negative_caching_enabled` -:c:macro:`TS_CONFIG_HTTP_NEGATIVE_CACHING_LIFETIME` :ts:cv:`proxy.config.http.negative_caching_lifetime` -:c:macro:`TS_CONFIG_HTTP_NEGATIVE_REVALIDATING_ENABLED` :ts:cv:`proxy.config.http.negative_revalidating_enabled` -:c:macro:`TS_CONFIG_HTTP_NEGATIVE_REVALIDATING_LIFETIME` :ts:cv:`proxy.config.http.negative_revalidating_lifetime` -:c:macro:`TS_CONFIG_HTTP_NORMALIZE_AE` :ts:cv:`proxy.config.http.normalize_ae` -:c:macro:`TS_CONFIG_HTTP_NUMBER_OF_REDIRECTIONS` :ts:cv:`proxy.config.http.number_of_redirections` -:c:macro:`TS_CONFIG_HTTP_PARENT_PROXY_FAIL_THRESHOLD` :ts:cv:`proxy.config.http.parent_proxy.fail_threshold` -:c:macro:`TS_CONFIG_HTTP_PARENT_PROXY_RETRY_TIME` :ts:cv:`proxy.config.http.parent_proxy.retry_time` -:c:macro:`TS_CONFIG_HTTP_PARENT_PROXY_TOTAL_CONNECT_ATTEMPTS` :ts:cv:`proxy.config.http.parent_proxy.total_connect_attempts` -:c:macro:`TS_CONFIG_HTTP_PER_PARENT_CONNECT_ATTEMPTS` :ts:cv:`proxy.config.http.parent_proxy.per_parent_connect_attempts` -:c:macro:`TS_CONFIG_HTTP_PER_SERVER_CONNECTION_MATCH` :ts:cv:`proxy.config.http.per_server.connection.match` -:c:macro:`TS_CONFIG_HTTP_PER_SERVER_CONNECTION_MAX` :ts:cv:`proxy.config.http.per_server.connection.max` -:c:macro:`TS_CONFIG_HTTP_POST_CHECK_CONTENT_LENGTH_ENABLED` :ts:cv:`proxy.config.http.post.check.content_length.enabled` -:c:macro:`TS_CONFIG_HTTP_REDIRECT_USE_ORIG_CACHE_KEY` :ts:cv:`proxy.config.http.redirect_use_orig_cache_key` -:c:macro:`TS_CONFIG_HTTP_REQUEST_BUFFER_ENABLED` :ts:cv:`proxy.config.http.request_buffer_enabled` -:c:macro:`TS_CONFIG_HTTP_REQUEST_HEADER_MAX_SIZE` :ts:cv:`proxy.config.http.request_header_max_size` -:c:macro:`TS_CONFIG_HTTP_RESPONSE_HEADER_MAX_SIZE` :ts:cv:`proxy.config.http.response_header_max_size` -:c:macro:`TS_CONFIG_HTTP_RESPONSE_SERVER_ENABLED` :ts:cv:`proxy.config.http.response_server_enabled` -:c:macro:`TS_CONFIG_HTTP_RESPONSE_SERVER_STR` :ts:cv:`proxy.config.http.response_server_str` -:c:macro:`TS_CONFIG_HTTP_SEND_HTTP11_REQUESTS` :ts:cv:`proxy.config.http.send_http11_requests` -:c:macro:`TS_CONFIG_HTTP_SERVER_SESSION_SHARING_MATCH` :ts:cv:`proxy.config.http.server_session_sharing.match` -:c:macro:`TS_CONFIG_HTTP_SLOW_LOG_THRESHOLD` :ts:cv:`proxy.config.http.slow.log.threshold` -:c:macro:`TS_CONFIG_HTTP_TRANSACTION_ACTIVE_TIMEOUT_IN` :ts:cv:`proxy.config.http.transaction_active_timeout_in` -:c:macro:`TS_CONFIG_HTTP_TRANSACTION_ACTIVE_TIMEOUT_OUT` :ts:cv:`proxy.config.http.transaction_active_timeout_out` -:c:macro:`TS_CONFIG_HTTP_TRANSACTION_NO_ACTIVITY_TIMEOUT_IN` :ts:cv:`proxy.config.http.transaction_no_activity_timeout_in` -:c:macro:`TS_CONFIG_HTTP_TRANSACTION_NO_ACTIVITY_TIMEOUT_OUT` :ts:cv:`proxy.config.http.transaction_no_activity_timeout_out` -:c:macro:`TS_CONFIG_HTTP_UNCACHEABLE_REQUESTS_BYPASS_PARENT` :ts:cv:`proxy.config.http.uncacheable_requests_bypass_parent` -:c:macro:`TS_CONFIG_NET_SOCK_OPTION_FLAG_OUT` :ts:cv:`proxy.config.net.sock_option_flag_out` -:c:macro:`TS_CONFIG_NET_SOCK_PACKET_MARK_OUT` :ts:cv:`proxy.config.net.sock_packet_mark_out` -:c:macro:`TS_CONFIG_NET_SOCK_PACKET_TOS_OUT` :ts:cv:`proxy.config.net.sock_packet_tos_out` -:c:macro:`TS_CONFIG_NET_SOCK_RECV_BUFFER_SIZE_OUT` :ts:cv:`proxy.config.net.sock_recv_buffer_size_out` -:c:macro:`TS_CONFIG_NET_SOCK_SEND_BUFFER_SIZE_OUT` :ts:cv:`proxy.config.net.sock_send_buffer_size_out` -:c:macro:`TS_CONFIG_PARENT_FAILURES_UPDATE_HOSTDB` :ts:cv:`proxy.config.http.parent_proxy.mark_down_hostdb` -:c:macro:`TS_CONFIG_SRV_ENABLED` :ts:cv:`proxy.config.srv_enabled` -:c:macro:`TS_CONFIG_SSL_CLIENT_CERT_FILENAME` :ts:cv:`proxy.config.ssl.client.cert.filename` -:c:macro:`TS_CONFIG_SSL_CERT_FILEPATH` :ts:cv:`proxy.config.ssl.client.cert.path` -:c:macro:`TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_PROPERTIES` :ts:cv:`proxy.config.ssl.client.verify.server.properties` -:c:macro:`TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_POLICY` :ts:cv:`proxy.config.ssl.client.verify.server.policy` -:c:macro:`TS_CONFIG_SSL_CLIENT_SNI_POLICY` :ts:cv:`proxy.config.ssl.client.sni_policy` -:c:macro:`TS_CONFIG_SSL_HSTS_INCLUDE_SUBDOMAINS` :ts:cv:`proxy.config.ssl.hsts_include_subdomains` -:c:macro:`TS_CONFIG_SSL_HSTS_MAX_AGE` :ts:cv:`proxy.config.ssl.hsts_max_age` -:c:macro:`TS_CONFIG_URL_REMAP_PRISTINE_HOST_HDR` :ts:cv:`proxy.config.url_remap.pristine_host_hdr` -:c:macro:`TS_CONFIG_WEBSOCKET_ACTIVE_TIMEOUT` :ts:cv:`proxy.config.websocket.active_timeout` -:c:macro:`TS_CONFIG_WEBSOCKET_NO_ACTIVITY_TIMEOUT` :ts:cv:`proxy.config.websocket.no_activity_timeout` -:c:macro:`TS_CONFIG_SSL_CLIENT_CERT_FILENAME` :ts:cv:`proxy.config.ssl.client.cert.filename` -:c:macro:`TS_CONFIG_SSL_CLIENT_PRIVATE_KEY_FILENAME` :ts:cv:`proxy.config.ssl.client.private_key.filename` -:c:macro:`TS_CONFIG_SSL_CLIENT_CA_CERT_FILENAME` :ts:cv:`proxy.config.ssl.client.CA.cert.filename` -:c:macro:`TS_CONFIG_HTTP_HOST_RESOLUTION_PREFERENCE` :ts:cv:`proxy.config.hostdb.ip_resolve` -================================================================== ==================================================================== +======================================================================== ==================================================================== +TSOverridableConfigKey Value Configuration Value +======================================================================== ==================================================================== +:c:enumerator:`TS_CONFIG_BODY_FACTORY_TEMPLATE_BASE` :ts:cv:`proxy.config.body_factory.template_base` +:c:enumerator:`TS_CONFIG_HTTP_ALLOW_HALF_OPEN` :ts:cv:`proxy.config.http.allow_half_open` +:c:enumerator:`TS_CONFIG_HTTP_ALLOW_MULTI_RANGE` :ts:cv:`proxy.config.http.allow_multi_range` +:c:enumerator:`TS_CONFIG_HTTP_ANONYMIZE_INSERT_CLIENT_IP` :ts:cv:`proxy.config.http.insert_client_ip` +:c:enumerator:`TS_CONFIG_HTTP_ANONYMIZE_REMOVE_CLIENT_IP` :ts:cv:`proxy.config.http.anonymize_remove_client_ip` +:c:enumerator:`TS_CONFIG_HTTP_ANONYMIZE_REMOVE_COOKIE` :ts:cv:`proxy.config.http.anonymize_remove_cookie` +:c:enumerator:`TS_CONFIG_HTTP_ANONYMIZE_REMOVE_FROM` :ts:cv:`proxy.config.http.anonymize_remove_from` +:c:enumerator:`TS_CONFIG_HTTP_ANONYMIZE_REMOVE_REFERER` :ts:cv:`proxy.config.http.anonymize_remove_referer` +:c:enumerator:`TS_CONFIG_HTTP_ANONYMIZE_REMOVE_USER_AGENT` :ts:cv:`proxy.config.http.anonymize_remove_user_agent` +:c:enumerator:`TS_CONFIG_HTTP_ATTACH_SERVER_SESSION_TO_CLIENT` :ts:cv:`proxy.config.http.attach_server_session_to_client` +:c:enumerator:`TS_CONFIG_HTTP_MAX_PROXY_CYCLES` :ts:cv:`proxy.config.http.max_proxy_cycles` +:c:enumerator:`TS_CONFIG_HTTP_AUTH_SERVER_SESSION_PRIVATE` :ts:cv:`proxy.config.http.auth_server_session_private` +:c:enumerator:`TS_CONFIG_HTTP_BACKGROUND_FILL_ACTIVE_TIMEOUT` :ts:cv:`proxy.config.http.background_fill_active_timeout` +:c:enumerator:`TS_CONFIG_HTTP_BACKGROUND_FILL_COMPLETED_THRESHOLD` :ts:cv:`proxy.config.http.background_fill_completed_threshold` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_CACHE_RESPONSES_TO_COOKIES` :ts:cv:`proxy.config.http.cache.cache_responses_to_cookies` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_CACHE_URLS_THAT_LOOK_DYNAMIC` :ts:cv:`proxy.config.http.cache.cache_urls_that_look_dynamic` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_GENERATION` :ts:cv:`proxy.config.http.cache.generation` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_GUARANTEED_MAX_LIFETIME` :ts:cv:`proxy.config.http.cache.guaranteed_max_lifetime` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_GUARANTEED_MIN_LIFETIME` :ts:cv:`proxy.config.http.cache.guaranteed_min_lifetime` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_HEURISTIC_LM_FACTOR` :ts:cv:`proxy.config.http.cache.heuristic_lm_factor` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_HEURISTIC_MAX_LIFETIME` :ts:cv:`proxy.config.http.cache.heuristic_max_lifetime` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_HEURISTIC_MIN_LIFETIME` :ts:cv:`proxy.config.http.cache.heuristic_min_lifetime` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_HTTP` :ts:cv:`proxy.config.http.cache.http` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_CHARSET_MISMATCH` :ts:cv:`proxy.config.http.cache.ignore_accept_charset_mismatch` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_ENCODING_MISMATCH` :ts:cv:`proxy.config.http.cache.ignore_accept_encoding_mismatch` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_LANGUAGE_MISMATCH` :ts:cv:`proxy.config.http.cache.ignore_accept_language_mismatch` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_MISMATCH` :ts:cv:`proxy.config.http.cache.ignore_accept_mismatch` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_IGNORE_AUTHENTICATION` :ts:cv:`proxy.config.http.cache.ignore_authentication` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_IGNORE_CLIENT_CC_MAX_AGE` :ts:cv:`proxy.config.http.cache.ignore_client_cc_max_age` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_IGNORE_CLIENT_NO_CACHE` :ts:cv:`proxy.config.http.cache.ignore_client_no_cache` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_IGNORE_SERVER_NO_CACHE` :ts:cv:`proxy.config.http.cache.ignore_server_no_cache` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_IMS_ON_CLIENT_NO_CACHE` :ts:cv:`proxy.config.http.cache.ims_on_client_no_cache` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_MAX_OPEN_READ_RETRIES` :ts:cv:`proxy.config.http.cache.max_open_read_retries` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_MAX_OPEN_WRITE_RETRIES` :ts:cv:`proxy.config.http.cache.max_open_write_retries` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_MAX_STALE_AGE` :ts:cv:`proxy.config.http.cache.max_stale_age` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_OPEN_READ_RETRY_TIME` :ts:cv:`proxy.config.http.cache.open_read_retry_time` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_OPEN_WRITE_FAIL_ACTION` :ts:cv:`proxy.config.http.cache.open_write_fail_action` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_RANGE_LOOKUP` :ts:cv:`proxy.config.http.cache.range.lookup` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_RANGE_WRITE` :ts:cv:`proxy.config.http.cache.range.write` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_REQUIRED_HEADERS` :ts:cv:`proxy.config.http.cache.required_headers` +:c:enumerator:`TS_CONFIG_HTTP_CACHE_WHEN_TO_REVALIDATE` :ts:cv:`proxy.config.http.cache.when_to_revalidate` +:c:enumerator:`TS_CONFIG_HTTP_CHUNKING_ENABLED` :ts:cv:`proxy.config.http.chunking_enabled` +:c:enumerator:`TS_CONFIG_HTTP_CHUNKING_SIZE` :ts:cv:`proxy.config.http.chunking.size` +:c:enumerator:`TS_CONFIG_HTTP_CONNECT_ATTEMPTS_MAX_RETRIES_DEAD_SERVER` :ts:cv:`proxy.config.http.connect_attempts_max_retries_dead_server` +:c:enumerator:`TS_CONFIG_HTTP_CONNECT_ATTEMPTS_MAX_RETRIES` :ts:cv:`proxy.config.http.connect_attempts_max_retries` +:c:enumerator:`TS_CONFIG_HTTP_CONNECT_ATTEMPTS_RR_RETRIES` :ts:cv:`proxy.config.http.connect_attempts_rr_retries` +:c:enumerator:`TS_CONFIG_HTTP_CONNECT_ATTEMPTS_TIMEOUT` :ts:cv:`proxy.config.http.connect_attempts_timeout` +:c:enumerator:`TS_CONFIG_HTTP_DEFAULT_BUFFER_SIZE` :ts:cv:`proxy.config.http.default_buffer_size` +:c:enumerator:`TS_CONFIG_HTTP_DEFAULT_BUFFER_WATER_MARK` :ts:cv:`proxy.config.http.default_buffer_water_mark` +:c:enumerator:`TS_CONFIG_HTTP_DOC_IN_CACHE_SKIP_DNS` :ts:cv:`proxy.config.http.doc_in_cache_skip_dns` +:c:enumerator:`TS_CONFIG_HTTP_DOWN_SERVER_CACHE_TIME` :ts:cv:`proxy.config.http.down_server.cache_time` +:c:enumerator:`TS_CONFIG_HTTP_FLOW_CONTROL_ENABLED` :ts:cv:`proxy.config.http.flow_control.enabled` +:c:enumerator:`TS_CONFIG_HTTP_FLOW_CONTROL_HIGH_WATER_MARK` :ts:cv:`proxy.config.http.flow_control.high_water` +:c:enumerator:`TS_CONFIG_HTTP_FLOW_CONTROL_LOW_WATER_MARK` :ts:cv:`proxy.config.http.flow_control.low_water` +:c:enumerator:`TS_CONFIG_HTTP_FORWARD_CONNECT_METHOD` :ts:cv:`proxy.config.http.forward_connect_method` +:c:enumerator:`TS_CONFIG_HTTP_FORWARD_PROXY_AUTH_TO_PARENT` :ts:cv:`proxy.config.http.forward.proxy_auth_to_parent` +:c:enumerator:`TS_CONFIG_HTTP_GLOBAL_USER_AGENT_HEADER` :ts:cv:`proxy.config.http.global_user_agent_header` +:c:enumerator:`TS_CONFIG_HTTP_INSERT_AGE_IN_RESPONSE` :ts:cv:`proxy.config.http.insert_age_in_response` +:c:enumerator:`TS_CONFIG_HTTP_INSERT_FORWARDED` :ts:cv:`proxy.config.http.insert_forwarded` +:c:enumerator:`TS_CONFIG_HTTP_INSERT_REQUEST_VIA_STR` :ts:cv:`proxy.config.http.insert_request_via_str` +:c:enumerator:`TS_CONFIG_HTTP_INSERT_RESPONSE_VIA_STR` :ts:cv:`proxy.config.http.insert_response_via_str` +:c:enumerator:`TS_CONFIG_HTTP_INSERT_SQUID_X_FORWARDED_FOR` :ts:cv:`proxy.config.http.insert_squid_x_forwarded_for` +:c:enumerator:`TS_CONFIG_HTTP_KEEP_ALIVE_ENABLED_IN` :ts:cv:`proxy.config.http.keep_alive_enabled_in` +:c:enumerator:`TS_CONFIG_HTTP_KEEP_ALIVE_ENABLED_OUT` :ts:cv:`proxy.config.http.keep_alive_enabled_out` +:c:enumerator:`TS_CONFIG_HTTP_KEEP_ALIVE_NO_ACTIVITY_TIMEOUT_IN` :ts:cv:`proxy.config.http.keep_alive_no_activity_timeout_in` +:c:enumerator:`TS_CONFIG_HTTP_KEEP_ALIVE_NO_ACTIVITY_TIMEOUT_OUT` :ts:cv:`proxy.config.http.keep_alive_no_activity_timeout_out` +:c:enumerator:`TS_CONFIG_HTTP_KEEP_ALIVE_POST_OUT` :ts:cv:`proxy.config.http.keep_alive_post_out` +:c:enumerator:`TS_CONFIG_HTTP_NEGATIVE_CACHING_ENABLED` :ts:cv:`proxy.config.http.negative_caching_enabled` +:c:enumerator:`TS_CONFIG_HTTP_NEGATIVE_CACHING_LIFETIME` :ts:cv:`proxy.config.http.negative_caching_lifetime` +:c:enumerator:`TS_CONFIG_HTTP_NEGATIVE_REVALIDATING_ENABLED` :ts:cv:`proxy.config.http.negative_revalidating_enabled` +:c:enumerator:`TS_CONFIG_HTTP_NEGATIVE_REVALIDATING_LIFETIME` :ts:cv:`proxy.config.http.negative_revalidating_lifetime` +:c:enumerator:`TS_CONFIG_HTTP_NORMALIZE_AE` :ts:cv:`proxy.config.http.normalize_ae` +:c:enumerator:`TS_CONFIG_HTTP_NUMBER_OF_REDIRECTIONS` :ts:cv:`proxy.config.http.number_of_redirections` +:c:enumerator:`TS_CONFIG_HTTP_PARENT_PROXY_FAIL_THRESHOLD` :ts:cv:`proxy.config.http.parent_proxy.fail_threshold` +:c:enumerator:`TS_CONFIG_HTTP_PARENT_PROXY_RETRY_TIME` :ts:cv:`proxy.config.http.parent_proxy.retry_time` +:c:enumerator:`TS_CONFIG_HTTP_PARENT_PROXY_TOTAL_CONNECT_ATTEMPTS` :ts:cv:`proxy.config.http.parent_proxy.total_connect_attempts` +:c:enumerator:`TS_CONFIG_HTTP_PER_PARENT_CONNECT_ATTEMPTS` :ts:cv:`proxy.config.http.parent_proxy.per_parent_connect_attempts` +:c:enumerator:`TS_CONFIG_HTTP_PER_SERVER_CONNECTION_MATCH` :ts:cv:`proxy.config.http.per_server.connection.match` +:c:enumerator:`TS_CONFIG_HTTP_PER_SERVER_CONNECTION_MAX` :ts:cv:`proxy.config.http.per_server.connection.max` +:c:enumerator:`TS_CONFIG_HTTP_POST_CHECK_CONTENT_LENGTH_ENABLED` :ts:cv:`proxy.config.http.post.check.content_length.enabled` +:c:enumerator:`TS_CONFIG_HTTP_REDIRECT_USE_ORIG_CACHE_KEY` :ts:cv:`proxy.config.http.redirect_use_orig_cache_key` +:c:enumerator:`TS_CONFIG_HTTP_REQUEST_BUFFER_ENABLED` :ts:cv:`proxy.config.http.request_buffer_enabled` +:c:enumerator:`TS_CONFIG_HTTP_REQUEST_HEADER_MAX_SIZE` :ts:cv:`proxy.config.http.request_header_max_size` +:c:enumerator:`TS_CONFIG_HTTP_RESPONSE_HEADER_MAX_SIZE` :ts:cv:`proxy.config.http.response_header_max_size` +:c:enumerator:`TS_CONFIG_HTTP_RESPONSE_SERVER_ENABLED` :ts:cv:`proxy.config.http.response_server_enabled` +:c:enumerator:`TS_CONFIG_HTTP_RESPONSE_SERVER_STR` :ts:cv:`proxy.config.http.response_server_str` +:c:enumerator:`TS_CONFIG_HTTP_SEND_HTTP11_REQUESTS` :ts:cv:`proxy.config.http.send_http11_requests` +:c:enumerator:`TS_CONFIG_HTTP_SERVER_SESSION_SHARING_MATCH` :ts:cv:`proxy.config.http.server_session_sharing.match` +:c:enumerator:`TS_CONFIG_HTTP_SLOW_LOG_THRESHOLD` :ts:cv:`proxy.config.http.slow.log.threshold` +:c:enumerator:`TS_CONFIG_HTTP_TRANSACTION_ACTIVE_TIMEOUT_IN` :ts:cv:`proxy.config.http.transaction_active_timeout_in` +:c:enumerator:`TS_CONFIG_HTTP_TRANSACTION_ACTIVE_TIMEOUT_OUT` :ts:cv:`proxy.config.http.transaction_active_timeout_out` +:c:enumerator:`TS_CONFIG_HTTP_TRANSACTION_NO_ACTIVITY_TIMEOUT_IN` :ts:cv:`proxy.config.http.transaction_no_activity_timeout_in` +:c:enumerator:`TS_CONFIG_HTTP_TRANSACTION_NO_ACTIVITY_TIMEOUT_OUT` :ts:cv:`proxy.config.http.transaction_no_activity_timeout_out` +:c:enumerator:`TS_CONFIG_HTTP_UNCACHEABLE_REQUESTS_BYPASS_PARENT` :ts:cv:`proxy.config.http.uncacheable_requests_bypass_parent` +:c:enumerator:`TS_CONFIG_NET_SOCK_OPTION_FLAG_OUT` :ts:cv:`proxy.config.net.sock_option_flag_out` +:c:enumerator:`TS_CONFIG_NET_SOCK_PACKET_MARK_OUT` :ts:cv:`proxy.config.net.sock_packet_mark_out` +:c:enumerator:`TS_CONFIG_NET_SOCK_PACKET_TOS_OUT` :ts:cv:`proxy.config.net.sock_packet_tos_out` +:c:enumerator:`TS_CONFIG_NET_SOCK_RECV_BUFFER_SIZE_OUT` :ts:cv:`proxy.config.net.sock_recv_buffer_size_out` +:c:enumerator:`TS_CONFIG_NET_SOCK_SEND_BUFFER_SIZE_OUT` :ts:cv:`proxy.config.net.sock_send_buffer_size_out` +:c:enumerator:`TS_CONFIG_PARENT_FAILURES_UPDATE_HOSTDB` :ts:cv:`proxy.config.http.parent_proxy.mark_down_hostdb` +:c:enumerator:`TS_CONFIG_SRV_ENABLED` :ts:cv:`proxy.config.srv_enabled` +:c:enumerator:`TS_CONFIG_SSL_CLIENT_CERT_FILENAME` :ts:cv:`proxy.config.ssl.client.cert.filename` +:c:enumerator:`TS_CONFIG_SSL_CERT_FILEPATH` :ts:cv:`proxy.config.ssl.client.cert.path` +:c:enumerator:`TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_PROPERTIES` :ts:cv:`proxy.config.ssl.client.verify.server.properties` +:c:enumerator:`TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_POLICY` :ts:cv:`proxy.config.ssl.client.verify.server.policy` +:c:enumerator:`TS_CONFIG_SSL_CLIENT_SNI_POLICY` :ts:cv:`proxy.config.ssl.client.sni_policy` +:c:enumerator:`TS_CONFIG_SSL_HSTS_INCLUDE_SUBDOMAINS` :ts:cv:`proxy.config.ssl.hsts_include_subdomains` +:c:enumerator:`TS_CONFIG_SSL_HSTS_MAX_AGE` :ts:cv:`proxy.config.ssl.hsts_max_age` +:c:enumerator:`TS_CONFIG_URL_REMAP_PRISTINE_HOST_HDR` :ts:cv:`proxy.config.url_remap.pristine_host_hdr` +:c:enumerator:`TS_CONFIG_WEBSOCKET_ACTIVE_TIMEOUT` :ts:cv:`proxy.config.websocket.active_timeout` +:c:enumerator:`TS_CONFIG_WEBSOCKET_NO_ACTIVITY_TIMEOUT` :ts:cv:`proxy.config.websocket.no_activity_timeout` +:c:enumerator:`TS_CONFIG_SSL_CLIENT_CERT_FILENAME` :ts:cv:`proxy.config.ssl.client.cert.filename` +:c:enumerator:`TS_CONFIG_SSL_CLIENT_PRIVATE_KEY_FILENAME` :ts:cv:`proxy.config.ssl.client.private_key.filename` +:c:enumerator:`TS_CONFIG_SSL_CLIENT_CA_CERT_FILENAME` :ts:cv:`proxy.config.ssl.client.CA.cert.filename` +:c:enumerator:`TS_CONFIG_HTTP_HOST_RESOLUTION_PREFERENCE` :ts:cv:`proxy.config.hostdb.ip_resolve` +======================================================================== ==================================================================== Examples ======== diff --git a/doc/developer-guide/api/functions/TSHttpSsnIdGet.en.rst b/doc/developer-guide/api/functions/TSHttpSsnIdGet.en.rst index 23ee8b2bf34..08e6d4a8191 100644 --- a/doc/developer-guide/api/functions/TSHttpSsnIdGet.en.rst +++ b/doc/developer-guide/api/functions/TSHttpSsnIdGet.en.rst @@ -38,7 +38,7 @@ Description Return Values ============= -Returns a :type:`int64_t` as the unique ID +Returns a :code:`int64_t` as the unique ID See also ======== diff --git a/doc/developer-guide/api/functions/TSHttpTxnInfoIntGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnInfoIntGet.en.rst index f2899660c65..0f7c2716808 100644 --- a/doc/developer-guide/api/functions/TSHttpTxnInfoIntGet.en.rst +++ b/doc/developer-guide/api/functions/TSHttpTxnInfoIntGet.en.rst @@ -37,34 +37,34 @@ requested info. For example, cache related info may be available only at or afte The :c:type:`TSHttpTxnInfoKey` currently supports the below integer-based info about a transaction -.. c:type:: TSHttpTxnInfoKey +.. c:enum:: TSHttpTxnInfoKey - .. c:member:: TS_TXN_INFO_CACHE_HIT_RAM + .. c:enumerator:: TS_TXN_INFO_CACHE_HIT_RAM - This info is available at or after :c:member:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook. A value of :literal:`1` indicates that the response + This info is available at or after :c:macro:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` hook. A value of :literal:`1` indicates that the response is returned from RAM cache. A value of :literal:`0` indicates otherwise. - .. c:member:: TS_TXN_INFO_CACHE_COMPRESSED_IN_RAM + .. c:enumerator:: 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 + This info is available at or after :c:macro:`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:member:: TS_TXN_INFO_CACHE_HIT_RWW + .. c:enumerator:: 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:member:: TS_TXN_INFO_CACHE_OPEN_READ_TRIES + .. c:enumerator:: 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:member:: TS_TXN_INFO_CACHE_OPEN_WRITE_TRIES + .. c:enumerator:: 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:member:: TS_TXN_INFO_CACHE_VOLUME + .. c:enumerator:: 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. diff --git a/doc/developer-guide/api/functions/TSHttpTxnIsInternal.en.rst b/doc/developer-guide/api/functions/TSHttpTxnIsInternal.en.rst index a3dd6757d51..68f86ee1e0c 100644 --- a/doc/developer-guide/api/functions/TSHttpTxnIsInternal.en.rst +++ b/doc/developer-guide/api/functions/TSHttpTxnIsInternal.en.rst @@ -24,7 +24,7 @@ Test whether a request is internally-generated. Synopsis ======== -.. code-block:: cpp +.. code-block:: c #include @@ -43,7 +43,7 @@ was originated within Traffic Server. Return Values ============= -Both these APIs return a :type:`int`, indicating whether the +Both these APIs return a :code:`int`, indicating whether the request was internal (:literal:`1`) or not (:literal:`0`). Examples diff --git a/doc/developer-guide/api/functions/TSHttpTxnMilestoneGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnMilestoneGet.en.rst index 2cebf100115..a55ec21b529 100644 --- a/doc/developer-guide/api/functions/TSHttpTxnMilestoneGet.en.rst +++ b/doc/developer-guide/api/functions/TSHttpTxnMilestoneGet.en.rst @@ -42,105 +42,105 @@ lifetime of a transaction and are measured in nanoseconds from the beginning of the transaction. :arg:`time` is used a pointer to storage to update if the call is successful. -.. type:: TSMilestonesType +.. enum:: TSMilestonesType - An enumeration of the valid indices of transaction milestone data. + An enumeration of the valid indices of transaction milestone data. - .. macro:: TS_MILESTONE_SM_START + .. enumerator:: TS_MILESTONE_SM_START - Transaction state machine is initialized. + Transaction state machine is initialized. - .. macro:: TS_MILESTONE_UA_BEGIN + .. enumerator:: TS_MILESTONE_UA_BEGIN - The client connection is accepted. + The client connection is accepted. - .. macro:: TS_MILESTONE_UA_READ_HEADER_DONE + .. enumerator:: TS_MILESTONE_UA_READ_HEADER_DONE - The request header from the client has been read and parsed. + The request header from the client has been read and parsed. - .. macro:: TS_MILESTONE_CACHE_OPEN_READ_BEGIN + .. enumerator:: TS_MILESTONE_CACHE_OPEN_READ_BEGIN - Initiate read of the cache. + Initiate read of the cache. - .. macro:: TS_MILESTONE_CACHE_OPEN_READ_END + .. enumerator:: TS_MILESTONE_CACHE_OPEN_READ_END - Initial cache read has resolved. + Initial cache read has resolved. - .. macro:: TS_MILESTONE_CACHE_OPEN_WRITE_BEGIN + .. enumerator:: TS_MILESTONE_CACHE_OPEN_WRITE_BEGIN - Start open for cache write. + Start open for cache write. - .. macro:: TS_MILESTONE_CACHE_OPEN_WRITE_END + .. enumerator:: TS_MILESTONE_CACHE_OPEN_WRITE_END - Cache has been opened for write. + Cache has been opened for write. - .. macro:: TS_MILESTONE_DNS_LOOKUP_BEGIN + .. enumerator:: TS_MILESTONE_DNS_LOOKUP_BEGIN - Initiate host resolution in HostDB + Initiate host resolution in HostDB - .. macro:: TS_MILESTONE_DNS_LOOKUP_END + .. enumerator:: TS_MILESTONE_DNS_LOOKUP_END - Host resolution resolves. + Host resolution resolves. - .. macro:: TS_MILESTONE_SERVER_FIRST_CONNECT + .. enumerator:: TS_MILESTONE_SERVER_FIRST_CONNECT - First time origin server connect attempted or shared session attached. + First time origin server connect attempted or shared session attached. - .. macro:: TS_MILESTONE_SERVER_CONNECT + .. enumerator:: TS_MILESTONE_SERVER_CONNECT - Most recent time origin server connect attempted or shared session attached. + Most recent time origin server connect attempted or shared session attached. - .. macro:: TS_MILESTONE_SERVER_CONNECT_END + .. enumerator:: TS_MILESTONE_SERVER_CONNECT_END - More recent time a connection attempt was resolved. + More recent time a connection attempt was resolved. - .. macro:: TS_MILESTONE_SERVER_BEGIN_WRITE + .. enumerator:: TS_MILESTONE_SERVER_BEGIN_WRITE - First byte is written to the origin server connection. + First byte is written to the origin server connection. - .. macro:: TS_MILESTONE_SERVER_FIRST_READ + .. enumerator:: TS_MILESTONE_SERVER_FIRST_READ - First byte is read from connection to origin server. + First byte is read from connection to origin server. - .. macro:: TS_MILESTONE_SERVER_READ_HEADER_DONE + .. enumerator:: TS_MILESTONE_SERVER_READ_HEADER_DONE - Origin server response has been read and parsed. + Origin server response has been read and parsed. - .. macro:: TS_MILESTONE_UA_BEGIN_WRITE + .. enumerator:: TS_MILESTONE_UA_BEGIN_WRITE - The response header write to the client starts. + The response header write to the client starts. - .. macro:: TS_MILESTONE_SERVER_CLOSE + .. enumerator:: TS_MILESTONE_SERVER_CLOSE - Last I/O activity on origin server connection. + Last I/O activity on origin server connection. - .. macro:: TS_MILESTONE_UA_CLOSE + .. enumerator:: TS_MILESTONE_UA_CLOSE - Last I/O activity on the client socket, or connection abort. + Last I/O activity on the client socket, or connection abort. - .. macro:: TS_MILESTONE_SM_FINISH + .. enumerator:: TS_MILESTONE_SM_FINISH - Transaction has finished, state machine final logging has started. + Transaction has finished, state machine final logging has started. - .. macro:: TS_MILESTONE_PLUGIN_ACTIVE + .. enumerator:: TS_MILESTONE_PLUGIN_ACTIVE - Amount of time plugins were active (running plugin code). + Amount of time plugins were active (running plugin code). - .. macro:: TS_MILESTONE_PLUGIN_TOTAL + .. enumerator:: TS_MILESTONE_PLUGIN_TOTAL - Amount of time spent in or waiting for plugins. + Amount of time spent in or waiting for plugins. - .. macro:: TS_MILESTONE_TLS_HANDSHAKE_START + .. enumerator:: TS_MILESTONE_TLS_HANDSHAKE_START Timestamp when the server starts the TLS handshake. 0 if no handshake is performed (connection reuse). - .. macro:: TS_MILESTONE_TLS_HANDSHAKE_END + .. enumerator:: TS_MILESTONE_TLS_HANDSHAKE_END Timestamp when the server completes the TLS handshake. 0 if no handshake is performed (connection reuse). - .. macro:: TS_MILESTONE_LAST_ENTRY + .. enumerator:: TS_MILESTONE_LAST_ENTRY - A pseudo index which is set to be one more than the last valid index. This is useful for looping over the data. + A pseudo index which is set to be one more than the last valid index. This is useful for looping over the data. * The server connect times predate the transmission of the :literal:`SYN` diff --git a/doc/developer-guide/api/functions/TSLifecycleHookAdd.en.rst b/doc/developer-guide/api/functions/TSLifecycleHookAdd.en.rst index 49e4b33d3d1..423abe18b40 100644 --- a/doc/developer-guide/api/functions/TSLifecycleHookAdd.en.rst +++ b/doc/developer-guide/api/functions/TSLifecycleHookAdd.en.rst @@ -26,7 +26,7 @@ TSLifecycleHookAdd Synopsis ======== -.. code-block:: cpp +.. code-block:: c #include @@ -112,21 +112,21 @@ Types Invoked with the event :c:data:`TS_EVENT_LIFECYCLE_SHUTDOWN` and ``NULL`` data. -.. c:type:: TSPluginMsg +.. c:struct:: TSPluginMsg - The format of the data for the plugin message event :c:data:`TS_EVENT_LIFECYCLE_MSG`. + The data for the plugin message event :c:data:`TS_EVENT_LIFECYCLE_MSG`. -.. c:member:: const char * TSPluginMsg::tag + .. c:var:: const char * tag - The tag of the message. This is a null terminated string. + The tag of the message. This is a null terminated string. -.. c:member:: const void * TSPluginMsg::data + .. c:var:: const void * data - Message data (payload). This is a raw slab of bytes - no structure is guaranteed. + Message data (payload). This is a raw slab of bytes - no structure is guaranteed. -.. c:member:: size_t TSPluginMsg::data_size + .. c:var:: size_t data_size - The size of :member:`TSPluginMsg::data`. + The number of valid bytes pointed at by :var:`TSPluginMsg.data`. Ordering ======== diff --git a/doc/developer-guide/api/functions/TSRemap.en.rst b/doc/developer-guide/api/functions/TSRemap.en.rst index 1d7e52ac022..b21989aef39 100644 --- a/doc/developer-guide/api/functions/TSRemap.en.rst +++ b/doc/developer-guide/api/functions/TSRemap.en.rst @@ -26,7 +26,7 @@ Traffic Server remap plugin entry points. Synopsis ======== -.. code-block:: cpp +.. code-block:: c #include #include @@ -89,45 +89,45 @@ For further information, see :ref:`developer-plugins-remap`. Types ===== -.. type:: TSRemapStatus +.. enum:: TSRemapStatus - Status return value for remap callback. + Status return value for remap callback. - .. macro:: TSREMAP_DID_REMAP + .. enumerator:: TSREMAP_DID_REMAP - The remap callback modified the request. + The remap callback modified the request. - .. macro:: TSREMAP_DID_REMAP_STOP + .. enumerator:: TSREMAP_DID_REMAP_STOP - The remap callback modified the request and that no more remapping callbacks should be invoked. + The remap callback modified the request and that no more remapping callbacks should be invoked. - .. macro:: TSREMAP_NO_REMAP + .. enumerator:: TSREMAP_NO_REMAP - The remap callback did not modify the request. + The remap callback did not modify the request. - .. macro:: TSREMAP_NO_REMAP_STOP + .. enumerator:: TSREMAP_NO_REMAP_STOP - The remap callback did not modify the request and that no further remapping - callbacks should be invoked. + The remap callback did not modify the request and that no further remapping + callbacks should be invoked. - .. macro:: TSREMAP_ERROR + .. enumerator:: TSREMAP_ERROR - The remapping attempt in general failed and the transaction should fail with an - error return to the user agent. + The remapping attempt in general failed and the transaction should fail with an + error return to the user agent. -.. type:: TSRemapReloadStatus +.. enum:: TSRemapReloadStatus - .. macro:: TSREMAP_CONFIG_RELOAD_FAILURE + .. enumerator:: TSREMAP_CONFIG_RELOAD_FAILURE - Notify the plugin that configuration parsing failed. + Notify the plugin that configuration parsing failed. - .. macro:: TSREMAP_CONFIG_RELOAD_SUCCESS_PLUGIN_USED + .. enumerator:: TSREMAP_CONFIG_RELOAD_SUCCESS_PLUGIN_USED - Configuration parsing succeeded and plugin was used by the new configuration. + Configuration parsing succeeded and plugin was used by the new configuration. - .. macro:: TSREMAP_CONFIG_RELOAD_SUCCESS_PLUGIN_UNUSED + .. enumerator:: TSREMAP_CONFIG_RELOAD_SUCCESS_PLUGIN_UNUSED - Configuration parsing succeeded but plugin was NOT used by the new configuration. + Configuration parsing succeeded but plugin was NOT used by the new configuration. Return Values ============= diff --git a/doc/developer-guide/api/functions/TSStat.en.rst b/doc/developer-guide/api/functions/TSStat.en.rst index 2988bc17cef..fe3c6a59f11 100644 --- a/doc/developer-guide/api/functions/TSStat.en.rst +++ b/doc/developer-guide/api/functions/TSStat.en.rst @@ -28,7 +28,7 @@ in contrast to processing log files. Synopsis ======== -.. code-block:: cpp +.. code-block:: c #include @@ -49,10 +49,10 @@ Description A plugin statistic is created by :func:`TSStatCreate`. The :arg:`name` must be globally unique and should follow the standard dotted tag form. To avoid collisions and for easy of use the first tag should be the plugin name or something easily derived from it. Currently only integers are supported -therefore :arg:`type` must be :macro:`TS_RECORDDATATYPE_INT`. The return value is the index of the -statistic. In general this should work but if it doesn't it will :code:`assert`. In particular, -creating the same statistic twice will fail in this way, which can happen if statistics are created -as part of or based on configuration files and |TS| is reloaded. +therefore :arg:`type` must be :enumerator:`~TSRecordDataType.TS_RECORDDATATYPE_INT`. The return value is +the index of the statistic. In general this should work but if it doesn't it will :code:`assert`. In +particular, creating the same statistic twice will fail in this way, which can happen if statistics +are created as part of or based on configuration files and |TS| is reloaded. :func:`TSStatFindName` locates a statistic by :arg:`name`. If found the function returns :const:`TS_SUCCESS` and the value pointed at by :arg:`idx_ptr` is updated to be the index of the @@ -65,7 +65,8 @@ decrease it by :arg:`value`. A group of records can be examined via :func:`TSRecordDump`. A set of records is specified and the iterated over. For each record in the set the callbac :arg:`callback` is invoked. -The records are specified by the :c:type:`TSRecordType`. This this is :c:macro:`TS_RECORDTYPE_NULL` then all records are examined. The callback is passed +The records are specified by the :enum:`TSRecordType`. If this is +:enumerator:`~TSRecordType.TS_RECORDTYPE_NULL` then all records are examined. The callback is passed :arg:`type` The record type. diff --git a/doc/developer-guide/api/functions/TSTypes.en.rst b/doc/developer-guide/api/functions/TSTypes.en.rst index 67257edf74f..0c5cfee20fb 100644 --- a/doc/developer-guide/api/functions/TSTypes.en.rst +++ b/doc/developer-guide/api/functions/TSTypes.en.rst @@ -221,11 +221,11 @@ more widely. Those are described on this page. An enum for the supported types of user arguments. -.. type:: TSUuidVersion +.. enum:: TSUuidVersion A version value for at :type:`TSUuid`. - .. member:: TS_UUID_V4 + .. enumerator:: TS_UUID_V4 A version 4 UUID. Currently only this value is used. diff --git a/doc/developer-guide/api/types/TSHttpHookID.en.rst b/doc/developer-guide/api/types/TSHttpHookID.en.rst index 02715b2b48a..3033d956bc3 100644 --- a/doc/developer-guide/api/types/TSHttpHookID.en.rst +++ b/doc/developer-guide/api/types/TSHttpHookID.en.rst @@ -28,73 +28,73 @@ Synopsis #include -.. c:type:: TSHttpHookID - Enum typedef defining the possible :ref:`developer-plugins-hooks` for setting up :ref:`developer-plugins-continuations` callbacks. Enumeration Members =================== -.. c:macro:: TSHttpHookID TS_HTTP_READ_REQUEST_HDR_HOOK +.. c:enum:: TSHttpHookID + + .. c:enumerator:: TS_HTTP_READ_REQUEST_HDR_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_OS_DNS_HOOK + .. c:enumerator:: TS_HTTP_OS_DNS_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_SEND_REQUEST_HDR_HOOK + .. c:enumerator:: TS_HTTP_SEND_REQUEST_HDR_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_READ_CACHE_HDR_HOOK + .. c:enumerator:: TS_HTTP_READ_CACHE_HDR_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_READ_RESPONSE_HDR_HOOK + .. c:enumerator:: TS_HTTP_READ_RESPONSE_HDR_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_SEND_RESPONSE_HDR_HOOK + .. c:enumerator:: TS_HTTP_SEND_RESPONSE_HDR_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_REQUEST_TRANSFORM_HOOK + .. c:enumerator:: TS_HTTP_REQUEST_TRANSFORM_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_RESPONSE_TRANSFORM_HOOK + .. c:enumerator:: TS_HTTP_RESPONSE_TRANSFORM_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_SELECT_ALT_HOOK + .. c:enumerator:: TS_HTTP_SELECT_ALT_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_TXN_START_HOOK + .. c:enumerator:: TS_HTTP_TXN_START_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_TXN_CLOSE_HOOK + .. c:enumerator:: TS_HTTP_TXN_CLOSE_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_SSN_START_HOOK + .. c:enumerator:: TS_HTTP_SSN_START_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_SSN_CLOSE_HOOK + .. c:enumerator:: TS_HTTP_SSN_CLOSE_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK + .. c:enumerator:: TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_PRE_REMAP_HOOK + .. c:enumerator:: TS_HTTP_PRE_REMAP_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_POST_REMAP_HOOK + .. c:enumerator:: TS_HTTP_POST_REMAP_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_RESPONSE_CLIENT_HOOK + .. c:enumerator:: TS_HTTP_RESPONSE_CLIENT_HOOK -.. c:macro:: TSHttpHookID TS_SSL_FIRST_HOOK + .. c:enumerator:: TS_SSL_FIRST_HOOK -.. c:macro:: TSHttpHookID TS_VCONN_START_HOOK + .. c:enumerator:: TS_VCONN_START_HOOK -.. c:macro:: TSHttpHookID TS_VCONN_OUTBOUND_START_HOOK + .. c:enumerator:: TS_VCONN_OUTBOUND_START_HOOK -.. c:macro:: TSHttpHookID TS_VCONN_CLOSE_HOOK + .. c:enumerator:: TS_VCONN_CLOSE_HOOK -.. c:macro:: TSHttpHookID TS_VCONN_OUTBOUND_CLOSE_HOOK + .. c:enumerator:: TS_VCONN_OUTBOUND_CLOSE_HOOK -.. c:macro:: TSHttpHookID TS_SSL_CLIENT_HELLO_HOOK + .. c:enumerator:: TS_SSL_CLIENT_HELLO_HOOK -.. c:macro:: TSHttpHookID TS_SSL_SNI_HOOK + .. c:enumerator:: TS_SSL_SNI_HOOK -.. c:macro:: TSHttpHookID TS_SSL_CERT_HOOK + .. c:enumerator:: TS_SSL_CERT_HOOK -.. c:macro:: TSHttpHookID TS_SSL_SERVERNAME_HOOK + .. c:enumerator:: TS_SSL_SERVERNAME_HOOK -.. c:macro:: TSHttpHookID TS_SSL_VERIFY_CLIENT_HOOK + .. c:enumerator:: TS_SSL_VERIFY_CLIENT_HOOK -.. c:macro:: TSHttpHookID TS_SSL_VERIFY_SERVER_HOOK + .. c:enumerator:: TS_SSL_VERIFY_SERVER_HOOK -.. c:macro:: TSHttpHookID TS_SSL_LAST_HOOK + .. c:enumerator:: TS_SSL_LAST_HOOK -.. c:macro:: TSHttpHookID TS_HTTP_LAST_HOOK + .. c:enumerator:: TS_HTTP_LAST_HOOK Description =========== diff --git a/doc/developer-guide/api/types/TSMgmtTypes.en.rst b/doc/developer-guide/api/types/TSMgmtTypes.en.rst index 6e18fd974ad..40526f1a385 100644 --- a/doc/developer-guide/api/types/TSMgmtTypes.en.rst +++ b/doc/developer-guide/api/types/TSMgmtTypes.en.rst @@ -86,94 +86,93 @@ OpTypes Possible operations or messages that can be sent between TM and remote clients. -.. cpp:type:: OpType +.. cpp:enum:: OpType -.. c:macro:: RECORD_SET + .. cpp:enumerator:: RECORD_SET -.. c:macro:: RECORD_GET + .. cpp:enumerator:: RECORD_GET -.. c:macro:: PROXY_STATE_GET + .. cpp:enumerator:: PROXY_STATE_GET -.. c:macro:: PROXY_STATE_SET + .. cpp:enumerator:: PROXY_STATE_SET -.. c:macro:: RECONFIGURE + .. cpp:enumerator:: RECONFIGURE -.. c:macro:: RESTART + .. cpp:enumerator:: RESTART -.. c:macro:: BOUNCE + .. cpp:enumerator:: BOUNCE -.. c:macro:: EVENT_RESOLVE + .. cpp:enumerator:: EVENT_RESOLVE -.. c:macro:: EVENT_GET_MLT + .. cpp:enumerator:: EVENT_GET_MLT -.. c:macro:: EVENT_ACTIVE + .. cpp:enumerator:: EVENT_ACTIVE -.. c:macro:: EVENT_REG_CALLBACK, + .. cpp:enumerator:: EVENT_REG_CALLBACK -.. c:macro:: EVENT_UNREG_CALLBACK + .. cpp:enumerator:: EVENT_UNREG_CALLBACK -.. c:macro:: EVENT_NOTIFY + .. cpp:enumerator:: EVENT_NOTIFY -.. c:macro:: STATS_RESET_NODE + .. cpp:enumerator:: STATS_RESET_NODE -.. c:macro:: STORAGE_DEVICE_CMD_OFFLINE + .. cpp:enumerator:: STORAGE_DEVICE_CMD_OFFLINE -.. c:macro:: RECORD_MATCH_GET + .. cpp:enumerator:: RECORD_MATCH_GET -.. c:macro:: API_PING + .. cpp:enumerator:: API_PING -.. c:macro:: SERVER_BACKTRACE + .. cpp:enumerator:: SERVER_BACKTRACE -.. c:macro:: RECORD_DESCRIBE_CONFIG + .. cpp:enumerator:: RECORD_DESCRIBE_CONFIG -.. c:macro:: LIFECYCLE_MESSAGE + .. cpp:enumerator:: LIFECYCLE_MESSAGE -.. c:macro:: UNDEFINED_OP + .. cpp:enumerator:: UNDEFINED_OP TSMgmtError =========== -.. cpp:type:: TSMgmtError +.. cpp:enum:: TSMgmtError -.. c:macro:: TS_ERR_OKAY + .. cpp:enumerator:: TS_ERR_OKAY -.. c:macro:: TS_ERR_READ_FILE + .. cpp:enumerator:: TS_ERR_READ_FILE -.. c:macro:: TS_ERR_WRITE_FILE + .. cpp:enumerator:: TS_ERR_WRITE_FILE -.. c:macro:: TS_ERR_PARSE_CONFIG_RULE + .. cpp:enumerator:: TS_ERR_PARSE_CONFIG_RULE -.. c:macro:: TS_ERR_INVALID_CONFIG_RULE + .. cpp:enumerator:: TS_ERR_INVALID_CONFIG_RULE -.. c:macro:: TS_ERR_NET_ESTABLISH + .. cpp:enumerator:: TS_ERR_NET_ESTABLISH -.. c:macro:: TS_ERR_NET_READ + .. cpp:enumerator:: TS_ERR_NET_READ -.. c:macro:: TS_ERR_NET_WRITE + .. cpp:enumerator:: TS_ERR_NET_WRITE -.. c:macro:: TS_ERR_NET_EOF + .. cpp:enumerator:: TS_ERR_NET_EOF -.. c:macro:: TS_ERR_NET_TIMEOUT + .. cpp:enumerator:: TS_ERR_NET_TIMEOUT -.. c:macro:: TS_ERR_SYS_CALL + .. cpp:enumerator:: TS_ERR_SYS_CALL -.. c:macro:: TS_ERR_PARAMS + .. cpp:enumerator:: TS_ERR_PARAMS -.. c:macro:: TS_ERR_NOT_SUPPORTED + .. cpp:enumerator:: TS_ERR_NOT_SUPPORTED -.. c:macro:: TS_ERR_PERMISSION_DENIED - -.. c:macro:: TS_ERR_FAIL + .. cpp:enumerator:: TS_ERR_PERMISSION_DENIED + .. cpp:enumerator:: TS_ERR_FAIL MgmtMarshallType ================ -.. cpp:type:: MgmtMarshallType +.. cpp:enum:: MgmtMarshallType -.. c:macro:: MGMT_MARSHALL_INT + .. cpp:enumerator:: MGMT_MARSHALL_INT -.. c:macro:: MGMT_MARSHALL_LONG + .. cpp:enumerator:: MGMT_MARSHALL_LONG -.. c:macro:: MGMT_MARSHALL_STRING + .. cpp:enumerator:: MGMT_MARSHALL_STRING -.. c:macro:: MGMT_MARSHALL_DATA + .. cpp:enumerator:: MGMT_MARSHALL_DATA diff --git a/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst b/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst index abc658665ab..b29c3e61af3 100644 --- a/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst +++ b/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst @@ -26,135 +26,134 @@ Synopsis #include -.. c:type:: TSOverridableConfigKey - -Enum typedef. +.. c:enum:: TSOverridableConfigKey Enumeration Members =================== -.. c:type:: TSOverridableConfigKey - - .. c:macro:: TS_CONFIG_URL_REMAP_PRISTINE_HOST_HDR - .. c:macro:: TS_CONFIG_HTTP_CHUNKING_ENABLED - .. c:macro:: TS_CONFIG_HTTP_NEGATIVE_CACHING_ENABLED - .. c:macro:: TS_CONFIG_HTTP_NEGATIVE_CACHING_LIFETIME - .. c:macro:: TS_CONFIG_HTTP_CACHE_WHEN_TO_REVALIDATE - .. c:macro:: TS_CONFIG_HTTP_KEEP_ALIVE_ENABLED_IN - .. c:macro:: TS_CONFIG_HTTP_KEEP_ALIVE_ENABLED_OUT - .. c:macro:: TS_CONFIG_HTTP_KEEP_ALIVE_POST_OUT - .. c:macro:: TS_CONFIG_HTTP_SERVER_SESSION_SHARING_MATCH - .. c:macro:: TS_CONFIG_NET_SOCK_RECV_BUFFER_SIZE_OUT - .. c:macro:: TS_CONFIG_NET_SOCK_SEND_BUFFER_SIZE_OUT - .. c:macro:: TS_CONFIG_NET_SOCK_OPTION_FLAG_OUT - .. c:macro:: TS_CONFIG_HTTP_FORWARD_PROXY_AUTH_TO_PARENT - .. c:macro:: TS_CONFIG_HTTP_ANONYMIZE_REMOVE_FROM - .. c:macro:: TS_CONFIG_HTTP_ANONYMIZE_REMOVE_REFERER - .. c:macro:: TS_CONFIG_HTTP_ANONYMIZE_REMOVE_USER_AGENT - .. c:macro:: TS_CONFIG_HTTP_ANONYMIZE_REMOVE_COOKIE - .. c:macro:: TS_CONFIG_HTTP_ANONYMIZE_REMOVE_CLIENT_IP - .. c:macro:: TS_CONFIG_HTTP_ANONYMIZE_INSERT_CLIENT_IP - .. c:macro:: TS_CONFIG_HTTP_RESPONSE_SERVER_ENABLED - .. c:macro:: TS_CONFIG_HTTP_INSERT_SQUID_X_FORWARDED_FOR - .. c:macro:: TS_CONFIG_HTTP_SEND_HTTP11_REQUESTS - .. c:macro:: TS_CONFIG_HTTP_CACHE_HTTP - .. c:macro:: TS_CONFIG_HTTP_CACHE_IGNORE_CLIENT_NO_CACHE - .. c:macro:: TS_CONFIG_HTTP_CACHE_IGNORE_CLIENT_CC_MAX_AGE - .. c:macro:: TS_CONFIG_HTTP_CACHE_IMS_ON_CLIENT_NO_CACHE - .. c:macro:: TS_CONFIG_HTTP_CACHE_IGNORE_SERVER_NO_CACHE - .. c:macro:: TS_CONFIG_HTTP_CACHE_CACHE_RESPONSES_TO_COOKIES - .. c:macro:: TS_CONFIG_HTTP_CACHE_IGNORE_AUTHENTICATION - .. c:macro:: TS_CONFIG_HTTP_CACHE_CACHE_URLS_THAT_LOOK_DYNAMIC - .. c:macro:: TS_CONFIG_HTTP_CACHE_REQUIRED_HEADERS - .. c:macro:: TS_CONFIG_HTTP_INSERT_REQUEST_VIA_STR - .. c:macro:: TS_CONFIG_HTTP_INSERT_RESPONSE_VIA_STR - .. c:macro:: TS_CONFIG_HTTP_CACHE_HEURISTIC_MIN_LIFETIME - .. c:macro:: TS_CONFIG_HTTP_CACHE_HEURISTIC_MAX_LIFETIME - .. c:macro:: TS_CONFIG_HTTP_CACHE_GUARANTEED_MIN_LIFETIME - .. c:macro:: TS_CONFIG_HTTP_CACHE_GUARANTEED_MAX_LIFETIME - .. c:macro:: TS_CONFIG_HTTP_CACHE_MAX_STALE_AGE - .. c:macro:: TS_CONFIG_HTTP_KEEP_ALIVE_NO_ACTIVITY_TIMEOUT_IN - .. c:macro:: TS_CONFIG_HTTP_KEEP_ALIVE_NO_ACTIVITY_TIMEOUT_OUT - .. c:macro:: TS_CONFIG_HTTP_TRANSACTION_NO_ACTIVITY_TIMEOUT_IN - .. c:macro:: TS_CONFIG_HTTP_TRANSACTION_NO_ACTIVITY_TIMEOUT_OUT - .. c:macro:: TS_CONFIG_HTTP_TRANSACTION_ACTIVE_TIMEOUT_OUT - .. c:macro:: TS_CONFIG_HTTP_ORIGIN_MAX_CONNECTIONS - .. c:macro:: TS_CONFIG_HTTP_CONNECT_ATTEMPTS_MAX_RETRIES - .. c:macro:: TS_CONFIG_HTTP_CONNECT_ATTEMPTS_MAX_RETRIES_DEAD_SERVER - .. c:macro:: TS_CONFIG_HTTP_CONNECT_ATTEMPTS_RR_RETRIES - .. c:macro:: TS_CONFIG_HTTP_CONNECT_ATTEMPTS_TIMEOUT - .. c:macro:: TS_CONFIG_HTTP_POST_CONNECT_ATTEMPTS_TIMEOUT - .. c:macro:: TS_CONFIG_HTTP_DOWN_SERVER_CACHE_TIME - .. c:macro:: TS_CONFIG_HTTP_DOWN_SERVER_ABORT_THRESHOLD - .. c:macro:: TS_CONFIG_HTTP_DOC_IN_CACHE_SKIP_DNS - .. c:macro:: TS_CONFIG_HTTP_BACKGROUND_FILL_ACTIVE_TIMEOUT - .. c:macro:: TS_CONFIG_HTTP_RESPONSE_SERVER_STR - .. c:macro:: TS_CONFIG_HTTP_CACHE_HEURISTIC_LM_FACTOR - .. c:macro:: TS_CONFIG_HTTP_BACKGROUND_FILL_COMPLETED_THRESHOLD - .. c:macro:: TS_CONFIG_NET_SOCK_PACKET_MARK_OUT - .. c:macro:: TS_CONFIG_NET_SOCK_PACKET_TOS_OUT - .. c:macro:: TS_CONFIG_HTTP_INSERT_AGE_IN_RESPONSE - .. c:macro:: TS_CONFIG_HTTP_CHUNKING_SIZE - .. c:macro:: TS_CONFIG_HTTP_FLOW_CONTROL_ENABLED - .. c:macro:: TS_CONFIG_HTTP_FLOW_CONTROL_LOW_WATER_MARK - .. c:macro:: TS_CONFIG_HTTP_FLOW_CONTROL_HIGH_WATER_MARK - .. c:macro:: TS_CONFIG_HTTP_CACHE_RANGE_LOOKUP - .. c:macro:: TS_CONFIG_HTTP_DEFAULT_BUFFER_SIZE - .. c:macro:: TS_CONFIG_HTTP_DEFAULT_BUFFER_WATER_MARK - .. c:macro:: TS_CONFIG_HTTP_REQUEST_HEADER_MAX_SIZE - .. c:macro:: TS_CONFIG_HTTP_RESPONSE_HEADER_MAX_SIZE - .. c:macro:: TS_CONFIG_HTTP_NEGATIVE_REVALIDATING_ENABLED - .. c:macro:: TS_CONFIG_HTTP_NEGATIVE_REVALIDATING_LIFETIME - .. c:macro:: TS_CONFIG_SSL_HSTS_MAX_AGE - .. c:macro:: TS_CONFIG_SSL_HSTS_INCLUDE_SUBDOMAINS - .. c:macro:: TS_CONFIG_HTTP_CACHE_OPEN_READ_RETRY_TIME - .. c:macro:: TS_CONFIG_HTTP_CACHE_MAX_OPEN_READ_RETRIES - .. c:macro:: TS_CONFIG_HTTP_CACHE_RANGE_WRITE - .. c:macro:: TS_CONFIG_HTTP_POST_CHECK_CONTENT_LENGTH_ENABLED - .. c:macro:: TS_CONFIG_HTTP_GLOBAL_USER_AGENT_HEADER - .. c:macro:: TS_CONFIG_HTTP_AUTH_SERVER_SESSION_PRIVATE - .. c:macro:: TS_CONFIG_HTTP_SLOW_LOG_THRESHOLD - .. c:macro:: TS_CONFIG_HTTP_CACHE_GENERATION - .. c:macro:: TS_CONFIG_BODY_FACTORY_TEMPLATE_BASE - .. c:macro:: TS_CONFIG_HTTP_CACHE_OPEN_WRITE_FAIL_ACTION - .. c:macro:: TS_CONFIG_HTTP_NUMBER_OF_REDIRECTIONS - .. c:macro:: TS_CONFIG_HTTP_CACHE_MAX_OPEN_WRITE_RETRIES - .. c:macro:: TS_CONFIG_HTTP_REDIRECT_USE_ORIG_CACHE_KEY - .. c:macro:: TS_CONFIG_HTTP_REQUEST_BUFFER_ENABLED - .. c:macro:: TS_CONFIG_HTTP_ATTACH_SERVER_SESSION_TO_CLIENT - .. c:macro:: TS_CONFIG_HTTP_MAX_PROXY_CYCLES - .. c:macro:: TS_CONFIG_HTTP_ORIGIN_MAX_CONNECTIONS_QUEUE - .. c:macro:: TS_CONFIG_WEBSOCKET_NO_ACTIVITY_TIMEOUT - .. c:macro:: TS_CONFIG_WEBSOCKET_ACTIVE_TIMEOUT - .. c:macro:: TS_CONFIG_HTTP_UNCACHEABLE_REQUESTS_BYPASS_PARENT - .. c:macro:: TS_CONFIG_HTTP_PARENT_PROXY_TOTAL_CONNECT_ATTEMPTS - .. c:macro:: TS_CONFIG_HTTP_TRANSACTION_ACTIVE_TIMEOUT_IN - .. c:macro:: TS_CONFIG_SRV_ENABLED - .. c:macro:: TS_CONFIG_HTTP_FORWARD_CONNECT_METHOD - .. c:macro:: TS_CONFIG_SSL_CLIENT_CERT_FILENAME - .. c:macro:: TS_CONFIG_SSL_CERT_FILEPATH - .. c:macro:: TS_CONFIG_PARENT_FAILURES_UPDATE_HOSTDB - .. c:macro:: TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_MISMATCH - .. c:macro:: TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_LANGUAGE_MISMATCH - .. c:macro:: TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_ENCODING_MISMATCH - .. c:macro:: TS_CONFIG_HTTP_CACHE_IGNORE_ACCEPT_CHARSET_MISMATCH - .. c:macro:: TS_CONFIG_HTTP_PARENT_PROXY_FAIL_THRESHOLD - .. c:macro:: TS_CONFIG_HTTP_PARENT_PROXY_RETRY_TIME - .. c:macro:: TS_CONFIG_HTTP_PER_PARENT_CONNECT_ATTEMPTS - .. c:macro:: TS_CONFIG_HTTP_PARENT_CONNECT_ATTEMPT_TIMEOUT - .. c:macro:: TS_CONFIG_HTTP_NORMALIZE_AE - .. c:macro:: TS_CONFIG_HTTP_INSERT_FORWARDED - .. c:macro:: TS_CONFIG_HTTP_ALLOW_MULTI_RANGE - .. c:macro:: TS_CONFIG_HTTP_ALLOW_HALF_OPEN - .. c:macro:: TS_CONFIG_HTTP_PER_SERVER_CONNECTION_MAX - .. c:macro:: TS_CONFIG_HTTP_PER_SERVER_CONNECTION_MATCH - .. c:macro:: TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_POLICY - .. c:macro:: TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_PROPERTIES - .. c:macro:: TS_CONFIG_SSL_CLIENT_SNI_POLICY - .. c:macro:: TS_CONFIG_SSL_CLIENT_PRIVATE_KEY_FILENAME - .. c:macro:: TS_CONFIG_SSL_CLIENT_CA_CERT_FILENAME - .. c:macro:: TS_CONFIG_HTTP_HOST_RESOLUTION_PREFERENCE +.. 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_DEAD_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_DOWN_SERVER_ABORT_THRESHOLD +.. 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 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. diff --git a/doc/developer-guide/api/types/TSRecordDataType.en.rst b/doc/developer-guide/api/types/TSRecordDataType.en.rst index f2f09b1caa2..75698a5f08f 100644 --- a/doc/developer-guide/api/types/TSRecordDataType.en.rst +++ b/doc/developer-guide/api/types/TSRecordDataType.en.rst @@ -22,63 +22,64 @@ TSRecordDataType Synopsis ======== -.. code-block:: cpp +.. code-block:: c #include -.. c:type:: TSRecordDataType +.. c:enum:: TSRecordDataType The underlying data type of a data record (configuration variable or statistic). - .. c:macro:: TS_RECORDDATATYPE_NULL + .. c:enumerator:: TS_RECORDDATATYPE_NULL No data type. Used as an invalid initialization value. - .. c:macro:: TS_RECORDDATATYPE_INT + .. c:enumerator:: TS_RECORDDATATYPE_INT An integer. - .. c:macro:: TS_RECORDDATATYPE_FLOAT + .. c:enumerator:: TS_RECORDDATATYPE_FLOAT Floating point. - .. c:macro:: TS_RECORDDATATYPE_STRING + .. c:enumerator:: TS_RECORDDATATYPE_STRING A string. - .. c:macro:: TS_RECORDDATATYPE_COUNTER + .. c:enumerator:: TS_RECORDDATATYPE_COUNTER A counter which has a count and a sum. - .. c:macro:: TS_RECORDDATATYPE_STAT_CONST + .. c:enumerator:: TS_RECORDDATATYPE_STAT_CONST A value that is unchangeable. - .. c:macro:: TS_RECORDDATATYPE_STAT_FX + .. c:enumerator:: TS_RECORDDATATYPE_STAT_FX Unknown. -.. c:type:: TSRecordData +.. c:union:: TSRecordData - A union that holds the data for a record. The correct member is indicated by a :c:type:`TSRecordType` value. + A union that holds the data for a record. The correct member is indicated by a :c:enum:`TSRecordType` value. .. c:member:: int rec_int - Data for :c:macro:`TS_RECORDDATATYPE_INT`. + Data for :c:enumerator:`TS_RECORDDATATYPE_INT `. .. c:member:: float rec_float - Data for :c:macro:`TS_RECORDDATATYPE_FLOAT`. + Data for :c:enumerator:`TS_RECORDDATATYPE_FLOAT `. .. c:member:: char * rec_string - Data for :c:macro:`TS_RECORDDATATYPE_STRING`. + Data for :c:enumerator:`TS_RECORDDATATYPE_STRING `. .. c:member:: int64_t rec_counter - Data for :c:macro:`TS_RECORDDATATYPE_COUNTER`. + Data for :c:enumerator:`TS_RECORDDATATYPE_COUNTER `. Description =========== -This data type describes the data stored in a management value such as a configuration value or a statistic value. +This data type describes the data stored in a management value such as a configuration value or a +statistic value. diff --git a/doc/developer-guide/api/types/TSRecordType.en.rst b/doc/developer-guide/api/types/TSRecordType.en.rst index cb72926b5ed..1e7493d3a2f 100644 --- a/doc/developer-guide/api/types/TSRecordType.en.rst +++ b/doc/developer-guide/api/types/TSRecordType.en.rst @@ -26,35 +26,35 @@ Synopsis #include -.. c:type:: TSRecordType +.. c:enum:: TSRecordType Effectively the scope of the record. - .. c:macro:: TS_RECORDTYPE_NULL + .. c:enumerator:: TS_RECORDTYPE_NULL Invalid value. This is used to indicate a failure or for initialization. - .. c:macro:: TS_RECORDTYPE_CONFIG + .. c:enumerator:: TS_RECORDTYPE_CONFIG A configuration record. - .. c:macro:: TS_RECORDTYPE_PROCESS + .. c:enumerator:: TS_RECORDTYPE_PROCESS - .. c:macro:: TS_RECORDTYPE_NODE + .. c:enumerator:: TS_RECORDTYPE_NODE - .. c:macro:: TS_RECORDTYPE_CLUSTER + .. c:enumerator:: TS_RECORDTYPE_CLUSTER Deprecated - shared among a cluster. - .. c:macro:: TS_RECORDTYPE_LOCAL + .. c:enumerator:: TS_RECORDTYPE_LOCAL Deprecated - not shared among a cluster. - .. c:macro:: TS_RECORDTYPE_PLUGIN + .. c:enumerator:: TS_RECORDTYPE_PLUGIN Created by a plugin. - .. c:macro:: TS_RECORDTYPE_ALL + .. c:enumerator:: TS_RECORDTYPE_ALL Description =========== diff --git a/doc/developer-guide/internal-libraries/Extendible.en.rst b/doc/developer-guide/internal-libraries/Extendible.en.rst index 8bb595e16bb..66011d6bbcb 100644 --- a/doc/developer-guide/internal-libraries/Extendible.en.rst +++ b/doc/developer-guide/internal-libraries/Extendible.en.rst @@ -170,8 +170,10 @@ which simplifies the code using it. Also this provides compile errors for common Inheritance ----------- - Unfortunately it is non-trivial handle multiple |Extendible| super types in the same inheritance tree. - :func:`template<> create()` handles allocation and initialization of the entire `Derived` class, but it is dependent on each class defining :code:`using super_type = *some_super_class*;` so that it recurse through the classes. +Unfortunately it is non-trivial handle multiple |Extendible| super types in the same inheritance +tree. :func:`template<> create()` handles allocation and initialization of the entire `Derived` +class, but it is dependent on each class defining :code:`using super_type = *some_super_class*;` so +that it recurse through the classes. .. code-block:: cpp @@ -245,7 +247,7 @@ Namespace `ext` :tparam Derived_t: The Derived class to allocate. .. function:: template \ - bool fieldAdd(FieldId\ & field_id, std::string const & field_name) + bool fieldAdd(FieldId & field_id, std::string const & field_name) Declare a new |FieldId| for Derived_t. @@ -253,7 +255,7 @@ Namespace `ext` :tparam Field_t: The type of the field. .. function:: template \ - bool fieldFind(FieldId\ & field_id, std::string const & field_name) + bool fieldFind(FieldId & field_id, std::string const & field_name) Find an existing |FieldId| for Derived_t. @@ -261,7 +263,7 @@ Namespace `ext` :tparam Field_t: The type of the field. .. function:: template \ - auto const get(T const &, FieldId\) + auto const get(T const &, FieldId) Returns T const& value from the field stored in the |Extendible| allocation. @@ -270,7 +272,7 @@ Namespace `ext` :tparam Field_t: The type of the field. .. function:: template \ - auto set(T &, FieldId\) + T & set(T &, FieldId) Returns T & value from the field stored in |Extendible| allocation. diff --git a/doc/developer-guide/internal-libraries/buffer-writer.en.rst b/doc/developer-guide/internal-libraries/buffer-writer.en.rst index fa2337d20b2..d37d532c659 100644 --- a/doc/developer-guide/internal-libraries/buffer-writer.en.rst +++ b/doc/developer-guide/internal-libraries/buffer-writer.en.rst @@ -343,15 +343,16 @@ will work with just the format ``{}``. In a sense, ``{}`` serves the same functi :code:`auto` does for programming - the compiler knows the type, it should be able to do something reasonable without the programmer needing to be explicit. -.. productionList:: Format +.. productionlist:: format format: "{" [name] [":" [specifier] [":" extension]] "}" name: index | ICHAR+ index: non-negative integer + specifier: extension: ICHAR* ICHAR: a printable ASCII character except for '{', '}', ':' -:token:`name` - The :token:`name` of the argument to use. This can be a non-negative integer in which case it is +:token:`~format:name` + The name of the argument to use. This can be a non-negative integer in which case it is the zero based index of the argument to the method call. E.g. ``{0}`` means the first argument and ``{2}`` is the third argument after the format. @@ -359,7 +360,7 @@ reasonable without the programmer needing to be explicit. ``bw.print("{1} {0}", 'a', 'b')`` => ``b a`` - The :token:`name` can be omitted in which case it is treated as an index in parallel to the + The name can be omitted in which case it is treated as an index in parallel to the position in the format string. Only the position in the format string matters, not what names other format elements may have used. @@ -376,10 +377,10 @@ reasonable without the programmer needing to be explicit. Alphanumeric names refer to values in a global table. These will be described in more detail someday. Such names, however, do not count in terms of default argument indexing. -:token:`specifier` +:token:`~format:specifier` Basic formatting control. - .. productionList:: specifier + .. productionlist:: spec specifier: [[fill]align][sign]["#"]["0"][[min][.precision][,max][type]] fill: fill-char | URI-char URI-char: "%" hex-digit hex-digit @@ -392,13 +393,13 @@ reasonable without the programmer needing to be explicit. type: type: "g" | "s" | "S" | "x" | "X" | "d" | "o" | "b" | "B" | "p" | "P" hex-digit: "0" .. "9" | "a" .. "f" | "A" .. "F" - The output is placed in a field that is at least :token:`min` wide and no more than :token:`max` wide. If - the output is less than :token:`min` then + The output is placed in a field that is at least :token:`~spec:min` wide and no more than + :token:`~spec:max` wide. If the output is less than :token:`~spec:min` then - * The :token:`fill` character is used for the extra space required. This can be an explicit - character or a URI encoded one (to allow otherwise reserved characters). + * The :token:`~spec:fill` character is used for the extra space required. This can be an + explicit character or a URI encoded one (to allow otherwise reserved characters). - * The output is shifted according to the :token:`align`. + * The output is shifted according to the :token:`~spec:align`. < Align to the left, fill to the right. @@ -412,14 +413,15 @@ reasonable without the programmer needing to be explicit. = Numerically align, putting the fill between the sign character and the value. - The output is clipped by :token:`max` width characters and by the end of the buffer. - :token:`precision` is used by floating point values to specify the number of places of precision. + The output is clipped by :token:`~spec:max` width characters and by the end of the buffer. + :token:`~spec:precision` is used by floating point values to specify the number of places of + precision. - :token:`type` is used to indicate type specific formatting. For integers it indicates the output - radix and if ``#`` is present the radix is prefix is generated (one of ``0xb``, ``0``, ``0x``). - Format types of the same letter are equivalent, varying only in the character case used for - output. Most commonly 'x' prints values in lower cased hexadecimal (:code:`0x1337beef`) while 'X' - prints in upper case hexadecimal (:code:`0X1337BEEF`). Note there is no upper case decimal or + :token:`~spec:type` is used to indicate type specific formatting. For integers it indicates the + output radix and if ``#`` is present the radix is prefix is generated (one of ``0xb``, ``0``, + ``0x``). Format types of the same letter are equivalent, varying only in the character case used + for output. Most commonly 'x' prints values in lower cased hexadecimal (:code:`0x1337beef`) while + 'X' prints in upper case hexadecimal (:code:`0X1337BEEF`). Note there is no upper case decimal or octal type because case is irrelevant for those. = =============== @@ -446,7 +448,7 @@ reasonable without the programmer needing to be explicit. type 's' yields ``true` or ``false``. The upper case form, 'S', applies only in these cases where the formatter generates the text, it does not apply to normally text based values unless specifically noted. -:token:`extension` +:token:`~format:extension` Text (excluding braces) that is passed to the type specific formatter function. This can be used to provide extensions for specific argument types (e.g., IP addresses). The base logic ignores it but passes it on to the formatting function which can then behave different based on the @@ -540,9 +542,9 @@ User Defined Formatting To get the full benefit of type safe formatting it is necessary to provide type specific formatting functions which are called when a value of that type is formatted. This is how type specific knowledge such as the names of enumeration values are encoded in a single location. Additional type -specific formatting can be provided via the :token:`extension` field. Without this, special formatting -requires extra functions and additional work at the call site, rather than a single consolidated -formatting function. +specific formatting can be provided via the :token:`~format:extension` field. Without this, special +formatting requires extra functions and additional work at the call site, rather than a single +consolidated formatting function. To provide a formatter for a type :code:`V` the function :code:`bwformat` is overloaded. The signature would look like this:: @@ -656,11 +658,11 @@ These are types for which there exists a type specific BWF formatter. 'p' or 'P' The pointer and length value of the view in lower ('p') or upper ('P') case. - The :token:`precision` is interpreted specially for this type to mean "skip :token:`precision` - initial characters". When combined with :token:`max` this allows a mechanism for printing - substrings of the :code:`std::string_view`. For instance, to print the 10th through 20th characters - the format ``{:.10,20}`` would suffice. Given the method :code:`substr` for :code:`std::string_view` - is cheap, it's unclear how useful this is. + The :token:`~spec:precision` is interpreted specially for this type to mean "skip + :token:`~spec:precision` initial characters". When combined with :token:`~spec:max` this allows a + mechanism for printing substrings of the :code:`std::string_view`. For instance, to print the + 10th through 20th characters the format ``{:.10,20}`` would suffice. Given the method + :code:`substr` for :code:`std::string_view` is cheap, it's unclear how useful this is. :code:`sockaddr const*` The IP address is printed. Fill is used to fill in address segments if provided, not to the diff --git a/doc/developer-guide/plugins/continuations/writing-handler-functions.en.rst b/doc/developer-guide/plugins/continuations/writing-handler-functions.en.rst index 8fafbfd2011..7fec877fabe 100644 --- a/doc/developer-guide/plugins/continuations/writing-handler-functions.en.rst +++ b/doc/developer-guide/plugins/continuations/writing-handler-functions.en.rst @@ -76,56 +76,56 @@ it receives: The following table lists events and the corresponding type of `void* data` passed to handler functions: -============================================ =========================================== ========================== -Event Event Sender Data Type -============================================ =========================================== ========================== -:data:`TS_EVENT_HTTP_READ_REQUEST_HDR` :data:`TS_HTTP_READ_REQUEST_HDR_HOOK` :type:`TSHttpTxn` -:data:`TS_EVENT_HTTP_PRE_REMAP` :data:`TS_HTTP_PRE_REMAP_HOOK` :type:`TSHttpTxn` -:data:`TS_EVENT_HTTP_OS_DNS` :data:`TS_HTTP_OS_DNS_HOOK` :type:`TSHttpTxn` -:data:`TS_EVENT_HTTP_SEND_REQUEST_HDR` :data:`TS_HTTP_SEND_REQUEST_HDR_HOOK` :type:`TSHttpTxn` -:data:`TS_EVENT_HTTP_READ_CACHE_HDR` :data:`TS_HTTP_READ_CACHE_HDR_HOOK` :type:`TSHttpTxn` -:data:`TS_EVENT_HTTP_READ_RESPONSE_HDR` :data:`TS_HTTP_READ_RESPONSE_HDR_HOOK` :type:`TSHttpTxn` -:data:`TS_EVENT_HTTP_SEND_RESPONSE_HDR` :data:`TS_HTTP_SEND_RESPONSE_HDR_HOOK` :type:`TSHttpTxn` -:data:`TS_EVENT_HTTP_SELECT_ALT` :data:`TS_HTTP_SELECT_ALT_HOOK` :type:`TSHttpTxn` -:data:`TS_EVENT_HTTP_TXN_START` :data:`TS_HTTP_TXN_START_HOOK` :type:`TSHttpTxn` -:data:`TS_EVENT_HTTP_TXN_CLOSE` :data:`TS_HTTP_TXN_CLOSE_HOOK` :type:`TSHttpTxn` -:data:`TS_EVENT_HTTP_SSN_START` :data:`TS_HTTP_SSN_START_HOOK` :type:`TSHttpSsn` -:data:`TS_EVENT_HTTP_SSN_CLOSE` :data:`TS_HTTP_SSN_CLOSE_HOOK` :type:`TSHttpSsn` -:data:`TS_EVENT_NONE` -:data:`TS_EVENT_CACHE_LOOKUP_COMPLETE` :data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` :type:`TSHttpTxn` -:data:`TS_EVENT_IMMEDIATE` :func:`TSVConnClose` - :func:`TSVIOReenable` - :func:`TSContScheduleOnPool` - :func:`TSContScheduleOnThread` -:data:`TS_EVENT_IMMEDIATE` :data:`TS_HTTP_REQUEST_TRANSFORM_HOOK` -:data:`TS_EVENT_IMMEDIATE` :data:`TS_HTTP_RESPONSE_TRANSFORM_HOOK` -:data:`TS_EVENT_CACHE_OPEN_READ` :func:`TSCacheRead` Cache VC -:data:`TS_EVENT_CACHE_OPEN_READ_FAILED` :func:`TSCacheRead` TS_CACHE_ERROR code -:data:`TS_EVENT_CACHE_OPEN_WRITE` :func:`TSCacheWrite` Cache VC -:data:`TS_EVENT_CACHE_OPEN_WRITE_FAILED` :func:`TSCacheWrite` TS_CACHE_ERROR code -:data:`TS_EVENT_CACHE_REMOVE` :func:`TSCacheRemove` -:data:`TS_EVENT_CACHE_REMOVE_FAILED` :func:`TSCacheRemove` TS_CACHE_ERROR code -:data:`TS_EVENT_NET_ACCEPT` :func:`TSNetAccept` :type:`TSNetVConnection` - :func:`TSHttpTxnServerIntercept` - :func:`TSHttpTxnIntercept` -:data:`TS_EVENT_NET_ACCEPT_FAILED` :func:`TSNetAccept` - :func:`TSHttpTxnServerIntercept` - :func:`TSHttpTxnIntercept` -:data:`TS_EVENT_HOST_LOOKUP` :func:`TSHostLookup` :type:`TSHostLookupResult` -:data:`TS_EVENT_TIMEOUT` :func:`TSContScheduleOnPool` - :func:`TSContScheduleOnThread` -:data:`TS_EVENT_ERROR` -:data:`TS_EVENT_VCONN_READ_READY` :func:`TSVConnRead` :type:`TSVIO` -:data:`TS_EVENT_VCONN_WRITE_READY` :func:`TSVConnWrite` :type:`TSVIO` -:data:`TS_EVENT_VCONN_READ_COMPLETE` :func:`TSVConnRead` :type:`TSVIO` -:data:`TS_EVENT_VCONN_WRITE_COMPLETE` :func:`TSVConnWrite` :type:`TSVIO` -:data:`TS_EVENT_VCONN_EOS` :func:`TSVConnRead` :type:`TSVIO` -:data:`TS_EVENT_NET_CONNECT` :func:`TSNetConnect` :type:`TSVConn` -:data:`TS_EVENT_NET_CONNECT_FAILED` :func:`TSNetConnect` :type:`TSVConn` -:data:`TS_EVENT_HTTP_CONTINUE` -:data:`TS_EVENT_HTTP_ERROR` -:data:`TS_EVENT_MGMT_UPDATE` :func:`TSMgmtUpdateRegister` -============================================ =========================================== ========================== +============================================= ============================================ ========================== +Event Event Sender Data Type +============================================= ============================================ ========================== +:macro:`TS_EVENT_HTTP_READ_REQUEST_HDR` :macro:`TS_HTTP_READ_REQUEST_HDR_HOOK` :type:`TSHttpTxn` +:macro:`TS_EVENT_HTTP_PRE_REMAP` :macro:`TS_HTTP_PRE_REMAP_HOOK` :type:`TSHttpTxn` +:macro:`TS_EVENT_HTTP_OS_DNS` :macro:`TS_HTTP_OS_DNS_HOOK` :type:`TSHttpTxn` +:macro:`TS_EVENT_HTTP_SEND_REQUEST_HDR` :macro:`TS_HTTP_SEND_REQUEST_HDR_HOOK` :type:`TSHttpTxn` +:macro:`TS_EVENT_HTTP_READ_CACHE_HDR` :macro:`TS_HTTP_READ_CACHE_HDR_HOOK` :type:`TSHttpTxn` +:macro:`TS_EVENT_HTTP_READ_RESPONSE_HDR` :macro:`TS_HTTP_READ_RESPONSE_HDR_HOOK` :type:`TSHttpTxn` +:macro:`TS_EVENT_HTTP_SEND_RESPONSE_HDR` :macro:`TS_HTTP_SEND_RESPONSE_HDR_HOOK` :type:`TSHttpTxn` +:macro:`TS_EVENT_HTTP_SELECT_ALT` :macro:`TS_HTTP_SELECT_ALT_HOOK` :type:`TSHttpTxn` +:macro:`TS_EVENT_HTTP_TXN_START` :macro:`TS_HTTP_TXN_START_HOOK` :type:`TSHttpTxn` +:macro:`TS_EVENT_HTTP_TXN_CLOSE` :macro:`TS_HTTP_TXN_CLOSE_HOOK` :type:`TSHttpTxn` +:macro:`TS_EVENT_HTTP_SSN_START` :macro:`TS_HTTP_SSN_START_HOOK` :type:`TSHttpSsn` +:macro:`TS_EVENT_HTTP_SSN_CLOSE` :macro:`TS_HTTP_SSN_CLOSE_HOOK` :type:`TSHttpSsn` +:macro:`TS_EVENT_NONE` +:macro:`TS_EVENT_CACHE_LOOKUP_COMPLETE` :macro:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK` :type:`TSHttpTxn` +:macro:`TS_EVENT_IMMEDIATE` :func:`TSVConnClose` + :func:`TSVIOReenable` + :func:`TSContScheduleOnPool` + :func:`TSContScheduleOnThread` +:macro:`TS_EVENT_IMMEDIATE` :macro:`TS_HTTP_REQUEST_TRANSFORM_HOOK` +:macro:`TS_EVENT_IMMEDIATE` :macro:`TS_HTTP_RESPONSE_TRANSFORM_HOOK` +:macro:`TS_EVENT_CACHE_OPEN_READ` :func:`TSCacheRead` Cache VC +:macro:`TS_EVENT_CACHE_OPEN_READ_FAILED` :func:`TSCacheRead` TS_CACHE_ERROR code +:macro:`TS_EVENT_CACHE_OPEN_WRITE` :func:`TSCacheWrite` Cache VC +:macro:`TS_EVENT_CACHE_OPEN_WRITE_FAILED` :func:`TSCacheWrite` TS_CACHE_ERROR code +:macro:`TS_EVENT_CACHE_REMOVE` :func:`TSCacheRemove` +:macro:`TS_EVENT_CACHE_REMOVE_FAILED` :func:`TSCacheRemove` TS_CACHE_ERROR code +:macro:`TS_EVENT_NET_ACCEPT` :func:`TSNetAccept` :type:`TSNetVConnection` + :func:`TSHttpTxnServerIntercept` + :func:`TSHttpTxnIntercept` +:macro:`TS_EVENT_NET_ACCEPT_FAILED` :func:`TSNetAccept` + :func:`TSHttpTxnServerIntercept` + :func:`TSHttpTxnIntercept` +:macro:`TS_EVENT_HOST_LOOKUP` :func:`TSHostLookup` :type:`TSHostLookupResult` +:macro:`TS_EVENT_TIMEOUT` :func:`TSContScheduleOnPool` + :func:`TSContScheduleOnThread` +:macro:`TS_EVENT_ERROR` +:macro:`TS_EVENT_VCONN_READ_READY` :func:`TSVConnRead` :type:`TSVIO` +:macro:`TS_EVENT_VCONN_WRITE_READY` :func:`TSVConnWrite` :type:`TSVIO` +:macro:`TS_EVENT_VCONN_READ_COMPLETE` :func:`TSVConnRead` :type:`TSVIO` +:macro:`TS_EVENT_VCONN_WRITE_COMPLETE` :func:`TSVConnWrite` :type:`TSVIO` +:macro:`TS_EVENT_VCONN_EOS` :func:`TSVConnRead` :type:`TSVIO` +:macro:`TS_EVENT_NET_CONNECT` :func:`TSNetConnect` :type:`TSVConn` +:macro:`TS_EVENT_NET_CONNECT_FAILED` :func:`TSNetConnect` :type:`TSVConn` +:macro:`TS_EVENT_HTTP_CONTINUE` +:macro:`TS_EVENT_HTTP_ERROR` +:macro:`TS_EVENT_MGMT_UPDATE` :func:`TSMgmtUpdateRegister` +============================================= ============================================ ========================== The continuation functions are listed below: diff --git a/doc/developer-guide/plugins/http-headers/mime-headers.en.rst b/doc/developer-guide/plugins/http-headers/mime-headers.en.rst index 1ccf0dada79..00a08d4312a 100644 --- a/doc/developer-guide/plugins/http-headers/mime-headers.en.rst +++ b/doc/developer-guide/plugins/http-headers/mime-headers.en.rst @@ -90,355 +90,285 @@ To facilitate fast comparisons and reduce storage size, Traffic Server defines several pre-allocated field names. These field names correspond to the field names in HTTP and NNTP headers. -.. c:var:: const char* TS_MIME_FIELD_ACCEPT - "Accept" +"Accept" + .. c:var:: const char* TS_MIME_FIELD_ACCEPT + .. c:var:: int TS_MIME_LEN_ACCEPT -.. c:var:: int TS_MIME_LEN_ACCEPT +"Accept-Charset" + .. c:var:: const char* TS_MIME_FIELD_ACCEPT_CHARSET + .. c:var:: int TS_MIME_LEN_ACCEPT_CHARSET -.. c:var:: const char* TS_MIME_FIELD_ACCEPT_CHARSET - "Accept-Charset" +"Accept-Encoding" + .. c:var:: const char* TS_MIME_FIELD_ACCEPT_ENCODING + .. c:var:: int TS_MIME_LEN_ACCEPT_ENCODING -.. c:var:: int TS_MIME_LEN_ACCEPT_CHARSET +"Accept-Language" + .. c:var:: const char* TS_MIME_FIELD_ACCEPT_LANGUAGE + .. c:var:: int TS_MIME_LEN_ACCEPT_LANGUAGE -.. c:var:: const char* TS_MIME_FIELD_ACCEPT_ENCODING - "Accept-Encoding" +"Accept-Ranges" + .. c:var:: const char* TS_MIME_FIELD_ACCEPT_RANGES + .. c:var:: int TS_MIME_LEN_ACCEPT_RANGES -.. c:var:: int TS_MIME_LEN_ACCEPT_ENCODING +"Age" + .. c:var:: const char* TS_MIME_FIELD_AGE + .. c:var:: int TS_MIME_LEN_AGE -.. c:var:: const char* TS_MIME_FIELD_ACCEPT_LANGUAGE - "Accept-Language" +"Allow" + .. c:var:: const char* TS_MIME_FIELDALLOW + .. c:var:: int TS_MIME_LEN_ALLOW -.. c:var:: int TS_MIME_LEN_ACCEPT_LANGUAGE +"Approved" + .. c:var:: const char* TS_MIME_FIELDAPPROVED + .. c:var:: int TS_MIME_LEN_APPROVED -.. c:var:: const char* TS_MIME_FIELD_ACCEPT_RANGES - "Accept-Ranges" +"Authorization" + .. c:var:: const char* TS_MIME_FIELDAUTHORIZATION + .. c:var:: int TS_MIME_LEN_AUTHORIZATION -.. c:var:: int TS_MIME_LEN_ACCEPT_RANGES +"Bytes" + .. c:var:: const char* TS_MIME_FIELDBYTES + .. c:var:: int TS_MIME_LEN_BYTES -.. c:var:: const char* TS_MIME_FIELD_AGE - "Age" +"Cache-Control" + .. c:var:: const char* TS_MIME_FIELDCACHE_CONTROL + .. c:var:: int TS_MIME_LEN_CACHE_CONTROL -.. c:var:: int TS_MIME_LEN_AGE +"Client-ip" + .. c:var:: const char* TS_MIME_FIELDCLIENT_IP + .. c:var:: int TS_MIME_LEN_CLIENT_IP -.. c:var:: const char* TS_MIME_FIELDALLOW - "Allow" +"Connection" + .. c:var:: const char* TS_MIME_FIELDCONNECTION + .. c:var:: int TS_MIME_LEN_CONNECTION -.. c:var:: int TS_MIME_LEN_ALLOW +"Content-Base" + .. c:var:: const char* TS_MIME_FIELDCONTENT_BASE + .. c:var:: int TS_MIME_LEN_CONTENT_BASE -.. c:var:: const char* TS_MIME_FIELDAPPROVED - "Approved" +"Content-Encoding" + .. c:var:: const char* TS_MIME_FIELDCONTENT_ENCODING + .. c:var:: int TS_MIME_LEN_CONTENT_ENCODING -.. c:var:: int TS_MIME_LEN_APPROVED +"Content-Language" + .. c:var:: const char* TS_MIME_FIELDCONTENT_LANGUAGE + .. c:var:: int TS_MIME_LEN_CONTENT_LANGUAGE -.. c:var:: const char* TS_MIME_FIELDAUTHORIZATION - "Authorization" +"Content-Length" + .. c:var:: const char* TS_MIME_FIELDCONTENT_LENGTH + .. c:var:: int TS_MIME_LEN_CONTENT_LENGTH -.. c:var:: int TS_MIME_LEN_AUTHORIZATION +"Content-Location" + .. c:var:: const char* TS_MIME_FIELDCONTENT_LOCATION + .. c:var:: int TS_MIME_LEN_CONTENT_LOCATION -.. c:var:: const char* TS_MIME_FIELDBYTES - "Bytes" +"Content-MD5" + .. c:var:: const char* TS_MIME_FIELDCONTENT_MD5 + .. c:var:: int TS_MIME_LEN_CONTENT_MD5 -.. c:var:: int TS_MIME_LEN_BYTES +"Content-Range" + .. c:var:: const char* TS_MIME_FIELDCONTENT_RANGE + .. c:var:: int TS_MIME_LEN_CONTENT_RANGE -.. c:var:: const char* TS_MIME_FIELDCACHE_CONTROL - "Cache-Control" +"Content-Type" + .. c:var:: const char* TS_MIME_FIELDCONTENT_TYPE + .. c:var:: int TS_MIME_LEN_CONTENT_TYPE -.. c:var:: int TS_MIME_LEN_CACHE_CONTROL +"Control" + .. c:var:: const char* TS_MIME_FIELDCONTROL + .. c:var:: int TS_MIME_LEN_CONTROL -.. c:var:: const char* TS_MIME_FIELDCLIENT_IP - "Client-ip" +"Cookie" + .. c:var:: const char* TS_MIME_FIELDCOOKIE + .. c:var:: int TS_MIME_LEN_COOKIE -.. c:var:: int TS_MIME_LEN_CLIENT_IP +"Date" + .. c:var:: const char* TS_MIME_FIELDDATE + .. c:var:: int TS_MIME_LEN_DATE -.. c:var:: const char* TS_MIME_FIELDCONNECTION - "Connection" +"Distribution" + .. c:var:: const char* TS_MIME_FIELDDISTRIBUTION + .. c:var:: int TS_MIME_LEN_DISTRIBUTION -.. c:var:: int TS_MIME_LEN_CONNECTION +"Etag" + .. c:var:: const char* TS_MIME_FIELDETAG + .. c:var:: int TS_MIME_LEN_ETAG -.. c:var:: const char* TS_MIME_FIELDCONTENT_BASE - "Content-Base" +"Expect" + .. c:var:: const char* TS_MIME_FIELDEXPECT + .. c:var:: int TS_MIME_LEN_EXPECT -.. c:var:: int TS_MIME_LEN_CONTENT_BASE +"Expires" + .. c:var:: const char* TS_MIME_FIELDEXPIRES + .. c:var:: int TS_MIME_LEN_EXPIRES -.. c:var:: const char* TS_MIME_FIELDCONTENT_ENCODING - "Content-Encoding" +"Followup-To" + .. c:var:: const char* TS_MIME_FIELDFOLLOWUP_TO + .. c:var:: int TS_MIME_LEN_FOLLOWUP_TO -.. c:var:: int TS_MIME_LEN_CONTENT_ENCODING +"From" + .. c:var:: const char* TS_MIME_FIELDFROM + .. c:var:: int TS_MIME_LEN_FROM -.. c:var:: const char* TS_MIME_FIELDCONTENT_LANGUAGE - "Content-Language" +"Host" + .. c:var:: const char* TS_MIME_FIELDHOST + .. c:var:: int TS_MIME_LEN_HOST -.. c:var:: int TS_MIME_LEN_CONTENT_LANGUAGE +"If-Match" + .. c:var:: const char* TS_MIME_FIELDIF_MATCH + .. c:var:: int TS_MIME_LEN_IF_MATCH -.. c:var:: const char* TS_MIME_FIELDCONTENT_LENGTH - "Content-Length" +"If-Modified-Since" + .. c:var:: const char* TS_MIME_FIELDIF_MODIFIED_SINCE + .. c:var:: int TS_MIME_LEN_IF_MODIFIED_SINCE -.. c:var:: int TS_MIME_LEN_CONTENT_LENGTH +"If-None-Match" + .. c:var:: const char* TS_MIME_FIELDIF_NONE_MATCH + .. c:var:: int TS_MIME_LEN_IF_NONE_MATCH -.. c:var:: const char* TS_MIME_FIELDCONTENT_LOCATION - "Content-Location" +"If-Range" + .. c:var:: const char* TS_MIME_FIELDIF_RANGE + .. c:var:: int TS_MIME_LEN_IF_RANGE -.. c:var:: int TS_MIME_LEN_CONTENT_LOCATION +"If-Unmodified-Since" + .. c:var:: const char* TS_MIME_FIELDIF_UNMODIFIED_SINCE + .. c:var:: int TS_MIME_LEN_IF_UNMODIFIED_SINCE -.. c:var:: const char* TS_MIME_FIELDCONTENT_MD5 - "Content-MD5" +"Keep-Alive" + .. c:var:: const char* TS_MIME_FIELDKEEP_ALIVE + .. c:var:: int TS_MIME_LEN_KEEP_ALIVE -.. c:var:: int TS_MIME_LEN_CONTENT_MD5 +"Keywords" + .. c:var:: const char* TS_MIME_FIELDKEYWORDS + .. c:var:: int TS_MIME_LEN_KEYWORDS -.. c:var:: const char* TS_MIME_FIELDCONTENT_RANGE - "Content-Range" +"Last-Modified" + .. c:var:: const char* TS_MIME_FIELDLAST_MODIFIED + .. c:var:: int TS_MIME_LEN_LAST_MODIFIED -.. c:var:: int TS_MIME_LEN_CONTENT_RANGE +"Lines" + .. c:var:: const char* TS_MIME_FIELDLINES + .. c:var:: int TS_MIME_LEN_LINES -.. c:var:: const char* TS_MIME_FIELDCONTENT_TYPE - "Content-Type" +"Location" + .. c:var:: const char* TS_MIME_FIELDLOCATION + .. c:var:: int TS_MIME_LEN_LOCATION -.. c:var:: int TS_MIME_LEN_CONTENT_TYPE +"Max-Forwards" + .. c:var:: const char* TS_MIME_FIELDMAX_FORWARDS + .. c:var:: int TS_MIME_LEN_MAX_FORWARDS -.. c:var:: const char* TS_MIME_FIELDCONTROL - "Control" +"Message-ID" + .. c:var:: const char* TS_MIME_FIELDMESSAGE_ID + .. c:var:: int TS_MIME_LEN_MESSAGE_ID -.. c:var:: int TS_MIME_LEN_CONTROL +"Newsgroups" + .. c:var:: const char* TS_MIME_FIELDNEWSGROUPS + .. c:var:: int TS_MIME_LEN_NEWSGROUPS -.. c:var:: const char* TS_MIME_FIELDCOOKIE - "Cookie" +"Organization" + .. c:var:: const char* TS_MIME_FIELDORGANIZATION + .. c:var:: int TS_MIME_LEN_ORGANIZATION -.. c:var:: int TS_MIME_LEN_COOKIE +"Path" + .. c:var:: const char* TS_MIME_FIELDPATH + .. c:var:: int TS_MIME_LEN_PATH -.. c:var:: const char* TS_MIME_FIELDDATE - "Date" +"Pragma" + .. c:var:: const char* TS_MIME_FIELDPRAGMA + .. c:var:: int TS_MIME_LEN_PRAGMA -.. c:var:: int TS_MIME_LEN_DATE +"Proxy-Authenticate" + .. c:var:: const char* TS_MIME_FIELDPROXY_AUTHENTICATE + .. c:var:: int TS_MIME_LEN_PROXY_AUTHENTICATE -.. c:var:: const char* TS_MIME_FIELDDISTRIBUTION - "Distribution" +"Proxy-Authorization" + .. c:var:: const char* TS_MIME_FIELDPROXY_AUTHORIZATION + .. c:var:: int TS_MIME_LEN_PROXY_AUTHORIZATION -.. c:var:: int TS_MIME_LEN_DISTRIBUTION +"Proxy-Connection" + .. c:var:: const char* TS_MIME_FIELDPROXY_CONNECTION + .. c:var:: int TS_MIME_LEN_PROXY_CONNECTION -.. c:var:: const char* TS_MIME_FIELDETAG - "Etag" +"Public" + .. c:var:: const char* TS_MIME_FIELDPUBLIC + .. c:var:: int TS_MIME_LEN_PUBLIC -.. c:var:: int TS_MIME_LEN_ETAG +"Range" + .. c:var:: const char* TS_MIME_FIELDRANGE + .. c:var:: int TS_MIME_LEN_RANGE -.. c:var:: const char* TS_MIME_FIELDEXPECT - "Expect" +"References" + .. c:var:: const char* TS_MIME_FIELDREFERENCES + .. c:var:: int TS_MIME_LEN_REFERENCES -.. c:var:: int TS_MIME_LEN_EXPECT +"Referer" + .. c:var:: const char* TS_MIME_FIELDREFERER + .. c:var:: int TS_MIME_LEN_REFERER -.. c:var:: const char* TS_MIME_FIELDEXPIRES - "Expires" +"Reply-To" + .. c:var:: const char* TS_MIME_FIELDREPLY_TO + .. c:var:: int TS_MIME_LEN_REPLY_TO -.. c:var:: int TS_MIME_LEN_EXPIRES +"Retry-After" + .. c:var:: const char* TS_MIME_FIELDRETRY_AFTER + .. c:var:: int TS_MIME_LEN_RETRY_AFTER -.. c:var:: const char* TS_MIME_FIELDFOLLOWUP_TO - "Followup-To" +"Sender" + .. c:var:: const char* TS_MIME_FIELDSENDER + .. c:var:: int TS_MIME_LEN_SENDER -.. c:var:: int TS_MIME_LEN_FOLLOWUP_TO +"Server" + .. c:var:: const char* TS_MIME_FIELDSERVER + .. c:var:: int TS_MIME_LEN_SERVER -.. c:var:: const char* TS_MIME_FIELDFROM - "From" +"Set-Cookie" + .. c:var:: const char* TS_MIME_FIELDSET_COOKIE + .. c:var:: int TS_MIME_LEN_SET_COOKIE -.. c:var:: int TS_MIME_LEN_FROM +"Subject" + .. c:var:: const char* TS_MIME_FIELDSUBJECT + .. c:var:: int TS_MIME_LEN_SUBJECTTS_MIME_LEN_SUBJECT -.. c:var:: const char* TS_MIME_FIELDHOST - "Host" +"Summary" + .. c:var:: const char* TS_MIME_FIELDSUMMARY + .. c:var:: int TS_MIME_LEN_SUMMARY -.. c:var:: int TS_MIME_LEN_HOST +"TE" + .. c:var:: const char* TS_MIME_FIELDTE + .. c:var:: int TS_MIME_LEN_TE -.. c:var:: const char* TS_MIME_FIELDIF_MATCH - "If-Match" +"Transfer-Encoding" + .. c:var:: const char* TS_MIME_FIELDTRANSFER_ENCODING + .. c:var:: int TS_MIME_LEN_TRANSFER_ENCODING -.. c:var:: int TS_MIME_LEN_IF_MATCH +"Upgrade" + .. c:var:: const char* TS_MIME_FIELDUPGRADE + .. c:var:: int TS_MIME_LEN_UPGRADE -.. c:var:: const char* TS_MIME_FIELDIF_MODIFIED_SINCE - "If-Modified-Since" +"User-Agent" + .. c:var:: const char* TS_MIME_FIELDUSER_AGENT + .. c:var:: int TS_MIME_LEN_USER_AGENT -.. c:var:: int TS_MIME_LEN_IF_MODIFIED_SINCE +"Vary" + .. c:var:: const char* TS_MIME_FIELDVARY + .. c:var:: int TS_MIME_LEN_VARY -.. c:var:: const char* TS_MIME_FIELDIF_NONE_MATCH - "If-None-Match" +"Via" + .. c:var:: const char* TS_MIME_FIELDVIA + .. c:var:: int TS_MIME_LEN_VIA -.. c:var:: int TS_MIME_LEN_IF_NONE_MATCH +"Warning" + .. c:var:: const char* TS_MIME_FIELDWARNING + .. c:var:: int TS_MIME_LEN_WARNING -.. c:var:: const char* TS_MIME_FIELDIF_RANGE - "If-Range" +"Www-Authenticate" + .. c:var:: const char* TS_MIME_FIELDWWW_AUTHENTICATE + .. c:var:: int TS_MIME_LEN_WWW_AUTHENTICATE -.. c:var:: int TS_MIME_LEN_IF_RANGE - -.. c:var:: const char* TS_MIME_FIELDIF_UNMODIFIED_SINCE - "If-Unmodified-Since" - -.. c:var:: int TS_MIME_LEN_IF_UNMODIFIED_SINCE - -.. c:var:: const char* TS_MIME_FIELDKEEP_ALIVE - "Keep-Alive" - -.. c:var:: int TS_MIME_LEN_KEEP_ALIVE - -.. c:var:: const char* TS_MIME_FIELDKEYWORDS - "Keywords" - -.. c:var:: int TS_MIME_LEN_KEYWORDS - -.. c:var:: const char* TS_MIME_FIELDLAST_MODIFIED - "Last-Modified" - -.. c:var:: int TS_MIME_LEN_LAST_MODIFIED - -.. c:var:: const char* TS_MIME_FIELDLINES - "Lines" - -.. c:var:: int TS_MIME_LEN_LINES - -.. c:var:: const char* TS_MIME_FIELDLOCATION - "Location" - -.. c:var:: int TS_MIME_LEN_LOCATION - -.. c:var:: const char* TS_MIME_FIELDMAX_FORWARDS - "Max-Forwards" - -.. c:var:: int TS_MIME_LEN_MAX_FORWARDS - -.. c:var:: const char* TS_MIME_FIELDMESSAGE_ID - "Message-ID" - -.. c:var:: int TS_MIME_LEN_MESSAGE_ID - -.. c:var:: const char* TS_MIME_FIELDNEWSGROUPS - "Newsgroups" - -.. c:var:: int TS_MIME_LEN_NEWSGROUPS - -.. c:var:: const char* TS_MIME_FIELDORGANIZATION - "Organization" - -.. c:var:: int TS_MIME_LEN_ORGANIZATION - -.. c:var:: const char* TS_MIME_FIELDPATH - "Path" - -.. c:var:: int TS_MIME_LEN_PATH - -.. c:var:: const char* TS_MIME_FIELDPRAGMA - "Pragma" - -.. c:var:: int TS_MIME_LEN_PRAGMA - -.. c:var:: const char* TS_MIME_FIELDPROXY_AUTHENTICATE - "Proxy-Authenticate" - -.. c:var:: int TS_MIME_LEN_PROXY_AUTHENTICATE - -.. c:var:: const char* TS_MIME_FIELDPROXY_AUTHORIZATION - "Proxy-Authorization" - -.. c:var:: int TS_MIME_LEN_PROXY_AUTHORIZATION - -.. c:var:: const char* TS_MIME_FIELDPROXY_CONNECTION - "Proxy-Connection" - -.. c:var:: int TS_MIME_LEN_PROXY_CONNECTION - -.. c:var:: const char* TS_MIME_FIELDPUBLIC - "Public" - -.. c:var:: int TS_MIME_LEN_PUBLIC - -.. c:var:: const char* TS_MIME_FIELDRANGE - "Range" - -.. c:var:: int TS_MIME_LEN_RANGE - -.. c:var:: const char* TS_MIME_FIELDREFERENCES - "References" - -.. c:var:: int TS_MIME_LEN_REFERENCES - -.. c:var:: const char* TS_MIME_FIELDREFERER - "Referer" - -.. c:var:: int TS_MIME_LEN_REFERER - -.. c:var:: const char* TS_MIME_FIELDREPLY_TO - "Reply-To" - -.. c:var:: int TS_MIME_LEN_REPLY_TO - -.. c:var:: const char* TS_MIME_FIELDRETRY_AFTER - "Retry-After" - -.. c:var:: int TS_MIME_LEN_RETRY_AFTER - -.. c:var:: const char* TS_MIME_FIELDSENDER - "Sender" - -.. c:var:: int TS_MIME_LEN_SENDER - -.. c:var:: const char* TS_MIME_FIELDSERVER - "Server" - -.. c:var:: int TS_MIME_LEN_SERVER - -.. c:var:: const char* TS_MIME_FIELDSET_COOKIE - "Set-Cookie" - -.. c:var:: int TS_MIME_LEN_SET_COOKIE - -.. c:var:: const char* TS_MIME_FIELDSUBJECT - "Subject" - -.. c:var:: int TS_MIME_LEN_SUBJECTTS_MIME_LEN_SUBJECT - -.. c:var:: const char* TS_MIME_FIELDSUMMARY - "Summary" - -.. c:var:: int TS_MIME_LEN_SUMMARY - -.. c:var:: const char* TS_MIME_FIELDTE - "TE" - -.. c:var:: int TS_MIME_LEN_TE - -.. c:var:: const char* TS_MIME_FIELDTRANSFER_ENCODING - "Transfer-Encoding" - -.. c:var:: int TS_MIME_LEN_TRANSFER_ENCODING - -.. c:var:: const char* TS_MIME_FIELDUPGRADE - "Upgrade" - -.. c:var:: int TS_MIME_LEN_UPGRADE - -.. c:var:: const char* TS_MIME_FIELDUSER_AGENT - "User-Agent" - -.. c:var:: int TS_MIME_LEN_USER_AGENT - -.. c:var:: const char* TS_MIME_FIELDVARY - "Vary" - -.. c:var:: int TS_MIME_LEN_VARY - -.. c:var:: const char* TS_MIME_FIELDVIA - "Via" - -.. c:var:: int TS_MIME_LEN_VIA - -.. c:var:: const char* TS_MIME_FIELDWARNING - "Warning" - -.. c:var:: int TS_MIME_LEN_WARNING - -.. c:var:: const char* TS_MIME_FIELDWWW_AUTHENTICATE - "Www-Authenticate" - -.. c:var:: int TS_MIME_LEN_WWW_AUTHENTICATE - -.. c:var:: const char* TS_MIME_FIELDXREF - "Xref" - -.. c:var:: int TS_MIME_LEN_XREF +"Xref" + .. c:var:: const char* TS_MIME_FIELDXREF + .. c:var:: int TS_MIME_LEN_XREF The header field names above are defined in ``ts.h`` as ``const char*`` strings. When Traffic Server sets the name portion of a header field (or diff --git a/doc/developer-guide/plugins/http-headers/urls.en.rst b/doc/developer-guide/plugins/http-headers/urls.en.rst index aab96234ba3..af439f3c5ae 100644 --- a/doc/developer-guide/plugins/http-headers/urls.en.rst +++ b/doc/developer-guide/plugins/http-headers/urls.en.rst @@ -27,16 +27,12 @@ The URL functions can create, copy, retrieve or delete entire URLs; they can also retrieve or modify parts of URLs, such as port or scheme information. -The general form of an Internet URL is: - -:: +The general form of an Internet URL is:: scheme://user:password@host:port/stuff The URL data structure includes support for two specific types of -internet URLs. HTTP URLs have the form: - -:: +internet URLs. HTTP URLs have the form:: http://user:password@host:port/path;params?query#fragment @@ -49,82 +45,66 @@ instance, the function that retrieves the host portion of a URL is named To facilitate fast comparisons and reduce storage size, Traffic Server defines several preallocated scheme names. -.. c:var:: TS_URL_SCHEME_FILE - "file" - -.. c:var:: TS_URL_LEN_FILE - -.. c:var:: TS_URL_SCHEME_FTP - "ftp" - -.. c:var:: TS_URL_LEN_FTP - -.. c:var:: TS_URL_SCHEME_GOPHER - "gopher" - -.. c:var:: TS_URL_LEN_GOPHER - -.. c:var:: TS_URL_SCHEME_HTTP - "http" - -.. c:var:: TS_URL_LEN_HTTP - -.. c:var:: TS_URL_SCHEME_HTTPS - "https" - -.. c:var:: TS_URL_LEN_HTTPS - -.. c:var:: TS_URL_SCHEME_MAILTO - "mailto" - -.. c:var:: TS_URL_LEN_MAILTO - -.. c:var:: TS_URL_SCHEME_NEWS - "news" - -.. c:var:: TS_URL_LEN_NEWS - -.. c:var:: TS_URL_SCHEME_NNTP - "nntp" - -.. c:var:: TS_URL_LEN_NNTP - -.. c:var:: TS_URL_SCHEME_PROSPERO - "prospero" - -.. c:var:: TS_URL_LEN_PROSPERO - -.. c:var:: TS_URL_SCHEME_TELNET - "telnet" - -.. c:var:: TS_URL_LEN_TELNET - -.. c:var:: TS_URL_SCHEME_WAIS - "wais" - -.. c:var:: TS_URL_LEN_WAIS - -.. c:var:: TS_URL_SCHEME_WS - "ws" - -.. c:var:: TS_URL_LEN_WS - -.. c:var:: TS_URL_SCHEME_WSS - "wss" - -.. c:var:: TS_URL_LEN_WSS - -The scheme names above are defined in ``ts.h`` as ``const`` ``char*`` -strings. When Traffic Server sets the scheme portion of the URL (or any -portion for that matter), it quickly checks to see if the new value is -one of the known values. If it is, then it stores a pointer into a -global table (instead of storing the known value in the marshal buffer). -The scheme values listed above are also pointers into this table. This -allows simple pointer comparison of the value returned from -``TSUrlSchemeGet`` or ``TSUrlRawSchemeGet`` with one of the values -listed above. You should use the Traffic Server-defined values when -referring to one of the known schemes, since doing so can prevent the -possibility of spelling errors. +"file" + .. c:var:: char const * TS_URL_SCHEME_FILE + .. c:var:: int TS_URL_LEN_FILE + +"ftp" + .. c:var:: char const * TS_URL_SCHEME_FTP + .. c:var:: int TS_URL_LEN_FTP + +"gopher" + .. c:var:: char const * TS_URL_SCHEME_GOPHER + .. c:var:: int TS_URL_LEN_GOPHER + +"http" + .. c:var:: char const * TS_URL_SCHEME_HTTP + .. c:var:: int TS_URL_LEN_HTTP + +"https" + .. c:var:: char const * TS_URL_SCHEME_HTTPS + .. c:var:: int TS_URL_LEN_HTTPS + +"mailto" + .. c:var:: char const * TS_URL_SCHEME_MAILTO + .. c:var:: int TS_URL_LEN_MAILTO + +"news" + .. c:var:: char const * TS_URL_SCHEME_NEWS + .. c:var:: int TS_URL_LEN_NEWS + +"nntp" + .. c:var:: char const * TS_URL_SCHEME_NNTP + .. c:var:: int TS_URL_LEN_NNTP + +"prospero" + .. c:var:: char const * TS_URL_SCHEME_PROSPERO + .. c:var:: int TS_URL_LEN_PROSPERO + +"telnet" + .. c:var:: char const * TS_URL_SCHEME_TELNET + .. c:var:: int TS_URL_LEN_TELNET + +"wais" + .. c:var:: char const * TS_URL_SCHEME_WAIS + .. c:var:: int TS_URL_LEN_WAIS + +"ws" + .. c:var:: char const * TS_URL_SCHEME_WS + .. c:var:: int TS_URL_LEN_WS + +"wss" + .. c:var:: char const * TS_URL_SCHEME_WSS + .. c:var:: int TS_URL_LEN_WSS + +The scheme names above are defined in ``apidefs.h``. When Traffic Server sets the scheme portion of +the URL (or any portion for that matter), it quickly checks to see if the new value is one of the +known values. If it is, then it stores a pointer into a global table (instead of storing the known +value in the marshal buffer). The scheme values listed above are also pointers into this table. This +allows simple pointer comparison of the value returned from ``TSUrlSchemeGet`` or +``TSUrlRawSchemeGet`` with one of the values listed above. You should use the Traffic Server-defined +values when referring to one of the known schemes, since doing so can prevent the possibility of +spelling errors. Traffic Server **URL functions** are listed below: